WeakWiki


Functions


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

allowEdit()

Returns if the current user has edit privileges.

void

allowRead()

Returns if the current user has read privileges.

void

currentUser()

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

getStartTopic()

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

getUserNames()

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.

Function Detail

modules\history\history_zlib.php at line 32

_createHistory

public void _createHistory(mixed title)

Creates a history file for a wiki entry. @param $title Wiki entry title.


lib\parser.library.php at line 550

_format_class

public void _format_class(mixed startTag, mixed text)

Formats flagged area. @param $startTag Start tag. @param $text Text. @return Parsed start tag.


lib\parser.library.php at line 537

_format_html

public void _format_html(mixed startTag, mixed text)

Formats HTML-enabled area. @param $startTag Start tag. @param $text Text. @return Parsed start tag.


modules\geshism\geshism.module.php at line 85

_geshi_parse

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.


lib\parser.library.php at line 405

_getArea

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.


lib\parser.library.php at line 750

_getCellFlags

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.


modules\history\history_zlib.php at line 54

_getHistory

public void _getHistory(mixed title, bool expand)

Gets the history file. @param $title Title.


lib\parser.library.php at line 381

_getMask

public void _getMask(mixed input)

Returns a unique mask string not contained in the input string. @param $input Input text. @return Mask string.


modules\history\history_zlib.php at line 103

_getPrevious

public void _getPrevious(mixed title, mixed id)

Gets the file previous to a file from history. @param $title Title. @param $id File ID.


modules\history\history_zlib.php at line 77

_getText

public void _getText(mixed title, mixed id)

Gets a file from history. @param $title Title. @param $id File ID.


lib\engine.library.php at line 697

_gzdecode

public void _gzdecode(mixed data)

Uncompresses a zlib-compressed string. @param $data String.


lib\lang.library.php at line 39

_lang

public void _lang(mixed file)

Returns the language file for a given source file. @param $file Source file name. @return Language file path.


lib\parser.library.php at line 588

_nextStop

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.


lib\parser.library.php at line 484

_parseBraced

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.


lib\parser.library.php at line 791

_parseHeadings

public void _parseHeadings(mixed input)

Parses headings. @param $input Input string. @return Parsed string.


lib\parser.library.php at line 426

_parseList

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.


lib\parser.library.php at line 609

_parseRawLinks

public void _parseRawLinks(mixed input)

Parses raw links. @param $input Input string. @return Parsed string.


lib\parser.library.php at line 657

_parseTables

public void _parseTables(mixed input)

Parses tables @param $input Input string. @return Parsed string.


modules\history\history_zlib.php at line 190

_renameHistory

public void _renameHistory(mixed oldTitle, mixed newTitle)

Renames history file. @param $oldTitle Old title. @param $newTitle New title.


lib\parser.library.php at line 563

_table_flags

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.


modules\history\history_zlib.php at line 144

_writeHistory

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.


lib\uc.library.php at line 578

allowEdit

public void allowEdit()

Returns if the current user has edit privileges. @return TRUE if current user has edit privileges. Otherwise returns FALSE.


lib\uc.library.php at line 566

allowRead

public void allowRead()

Returns if the current user has read privileges. @return TRUE if current user has read privileges. Otherwise returns FALSE.


lib\uc.library.php at line 556

currentUser

public void currentUser()

Returns the current user. @return Current session's user. NULL if no session.


lib\engine.library.php at line 681

formatSource

public void formatSource(mixed text)

Formats source code. @param $text Source.


lib\engine.library.php at line 673

fromTitle

public void fromTitle(mixed title)

Formats system-complient wiki title into textual wiki title. @param $title Input string. @return Formatted string.


modules\forum\forum.support.include.php at line 373

getStartTopic

public void getStartTopic()

Returns the start topic. @return Start topic.


modules\forum\forum.support.include.php at line 381

getTopic

public void getTopic(mixed file)

Returns the topic. @return Topic.


lib\uc.library.php at line 543

getUser

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.


lib\uc.library.php at line 528

getUserByEMail

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.


lib\uc.library.php at line 482

getUserNames

public void getUserNames()

Returns an array containing all user objects on the system. @return Array of users.


lib\uc.library.php at line 511

getUsers

public void getUsers()

Returns an array containing all user objects on the system. @return Array of users.


lib\uc.library.php at line 590

isAdmin

public void isAdmin()

Returns if the current user has superuser privileges. @return TRUE if current user has superuser privileges. Otherwise returns FALSE.


lib\engine.library.php at line 647

jwrite

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).


lib\uc.library.php at line 448

logon

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.


lib\uc.library.php at line 465

logout

public void logout()

Logs out a user.


lib\engine.library.php at line 659

toTitle

public void toTitle(mixed title)

Formats input string as a file system-complient wiki title. @param $title Input string. @return Formatted string.


lib\uc.library.php at line 474

userExists

public void userExists(mixed uid)

Returns if a user exists. @return TRUE if the user object exists, otherwise FALSE.


lib\parser.library.php at line 45

wikiParse

public void wikiParse(mixed input)

Parses wiki markup text @param $input Text. @return Parsed text.


WeakWiki