Function Summary | |
---|---|
void | _createHistory(mixed title) Creates a history file for a wiki entry. |
void | _format_class(mixed startTag, mixed text) Formats flagged area. |
void | _format_html(mixed startTag, mixed text) Formats HTML-enabled area. |
void | _geshi_parse(mixed startTag, mixed text) Translates table flags into CSS classes. |
void | _getArea(mixed input, mixed start, mixed end, int pos) Returns the text area between markup-tags given. |
void | _getCellFlags(mixed value, mixed tclass, mixed rclass, mixed cclass) Gets cell flags for flagging tables. |
void | _getHistory(mixed title, bool expand) Gets the history file. |
void | _getMask(mixed input) Returns a unique mask string not contained in the input string. |
void | _getPrevious(mixed title, mixed id) Gets the file previous to a file from history. |
void | _getText(mixed title, mixed id) Gets a file from history. |
void | _gzdecode(mixed data) Uncompresses a zlib-compressed string. |
void | _lang(mixed file) Returns the language file for a given source file. |
void | _nextStop(mixed input, mixed stop, mixed pos) Returns the position of the next stop character. |
void | _parseBraced(mixed input, mixed start, mixed end, mixed starttag, mixed endtag, mixed disallow) Parses braced areas into their HTML representations. |
void | _parseHeadings(mixed input) Parses headings. |
void | _parseList(mixed input, mixed symbol, mixed tag) Parses ordered and unordered lists. |
void | _parseRawLinks(mixed input) Parses raw links. |
void | _parseTables(mixed input) Parses tables @param $input Input string. |
void | _renameHistory(mixed oldTitle, mixed newTitle) Renames history file. |
void | _table_flags(mixed startTag, mixed text) Translates table flags into CSS classes. |
void | _writeHistory(mixed title, mixed text) Writes into a wiki entry history file. |
void | Returns if the current user has edit privileges. |
void | Returns if the current user has read privileges. |
void | Returns the current user. |
void | formatSource(mixed text) Formats source code. |
void | fromTitle(mixed title) Formats system-complient wiki title into textual wiki title. |
void | Returns the start topic. |
void | getTopic(mixed file) Returns the topic. |
void | getUser(mixed uid) Returns a user object by its user ID. |
void | getUserByEMail(mixed email) Returns a user object by its e-mail address. |
void | Returns an array containing all user objects on the system. |
void | getUsers() Returns an array containing all user objects on the system. |
void | isAdmin() Returns if the current user has superuser privileges. |
void | jwrite(mixed text, str document, str uid) Returns a link to collapse/expand the side bar. |
void | logon(mixed uid, mixed password) Allows a user to log in to the system. |
void | logout() Logs out a user. |
void | toTitle(mixed title) Formats input string as a file system-complient wiki title. |
void | userExists(mixed uid) Returns if a user exists. |
void | wikiParse(mixed input) Parses wiki markup text @param $input Text. |
public void _createHistory(mixed title)
Creates a history file for a wiki entry. @param $title Wiki entry title.
public void _format_class(mixed startTag, mixed text)
Formats flagged area. @param $startTag Start tag. @param $text Text. @return Parsed start tag.
public void _format_html(mixed startTag, mixed text)
Formats HTML-enabled area. @param $startTag Start tag. @param $text Text. @return Parsed start tag.
public void _geshi_parse(mixed startTag, mixed text)
Translates table flags into CSS classes. @param $startTag Start tag. @param $text Text. @return Parsed start tag.
public void _getArea(mixed input, mixed start, mixed end, int pos)
Returns the text area between markup-tags given. @param $input Input text. @param $start Start tag. @param $end End tag. @param $pos Takes the position within the text to start from. _getArea() will also write the end position of the area found in $pos. If no area could be found, $pos will be set to -1. @return Returns the markup text of the found area.
public void _getCellFlags(mixed value, mixed tclass, mixed rclass, mixed cclass)
Gets cell flags for flagging tables. @param $value Cell value. @param $tclass CSS table class. @param $rclass CSS row class. @param $cclass CSS cell class.
public void _getHistory(mixed title, bool expand)
Gets the history file. @param $title Title.
public void _getMask(mixed input)
Returns a unique mask string not contained in the input string. @param $input Input text. @return Mask string.
public void _getPrevious(mixed title, mixed id)
Gets the file previous to a file from history. @param $title Title. @param $id File ID.
public void _getText(mixed title, mixed id)
Gets a file from history. @param $title Title. @param $id File ID.
public void _gzdecode(mixed data)
Uncompresses a zlib-compressed string. @param $data String.
public void _lang(mixed file)
Returns the language file for a given source file. @param $file Source file name. @return Language file path.
public void _nextStop(mixed input, mixed stop, mixed pos)
Returns the position of the next stop character. @param $input Input string. @param $stop Stop character list. @param $pos Start position. @return Position of the character from the stop list next to the starting position.
public void _parseBraced(mixed input, mixed start, mixed end, mixed starttag, mixed endtag, mixed disallow)
Parses braced areas into their HTML representations. @param $input Input string. @param $start Wiki markup start tag. @param $end Wiki markup end tag. @param $starttag HTML markup start tag. @param $endtag HTML markup end tag. @param $disallow (optional) Array of disallowed symbols within the area. @return Parsed text.
public void _parseHeadings(mixed input)
Parses headings. @param $input Input string. @return Parsed string.
public void _parseList(mixed input, mixed symbol, mixed tag)
Parses ordered and unordered lists. @param $input Input text. @param $symbol Wiki markup tag. @param $tag HTML tag. @return Returns the input text with all lists parsed.
public void _parseRawLinks(mixed input)
Parses raw links. @param $input Input string. @return Parsed string.
public void _parseTables(mixed input)
Parses tables @param $input Input string. @return Parsed string.
public void _renameHistory(mixed oldTitle, mixed newTitle)
Renames history file. @param $oldTitle Old title. @param $newTitle New title.
public void _table_flags(mixed startTag, mixed text)
Translates table flags into CSS classes. @param $startTag Start tag. @param $text Text. @return Parsed start tag.
public void _writeHistory(mixed title, mixed text)
Writes into a wiki entry history file. @param $title Wiki entry title. @param $text History log text. @return Unique ID for associated wiki plaintext.
public void allowEdit()
Returns if the current user has edit privileges. @return TRUE if current user has edit privileges. Otherwise returns FALSE.
public void allowRead()
Returns if the current user has read privileges. @return TRUE if current user has read privileges. Otherwise returns FALSE.
public void currentUser()
Returns the current user. @return Current session's user. NULL if no session.
public void formatSource(mixed text)
Formats source code. @param $text Source.
public void fromTitle(mixed title)
Formats system-complient wiki title into textual wiki title. @param $title Input string. @return Formatted string.
public void getStartTopic()
Returns the start topic. @return Start topic.
public void getTopic(mixed file)
Returns the topic. @return Topic.
public void getUser(mixed uid)
Returns a user object by its user ID. @param $uid User ID. @return User object. NULL if no user with the given user ID exists.
public void getUserByEMail(mixed email)
Returns a user object by its e-mail address. @param $email e-mail address. @return User object. NULL if no user with the given e-mail address exists.
public void getUserNames()
Returns an array containing all user objects on the system. @return Array of users.
public void getUsers()
Returns an array containing all user objects on the system. @return Array of users.
public void isAdmin()
Returns if the current user has superuser privileges. @return TRUE if current user has superuser privileges. Otherwise returns FALSE.
public void jwrite(mixed text, str document, str uid)
Returns a link to collapse/expand the side bar. @param $mode Mode. SIDE_COLLAPSE or SIDE_EXPAND. @return Link. function linkSide($mode) { return _WIKI_COMMAND . '?action=' . $mode . '&' . str_replace('action=', 'paction=', str_replace('?', '&', $_SERVER['QUERY_STRING'])); } Returns a link to the referring page of a side bar collapse/expand. @return Link. function referSide() { return '?' . trim(str_replace('action=' . SIDE_EXPAND, '', str_replace('action=' . SIDE_COLLAPSE, '', str_replace('?', '&', $_SERVER['QUERY_STRING']))), '&'); } Writes a system log entry. @param $text Text. @param $document Document (optional). @param $uid User ID (optional).
public void logon(mixed uid, mixed password)
Allows a user to log in to the system. @param $uid User ID. @param $password Password. @return TRUE, if logon attampt was sucessfull, otherwise FALSE.
public void logout()
Logs out a user.
public void toTitle(mixed title)
Formats input string as a file system-complient wiki title. @param $title Input string. @return Formatted string.
public void userExists(mixed uid)
Returns if a user exists. @return TRUE if the user object exists, otherwise FALSE.
public void wikiParse(mixed input)
Parses wiki markup text @param $input Text. @return Parsed text.