Funktionenliste
Entwickler
Eine einfache Liste der von PmWiki zur Verfügung gestellten Funktionen. . Eventuell mit ein bisschen Fleisch versehen mit weiteren Beschreibungen und Verweisen auf passende Seiten.
pmwiki.php:
Helper-Funktionen
| SDV(&$v,$x)? | "set default value" -- weist $x der Variablen $v zu, aber nur, wenn $v nicht bereits definiert ist (z. B. in config.php) |
| SDVA(&$var,$val) | "set default value array" -- weist Array $val das Array $var zu für undefinierte Elemente |
| PUE($x) | url encode $x |
| IsEnabled?(&$var,$f=0) | liefert $var, wenn $var gesetzt ist, sonst liefert es $f |
| mkdirp($dir) | erzeugt Verzeichnis $dir, wenn es nicht exsistiert (mit angemessenen Rechten) |
| fixperms($fname, $add = 0) | korrigiert Dateirechte für $fname |
| stripmagic($x) | macht die Effekte von PHP's (defekten) magic_quotes-Setzungen rückgängig |
| Lock($op) | stellt ein Semaphore für Wikiprozesse zur Verfügung (vermeidet Schreib/Lese--Konflikte) |
| ParseArgs($x) | durchläuft Strings, die Argumentlisten enthalten |
| StopWatch?($x) | mark elapsed time in processing |
| pmcrypt($pass, $salt) | erzeugt oder prüft ein Passwort-Hash |
Markup helper functions
PSS($x) - entfernt backslashes (hinzugefügt durch die /e-Option bei preg_replace) von $x. functions PVS($x) - Wandelt \n\n-Sequenzen in <:vspace> um PVSE($x) - Wandelt spezielle Zeichen in HTML-Entities um (außer Anführungszeichen) und wandelt \n\nSequenzen in <:vspace> um PZZ($x,$y='') - liefert einen null-String (wird wegen ihres Seiteneffekts auf die Auswertung von $x und $y eingesetzt) PRR($x=NULL) - zeigt an, dass wir den Markup-Prozess erneut starten müssen PQA($x) - "prepare quoted arguments" -- quote any attributes in HTML tags NoCache?($x='') - zeigt an, dass die aktuelle Seite nicht 'gecacht' werden soll
Markup functions
CompareArgs?($arg) CondAuth($pagename, $condparm) CondExpr($pagename, $condname, $condparm) SetTmplDisplay?($var, $val) AsSpaced?($text) MatchNames?($pagelist, $pat, $caseinsensitive = true)
$list ist ein Zeichenkettenarray (tokens etc.), das geprüft werden soll. $pat ist ein Muster (z. B. "example,exemplar") oder ein Array aus Mustern (die Jokerzeichen * und ? enthalten können). Wenn $pat ein Array aus Mustern ist, muss ein $list-Element auf jedes Muster des Arrays passen. MatchNames? gibt ein Array aus den $list-Elementen zurück, die auf die Muster passen.
MatchPageNames?($pagelist, $pat, $caseinsensitive = true) FixGlob?($x, $rep = '$1*.$2') ResolvePageName?($pagename) MakePageName?($basepage,$x) PCache?($pagename, $page) SetProperty?($pagename, $prop, $value, $sep = NULL) PageVar?($pagename, $var, $pn = '') FmtPageName($fmt,$pagename) XL($key) XLSDV($lang,$a) XLPage($lang,$p) CmpPageAttr?($a, $b) PageStore?($d='$WorkDir/$FullName', $w=0) pagefile($pagename) read($pagename, $since=0) write($pagename,$page) exists($pagename) delete($pagename) ls($pats=NULL) ReadPage?($pagename, $since=0) - liefert ein Array, jedes Element enthält eine einzelne Zeile, zerlegt durch '=' als array($key => $value) WritePage?($pagename,$page) PageExists?($pagename) ListPages?($pat=NULL) RetrieveAuthPage?($pagename, $level, $authprompt=true, $since=0) - liest eine Seite mit Beachtung der Autentifikationsmechanismen (hookable) (reference) Abort($msg) Redirect($pagename,$urlfmt='$PageUrl') PrintFmt?($pagename,$fmt) PrintWikiPage?($pagename, $wikilist=NULL, $auth='read') Keep($x, $pool=NULL) - der $x-String wird unverändert an die Ausgabe weitergegeben CondText?($pagename,$condspec,$condtext) IncludeText?($pagename, $inclspec) RedirectMarkup?($pagename, $opt) Block($b) FormatTableRow?($x) WikiLink?($pagename, $word) LinkIMap?($pagename,$imap,$path,$title,$txt,$fmt=NULL) LinkPage?($pagename,$imap,$path,$title,$txt,$fmt=NULL) MakeLink($pagename,$tgt,$txt=NULL,$suffix=NULL,$fmt=NULL) - erzeugt einen Verweis mit den passenden Site-Infos, siehe MakeLink? Markup($id,$cmd,$pat=NULL,$rep=NULL) DisableMarkup?() mpcmp($a,$b) { return @strcmp($a['seq'].'=',$b['seq'].'='); } BuildMarkupRules?() MarkupToHTML?($pagename, $text, $opt = NULL) HandleBrowse?($pagename, $auth = 'read') EditTemplate?($pagename, &$page, &$new) RestorePage?($pagename,&$page,&$new,$restore=NULL) ReplaceOnSave?($pagename,&$page,&$new) SaveAttributes?($pagename,&$page,&$new) PostPage?($pagename, &$page, &$new) PostRecentChanges?($pagename,&$page,&$new) PreviewPage?($pagename,&$page,&$new) HandleEdit?($pagename, $auth = 'edit') HandleSource?($pagename, $auth = 'read') PmWikiAuth?($pagename, $level, $authprompt=true, $since=0) - liest eine Seite mit Beachtung der Autentifikationsmechanismen IsAuthorized?($chal, $source, &$from) SessionAuth?($pagename, $auth = NULL) PrintAttrForm?($pagename) HandleAttr?($pagename, $auth = 'attr') HandlePostAttr?($pagename, $auth = 'attr') HandleLogoutA?($pagename, $auth = 'read') HandleLoginA?($pagename, $auth = 'login')
scripts/author.php:
RequireAuthor?($pagename, &$page, &$new)
scripts/authuser.php:
AuthUserId?($pagename, $id, $pw=NULL) AuthUserConfig?($pagename, $id, $pw, $pwlist) AuthUserHtPasswd?($pagename, $id, $pw, $pwlist) AuthUserLDAP?($pagename, $id, $pw, $pwlist) _crypt($plain, $salt=null)
scripts/compat1x.php:
ConvertV1WikiD?($path) is a that allows pages to be converted (?)
read($pagename)
UseV1WikiD?($path)
ConvertV1WikiD?($path)
scripts/crypt.php:
HandleCrypt?($pagename, $auth='read')
scripts/diag.php:
Ruleset()
HandleRuleset?($pagename)
StopWatchHTML?()
scripts/draft.php:
EditDraft?(&$pagename, &$page, &$new)
scripts/feeds.php:
HandleFeed?($pagename, $auth = 'read') RSSEnclosure?($pagename, &$page, $k)
scripts/forms.php:
InputMarkup?($pagename, $type, $args)
scripts/guiedit.php:
GUIButtonCode?($pagename)
scripts/httpauth.php:
HTTPBasicAuthPrompt?($pagename)
scripts/notify.php:
NotifyCheck?($pagename) PostNotify?($pagename, &$page, &$new) NotifyUpdate?($pagename, $dir='')
scripts/pagelist.php:
SearchBox?($pagename, $opt) FmtPageList?($outfmt,$pagename, $opt) MakePageList?($pagename, $opt, $retpages = 1) SortPageList?(&$matches, $order) HandleSearchA?($pagename, $level = 'read') FPLTemplate?($pagename, &$matches, $opt) PageIndexTerms?($terms) PageIndexUpdate?($pagelist, $dir = '') PageIndexGrep?($terms, $invert = false) PostPageIndex?($pagename, &$page, &$new)
scripts/pagerev.php:
LinkSuppress?($pagename,$imap,$path,$title,$txt,$fmt=NULL) PrintDiff?($pagename) HandleDiff?($pagename, $auth='read')
scripts/phpdiff.php:
PHPDiff?($old,$new)
scripts/simuledit.php:
Merge($newtext,$oldtext,$pagetext)
MergeSimulEdits?($pagename,&$page,&$new)
scripts/skins.php:
SetSkin?($pagename, $skin) LoadPageTemplate?($pagename,$tfilefmt) PrintSkin?($pagename, $arg) verbunden mit $PageEndFmt = "function:PrintSkin? End" $PageStartFmt = "function:PrintSkin? Start"
scripts/stdmarkup.php:
PreserveText?($sigil, $text, $lead) PrintMetaTags?($pagename, $args) TrackAnchors?($x) { global $SeenAnchor; return @$SeenAnchor[$x]++; } WSIndent?($i) Cells($name,$attr) MarkupMarkup?($pagename, $text, $opt = '') CondDate?($condparm)
scripts/trails.php:
ReadTrail?($pagename,$trailname) MakeTrailStop?($pagename,$trailname) MakeTrailStopB?($pagename,$trailname) MakeTrailPath?($pagename,$trailname)
scripts/transition.php:
FPLByGroup?($pagename, &$matches, $opt) GUIEdit?($pagename, &$page, &$new)
scripts/upload.php:
MakeUploadName?($pagename,$x) LinkUpload?($pagename, $imap, $path, $title, $txt, $fmt=NULL) HandleUpload?($pagename, $auth = 'upload') HandleDownload?($pagename, $auth = 'read') HandlePostUpload?($pagename, $auth = 'upload') UploadVerifyBasic?($pagename,$uploadfile,$filepath) dirsize($dir) FmtUploadList?($pagename, $args) AttachExist?($pagename)
scripts/urlapprove.php:
LinkHTTP?($pagename,$imap,$path,$title,$txt,$fmt=NULL) ReadApprovedUrls?($pagename) HandleApprove?($pagename, $auth='edit') BlockUnapprovedPosts?($pagename, &$page, &$new)
scripts/vardoc.php:
VarLink?($pagename,$tgt,$txt) VarIndexLoad?($pagename) VarIndexList?($pagename)
scripts/wikistyles.php:
ApplyStyles?($x)
scripts/xlpage-utf-8.php:
utf8toupper($x)
Category: PmWiki Internals PmWiki Developer
Originalseite auf PmWikiDe.FunctionList — Rückverweise
| Zuletzt geändert: | PmWikiDe.FunctionList | am 25.04.2022 |