CMSimple_XH (1.7.X) Dokumentation

5.8 • Funktionen

Wesentliche Änderungen bei den Funktionen unter CMSimple_XH 1.7 sind:

• Mehrere bereits missbilligte Funktionen wurden nach cmsimple/compat.php verschoben. Wenn man sich sicher ist, dass diese Funktionen nicht gebraucht wird, kann in cmsimple/config.php $cf[site][compat] ein leerer String zugewiesen werden.
• Die Funktion submenu() akzeptiert nun einen optionalen Parameter, der benutzerdefiniertes Markup für die Submenü-Überschrift erlaubt.
• Die Funktion legallink(), die von CMSimple_XH 1.5.8 an missbilligt war, wurde entfernt.
• Die Funktion editmenu() wurde missbilligt. Sie machte seit XH 1.5 sowieso nichts mehr, so dass es Zeit wird sie aus Templates zu entfernen.
• Die Funktion tag() wurde missbilligt. Es wird empfohlen statt dessen einfach valides HTML5 zu verwenden.
•  Die Funktion top() akzeptiert nun einen optionalen Parameter, der genutzt werden kann um zu einer anderen ID als #TOP zu verlinken.
• initvar() wurde missbilligt. Es ist zu beachten dass es nicht nötig ist initvar('action') oder initvar('admin') aufzurufen, weil dies bereits vom Core getan wird. Für alle anderen Verwendungen von initvar(): sollten keine globalen Variable verwendet werden.
• Die JSON-Klasse, die einen Fallback für alte PHP-Versionen ohne JSON-Support bot, wurde entfernt. XH_decodeJson() und XH_encodeJson() sind immer noch verfügbar, aber sind nun nur noch dünne Wrapper über json_decode() und json_encode(). Erwägt, die json_*() Funktionen direkt zu verwenden.
• Die PasswordHash Klasse wurde entfernt und statt dessen sollte die Password-Hashing-Funktionen (password_hash() und password_verify()) bzw. random_bytes() verwendet werden. Für ältere PHP-Versionen gibt es Fallbacks in cmsimple/password.php.
• Die Funktionen h() und l(), die dünne Wrapper über $h bzw. $l sind, wurden missbilligt. Es kann statt dessen XH\Pages verwendet werden.
• plugin_admin_common() erwartet nun keine Argumente mehr, da diese auch früher nie verwendet wurden. Es können auch weiterhin $action, $admin und $plugin an die Funktion übergeben werden, da PHP überschüssige Argumente stillschweigend ignoriert, und sich dies in der nahen Zukunft vermutlich nicht ändern wird (falls überhaupt jemals).
• XH_afterFinalCleanUp() wurde hinzugefügt, das es Plugins ermöglicht eine Funktion zu registrieren, die kurz vor dem Ende des Requests aufgerufen wird, so dass das vollständige HTML manipuliert werden kann.
• XH_formatDate() ist nun internationalisiert, falls ext/intl verfügbar ist. Erwägt es für menschenlesbare Formatierung von Datums-/Zeitangaben zu verwenden.

Die wichtigsten globalen Funktionen sind hier namentlich aufgelistet und über die folgenden Links kann die jeweilige Dokumentation eingesehen werden:
http://www.cmsimple-xh.org/dev-doc/php/cms_8php.html

