dokeos
[ class tree: dokeos ] [ index: dokeos ] [ all elements ]

Procedural File: common.inc

Source Location: /plugin/search/server/www/common.inc



Page Details:

Library for the common formatting functions



Tags:

filesource:  Source Code for this file








exit_local [line 9]

void exit_local( [integer $print_err = 1])

Exit, dropping the temporary tables just before that



Parameters

integer   $print_err   Whether to print an error message (passed to drop_temp_table())
[ Top ]



format_dp [line 62]

integer format_dp( string $dp)

Format date in seconds from a source in s,M,h,d,m,y



Tags:

return:  Date in seconds


Parameters

string   $dp   Date
[ Top ]



format_lastmod [line 49]

string format_lastmod( integer $lastmod)

Format last modified date



Tags:

return:  Formatted date


Parameters

integer   $lastmod   UNIX Timestamp?
[ Top ]



format_userdate [line 93]

string format_userdate( string $date)

Formats the date using the user's settings as defined in search.html



Tags:

return:  Formatted date


Parameters

string   $date   Date
[ Top ]



get_doc_count [line 33]

mixed get_doc_count( )

Gets the number of documents from the udm object



Tags:

return:  An integer or "Unknown" if not found


[ Top ]



ParseDocText [line 113]

string ParseDocText( string $text)

Parses the given text for the words searched and highlight the words, the returns the string



Tags:

return:  Same string but with highlight tags (as defined in search.html)


Parameters

string   $text   Resulting document excerpt
[ Top ]



ParseQString [line 139]

void ParseQString( )

Parses the global variable $QUERY_STRING



[ Top ]



print_error_local [line 18]

void print_error_local( string $str)

Prints the error and the template bottom, then exit



Parameters

string   $str   The error message
[ Top ]



Documentation generated on Thu, 12 Jun 2008 13:08:06 -0500 by phpDocumentor 1.4.1