Revision history for WikkaCore
Additions:
""<div style="float:right; width: 46%; padding: 4px 8px 2px 8px; background-color:#FEE; border:1px solid #EDD"><img src="images/icons/24x24/gnome-settings.png" title="todo" alt="todo icon" /> This page needs to be updated to match <strong>Wikka 1.1.6.6</strong></div><br style="clear:right"/>""
''Since the content of this page was always out of sync with actuall releases I have removed its outdated content. To get an overview please take a look at **libs/Wakka.class.php**.
''Since the content of this page was always out of sync with actuall releases I have removed its outdated content. To get an overview please take a look at **libs/Wakka.class.php**.
Deletions:
Below I try to descibe the functions of the Wikka core that Action writers may find useful. I would be pleased to see people filling the gaps in this page. Please help :). The description in most cases should mention received arguments, what the function does and what it returns.
----//Based on the WikkaWiki version 1.1.5.3 package ''(unless indicated otherwise)''//----
===Functions relating to the Database===
%%(php) Query($query)%%
Generic function that receives an SQL Query as an argument and executes it on the database.
It returns the result.
%%(php)LoadSingle($query)%%
Receives an SQL Query as an argument and executes it on the database.
It returns the first row of the result array.
%%(php) LoadAll($query)%%
Receives an SQL Query as an argument and executes it on the database.
It returns the result of the SQL operation in the form of an array.
%%(php) CheckMySQLVersion($major, $minor, $subminor)%%
As the function's name betrays it checks the string ##"$major.$minor.$subminor"## against the MySQL version hosted on the particular machine PHP is running on. It returns :
**1** //if the version is newer or equal to the provided arguments.//
**0** //if the version is older than the provided arguments.//
===Miscellaneous Utility Functions===
%%(php) GetMicroTime()%%
A utility function that is usefull to retrieve operation timing. It returns a number (float).
%%(php)IncludeBuffered($filename, $notfoundText = '', $vars = '', $path = '')%%
The main Actions loading function. It may come in handy in bigger modding projects on Wakka but for basic to novice Actions I can hardly think of how it can be used. It executes the contents of a given filename (##$filename##) in a given path (##$path##) allowing for customising the error message in case of an error. Variables (##$vars##) are passed to the loaded file.
%%(php)ReturnSafeHTML($html)%%
Receives any string (preferably HTML) and returns it filtered and comformed to the XHTML standards.
===Functions relating to Wakka Variables===
%%(php) GetPageTag()%%
Returns the tag (##""WikiPageName""##) of the current page, a string.
%%(php)GetPageTime()%%
Returns the creation date and time of the current page as a string in the form of: ##"2004-12-16 20:36:17"##.
%%(php)GetMethod()%%
Returns the method (for example: ##""WikiPage/edit""##) with which this page was called, as a string.
%%(php)GetConfigValue($name)%%
Returns the value from a configuration field (##$name##). Configuration is defined inside the ##wakka.conf.php## file inside the wakka installation folder. It reruns a string when ##$name## matches any field of the configuration file or //null// if the configuration file doesnt have a ##$name## field.
%%(php)GetWakkaName()%%
Is the same as doing : //##$this->""GetConfigValue""('wakka_name')##// (see above function).
%%(php)GetWakkaVersion()%%
Returns the Wakka version (not from a configuration field, hard-coded on ##wikka.php## beginning).
===Functions relating to ""WikiPages""===
%%(php) LoadPage($tag, $time = '', $cache = 1)%%
Returns the content of the page identified by ##$tag##. If ##$time## set, it will return the page stored at this time, else it will return the latest one. If ##$cache## set (and ##$time## not set), it will return, if it exists, the cached content of the page.
%%(php) IsLatestPage()%%
Returns a boolean (?, can't find where it is set in code) indicating whether or not the current page is the latest revision.
%%(php) GetCachedPage($tag)%%
Returns the content of the page identified by ##$tag## if it is available in cache. Else returns null.
%%(php) CachePage($page)%%
Set the content of the cache with ##$page##.
%%(php) SetPage($page)%%
%%(php) LoadPageById($id)%%
%%(php) LoadRevisions($page)%%
%%(php) LoadPagesLinkingTo($tag)%%
%%(php) LoadRecentlyChanged()%%
%%(php) LoadWantedPages()%%
%%(php) IsWantedPage($tag)%%
%%(php) LoadOrphanedPages()%%
%%(php) LoadPageTitles()%%
%%(php) LoadAllPages()%%
%%(php) FullTextSearch($phrase)%%
%%(php) FullCategoryTextSearch($phrase)%%
%%(php) SavePage($tag, $body, $note)%%
%%(php) PageTitle()%%
===COOKIES===
%%(php) SetSessionCookie($name, $value)%%
%%(php) SetPersistentCookie($name, $value)%%
%%(php) DeleteCookie($name)%%
%%(php) GetCookie($name)%%
===HTTP/REQUEST/LINK RELATED===
%%(php) SetMessage($message)%%
Set a message to be used for the Redirect function. //''No longer necessary in 1.1.6.0 - See ##""Redirect()""## below''//
%%(php) GetMessage()%%
%%(php) Redirect($url = '', $message = '')%% //''1.1.6.0''//
%%(php) MiniHref($method = '', $tag = '')%%
%%(php) Href($method = '', $tag = '', $params = '')%%
%%(php) Link($tag, $method = '', $text = '', $track = 1, $escapeText = 1, $title = '')%%
%%(php) IsWikiName($text)%%
%%(php) TrackLinkTo($tag)%%
%%(php) GetLinkTable()%%
%%(php) ClearLinkTable()%%
%%(php) StartLinkTracking()%%
%%(php) StopLinkTracking()%%
%%(php) WriteLinkTable()%%
%%(php) Header()%%
%%(php) Footer()%%
===FORMS===
%%(php) FormOpen($method = '', $tag = '', $formMethod = 'post')%%
%%(php) FormClose()%%
===INTERWIKI STUFF===
%%(php) ReadInterWikiConfig()%%
%%(php) AddInterWiki($name, $url)%%
%%(php) GetInterWikiUrl($name, $tag)%%
===REFERRERS===
%%(php) LogReferrer($tag = '', $referrer = '')%%
%%(php) LoadReferrers($tag = '')%%
===PLUGINS===
%%(php) Action($action, $forceLinkTracking = 0)%%
Responsible for executing the Actions /Plugins that are found in the ##/wikka/actions/## directory. It receives a string (##$action##) that specifies which file to execute. It also is responsible for passing the ##$vars## array to the executed php script. The file has to have a //##.php##// extension in order to be executed by this function.
%%(php)Method($method)%%
Returns the method that the current page was called by. Known methods are /edit /create /delete ...
%%(php)Format($text, $formatter = 'wakka')%%
Returns the parsed string (##$text##) after it has been parsed from the specified formatter (##$formatter##). If no ##$formatter## is supplied then it assumes the default "wakka" formatter that is responsible for converting the wiki syntax to displayable HTML. The availble formatters are found under the ##/wikka/formatters/## directory.
===Functions relating to **Users**===
%%(php) LoadUser($name, $password = 0)%%
%%(php) LoadUsers()%%
Returns an, alphabetically sorted by name, array of the users table. This array contains numerical indexes that hold a associative array of all the fields the ##wakka_users## table has, in the form of ##["field_name"] = > "field_value"## .
%%(php)GetUserName()%%
Returns the result of ##""GetUser""()## (see below) or the hostname of the visitor's host.
%%(php)GetUser()%%
Retreives the ""UserName"" of the visitor from the global php ##$_SESSION['user']## field. It is highly reccomended to use the ##""GetUserName""()## function instead of this one unless you have a special reason.
%%(php)SetUser($user)%%
Used in the ##Run()## function of the ##""WakkaCore""##. It fetches and sets the ##""UserName""## (if found) from a cookie.
%%(php)LogoutUser()%%
Removes any cookie send to the user using the ##""DeleteCookie""()## function, effectively forgetting the login of the particular user.
%%(php)UserWantsComments()%%
Returns true if the user is logged in and has set his preferences to show any page's comments by default. It returns false in any other case.
===Functions related to Comments===
%%(php) LoadComments($tag)%%
Returns an array of the comments on the received tag (""WikiPage""), sorted by time each comment record was made.
%%(php)LoadRecentComments($limit = 50)%%
Returns an array of the most recent ( depenting on the limit (##$limit##) ) number of comments to the current ""WikiPage"". The default value for the array size is 50.
%%(php)LoadRecentlyCommented($limit = 50)%%
Returns an array of the most recently commented ##""WikiPages""## in an array. The size of the array maybe be specified (##$limit##). The default value for ##$limit## is 50.
%%(php)SaveComment($page_tag, $comment)%%
Saves a comment (##$comment##) on a ##""WikiPage""## (##$page_tag##) to the database.
===Functions related to controling Access===
%%(php) UserIsOwner($tag = '')%%
Returns true if logged in user is owner of the provided page (##$tag##). If no ##$tag## is provided then it acts on the current page.
%%(php) IsAdmin()%%
Returns //##true##// if user is listed in configuration list as admin, //##false##// if any other case.
%%(php) GetPageOwner($tag = '', $time = '')%%
Returns the ##""UserName""## of the page's (##$tag##) owner. If no ##$tag## is provided when calling the function then it acts on the current page.
%%(php) SetPageOwner($tag, $user)%%
Sets the page's ($tag) ownership to the specified ""UserName"" ($user). Both arguments need to be provided.
%%(php) LoadACL($tag, $privilege, $useDefaults = 1)%%
Returns an array. The form of the array is as follows :
%%(php) array = {
["page_tag"] => $tag,
[$privilege."_acl"] => the_default_configuration_acl_for_this_privilege
}%%
%%(php) LoadAllACLs($tag, $useDefaults = 1)%%
%%(php) SaveACL($tag, $privilege, $list)%%
%%(php) TrimACLs($list)%%
%%(php) HasAccess($privilege, $tag = '', $user = '')%%
This returns true or 1 if the user (##$user##) can complete the requested action (##$privilege##) on the page (##$tag##). If no ##$tag## is provided then it acts on the displayed ""WikiPage"". If no ##$user## is provided then it acts on the current ""UserName"".
No Differences
Deletions:
Additions:
CategoryEN
CategoryReview
CategoryDevelopment
CategoryReview
CategoryDevelopment
Deletions:
Additions:
""<div style="float:right; width: 46%; padding: 4px 8px 2px 8px; background-color:#FEE; border:1px solid #EDD"><img src="images/icons/24x24/gnome-settings.png" title="todo" alt="todo icon" /> This page needs to be updated to match <strong>Wikka 1.1.6.4</strong></div><br style="clear:right"/>""
Deletions:
Additions:
HomePage
%%(php) Query($query)%%
%%(php)LoadSingle($query)%%
%%(php) LoadAll($query)%%
%%(php) CheckMySQLVersion($major, $minor, $subminor)%%
As the function's name betrays it checks the string ##"$major.$minor.$subminor"## against the MySQL version hosted on the particular machine PHP is running on. It returns :
%%(php) GetMicroTime()%%
%%(php)IncludeBuffered($filename, $notfoundText = '', $vars = '', $path = '')%%
The main Actions loading function. It may come in handy in bigger modding projects on Wakka but for basic to novice Actions I can hardly think of how it can be used. It executes the contents of a given filename (##$filename##) in a given path (##$path##) allowing for customising the error message in case of an error. Variables (##$vars##) are passed to the loaded file.
%%(php)ReturnSafeHTML($html)%%
Receives any string (preferably HTML) and returns it filtered and comformed to the XHTML standards.
%%(php) GetPageTag()%%
Returns the tag (##""WikiPageName""##) of the current page, a string.
%%(php)GetPageTime()%%
Returns the creation date and time of the current page as a string in the form of: ##"2004-12-16 20:36:17"##.
%%(php)GetMethod()%%
Returns the method (for example: ##""WikiPage/edit""##) with which this page was called, as a string.
%%(php)GetConfigValue($name)%%
Returns the value from a configuration field (##$name##). Configuration is defined inside the ##wakka.conf.php## file inside the wakka installation folder. It reruns a string when ##$name## matches any field of the configuration file or //null// if the configuration file doesnt have a ##$name## field.
%%(php)GetWakkaName()%%
Is the same as doing : //##$this->""GetConfigValue""('wakka_name')##// (see above function).
%%(php)GetWakkaVersion()%%
Returns the Wakka version (not from a configuration field, hard-coded on ##wikka.php## beginning).
%%(php) LoadPage($tag, $time = '', $cache = 1)%%
Returns the content of the page identified by ##$tag##. If ##$time## set, it will return the page stored at this time, else it will return the latest one. If ##$cache## set (and ##$time## not set), it will return, if it exists, the cached content of the page.
%%(php) IsLatestPage()%%
%%(php) GetCachedPage($tag)%%
Returns the content of the page identified by ##$tag## if it is available in cache. Else returns null.
%%(php) CachePage($page)%%
Set the content of the cache with ##$page##.
%%(php) SetPage($page)%%
%%(php) LoadPageById($id)%%
%%(php) LoadRevisions($page)%%
%%(php) LoadPagesLinkingTo($tag)%%
%%(php) LoadRecentlyChanged()%%
%%(php) LoadWantedPages()%%
%%(php) IsWantedPage($tag)%%
%%(php) LoadOrphanedPages()%%
%%(php) LoadPageTitles()%%
%%(php) LoadAllPages()%%
%%(php) FullTextSearch($phrase)%%
%%(php) FullCategoryTextSearch($phrase)%%
%%(php) SavePage($tag, $body, $note)%%
%%(php) PageTitle()%%
%%(php) SetSessionCookie($name, $value)%%
%%(php) SetPersistentCookie($name, $value)%%
%%(php) DeleteCookie($name)%%
%%(php) GetCookie($name)%%
%%(php) SetMessage($message)%%
Set a message to be used for the Redirect function. //''No longer necessary in 1.1.6.0 - See ##""Redirect()""## below''//
%%(php) GetMessage()%%
%%(php) Redirect($url = '', $message = '')%% //''1.1.6.0''//
%%(php) MiniHref($method = '', $tag = '')%%
%%(php) Href($method = '', $tag = '', $params = '')%%
%%(php) Link($tag, $method = '', $text = '', $track = 1, $escapeText = 1, $title = '')%%
%%(php) IsWikiName($text)%%
%%(php) TrackLinkTo($tag)%%
%%(php) GetLinkTable()%%
%%(php) ClearLinkTable()%%
%%(php) StartLinkTracking()%%
%%(php) StopLinkTracking()%%
%%(php) WriteLinkTable()%%
%%(php) Header()%%
%%(php) Footer()%%
%%(php) FormOpen($method = '', $tag = '', $formMethod = 'post')%%
%%(php) FormClose()%%
%%(php) ReadInterWikiConfig()%%
%%(php) AddInterWiki($name, $url)%%
%%(php) GetInterWikiUrl($name, $tag)%%
%%(php) LogReferrer($tag = '', $referrer = '')%%
%%(php) LoadReferrers($tag = '')%%
%%(php) Action($action, $forceLinkTracking = 0)%%
Responsible for executing the Actions /Plugins that are found in the ##/wikka/actions/## directory. It receives a string (##$action##) that specifies which file to execute. It also is responsible for passing the ##$vars## array to the executed php script. The file has to have a //##.php##// extension in order to be executed by this function.
%%(php)Method($method)%%
%%(php)Format($text, $formatter = 'wakka')%%
Returns the parsed string (##$text##) after it has been parsed from the specified formatter (##$formatter##). If no ##$formatter## is supplied then it assumes the default "wakka" formatter that is responsible for converting the wiki syntax to displayable HTML. The availble formatters are found under the ##/wikka/formatters/## directory.
%%(php) LoadUser($name, $password = 0)%%
%%(php) LoadUsers()%%
Returns an, alphabetically sorted by name, array of the users table. This array contains numerical indexes that hold a associative array of all the fields the ##wakka_users## table has, in the form of ##["field_name"] = > "field_value"## .
%%(php)GetUserName()%%
Returns the result of ##""GetUser""()## (see below) or the hostname of the visitor's host.
%%(php)GetUser()%%
Retreives the ""UserName"" of the visitor from the global php ##$_SESSION['user']## field. It is highly reccomended to use the ##""GetUserName""()## function instead of this one unless you have a special reason.
%%(php)SetUser($user)%%
Used in the ##Run()## function of the ##""WakkaCore""##. It fetches and sets the ##""UserName""## (if found) from a cookie.
%%(php)LogoutUser()%%
Removes any cookie send to the user using the ##""DeleteCookie""()## function, effectively forgetting the login of the particular user.
%%(php)UserWantsComments()%%
%%(php) LoadComments($tag)%%
%%(php)LoadRecentComments($limit = 50)%%
Returns an array of the most recent ( depenting on the limit (##$limit##) ) number of comments to the current ""WikiPage"". The default value for the array size is 50.
%%(php)LoadRecentlyCommented($limit = 50)%%
Returns an array of the most recently commented ##""WikiPages""## in an array. The size of the array maybe be specified (##$limit##). The default value for ##$limit## is 50.
%%(php)SaveComment($page_tag, $comment)%%
Saves a comment (##$comment##) on a ##""WikiPage""## (##$page_tag##) to the database.
%%(php) UserIsOwner($tag = '')%%
Returns true if logged in user is owner of the provided page (##$tag##). If no ##$tag## is provided then it acts on the current page.
%%(php) IsAdmin()%%
Returns //##true##// if user is listed in configuration list as admin, //##false##// if any other case.
%%(php) GetPageOwner($tag = '', $time = '')%%
Returns the ##""UserName""## of the page's (##$tag##) owner. If no ##$tag## is provided when calling the function then it acts on the current page.
%%(php) SetPageOwner($tag, $user)%%
%%(php) LoadACL($tag, $privilege, $useDefaults = 1)%%
%%(php) array = {
%%(php) LoadAllACLs($tag, $useDefaults = 1)%%
%%(php) SaveACL($tag, $privilege, $list)%%
%%(php) TrimACLs($list)%%
%%(php) HasAccess($privilege, $tag = '', $user = '')%%
This returns true or 1 if the user (##$user##) can complete the requested action (##$privilege##) on the page (##$tag##). If no ##$tag## is provided then it acts on the displayed ""WikiPage"". If no ##$user## is provided then it acts on the current ""UserName"".
CategoryEN - CategoryReview
%%(php) Query($query)%%
%%(php)LoadSingle($query)%%
%%(php) LoadAll($query)%%
%%(php) CheckMySQLVersion($major, $minor, $subminor)%%
As the function's name betrays it checks the string ##"$major.$minor.$subminor"## against the MySQL version hosted on the particular machine PHP is running on. It returns :
%%(php) GetMicroTime()%%
%%(php)IncludeBuffered($filename, $notfoundText = '', $vars = '', $path = '')%%
The main Actions loading function. It may come in handy in bigger modding projects on Wakka but for basic to novice Actions I can hardly think of how it can be used. It executes the contents of a given filename (##$filename##) in a given path (##$path##) allowing for customising the error message in case of an error. Variables (##$vars##) are passed to the loaded file.
%%(php)ReturnSafeHTML($html)%%
Receives any string (preferably HTML) and returns it filtered and comformed to the XHTML standards.
%%(php) GetPageTag()%%
Returns the tag (##""WikiPageName""##) of the current page, a string.
%%(php)GetPageTime()%%
Returns the creation date and time of the current page as a string in the form of: ##"2004-12-16 20:36:17"##.
%%(php)GetMethod()%%
Returns the method (for example: ##""WikiPage/edit""##) with which this page was called, as a string.
%%(php)GetConfigValue($name)%%
Returns the value from a configuration field (##$name##). Configuration is defined inside the ##wakka.conf.php## file inside the wakka installation folder. It reruns a string when ##$name## matches any field of the configuration file or //null// if the configuration file doesnt have a ##$name## field.
%%(php)GetWakkaName()%%
Is the same as doing : //##$this->""GetConfigValue""('wakka_name')##// (see above function).
%%(php)GetWakkaVersion()%%
Returns the Wakka version (not from a configuration field, hard-coded on ##wikka.php## beginning).
%%(php) LoadPage($tag, $time = '', $cache = 1)%%
Returns the content of the page identified by ##$tag##. If ##$time## set, it will return the page stored at this time, else it will return the latest one. If ##$cache## set (and ##$time## not set), it will return, if it exists, the cached content of the page.
%%(php) IsLatestPage()%%
%%(php) GetCachedPage($tag)%%
Returns the content of the page identified by ##$tag## if it is available in cache. Else returns null.
%%(php) CachePage($page)%%
Set the content of the cache with ##$page##.
%%(php) SetPage($page)%%
%%(php) LoadPageById($id)%%
%%(php) LoadRevisions($page)%%
%%(php) LoadPagesLinkingTo($tag)%%
%%(php) LoadRecentlyChanged()%%
%%(php) LoadWantedPages()%%
%%(php) IsWantedPage($tag)%%
%%(php) LoadOrphanedPages()%%
%%(php) LoadPageTitles()%%
%%(php) LoadAllPages()%%
%%(php) FullTextSearch($phrase)%%
%%(php) FullCategoryTextSearch($phrase)%%
%%(php) SavePage($tag, $body, $note)%%
%%(php) PageTitle()%%
%%(php) SetSessionCookie($name, $value)%%
%%(php) SetPersistentCookie($name, $value)%%
%%(php) DeleteCookie($name)%%
%%(php) GetCookie($name)%%
%%(php) SetMessage($message)%%
Set a message to be used for the Redirect function. //''No longer necessary in 1.1.6.0 - See ##""Redirect()""## below''//
%%(php) GetMessage()%%
%%(php) Redirect($url = '', $message = '')%% //''1.1.6.0''//
%%(php) MiniHref($method = '', $tag = '')%%
%%(php) Href($method = '', $tag = '', $params = '')%%
%%(php) Link($tag, $method = '', $text = '', $track = 1, $escapeText = 1, $title = '')%%
%%(php) IsWikiName($text)%%
%%(php) TrackLinkTo($tag)%%
%%(php) GetLinkTable()%%
%%(php) ClearLinkTable()%%
%%(php) StartLinkTracking()%%
%%(php) StopLinkTracking()%%
%%(php) WriteLinkTable()%%
%%(php) Header()%%
%%(php) Footer()%%
%%(php) FormOpen($method = '', $tag = '', $formMethod = 'post')%%
%%(php) FormClose()%%
%%(php) ReadInterWikiConfig()%%
%%(php) AddInterWiki($name, $url)%%
%%(php) GetInterWikiUrl($name, $tag)%%
%%(php) LogReferrer($tag = '', $referrer = '')%%
%%(php) LoadReferrers($tag = '')%%
%%(php) Action($action, $forceLinkTracking = 0)%%
Responsible for executing the Actions /Plugins that are found in the ##/wikka/actions/## directory. It receives a string (##$action##) that specifies which file to execute. It also is responsible for passing the ##$vars## array to the executed php script. The file has to have a //##.php##// extension in order to be executed by this function.
%%(php)Method($method)%%
%%(php)Format($text, $formatter = 'wakka')%%
Returns the parsed string (##$text##) after it has been parsed from the specified formatter (##$formatter##). If no ##$formatter## is supplied then it assumes the default "wakka" formatter that is responsible for converting the wiki syntax to displayable HTML. The availble formatters are found under the ##/wikka/formatters/## directory.
%%(php) LoadUser($name, $password = 0)%%
%%(php) LoadUsers()%%
Returns an, alphabetically sorted by name, array of the users table. This array contains numerical indexes that hold a associative array of all the fields the ##wakka_users## table has, in the form of ##["field_name"] = > "field_value"## .
%%(php)GetUserName()%%
Returns the result of ##""GetUser""()## (see below) or the hostname of the visitor's host.
%%(php)GetUser()%%
Retreives the ""UserName"" of the visitor from the global php ##$_SESSION['user']## field. It is highly reccomended to use the ##""GetUserName""()## function instead of this one unless you have a special reason.
%%(php)SetUser($user)%%
Used in the ##Run()## function of the ##""WakkaCore""##. It fetches and sets the ##""UserName""## (if found) from a cookie.
%%(php)LogoutUser()%%
Removes any cookie send to the user using the ##""DeleteCookie""()## function, effectively forgetting the login of the particular user.
%%(php)UserWantsComments()%%
%%(php) LoadComments($tag)%%
%%(php)LoadRecentComments($limit = 50)%%
Returns an array of the most recent ( depenting on the limit (##$limit##) ) number of comments to the current ""WikiPage"". The default value for the array size is 50.
%%(php)LoadRecentlyCommented($limit = 50)%%
Returns an array of the most recently commented ##""WikiPages""## in an array. The size of the array maybe be specified (##$limit##). The default value for ##$limit## is 50.
%%(php)SaveComment($page_tag, $comment)%%
Saves a comment (##$comment##) on a ##""WikiPage""## (##$page_tag##) to the database.
%%(php) UserIsOwner($tag = '')%%
Returns true if logged in user is owner of the provided page (##$tag##). If no ##$tag## is provided then it acts on the current page.
%%(php) IsAdmin()%%
Returns //##true##// if user is listed in configuration list as admin, //##false##// if any other case.
%%(php) GetPageOwner($tag = '', $time = '')%%
Returns the ##""UserName""## of the page's (##$tag##) owner. If no ##$tag## is provided when calling the function then it acts on the current page.
%%(php) SetPageOwner($tag, $user)%%
%%(php) LoadACL($tag, $privilege, $useDefaults = 1)%%
%%(php) array = {
%%(php) LoadAllACLs($tag, $useDefaults = 1)%%
%%(php) SaveACL($tag, $privilege, $list)%%
%%(php) TrimACLs($list)%%
%%(php) HasAccess($privilege, $tag = '', $user = '')%%
This returns true or 1 if the user (##$user##) can complete the requested action (##$privilege##) on the page (##$tag##). If no ##$tag## is provided then it acts on the displayed ""WikiPage"". If no ##$user## is provided then it acts on the current ""UserName"".
CategoryEN - CategoryReview
Deletions:
""Query($query)""
""LoadSingle($query)""
""LoadAll""($query)
""CheckMySQLVersion""($major, $minor, $subminor)
As the function's name betrays it checks the string "$major.$minor.$subminor" against the MySQL version hosted on the particular machine PHP is running on. It returns :
""GetMicroTime()""
""IncludeBuffered($filename, $notfoundText = '', $vars = '', $path = '')""
The main Actions loading function. It may come in handy in bigger modding projects on Wakka but for basic to novice Actions I can hardly think of how it can be used. It executes the contents of a given filename ($filename) in a given path ($path) allowing for customising the error message in case of an error. Variables ($vars) are passed to the loaded file.
""ReturnSafeHTML($html)""
Receives any string (preferably HTML, hehe) and returns it filtered and comformed to the XHTML standards.
""GetPageTag()""
Returns the tag (""WikiPageName"") of the current page, a string.
""GetPageTime()""
Returns the creation date and time of the current page as a string in the form of: "2004-12-16 20:36:17".
""GetMethod()""
Returns the method (for example: WikiPage/edit) with which this page was called, as a string.
""GetConfigValue($name)""
Returns the value from a configuration field ($name). Configuration is defined inside the wakka.conf.php file inside the wakka installation folder. It reruns a string when $name mathces any field of the configuration file or //null// if the configuration file doesnt have a $name field.
""GetWakkaName()""
Is the same as doing : //$this->""GetConfigValue""('wakka_name')// (see above function).
""GetWakkaVersion()""
Returns the Wakka version (not from a configuration field, hard-coded on wikka.php beginning).
""LoadPage($tag, $time = '', $cache = 1)""
Returns the content of the page identified by $tag. If $time set, it will return the page stored at this time, else it will return the latest one. If $cache set (and $time not set), it will return, if it exists, the cached content of the page.
""IsLatestPage()""
""GetCachedPage($tag)""
Returns the content of the page identified by $tag if it is available in cache. Else returns null.
""CachePage($page)""
Set the content of the cache with $page.
""SetPage($page)""
""LoadPageById($id)""
""LoadRevisions($page)""
""LoadPagesLinkingTo($tag)""
""LoadRecentlyChanged()""
""LoadWantedPages()""
""IsWantedPage($tag)""
""LoadOrphanedPages()""
""LoadPageTitles()""
""LoadAllPages()""
""FullTextSearch($phrase)""
""FullCategoryTextSearch($phrase)""
""SavePage($tag, $body, $note)""
""PageTitle()""
""SetSessionCookie($name, $value)""
""SetPersistentCookie($name, $value)""
""DeleteCookie($name)""
""GetCookie($name)""
""SetMessage($message)""
Set a message to be used for the Redirect function. //''No longer necessary in 1.1.6.0 - See ""Redirect()"" below''//
""GetMessage()""
""Redirect($url = '', $message = '')"" //''1.1.6.0''//
""MiniHref($method = '', $tag = '')""
""Href($method = '', $tag = '', $params = '')""
""Link($tag, $method = '', $text = '', $track = 1, $escapeText = 1, $title = '')""
""IsWikiName($text)""
""TrackLinkTo($tag)""
""GetLinkTable()""
""ClearLinkTable()""
""StartLinkTracking()""
""StopLinkTracking()""
""WriteLinkTable()""
""Header()""
""Footer()""
""FormOpen($method = '', $tag = '', $formMethod = 'post')""
""FormClose()""
""ReadInterWikiConfig()""
""AddInterWiki($name, $url)""
""GetInterWikiUrl($name, $tag)""
""LogReferrer($tag = '', $referrer = '')""
""LoadReferrers($tag = '')""
""Action($action, $forceLinkTracking = 0)""
Responsible for executing the Actions /Plugins that are found in the /wikka/actions/ directory. It receives a string ($action) that specifies which file to execute. It also is responsible for passing the $vars array to the executed php script. The file has to have a //.php// extension in order to be executed by this function.
""Method($method)""
""Format($text, $formatter = 'wakka')""
Returns the parsed string ($text) after it has been parsed from the specified formatter ($formatter). If no $formatter is supplied then it assumes the default "wakka" formatter that is responsible for converting the wiki syntax to displayable HTML. The availble formatters are found under the /wikka/formatters/ directory.
""LoadUser($name, $password = 0)""
""LoadUsers()""
Returns an, alphabetically sorted by name, array of the users table. This array contains numerical indexes that hold a associative array of all the fields the wakka_users table has, in the form of ["field_name"] = > "field_value" .
""GetUserName()""
Returns the result of ""GetUser""() (see below) or the hostname of the visitor's host.
""GetUser()""
Retreives the ""UserName"" of the visitor from the global php $_SESSION['user'] field. It is highly reccomended to use the ""GetUserName""() function instead of this one unless you have a special reason.
""SetUser($user)""
Used in the Run() function of the ""WakkaCore"". It fetches and sets the ""UserName"" (if found) from a cookie.
""LogoutUser()""
Removes any cookie send to the user using the ""DeleteCookie""() function, effectively forgetting the login of the particular user.
""UserWantsComments()""
""LoadComments($tag)""
""LoadRecentComments($limit = 50)""
Returns an array of the most recent ( depenting on the limit ($limit) ) number of comments to the current ""WikiPage"". The default value for the array size is 50.
""LoadRecentlyCommented($limit = 50)""
Returns an array of the most recently commented ""WikiPages"" in an array. The size of the array maybe be specified ($limit). The default value for $limit is 50.
""SaveComment($page_tag, $comment)""
Saves a comment ($comment) on a ""WikiPage"" ($page_tag) to the database.
""UserIsOwner($tag = '')""
Returns true if logged in user is owner of the provided page ($tag). If no $tag is provided then it acts on the current page.
""IsAdmin()""
Returns //true// if user is listed in configuration list as admin, //false// if any other case.
""GetPageOwner($tag = '', $time = '')""
Returns the ""UserName"" of the page's ($tag) owner. If no $tag is provided when calling the function then it acts on the current page.
""SetPageOwner($tag, $user)""
""LoadACL($tag, $privilege, $useDefaults = 1)""
%%(php)array = {
""LoadAllACLs($tag, $useDefaults = 1)""
""SaveACL($tag, $privilege, $list)""
""TrimACLs($list)""
""HasAccess($privilege, $tag = '', $user = '')""
This returns true or 1 if the user ($user) can complete the requested action ($priviledge) on the page ($tag). If no $tag is provided then it acts on the displayed ""WikiPage"". If no $user is provided then it acts on the current ""UserName"".
CategoryDocumentation
