L'API de Wikka pour écrire des Actions
Les Actions permettent d'ajouter de nouvelles capacités à votre Wiki. On parle aussi de plugins. Pour ne pas réinventer la roue, utilisez les fonctions déjà disponibles dans le coeur de Wikka. Vous gagnerez du temps et de la cohérence.
Décrivons maintenant ces fonctions. N'hésitez pas s'il vous plaît à compléter ces lignes (but de la fonction, ses paramètres, les résultats qu'elles retourne...). Ceci n'est pas la documentation officielle...
Texte fondé sur WikkaWiki version 1.1.5.3 package
Allons-y ! ...
Fonctions relatives à la base de données
Query($query)
reçoit une SQL Recherche en argument, l'exécute sur la base
Retourne les résultats.
LoadSingle($query)
reçoit une SQL Recherche en argument, l'exécute sur la base
Retourne la première ligne des résultats.
LoadAll($query)
reçoit une SQL Recherche en argument, l'exécute sur la base
retourne les résultats sous la forme d'un tableau (vecteur)
CheckMySQLVersion($major, $minor, $subminor)
Retourne :
1 si la version utilisée est la même ou plus récente.
0 si la version utilisée est plus vieille.
Diverses fonctions utiles
GetMicroTime()
A utility function that is usefull to retrieve operation timing. Retourne (float).
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 thing 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)
Reçoit des caractères (preferably HTML, hehe)
Retourne ceux-ci conformes aux standards XHTML.
Fonctions concernant les variables Wakka
GetPageTag()
Returne le nom ( tag, WikiPageName) de la page affichée (chaîne de caractères).
GetPageTime()
Returne la date et l'heure de création and time de la page affichée (chaîne de caractères : "2004-12-16 20:36:17").
GetMethod()
Returne la méthode (par exemple: WikiPage/edit) qui appelle la page affichée (chaîne de caractères).
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.
Fonctions concernant les WikiPages
LoadPage($tag, $time = "", $cache = 1)
IsLatestPage()
GetCachedPage($tag)
CachePage($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()
COOKIES
SetSessionCookie($name, $value)
SetPersistentCookie($name, $value)
DeleteCookie($name)
GetCookie($name)
Fonctions concernant les HTTP/REQUEST/LINK RELATED
SetMessage($message)
GetMessage()
Redirect($url)
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()
Fonctions concernant les formulaires (FORMS)
FormOpen($method = "", $tag = "", $formMethod = "post")
FormClose()
Fonctions concernant les liens INTERWIKI STUFF
ReadInterWikiConfig()
AddInterWiki($name, $url)
GetInterWikiUrl($name, $tag)
REFERRERS
LogReferrer($tag = "", $referrer = "")
LoadReferrers($tag = "")
Fonctions concernant les PLUGINS
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)
Returns the method that the current page was called by. Known methods are /edit /create /delete ...
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.
Fonctions concernant les Utilisateurs (Users)
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()
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.
Fonctions concernant les commentaires (Comments)
LoadComments($tag)
Returns an array of the comments on the received tag (WikiPage), sorted by time each comment record was made.
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.
Fonctions concernant les contrôles des accès aux pages(ACL)
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)
Sets the page's ($tag) owneship to the specified UserName ($user). Both arguments need to be provided.
LoadACL($tag, $privilege, $useDefaults = 1)
Returns an array. The form of the array is as follows :
array = {
["page_tag"] => $tag,
[$privilege."_acl"] => the_default_configuration_acl_for_this_privilege
}
["page_tag"] => $tag,
[$privilege."_acl"] => the_default_configuration_acl_for_this_privilege
}
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 the displayed WikiPage. If no $user is provided then it acts on the current UserName.
CategoryFR