• a()
• amp()  (Deprecated: since 1.5.4. Use & instead.
• autogallery()  (since 1.5.4. Use a gallery plugin instead.)
• chkdl()  (Deprecated: since 1.6.)
• chkfile()  (Deprecated: since 1.6.)
• cmscript()
• download()
• e()
• editor_replace()
• evaluate_cmsimple_scripting()  (Since  1.5)
• evaluate_plugincall()  (Since  1.5)
• evaluate_scripting()  (Since  1.5)
• gc()
• geturl()
• geturlwp()
• guestbooklink()  (Deprecated: since 1.5.4)
• h()  (Deprecated: since 1.7. Use $h instead.)
• hide()
• include_editor()
• init_editor()
• initvar()  (Deprecated: since 1.7.0)
• l()  (Deprecated: since 1.7. Use $l instead.)
• logincheck()
• loginforms()
• meta()
• ml()
• newsbox()
• pluginFiles()
• preCallPlugins()  (Deprecated: since 1.6)
• rf()  (Deprecated: since 1.6)
• rfc()
• rmanl()
• rmnl()
• rp()  (Deprecated: since 1.5.4. Use realpath() instead.)
• shead()
• sortdir()
• stsl()
• sv()
• tag()  (Deprecated: since 1.7, Todo: Add deprecation warning (XH 1.8?) )
• uenc()  (See also XH_uenc() )
• writelog()  (Deprecated: since 1.6)
• XH_adjustStylesheetURLs()  (Since 1.6)
• XH_afterFinalCleanUp()  (Since 1.7)
• XH_afterPluginLoading()  (Since 1.6)
• XH_autoload()  (Since 1.7)
• XH_availableLocalizations()  (Since 1.6)
• XH_backup()  (Since 1.6)
• XH_builtinTemplate()  (Since 1.6)
• XH_checkValidUtf8()  (Since 1.5.5)
• XH_convertPrintUrls()  (Since 1.6)
• XH_convertToPrintUrl()  (Since 1.6)
• XH_createLanguageFile()  (Since 1.6, Todo: Remove handling of LANGconfigs, unless they won't get reintroduced.)
• XH_debug()
• XH_debugmode()  (Since 1.0rc3)
• XH_decodeJson()  (Since 1.6, Todo: Deprecate starting with 1.8.)
• XH_encodeJson()  (Todo: Deprecate starting with 1.8.)
• XH_escapeCMSimpleScripting()  (Since 1.6.6)
• XH_evaluateSinglePluginCall()  (Since 1.6)
• XH_exit()  (Since 1.6.2)
• XH_finalCleanUp()  (Since 1.6)
• XH_findNextPage()  (Since 1.6.3)
• XH_findPreviousPage()  (Since 1.6.3)
• XH_formatDate()  (Since 1.6.3)
• XH_getLocatorModel()  (Since 1.7)
• XH_getPageURL()  (Since 1.7)
• XH_getRootFolder()  (Since 1.6.2)
• XH_helpIcon()  (Since 1.6, Todo: Change the DIVs to SPANs and require the $tooltip to be an inline fragment (requires block level elements to be removed from all help texts–even $plugin_tx).)
• XH_highlightSearchWords()  (Since 1.6.5)
• XH_hsc()  (Since 1.5.8)
• XH_includeVar()  (Since 1.6)
• XH_isContentBackup()  (Since 1.6)
• XH_isInternalPath()  (Since 1.6)
• XH_isInternalUrl()  (Since 1.6)
• XH_isLanguageFolder()  (Since 1.6)
• XH_lastJsonError()  (Since 1.6, Todo: Deprecate starting with 1.8.)
• XH_lockFile()  (Since 1.6.3)
• XH_logMessage()  (Since 1.6)
• XH_mailform()  (Since 1.6)
• XH_message()  (Since 1.6)
• XH_numberSuffix()  (Since 1.6)
• XH_onShutdown()  (Since 1.6.3)
• XH_plugins()  (Since 1.6, Todo: Might be optimized to set $admPlugins only when necessary. with PHP 5.4.0 replace array_values() by sort($plugins, SORT_NATURAL | SORT_FLAG_CASE) )
• XH_pluginStylesheet()  (Since 1.6)
• XH_pluginURL()  (Since 1.7)
• XH_poweredBy()  (Since 1.7)
• XH_readConfiguration()  (Since 1.6)
• XH_readContents()  (Since 1.6)
• XH_readFile()  (Since 1.6)
• XH_redirectSelectedUrl()  (Since 1.7.0)
• XH_registeredEditmenuPlugins()  (Since 1.6.2)
• XH_registeredEditorPlugins()  (Since 1.6.2)
• XH_registeredFilebrowserPlugins()  (Since 1.6.2)
• XH_registeredPagemanagerPlugins()  (Since 1.6.2)
• XH_registerPluginType()  (Since 1.6.2)
• XH_renameFile()  (Since 1.6, Todo: Deprecate for 1.8.)
• XH_rmws()  (Since 1.5.4)
• XH_secondLanguages()  (Since 1.6)
• XH_spliceString()  (Since 1.6)
• XH_startSession()  (Since 1.7)
• XH_templates()  (Since 1.6)
• XH_title()  (Since 1.6)
• XH_uenc()  (See also uenc(), Since 1.6)
• XH_unionOf2DArrays()  (Since 1.6)
• XH_writeFile()  (Since 1.6)

http://www.cmsimple-xh.org/dev-doc/php/adminfuncs_8php.html

• plugin_admin_common()
• pluginMenu()
• print_plugin_admin()
• XH_absoluteUrlPath()  (Since 1.6.1)
• XH_adminJSLocalization()  (Since 1.6)
• XH_adminMenu()  (Since 1.6)
• XH_adminMenuItem()  (Since 1.6)
• XH_backupsView()  (Since 1.6)
• XH_contentEditor()  (Since 1.6)
• XH_emptyContents()
• XH_extraBackup()  (Since 1.6)
• XH_isAccessProtected()  (Since 1.6.1)
• XH_logFileView()  (Since 1.6)
• XH_pluginsView()  (Since 1.7)
• XH_pluginVersion()  (Since 1.6)
• XH_registerPluginMenuItem()  (Since 1.6.2)
• XH_registerStandardPluginMenuItems()  (Since 1.6.2)
• XH_restore()  (Since 1.6)
• XH_saveContents()  (Since 1.6)
• XH_saveEditorContents()  (Since 1.6)
• XH_settingsView()  (Since 1.6)
• XH_sysinfo()  (Since 1.6)
• XH_systemCheck()  (Since 1.5.4)
• XH_systemCheckLi()  (Since 1.7)
• XH_wantsPluginAdministration()  (Since 1.6.3)