PHP Framework
Das PHP-Framework, als Bestandteil von Weblication, stellt Ihnen die wichtigsten Funktionen zur Verfügung, um schnell eigene Anpassungen, Erweiterungen und Anwendungen zu entwickeln.
Wie Sie Framework-Funktionen in eigenen Scripten nutzen, ist in diesem Artikel beschrieben.
Übersicht der verfügbaren Funktionen nach Klassen sortiert
-
wAI
KI-Klasse- queryFührt eine Anfrage an eine KI durch (verfügbar ab CMS-Version 017.006.226.000 (CMS-Version 18 aktiviert) mit entsprechender Lizenz)Array query(String query, Array options)
- query
-
wAnalyzer
Analyse- createReportLastMonthGeneriert einen Report für den letzten Monat (verfügbar ab CMS-Version 017.001.079.000)String createReportLastMonth(String project, Array options)
- getDataErmittelt Statistikdaten innerhalb eines angegebenen Zeitraums (verfügbar ab CMS-Version 016.001.131.000)Int getData(String $project, Array $options)
- getDataPagesErmittelt die Aufrufe nach Seiten innerhalb eines angegebenen Zeitraums (verfügbar ab CMS-Version 017.001.055.000)Array getDataPages(String project, Array options)
- getNumberRequestsErmittelt die Anzahl der Seitenaufrufe innerhalb eines angegebenen Zeitraums (verfügbar ab CMS-Version 014.004.031.000, Parameter path ab CMS-Version 016.001.001.000)Int getNumberRequests(String $project, Array $options)
- prepareDataStatisticGeneriert die Statistikdaten aus den Request- bzw. RAW-Daten (verfügbar ab CMS-Version 017.005.030.000)Void prepareDataStatistic(String projecct)
- sendReportLastMonthSendet einen Report für den letzten Monat (verfügbar ab CMS-Version 017.001.079.000)Void sendReportLastMonth(String receiver, String project, Array options)
- createReportLastMonth
-
wApplication
Die aktuelle Installation- clearLogsSäubert Log-Dateien des Systems (verfügbar ab CMS-Version 015.005.100.000)Void clearLogs(String dir, Int limitDays = 31)
- clearTmpSäubert das temporäre VerzeichnisVoid clearTmp(Int possibility = 1, Int $expires = 86400, Boolean $useAsync = true)
- clearTmpHTTPSäubert das temporäre DownloadverzeichnisVoid clearTmpHTTP(Int possibility = 1, Int $expires = 3600, Boolean $useAsync = true)
- getDataProjectsErmittelt die verfügbaren Projekte (verfügbar ab CMS-Version 008.004.022.00)Array getDataProjects(String type = '')
- getOptionPathErmittelt eine SystemeinstellungString getOptionPath(String xPath)
- getVersionErmittelt die aktuelle Software-VersionString getVersion()
- preparePackagesLädt die aktuellen BASE-Pakete vom Server (verfügbar ab CMS-Version 015.005.163.000)Boolean preparePackages()
- setOptionPathSetzt den Wert einer Systemeinstellung (verfügbar ab CMS-Version 017.006.281.000)String setOptionPath(String xPath, String value)
- clearLogs
-
wArchiving
Archivierungsfunktionen- archiveFilesArchiviert alle zur Archivierung vorgemerkten DateienArray archiveFiles(String path = '', String ifExists = '')
- archiveFiles
-
wBackup
Klasse für Backups- clearBackupsLöscht alte bzw. überflüssige Backups (verfügbar ab CMS-Version 017.003.000.000)Array clearBackups(Int filterAgeDays, String filterPath = '')
- createBackupErstellt ein Backup (verfügbar ab CMS-Version 013.006.020.000)String createBackup(String path, String excludeStr = '')
- clearBackups
-
wBenchmark
Klasse mit Informationen zur Ermittlung des Ressourcenverbrauchs- getMemoryPeakUsageErmittelt den maximal genutzten Speicher in MBFloat getMemoryPeakUsage()
- getTimeScriptErmittelt die Zeit des SkriptesFloat getTimeScript()
- getMemoryPeakUsage
-
wBrowseEdit
Erstellt Schaltflächen in der Webseite- createButtonErstellt eine allgemeine SchaltflächeString createButton(String onclick = '', String icon = '', String caption = '', String title = '')
- createButtonApproveDocumentGibt ein Dokument aus dem Workflow freiString createButtonApproveDocument(String path = '', String icon = '', String caption = '', String title = '', Array options = array())
- createButtonBackendErstellt eine Schaltfläche, um die Weblication Obefläche zu öffnen, falls der Benutzer Administrator istString createButtonBackend(String icon = '', String caption = '', String title = '', Array attributes = array())
- createButtonCreateDirectoryErstellt eine Schaltfläche zur Erstellung eines neuen VerzeichnissesString createButtonCreateDirectory(String destDir = '', String icon = '', String caption = '', String title = '', Array options = array())
- createButtonCreateDocumentErstellt eine Schaltfläche zur Erstellung eines neuen Dokumentes (einer neuen Seite)String createButtonCreateDocument(String destDir = '', String icon = '', String caption = '', String title = '', Array options = array())
- createButtonDeleteErstellt eine Schaltfläche, um eine Seite zu löschenString createButtonDelete(String path = '', String icon = '', String caption = '', String title = '', Array attributes = array())
- createButtonEditErstellt eine Schaltfläche zum Bearbeiten einer SeiteString createButtonEdit(String path = '', String icon = '', String caption = '', String title = '')
- createButtonFilemanagerErstellt eine Schaltfläche mit Funktionen zum Öffnen der DateiverwaltungString createButtonFilemanager(String path = '', String caption = '', String title = '', Array options = array())
- createButtonInsertNavpointÖffnet die Navigationsbearbeitung, um eine Seite, falls diese noch nicht verlinkt ist, hinzuzufügen.String createButtonInsertNavpoint(String path = '', String caption = '', String title = '')
- createButtonLogoutErstellt eine Schaltfläche, um sich abzumeldenString createButtonLogout(String icon = '', String caption = '', String title = '')
- createButtonOnlineStatusErstellt eine Schaltfläche, um den Online-Status einer Datei zu ändernString createButtonOnlineStatus(String path = '', String icon = '', String caption = '', String title = '', Array attributes = array())
- createButtonRejectDocumentWeist ein Dokument aus dem Workflow zurückString createButtonRejectDocument(String path = '', String icon = '', String caption = '', String title = '', Array options = array())
- createButtonUploadErstellt eine Schaltfläche, um Dateien hochzuladenString createButtonUpload(String destDir = '', String icon = '', String caption = '', String title = '', Array attributes = array())
- createButtonWeblicsErstellt eine Schaltfläche, um die Weblics-Verwaltung zu öffnen, falls der Benutzer Administrator istString createButtonWeblics(String project = '', String icon = '', String caption = '', String title = '', Array attributes = array())
- isInEditorÜberprüft, ob der aktuelle Pfad im Editor aufgerufen istBoolean isInEditor()
- createButton
-
wCache
Stellt Cache-Funktionen zur Verfügung- clearCacheSäubert den Projekt-CacheVoid clearCache(String project, Int probability = 1, Int expires = 3600)
- clearCachePathLöscht den Cache einer Datei (ab Version 006.000.000.000)Void clearCachePath(String path, String project = '', Int expires = -1)
- clearCacheProjectLöscht den gesamten Projekt-CacheBoolean clearCacheProject(String project, Array options = array())
- clearCacheURLLöscht den Cache einer URL (ab Version 006.000.000.000 einsetzbar)Void clearCacheURL(String url, String project = '', Int expires = -1)
- getFilesTdpExpiresErmittelt, für welche Dateien der Cache aufgrund der zeitgesteuerten Veröffentlichung gelöscht werden mussArray getFilesTdpExpires(String project)
- getTimeCachedURLErmittelt das Erstellungsdatum des Caches einer URL als Zeitstempel. Falls keine Cache-Datei vorliegt, wird 0 zurückgegeben.Int getTimeCachedURL(String url, String project = '')
- rebuildCacheURLErneuert den Cache einer URL (ab Version 014.003.041.000 einsetzbar)Void rebuildCacheURL(String url, Array options = array())
- tdpExpiresPrüft, ob der Cache aufgrund der zeitgesteuerten Veröffentlichung gelöscht werden mussBoolean tdpExpires(String project)
- clearCache
-
wCaptcha
Stellt Funktionen zur Generierung von Bildern aus Text zur Verfügung, um das automatisierte Versenden von Formularen zu verhindern- createCaptchaErstellt ein Bild aus einer Zeichenkette, um Spam in Formularen zu verhindernString createCaptcha(String text, Array options = array)
- createCaptcha
-
wCart
Warenkorb- addArticleFügt dem Warenkorb einen Artikel hinzuVoid addArticle(String path, Int amount = 1, Array attributes = null, String cartId = 'default')
- addArticlesErmittelt den Inhalt des Warenkorbs
- clearCartLöscht den WarenkorbVoid clearCart(String cartId = 'default')
- deleteArticleLöscht einen Artikel aus dem WarenkorbVoid deleteArticle(String path, String cartId = 'default')
- getAmountOfArticleErmittelt die Anzahl eines Artikels im WarenkorbInt getAmountOfArticle(String path, String cartId = 'default')
- getArticleErmittelt die Daten eines ArtikelsMixed getArticle(String path, String cartId = 'default')
- getArticlesErmittelt den Inhalt des WarenkorbsArray getArticles(String cartId = 'default')
- getAttributeOfArticleErmittelt ein Attribut eines ArtikelsInt getAttributeOfArticle(String path, String name, String cartId = 'default')
- setAttributeOfArticleSetzt ein Attribut eines ArtikelsVoid setAttributeOfArticle(String path, String name, String value, String cartId = 'default')
- updateArticleÄndert einen Artikel im WarenkorbVoid updateArticle(String path, Int amount = 1, Array attributes = null, String cartId = 'default')
- addArticle
-
wCategories
Klasse für Kategorien- createCategoriesHtmlOfDocumentZeigt die Categorien eines Dokumentes an (verfügbar ab CMS-Version 013.007.043.000)String createCategoriesHtmlOfDocument(String pathDocument, String xPathCategories, String pathCategories)
- getCategoriesAsArrayErmittelt die Kategorien als Array. (verfügbar ab CMS-Version 017.006.151.000)String getCategoriesAsArray(String path, Int deep = 16)
- getCategoryTextErmittelt den Text einer Kategorie (verfügbar ab CMS-Version 017.006.151.000)String getCategoryText(String path, String id, String lang = '')
- mergeCategoriesFügt mehrere Kategoriendateien zu einer zusammenBoolean mergeCategories(String pathDest, Array pathesSource, Array options = array())
- createCategoriesHtmlOfDocument
-
wCron
Cron-Skripte- executeFührt ein Cron-Skript aus (verfügbar ab CMS-Version 016.003.169.000)void execute(string $cronId, bool $forceExecute = false)
- execute
-
wCSS
Zugriff auf CSS-Daten- deleteVariantOfCssStrLöscht eine CSS-Only Variante (verfügbar ab CMS-Version 014.003.081.000)String deleteVariantOfCssStr(String cssStr, String variant)
- getDiffWidthElementErmittelt die Differenz der inneren und der äußeren Breite eines ElementesString getDiffWidthElement(String file, String selector)
- getEditmaskExtendedErmittelt den Wert für ein pflegbares FeldString getEditmaskExtended(String file, String variantName, String variantId, String editmask, String default = '')
- getValueErmittelt einen Wert aus einer CSS-DateiString getValue(String file, String selector, String key, String default = null, Boolelan inherit = false)
- getWidthBlockErmittelt eine Breite eines Blockes aus einer CSS-DateiString getWidthBlock(String file, String selector, String key = '(int)width', String objectClass = '')
- getWidthColErmittelt die angegebene Breite einer Klasse aus einer CSS-DateiString getWidthCol(String file, String selector, String key, String widthCurrent = null)
- getWidthElementErmittelt eine Breite eines Elementes aus einer CSS-DateiString getWidthElement(String file, String selector, String withTop = '', Array parents = array())
- getWidthInnerErmittelt die innere Breite eines ElementesString getWidthInner(String file, String selector, String withTop = '', Array parents = array())
- optimizeCSSOptimiert CSSString optimizeCSS(String cssStr, Array options = array())
- setWidthBlockSetzt die Breite eines Blocks für CSS-Only manuell (ab CMS-Version 008.000.107.000 verfügbar)String setWidthBlock(String block, String width)
- deleteVariantOfCssStr
-
wDate
Datumsfunktionen- displayFromToGibt ein Von- / Bis-Datum formatiert ausString displayFromTo(String from, String to = '', Array options)
- formatDateFormatiert ein Datum (als Format können die Formate genutzt werden, die die PHP date() Funktion bereitstellen)String formatDate(String format = '', String date = '', String lang = '', Boolean smartLength = false)
- prepareObjectdataBereitet Objekdaten zur Ausgabe innerhalb des Objektwizards vor.Array prepareObjectdata(Array $dateData, Array options = array())
- displayFromTo
-
wDB
Dabenbank-Objekt- checkConnectionPrüft, ob die aktuelle Verbindung korrekt hergestellt wurde
- getPDOObjectLiefert das PDO-Objekt der aktuellen Verbindung, um damit weitere Funktionen ausführen zu könnenPDOObject getPDOObject()
- isSelectStatementPrüft, ob ein SQL-Statement eine reine SELECT-Abfrage ist (verfügbar ab CMS-Version 019.001.026.000)
- queryFührt eine Datenbank-Abfrage durchPDOStatement query(String sql)
- checkConnection
-
wDiff
Versionsvergleich- getDiffItemsOfLastVersionErmittelt Unterschiede der Elemente eines DokumentesArray getDiffItemsOfLastVersion(String path, Array options = array())
- getDiffItemsOfLastVersion
-
wDocument
Dokumenten-Objekt- setStatusOnlineSetzt den Online-Status eines DokumentesBoolean setStatusOnline(String status)
- getNavIdErmittelt die Navigations-ID des DokumentesString getNavId()
- getOwnerErmittelt den Besitzer (verfügbar ab CMS-Version 017.002.068.000)Boolean getOwner()
- getTemplateViewErmittelt den Pfad des AnsichtstemplatesString getTemplateView()
- getUsersErmittelt die Benutzer (verfügbar ab CMS-Version 017.002.077.000)Array getUsers()
- isCheckedInPrüft, ob ein Dokument eingecheckt ist, dass heißt, ob es eine eigene Dokumentenerweiterung besitzt.Boolean isCheckedIn()
- isOfflineFuturePrüft, ob das zeitgesteuerte Dokument in Zukunft offline geschaltet wird (verfügbar ab CMS-Version 016.005.071.001)Boolean isOfflineFuture()
- isOnlinePrüft, ob das Dokument online istBoolean isOnline()
- isOnlineFuturePrüft, ob das zeitgesteuerte Dokument in Zukunft online geschaltet wird (verfügbar ab CMS-Version 016.005.071.001)Boolean isOnlineFuture()
- isPersonalizedPrüft, ob das Dokument personalisiert ist.Boolean isPersonalized()
- isTimeDependentPublishedPrüft, ob das Dokument zeitgesteuert ist (verfügbar ab CMS-Version 016.005.071.001)Boolean isTimeDependentPublished()
- isTimerPrüft, ob das Dokument zeitgesteuert veröffentlicht istBoolean isTimer()
- setStatusOnline
-
wDocumentData
Zugriff auf Daten eines Dokumentes- addCategorySetzt Kategorien eines Dokumentes. Ab CMS-Version 012.005.077.000 unterstützt die Funktion auch die Möglichkeit, Kategorien für beliebige Objektdaten zu setzenBoolean addCategory(String document, String category, String dataID = '')
- deleteCategoryLöscht eine Kategorie (verfügbar ab CMS-Version 016.003.019.000)Boolean deleteCategory(String document, String category, String dataID = '')
- getDataErmittelt Daten eines Dokumentes als ZeichenketteString getData(String document, String data, Array options = array())
- getDataAsHTMLErmittelt Daten eines Dokumentes als HTML-ZeichenketteString getDataAsHTML(String document, String wPath, Array options = array())
- getDataEmbedInvoicePDFErmittelt die Daten einer eingebetteten E-Rechnung (verfügbar ab CMS-Version 019.001.086.000)Array getDataEmbedInvoicePDF(String document)
- getDataObjectErmittelt Objektdaten eines Dokumentes (ab Version 007.004.040.000 verfügbar)String getDataObject(String document, String id)
- getDataObjectAsArrayErmittelt alle Objektdaten als ArrayArray getDataObjectAsArray(String document, Boolean full)
- getNodesErmittelt Daten eines DokumentesDOMNodeList getNodes(String document, String wPath)
- getSizeErmittelt die Dateigröße eines DokumentesFloat getSize(String document, String unit, Int precision = 2)
- getValueOfDefaultExtensionErmittelt den Wert der Standard-DateieinstellungString getValueOfDefaultExtension(String document, String data, Boolean force)
- getViewGroupsErmittelt die Ansichtsgruppen (Modul Personalisierung)Array getViewGroups(String document)
- getViewUsersErmittelt die Ansichtsbenutzer (Modul Personalisierung)Array getViewUsers(String document)
- replaceCurrentObjectdataErsetzt Objektdaten der aktuellen Seite (verfügbar ab CMS-Version 14)String replaceCurrentObjectdata(String str, Boolean disableOutputEscaping = false)
- setDataSetzt Daten eines DokumentesBoolean setData(String document, String data, String value, Array options = array())
- setDataObjectSetzt Objektdaten eines Dokumentes (ab Version 007.004.040.000 verfügbar)Boolean setDataObject(String document, String id, String value, Array options = array())
- addCategory
-
wDOM
DOM zur Verarbeitung von XML-Daten- dom2ArrayWandelt ein DOM-Objekt in eine PHP-Datenstruktur umArray dom2Array(&DOMNode $node)
- executeXPathFührt eine xPath-Abfrage auf ein DOM-Objekt ausDomNodeList executeXPath(DOMDocument dom, String xPathExpression)
- getValueOfErmittelt einen Wert aus einem XML-BaumString getValueOf(DomDocument dom, String xPathExpression)
- parseFileErstellt ein DOM-Objekt auf Basis einer XML-DateiDOMDocument parseFile(String path)
- parseStringErstellt ein DOM-Objekt auf Basis einer XML-ZeichenketteDOMDocument parseString(String xmlString)
- dom2Array
-
wEnv
Umgebung des aktuellen Skriptaufrufs- getCookieValueErmittelt einen Cookie-WertString getCookieValue(String key)
- getGlobalValueErmittelt einen globalen WertString getGlobalValue(String key)
- getHttpHostErmittelt den Host (verfügbar ab CMS-Version 018.007.213.000)String getHttpHost()
- getLanguageUserAgentErmittelt die Hauptsprache des BrowsersString getLanguageUserAgent()
- getLanguagesUserAgentErmittelt alle Sprachen des BrowsersString getLanguagesUserAgent()
- getTimeScriptErmittelt die aktuelle Ausführzeit des SkriptesFloat getTimeScript(String round = null)
- getUrlHostErmittelt den Host der aktuell aufgerufenen URLString getUrlHost()
- includeOnceBindet eine Datei ein (verfügbar ab CMS-Version 017.005.082.000)String includeOnce(String path)
- initMobileVersionInitialisiert alle notwendigen Werte, falls die Seite mobil angezeigt werden soll.String initMobileVersion()
- isMobileUserAgentErmittelt, ob der Besucher ein mobiles Endgerät nutzt (z.B. Blackberry|Android|iPod|Windows CE|Phone|Palm|Opera Mini|Nokia)String isMobileUserAgent(String matches)
- setCookieValueSetzt einen Cookie-WertString setCookieValue(String key, String value, String expires, String path, String domain, Boolean secure, Boolean httponly, String samesite)
- setGlobalValueSetzt einen globalen WertString setGlobalValue(String key, Mixed value)
- getCookieValue
-
wEvent
Ereignis- fireFeuert ein Ereignis auf ein VerzeichnisBoolean fire(String eventName, String path, Array param = array())
- setUploadedFileNameSetzt den Namen der hochgeladenen Datei neu, falls sich dieser im Ereignis geändert hatBoolean setUploadedFileName($filename)
- stopTransactionUnterbricht eine Transaktion auf EreignisebeneBoolean stopTransaction()
- fire
-
wFacebook
Klasse für Facebook Funktionen- createAuthTokenErstellt einen AuthentifizierungsschlüsselBoolean createAuthToken(String parameters, String consumerKey, String consumerSecret, String code)
- deleteAuthTokenLöscht einen AuthentifizierungsschlüsselBoolean deleteAuthToken(String consumerKey, String consumerSecret)
- getAuthTokenLiest einen AuthentifizierungsschlüsselBoolean getAuthToken(String consumerKey, String consumerSecret)
- hasAuthTokenPrüft, ob ein Authentifizierungsschlüssel existiertBoolean hasAuthToken(String consumerKey, String consumerSecret)
- postMessageVeröffentlicht eine Meldung bei FacebookBoolean postMessage(String message, String name, String consumerKey, String consumerSecret, Array data)
- requestAuthTokenFragt einen Authentifizierungsschlüssel an, der vom Benutzer bestätigt werden mussVoid requestAuthToken(String consumerKey)
- setAuthTokenSchreibt einen AuthentifizierungsschlüsselBoolean setAuthToken(Object token, String consumerKey, String consumerSecret)
- createAuthToken
-
wForm
Stellt Formular Funktionen zur Verfügung- addElementFügt dem Formular ein Eingabefeld bzw. Element hinzuBoolean addElement(String type, String name = null, label = null, options = array())
- addEventServerFügt dem Formular ein Server-Ereignis hinzuBoolean addEventServer(String eventName, Function function)
- addOptionFügt ein Auswahlfeld hinzuString addOption(String value, String text, Boolean selected, String optgroup)
- deleteElementLöscht ein Element aus dem FormularBoolean deleteElement(String name)
- deleteOptionLöscht ein AuswahlfeldString deleteOption(Array option)
- fireEventServerFührt innerhalb eines Formulares ein Server-Ereignis ausBoolean fireEventServer(String eventName)
- getMailDataStrErmittelt die Formulardaten als ZeichenketteString getMailDataStr()
- modifyOptionÄndert ein Auswahlfeld
- addElement
-
wGeoData
Ermittelt GEO-Daten- getCoordinatesOfLocationErmittelt die Koordination eines Ortes über die HERE GEO-API (verfügbar ab CMS-Version 018.004.106.000)String getCoordinatesOfLocation(String location, Array options)
- getCountryOfIpErmittelt den Ländercode einer IP-Adresse auf Basis einer IpToCountry.csv Datei (ab CMS Version 006.001.070.000)String getCountryOfIp(String ip, String pathIpToCountryCsv)
- getCoordinatesOfLocation
-
wGroupData
Ermöglicht den Zugriff auf Gruppendaten- clearIndexLöscht den Index der Gruppendatenvoid clearIndex()
- getDataErmittelt Daten einer GruppeString getData(String user = null, String data = null))
- clearIndex
-
wImage
Klasse für Bildfunktionen- convertToJPEGKonvertiert ein Bild in eine JPEG-BildBoolean convertToJPEG(String path)
- createQRErstellt einen QR-Code für eine URL (verfügbar ab CMS-Version 019.003.048.000)String createQR(String url, Array options)
- getDataUrlPlaceholderErmittelt eine Data-URL für einen transparenten PlatzhalterString getDataUrlPlaceholder(String path, Integer width, Integer height)
- getHeightErmittelt die Höhe eines BildesString getHeight(String path, Boolean useCache)
- getWidthErmittelt die Breite eines BildesString getWidth(String path, Boolean useCache)
- resizeÄndert die BildgrößeString resize(String path, String pathDest, Integer width, Integer height, String mode)
- rotateDreht ein Bild. (ab CMS-Version 011.002.222.000)String rotate(String path, String pathDest, Integer deg)
- convertToJPEG
-
wLanguages
Klasse für Sprachverwaltung- dissolveFileLanguageLöscht einen Pfad aus der Sprachknotendatei (verfügbar ab CMS-Version 015.006.009.000)String dissolveFileLanguage(String path, String pathToDissolve)
- isTranslatablePrüft, ob eine Datei grundsätzlich übersetzbar ist (ab CMS-Version 014.006.000.000) - deepL-Schnittstelle in Weblication Lizenz erforderlich!String isTranslatable(String path)
- removeStructureReferenceLöscht in einer Datei die Strukturreferenz (ab CMS-Version 017.002.212.000)String removeStructureReference(String path, String pathReference)
- setStructureReferenceSetzt in einer Datei eine Strukturreferenz (ab CMS-Version 017.002.212.000)String setStructureReference(String path, String pathReference)
- translateCorrespondantDocumentsToTranslateWithDeepLÜbernimmt die Struktur in die korrespondierenden Sprachdateien und übersetzt die Texte automatisch mit DeepL (falls Weblication Modul und DeepL-Api lizenziert sind) (ab CMS-Version 014.006.000.000) - deepL-Schnittstelle in Weblication Lizenz erforderlich!String translateCorrespondantDocumentsToTranslateWithDeepL(String path, Array options)
- translateTextDeepLÜbersetzt Texte über die DeepL-Schnittstelle (ab CMS-Version 014.005.009.000) - deepL-Schnittstelle in Weblication Lizenz erforderlich!String translateTextDeepL(String text, String targetLang, Array options)
- dissolveFileLanguage
-
wLinkchecker
Klasse für Linkprüfung- cronjobLinkprüfung über einen Cronjob ausführen (verfügbar ab CMS-Version 014.003.043.000, erweitert ab CMS-Version 014.004.109.000)String cronjob(string $root, Array $options)
- getLinksNotAvailableErmittelt nicht verfügbare Links innerhalb einer Datei (verfügbar ab CMS-Version 015.005.106.000)String getLinksNotAvailable(string $path)
- getStatusErmittelt den aktuellen Status einer Linkchecker-Instanz (verfügbar ab CMS-Version 014.004.107.000)String getStatus(string $checkerid)
- cronjob
-
wList
Stellt Funktionen zur Generierung von Listen zur Verfügung- createListGeneriert eine Dateiliste über ein TemplateString createList(String template, Array options = array())
- createListArrayGeneriert eine Dateiliste und gibt das Ergebnis als Array zurückString createListArray(Array options = array(), String $resultValue = 'path')
- createListArrayDataGeneriert eine Liste als Assoziatives ArrayString createListArrayData(Array options = array())
- createListDirGeneriert eine Liste von Verzeichnissen in HTMLString createListDir(String template, Array options = array())
- createListFromXMLGeneriert eine Liste auf Basis einer XML-ZeichenketteString createListFromXML(String template, String xmlStr, Array options = array())
- createListXMLGeneriert eine Dateiliste und gibt das Ergebnis als XML-String zurückString createListXML(Array options = array())
- createXsltEditbuttonsErstellt das notwendige XSLT, um Pflegeschaltflächen für einen Eintrag anzuzeigenString createXsltEditbuttons(Array options){
- getListDataErmittelt einen Wert aus den aktuellen Listendaten (XML-Datei)String getListData(String name)
- setListDataGeneriert eine Liste als Assoziatives ArrayString setListData(String name, String value){
- createList
-
wMailer
Stellt E-Mail Funktionen zur Verfügung- addPlaceholdersVerarbeitet die Platzhalter einer E-MailBoolean addPlaceholders(String mailStr, Array placeholders = array(), Array placeholderExt = array())
- getDefaultMailErmittelt die Standard E-Mail Adresse der aktuellen DomainString getDefaultMail(String name = 'info')
- getLastErrorGibt den letzten aufgetretenden Fehler zurückString getLastError()
- getUsersWithEncryptedInboxLiefert alle Benutzer mit einem verschlüsselten Briefkasten (ab CMS-Version 12.x verfügbar)String getUsersWithEncryptedInbox()
- sendMailAlternativeSendet eine E-mail als Text und HTML(multipart/alternative)Boolean sendMailAlternative(Array header, String text, String html, Array attachment = null)
- sendMailHtmlSendet eine E-Mail im HTML-FormatBoolean sendMailHtml(Array header, String text, Array attachment = null)
- sendMailStrSendet eine E-Mail basierend auf einem StringBoolean sendMailStr(String mailStr, Array placeholders = array(), Array placeholders = array(), Array attachment = array(), Array options = array())
- sendMailTextSendet eine E-Mail im TextformatBoolean sendMailText(Array header, String text, Array attachment = null, Array options = null)
- sendOutboxSendet den Postausgang (verfügbar ab CMS-Version 017.001.189.000)Boolean sendOutbox(Array options)
- addPlaceholders
-
wMessagecenter
Nachrichtenzentrum- createNoteErstellt eine NotizBoolean createNote(String pathMessageObject, String receiver, String text, Array data = array())
- createTodoErstellt eine AufgabeBoolean createTodo(String pathMessageObject, String receiver, String text, Array data = array())
- purgeMessagesBereinigt die Aufgaben und Notizen (verfügbar ab CMS-Version 017.001.157.000)Boolean purgeMessages()
- registerMessagesOfPathRegistriert die Aufgaben und Notizen eines Objektes (verfügbar ab CMS-Version 015.007.006.000)Boolean registerMessagesOfPath(String path)
- createNote
-
wNavigation
Navigationsgenerator- createNavigationHTMLGeneriert eine NavigationString createNavigationHTML(String data, String template, String mode, String navId, Array options = array())
- createNavigationHTMLFromXMLGeneriert eine Navigation auf Basis einer XML-ZeichenketteString createNavigationHTMLFromXML(String navigationStr, String template, String mode, String navId, Array options = array())
- createNavigationXMLGeneriert eine NavigationString createNavigationXML(String data, String mode, String navId, Array options = array())
- getNavIdErmittelt die navid der angegebenen SeiteString getNavId(String data, String url)
- getPathesOfSubpointsErmittelt die Pfade von UnterpunktenString getPathesOfSubpoints(String data, String navId)
- getUrlOfNavIdErmittelt die URL einer Navigations-IDString getUrlOfNavId(String data, String navId)
- mergeNavigationsFügt mehrere Navigationen zu einer Navigation zusammenString mergeNavigations(String pathDest, Array pathesSource, Array options)
- setNavIdSetzt die Navigations-ID der aktuellen Seite (verfübar ab CMS-Version 018.007.127.000)String setNavId(String navId)
- createNavigationHTML
-
wNet
HTTP-Anfragen- getUrlFührt eine GET-Anfrage aus und liefert die Header-Daten und den InhaltString getUrl(String url, Array options)
- getUrlAsyncFührt eine asynchrone GET-Anfrage aus. (verfügbar ab CMS-Version 011.001.252.000)String getUrlAsync(String url)
- getUrlContentFührt eine GET-Anfrage aus und liefert den InhaltString getUrlContent(String url, Array options)
- getUrlHeaderFührt eine GET-Anfrage aus und liefert die Header-DatenString getUrlHeader(String url, Array options)
- getUrl
-
wNewsletter
Stellt Newsletter Funktionen zur Verfügung- autosendNewslettersSendet die noch offenen Newsletter über das Framework, sofern diese allowAutosend auf 1 stehen haben (ab CMS-Version 013.004.080.000)String autosendNewsletters(String path)
- clearPresubscribedCSVLöscht voreingetragene Benutzer aus der Empfängerliste, falls diese nicht nach einer gewissen Zeit bestätigt wurden (verfügbar ab CMS-Version 017.001.100.000)Boolean clearPresubscribedCSV(String pathCSV, Array options)
- confirmSubscriptionCSVBestätigt die Eintragung in einen NewsletterBoolean confirmSubscriptionCSV(String pathCSV, String receiversId, String email, String unsubscribeId)
- getDataEntryCSVErmittelt die Daten eines Eintrages auf Basis der E-MailString getDataEntryCSV(String $pathCSV, String $email)
- getDataNewsletterErmittelt Daten aus einem NewsletterString getDataNewsletter(String path, String data)
- getLinkConfirmSubscriptionGeneriert einen Link, über den eine Newsletter-Registrierung bestätigt werden kannBoolean getLinkConfirmSubscription(String urlScript, String pathCSV, String email, String unsubscribeId)
- getMailOfUnsubscribeIdErmittelt die E-Mail eines Eintrags auf Basis der Austragungs-IDString getMailOfUnsubscribeId(String $path, String $newsletterID, String $unsubscribeID)
- getMailOfUnsubscribeIdCSVErmittelt die E-Mail eines Eintrags auf Basis der Austragungs-ID (verfügbar ab CMS-Version 016.002.049.000)String getMailOfUnsubscribeIdCSV(String $path, String $unsubscribeID)
- getPathCSVErmittelt den Pfad der Empfänger CSV-DateiString getPathCSV(String $dirCSV, String $receiversId)
- getPathCSVOfNewsletterIdErmittelt eine CSV-Datei auf Basis einer Newsletter-IDBoolean getPathCSVOfNewsletterId(String $newsletterId)
- getPathNewsletterErmittelt das Newsletterverzeichnis basierend auf der zu versendenen E-MailString getPathNewsletter(String path)
- getSubscriptionsCSVErmittelt alle Abos eines Newsletter Verteilers (verfügbar ab CMS-Version 016.003.061.000)Boolean getSubscriptionsCSV(String path)
- importReceiversImportiert die Empfängerliste in einen Newsletter (verfügbar ab CMS-Version 015.006.037.000)String importReceivers(String path)
- logRequestProtokolliert einen Seitenaufruf, der über einen Link aus dem Newsletter gemacht wurdeString logRequest()
- prepareNewsletterBereitet den Newsletter im HTML- bzw. Text-Format zum Versand vor (verfügbar ab CMS 16.x mit CMS-Version Beta 015.006.067.000)String prepareNewsletter(String path)
- setSubscriptionsCSVSetzt die Abos für einen Eintrag (verfügbar ab CMS-Version 016.001.124.000)Boolean setSubscriptionsCSV(String path, String email, String unsubscribeID, Array subscriptions, Array options)
- setValueOfEntrySetzt den Wert eines EintragsBoolean setValueOfEntry(String path, String newsletterID, String email, String col, String value)
- setValueOfEntryCSVSetzt den Wert eines Eintrags (verfügbar ab CMS-Version 016.001.124.000)Boolean setValueOfEntryCSV(String path, String email, String col, String value)
- subscribeCSVTrägt einen Empfänger in eine CSV-Datei einBoolean subscribeCSV(String pathCSV, Array data)
- unsubscribeLöscht einen Benutzer aus der EmpfängerlisteBoolean unsubscribe(String path, String newsletterID, String email, String unsubscribeID, Array options)
- unsubscribeCSVLöscht einen Benutzer aus der EmpfängerlisteBoolean unsubscribeCSV(String pathCSV, String email, String unsubscribeID, Array options)
- autosendNewsletters
-
wOutput
Stellt Funktionen zur Generierung von Seiten und zur Manipulation der Ausgabe zur Verfügung.- deactivateJavaScriptDeaktiviert das Laden von externen JavaScript Ressourcen (verfügbar ab CMS-Version 016.001.133.000)String deactivateJavaScript(String str, String class)
- filterLinksOfflineFiltert Links aus der Seite heraus, die nicht online sindString filterLinksOffline(String pageStr, Array options = array())
- getNumberItemsDisplayed Ermittelt die bisher angezeigten Strukturelemente, falls diese über isViewableItem eingebunden wurden
- getRedirectErmittelt das Weiterleitungsziel für eine umbenannte bzw. verschobene Datei. Manuell eingerichtete Weiterleitungen werden vorrangig berücksichtigt.String getRedirect(String url)
- isViewableItemPrüft, ob das aktuelle Element (wd:item) angzeigt werden darfBoolean isViewableItem(Node wItemNode, String viewMode = '')
- loadWithoutCacheSorgt dafür, dass die angegebene URL vom Benutzer ohne Cache aufgerufen wirdBoolean loadWithoutCache(String url)
- maskEmailsMaskiert E-Mail AdressenString maskEmails(String html, Int level)
- parseStringErsetzt Platzhalter und interpretiert Bedingungen (ab CMS-Version 012.006.124.000)String parseString(String $path, Array $placeholders, Boolean $htmlspecialchars)
- processPageStrGeneriert eine SeiteString processPageStr(String pageStr, String templateStr, Array parameters = array(), Array options = array())
- sendFormularsOverHTTPSSorgt dafür, dass Formulardaten generell über HTTPS gesendet werdenString sendFormularsOverHTTPS(String pageStr)
- setNumberItemsDisplayedSetzt den Wert für die Anzahl der bisher angezeigten StrukturelementeVoid setNumberItemsDisplayed(String value)
- deactivateJavaScript
-
wPageAccelerator
Seitenbeschleuniger- solveListItemsSchreibt das Listenergebnis als Dateien fix in die Liste (verfügbar ab CMS-Version 017.007.011.000)Void solveListItems($path)
- solveListItems
-
wPageCur
Aktuelle Seite- addRankingSpeichert das aktuelle Ranking zur Seite abvoid addRanking(Array options)
- appendCssFügt eine CSS-Datei zur design.css hinzu. (verfügbar ab CMS-Version 015.001.011.000)Void appendCss(String path)
- doNotAddToCacheVerhindert, dass die aktuelle Seite dem Cache hinzugefügt wird. Diese Funktion steht erst in der XSLT-Transformation zur VerfügungString doNotAddToCache()
- getCorrespondentLanguageFilesErmittelt die Daten als Array zu korrespondierenden SprachversionenArray getCorrespondentLanguageFiles(String path = '', Array options = array())
- getDataLanguageFileErmittelt Daten zu einer bestimmten SprachversionArray getDataLanguageFile()
- getLastFormLiefert das zuletzt erstellte FormularobjektwForm getLastForm()
- getPathErmittelt den Pfad der aktuellen DateiString getPath()
- getPathCSSErmittelt den Pfad der aktuellen CSS-Datei (ab CMS-Version 011.001.271.000)String getPathCSS()
- getVarErmittelt eine Variable der aktuellen SeiteString getVar(String name, String value)
- insertBeforeCssFügt eine CSS-Datei zur design.css hinzu. (verfügbar ab CMS-Version 015.001.011.000)Void insertBeforeCss(String path, String insertBeforePath)
- logRequestProtokolliert alle Zugriffe auf Seiten in einer täglichen ProtokolldateiBoolean logRequest(Array options)
- registerCssRegistriert eine CSS Datei, um diese im HTML-Kopf über wsl:includeCssRessources einbinden zu können.Void registerCss(String path, String media)
- registerJsRegistriert eine JS Datei, um diese im HTML-Kopf über wsl:includeJsRessources einbinden zu können.Void registerJs(String path, String target, String allowMerge)
- setVarSetzt eine Variable der aktuellen SeiteVoid setVar(String name, String value)
- wasCachedErmittelt, ob die aktuelle Seite aus dem Cache kommtString wasCached()
- willAddToCacheErmittelt, ob die aktuelle Seite dem Cache hinzugefügt wird. Diese Funktion steht erst in der XSLT-Transformation zur VerfügungString willAddToCache()
- addRanking
-
wPageProcessor
Aktuelle Seiten-Transformation- addCurrentWidthPathErweitert den eindeutigen Pfad der aktuellen BreiteString addCurrentWidthPath($path)
- getCurrentWidthPathErmittelt den eindeutigen Pfad der aktuellen BreiteString getCurrentWidthPath()
- getVariantsDataErmittelt alle VariantendatenString getVariantsData()
- isInEditorÜberprüft, ob der aktuelle Aufruf im Editor stattfindetBoolean isInEditor()
- restoreCurrentWidthPathStellt den aktuellen, eindeutigen Breitenpfad (UID) der übergebenen ID wieder herString restoreCurrentWidthPath($id)
- setCurrentWidthPathSetzt den aktuellen, eindeutigen Breitenpfad (UID)String setCurrentWidthPath($path)
- storeCurrentWidthPathSpeichert den aktuellen, eindeutigen Breitenpfad (UID) im Wert mit der übergebenen IDString storeCurrentWidthPath($id)
- addCurrentWidthPath
-
wPathName
Stellt Funktionen für die Verarbeitung von Dateipfaden zur Verfügung- addSlashAfterFügt einen Schrägstrich hinter einen Pfad, falls noch kein Schrägstrich vorhanden ist.String addSlashAfter(String path)
- addSlashBeforeFügt einen Schrägstrich vor einen Pfad, falls noch kein Schrägstrich vorhanden ist.
- createPathSecureVerhindert Pfade, über die darüberliegende Verzeichnisse angesprochen werden könnenString createPathSecure(String path)
- getDirFileErmittelt den Verzeichnispfad einer DateiString getDirFile(String path)
- getDirNameErmittelt den Namen eines Verzeichnisses auf Basis eines VerzeichnispfadesString getDirName(String path)
- getDirNameFileErmittelt den Verzeichnisnamen einer DateiString getDirNameFile(String path)
- getDirParentErmittelt den Pfad des Elternverzeichnisses eines VerzeichnissesString getDirParent(String path)
- getDirTopErmittelt das Hauptverzeichnis eines PfadesString getDirTop(String path, Integer deep = 1)
- getFileExtensionErmittelt die Dateiendung einer DateiString getFileExtension(String path)
- getFileNameErmittelt den Dateinamen einer DateiString getFileName(String path)
- getFileNameOnlyErmittelt den Dateiname ohne DateiendungString getFileNameOnly(String path)
- getObjectIdErmittelt aus dem Dateipfad nur die ObjektIdString getObjectId(String path)
- getPathDraftLiefert den Pfad der ArbeitskopieString getPathDraft(String path)
- interpretePathInterpretiert einen Pfad, in dem die enthaltenen Platzhalter ($param[PARAMETERNAME], $globalValue[GLOBALERWERT], $dirSelf, $nextYear, $lastYear, $year, $nextMonth, $lastMonth, $month, $day, $hour, $minute, $second, $user) ausgefüllt werden. (verfügbar ab CMS-Version 011.002.001.000)String interpretePath(String path)
- isDraftPrüft, ob es sich bei einem Pfad um eine Arbeitskopie handeltString isDraft(String path)
- removeDocumentRootEntfernt die DOCUMENT_ROOT aus einem Pfad.String removeDocumentRoot(String path)
- removeSlashAfterEntfernt den Slash am Ende eines VerzeichnissesString removeSlashAfter(String path)
- removeSlashBeforeEntfernt einen Schrägstrich am Anfang eines PfadesString removeSlashBefore(String path)
- addSlashAfter
-
wPDF
Klasse zur Generierung von PDF-Dokumenten über XSL-FO- createPDFFromXSLFOGeneriert ein PDF auf Basis einer XSL-FoVoid createPDFFromXSLFO(String pdfPath, Strig foStr)
- createThumbnailErstellt ein Vorschaubild einer PDF Datei (z.B. auch für einen Blätterkatalog nutzbar) (verfügbar ab CMS-Version 15)String createThumbnail(String path, Integer resolution)
- createXSLFOFromXHTMLGeneriert ein XSL-Fo Template auf Basis einer XHTML-SeiteVoid createXSLFOFromXHTML(String xslFoPath, Strig XHTMLStr)
- createPDFFromXSLFO
-
wPicture
Klasse, um responsive Bilder über das PICTURE-Element zu generieren- createPictureErstellt ein Bild über ein PICTURE-ElementString createPicture(String path, Array data, Array, options)
- createPicture
-
wProject
Verwaltet Informationen eines Projektes- addCopyrightInfoToProjectErgänzt das Copyright in der Projekttabelle (verfügbar ab CMS-Version 019.003.084.000)String addCopyrightInfoToProject(String path, String copyright)
- clearLanguageLöscht die Sprachknoten für eine Sprache (verfügbar ab CMS-Version 013.006.015.012)String clearLanguage(String project, String language)
- clearLogsLöscht alte LogdateienString clearLogs(String project, Int limit)
- getLanguageErmittelt die Sprache das aktuellen ProjektesString getLanguage(String project)
- getLanguageCodeISOErmittelt das ISO-Sprachkürzel der ProjektspracheString getLanguageCodeISO(String projectLanguage, Array languagesArray)
- getLanguageCodeISOExtErmittelt das erweiterte ISO-Sprachkürzel der Projektsprache (ab CMS-Version 012.007.035.000)String getLanguageCodeISOExt(String projectLanguage, Array languagesArray)
- getPathAssetsErmittelt den Projektpfad des Asset-Projektes. (verfügbar ab CMS-Version 011.002.118.000)String getPathAssets(String project)
- getPathGlobalErmittelt den globalen Projektpfad des angegebenen ProjektesString getPathGlobal(String project)
- getPathLayoutErmittelt den Projektpfad des angegebenen Layoutprojektes. Falls kein spezielles Layoutprojekt angegeben wurde, wird das globale Projekt verwendet.String getPathLayout(String project)
- getValueOfErmittelt einen Wert aus den ProjekteinstellungenString getValueOf(String project, String xPath)
- addCopyrightInfoToProject
-
wProjectCur
Verwaltet Informationen des aktuellen Projektes- getCorrespondentLanguageDirsErmittelt die Daten der korrespondierenden Sprachversionen zu einem Verzeichnis.Array getCorrespondentLanguageDirs(String path = '', Array options = array())
- getLanguageErmittelt die Sprache das aktuellen ProjektesString getLanguage()
- getPathErmittelt den aktuellen ProjektpfadString getPath()
- getPathAssetsErmittelt den Projektpfad des Asset-ProjektesString getPathAssets()
- getPathContentErmittelt den Projektpfad des ersten Inhaltsprojektes (verfügbar ab CMS-Version 019.002.004.000)String getPathContent()
- getPathGlobalErmittelt den Projektpfad des aktuellen globalen ProjektesString getPathGlobal()
- getPathLayoutErmittelt den Projektpfad des aktuellen Layoutprojektes. Falls kein spezielles Layoutprojekt angegeben wurde, wird das globale Projekt verwendet.String getPathLayout()
- getCorrespondentLanguageDirs
-
wReadWrite
Ermöglicht das Schreiben und Lesen von Dateiinhalten- readFileLiest den Inhalt einer DateiString readFile(String filePath)
- readFileArrayLiest den Inhalt einer Datei zeilenweise in ein ArrayArray readFileArray(String filePath, String option = 'r')
- readFileCSVArrayLiest den Inhalt einer CSV-Datei zeilenweise in ein ArrayArray readFileCSVArray(String filePath, Boolean encodeUTF8)
- writeFileSchreibt den Inhalt einer DateiBoolean writeFile(String filePath, String fileStr, String option = 'w')
- writeFileCSVArraySchreibt einen Datensatz bzw. Datensätze in eine CSV-Datei (verfügbar ab CMS-Version 017.002.110.000)Boolean writeFileCSVArray(String filePath, Array csvData, Array option = array())
- readFile
-
wRepository
Stellt Zugriffsmöglichkeiten auf Dateien und Verzeichnisse bereit- checkInDirCheckt ein Verzeichnis einvoid checkInDir(String dir)
- checkInDocumentCheckt ein Dokument einvoid checkInDocument(String path, Array options)
- checkInProjectCheckt ein Projekt einvoid checkInProject(String dir)
- checkOutDirCheckt ein Verezeichnis ausBoolean checkOutDir(String dir)
- checkOutDocumentCheckt ein Dokument ausBoolean checkOutDocument(String path, Array options)
- checkPermissionDirectoryPrüft, ob der aktuelle Benutzer ein bestimmtes Recht an einem Verzeichnis besitztBoolean checkPermissionDirectory(String path, String permission)
- checkPermissionDocumentPrüft, ob der aktuelle Benutzer ein bestimmtes Recht an einem Dokument besitztBoolean checkPermissionDocument(String path, String permission)
- checkPermissionGroupDirectoryPrüft, ob eine Gruppe ein bestimmtes Recht auf ein Verzeichnis hatBoolean checkPermissionGroupDirectory(String path, String group, String permission)
- checkPermissionGroupDocumentPrüft, ob eine Gruppe ein bestimmtes Recht auf ein Dokument hatBoolean checkPermissionGroupDocument(String path, String group, String permission)
- checkPermissionUserDirectoryPrüft, ob ein Benutzer ein bestimmtes Recht auf ein Verzeichnis hatBoolean checkPermissionUserDirectory(String path, String user, String permission)
- checkPermissionUserDocumentPrüft, ob ein Benutzer ein bestimmtes Recht auf ein Dokument hatBoolean checkPermissionUserDocument(String path, String user, String permission)
- checkPermissionViewDocumentPrüft, ob der aktuelle Benutzer das Recht zur Ansicht eines Dokuments hat. (Modul Personalisierte Ausgabe erforderlich)Boolean checkPermissionViewDocument(String path)
- clearIndexDirLöscht den Verzeichnisindexvoid clearIndexDir(String dir)
- connectDirWithLanguageStellt eine Sprachverknüpfung zwischen zwei Verzeichnissen her (ab CMS-Version 009.003.190.000)Array connectDirWithLanguage(String sourcePath, String destPath)
- connectFileWithLanguageStellt eine Sprachverknüpfung zwischen zwei Dateien her (ab CMS-Version 009.003.190.000)Array connectFileWithLanguage(String sourcePath, String destPath)
- copyDirectoryKopiert ein VerzeichnisBoolean copyDirectory(String source, String dest, Array options)
- copyDocumentKopiert ein DokumentBoolean copyDocument(String source, String dest, Array options)
- createAccessTokenErstellt einen Token, um eine Datei trotz Personalisierung und Offline-Schaltung anzuzeigen (verfügbar ab CMS-Version 018.004.058.000) Voraussetzung ist, der Konfigurationseintrag: /wConf/personalization/allowAccessToken/@value = 1String createAccessToken(String path, Array options)
- createDirErstellt ein VerzeichnisBoolean createDir(String dir, String template)
- createDocumentErstellt eine neue Datei auf Basis einer Vorlage (verfügbar ab CMS-Version 019.002.140.000)Array createDocument(String pathNewDocument, String pathTemplate, Array options)
- createDocumentAndSetDataErstellt eine neue Datei auf Basis einer Vorlage und füllt diese Datei mit Daten bzw. Inhalten (verfügbar ab CMS-Version 019.003.047.000)Array createDocumentAndSetData(String pathNewDocument, String pathTemplate, Array options)
- createDocumentLanguageErstellt eine SprachversionBoolean createDocumentLanguage(String source, String dest)
- createDocumentVersionErstellt eine Version eines DokumentesString createDocumentVersion(String path)
- createDocumentXtDefaultErstellt eine Standarddateierweiterung für ein Verzeichnis, falls diese noch nicht existiert (verfügbar ab CMS-Version 018.009.058.000)Boolean createDocumentXtDefault(String dir)
- createDraftErstellt eine ArbeitskopiewDocument createDraft(String path, createEditorIds = false)
- deleteDirLöscht ein VerzeichnisBoolean deleteDir(String path)
- deleteDocumentLöscht ein DokumentBoolean deleteDocument(String path, Array options)
- deleteDraftLöscht die Arbeitskopie eines DokumentesBoolean deleteDraft(String path, Integer timeMin)
- deleteThumbnailsDirLöscht die Vorschaubilder eines Verzeichnissesvoid deleteThumbnailsDir(String dir, Boolean keepPicturedatas)
- deleteVersionsLöscht die Versionen eines DokumentesInteger deleteVersions(String path, Integer remainingVersions)
- directoryExistsPrüft, ob ein Verzeichnis existiert.Boolean directoryExists(String path)
- documentExistsPrüft, ob ein Dokument existiert.Boolean documentExists(String path)
- emptyTrashLöscht den Papierkorb (verfügbar ab CMS-Version 013.008.014.000)Array emptyTrash(String project, String limit)
- getContentDirLiefert alle Inhalte eines Verzeichnisses rekursiv als Array mit Pfad und Type (f für Datei, d für Verzeichnis) (verfügbar ab CMS-Version 018.003.025.000)Array getContentDir(String path)
- getDocumentGibt ein Dokumenten-Objekt zurückwDocument getDocument(String path)
- getDocumentContentGibt den Inhalt eines Dokumente zurück.String getDocumentContent(String path)
- getDocumentSizeErmittelt die Dateigröße in ByteswDocument getDocumentSize(String path, Boolean format)
- getDocumentVersionsErmittelt alle Versionen eines DokumentesArray getDocumentVersions(String path)
- getDocumentsDirLiefert eine Liste aller Dokumente eines VerzeichnissesArray getDocumentsDir(String dir, Array options)
- getDocumentsDirRecursiveLiefert eine Liste aller Dateien eines Verzeichnisses und dessen Unterverzeichnisse.Array getDocumentsDirRecursive(String dir, Array options)
- getDraftGibt ein Dokumenten-Objekt der Arbeitskopie zurückwDocument getDraft(String path)
- getFilesWithLinksToDocumentErmittelt alle Seiten, in denen das Dokument verlinkt istArray getFilesWithLinksToDocument(String path)
- getPermissionsDocumentErmittelt die Berechtigungen einees Dokumentes (verfügbar ab CMS-Version 019.004.009.000 )Array getPermissionsDocument(String path)
- getSubdirsDirLiefert eine Listen aller Unterverzeichnisse eines VerzeichnissesArray getSubdirsDir(String dir)
- getSubdirsDirRecursiveLiefert eine Listen aller Unterverzeichnisse eines Verzeichnisses rekursivArray getSubdirsDirRecursive(String dir, Array options)
- getUsersWithPermissionToViewDocumentErmittelt alle Benutzer, die ein personalisiertes Dokument sehen dürfen. (Modul Personalisierte Ausgabe erforderlich)Array getUsersWithPermissionToViewDocument(String path)
- grepDocumentsDirLiefert alle Dateien eines Verzeichnisses zurück, die dem regulären Ausdruck entsprechenArray grepDocumentsDir(String dir, String grepString, Array options)
- grepDocumentsDirRecursiveErmittelt alle Dokumente eines Verzeichnisses und dessen Unterverzeichnisse, deren Namen auf einen Regulären Ausdruck passenArray grepDocumentsDirRecursive(String dir, String grepString, Array options)
- hasDraftPrüft, ob eine Arbeitskopie bestehtwDocument hasDraft(String path)
- importCsvToObjectsObjekte aus einer CSV-Datei erstellen (verfügbar ab CMS-Version 017.005.093.000)Array importCsvToObjects(String dirDest, String pathCSV, String objectTemplate)
- isCheckedInDirPrüft, ob ein Verzeichnis eingecheckt ist (verfügbar ab CMS-Version 015.001.064.000)Boolean isCheckedInDir(String path)
- isCheckedInDocumentPrüft, ob ein Dokument eingecheckt ist (verfügbar ab CMS-Version 015.001.066.000)Boolean isCheckedInDocument(String path)
- isOnlineDocumentPrüft, ob ein Dokument online ist.Boolean isOnlineDocument(String path)
- isPersonalizedDocumentPrüft, ob ein Dokument personalisiert istBoolean isPersonalizedDocument(String path)
- isTimeDependendPublishedPrüft, ob ein Dokument zeitgesteuert veröffentlicht istBoolean isTimeDependendPublished(String path, Boolean default)
- mayAccessDocumentPrüft, ob ein Dokument vom aktuellen Benutzer abrufbar ist.Boolean mayAccessDocument(String path)
- moveDirectoryVerschiebt ein VerzeichnisBoolean moveDirectory(String source, String dest, Array options)
- moveDocumentVerschiebt ein DokumentBoolean moveDocument(String source, String dest, Array options)
- protectDirSperrt ein Verzeichnis über .htaccessBoolean protectDir(String path)
- rebuildLinksBaut das Linkverzeichnis neu aufvoid rebuildLinks(String project)
- registerLinksFromDocumentRegistriert die verlinkten Dateien im ProjektBoolean registerLinksFromDocument(String path)
- renameDirectoryBenennt ein Verzeichnis umBoolean renameDirectory(String path, String nameNew, Array options)
- renameDocumentBenennt ein Dokument umBoolean renameDocument(String path, String nameNew, Array options)
- renameProjectGlobalBenennt ein globales Verzeichnis um (verfügbar ab CMS-Version 017.006.051.000)Boolean renameProjectGlobal(String path, String nameNew, Array options)
- selectDocumentsLiefert eine Listen von Dokumenten, die der Abfragebedingung entsprechenArray selectDocuments(Array query)
- setPermissionsDirectorySetzt die Berechtigungen für ein Verzeichnis, falls dieses eingecheckt ist (verfügbar ab Version 007.005.189.000)Boolean setPermissionsDirectory(String path, Array permissions)
- setPermissionsDocumentSetzt die Berechtigungen für das aktuelle Dokument, falls dieses eingecheckt ist (verfügbar ab Version 006.004.009.000)Boolean setPermissionsDocument(String path, Array permissions)
- setPermissionsInheritDocumentSetzt die Berechtigungen für ein Dokument auf erben, falls dieses eingecheckt ist (verfügbar ab Version 010.002.202.000)Boolean setPermissionsInheritDocument(String path)
- setPermissionsInheritViewDocumentSetzt die Berechtigungen zur Ansicht eines Dokumentes auf erben, falls dieses eingecheckt ist (verfügbar ab Version 010.002.202.000)Boolean setPermissionsInheritViewDocument(String path)
- setPermissionsViewDocumentSetzt die Berechtigungen zur Ansicht eines Dokumentes, falls dieses eingecheckt ist (verfügbar ab Version 010.002.202.000)Boolean setPermissionsViewDocument(String path, Array permissions)
- setPublicDocumentMacht ein Dokument öffentlich zugänglich (bei Bedarf wird das Dokument eingecheckt) (verfügbar ab CMS-Version 018.004.036.000)Boolean setPublicDocument(String path)
- checkInDir
-
wRequest
Anfrage-Objekt- checkActionTokenPrüft einen Action-Token (verfügbar ab CMS-Version 017.001.070.000)Void checkActionToken(String actionToken = '')
- checkFormTokenPrüft einen Form-Token (verfügbar ab CMS-Version 018.004.161.000)Void checkFormToken(String formToken = '')
- createActionTokenErstellt einen Action-Token um eine Aktion einmalig auszuführen (verfügbar ab CMS-Version 017.001.070.000)Void createActionToken()
- getClientIPErmittelt die IP-Adresse des ClientsVoid getClientIP()
- getCookieErmittelt die CookiesString getCookie()
- getDomainErmittelt die aktuelle DomainString getDomain()
- getMethodErmittelt die Methode der aktuellen AnfrageString getMethod()
- getParameterErmittelt den Wert eines Request-ParametersMixed getParameter(String name, String filter = '')
- getParameterIntErmittelt den Wert eines Request-Parameters als IntegerString getParameterInt(String name)
- getParameterPathSecureErmittelt den Wert eines Request-Parameters als sicheren PfadString getParameterPathSecure(String name)
- getParameterSecureErmittelt den Wert eines Parameters und verhindert das Einschleußen von Code, ohne ' und " zu ersetzenString getParameterSecure(String name)
- getParameterSecureStrictErmittelt den Wert eines Parameters und verhindert das Einschleussen von Code. Der Einsatz dieser Funktion wird an XSS kritischen Stellen empfohlenString getParameterSecureStrict(String name)
- getParameterTextErmittelt den Wert eines Request-Parameters als Text (führt bei Bedarf eine Umwandlung in UTF-8 durch)String getParameterText(String name)
- getPathErmittelt den Pfad der aktuellen AnfrageString getPath()
- getSearchengineTermGibt den Suchbegriff zurück, über den man auf diese Seite gelangt ist (Google oder Bing)String getSearchengineTerm()
- getUrlErmittelt die URL der aktuellen AnfrageString getUrl()
- getUrlRelGibt die vollständige aktuelle URL ohne Domain zurückString getUrlRel()
- hasValidDraftTokenPrüft, ob ein gültiger Draft-Token mit der URL übergeben wurde (verfügbar ab CMS-Version 018.005.034.000)Void hasValidDraftToken(String draftToken = '')
- includePageZeigt eine beliebige Seite innerhalb der aktuellen Domain an (verfügbar ab CMS-Version 008.004.103.000)Void includePage(String $path, String $queryString = '')
- isAIPrüft, ob die aktuelle Seite von der KI aufgerufen wird (ab CMS-Version 018.009.102.000 verfügbar)Boolean isAI(Boolean checkIfIsServer = false)
- isCronPrüft, ob die aktuelle Seite über ein Cron-Skript aufgerufen wurdeBoolean isCron()
- isDiffViewPrüft, ob die aktuelle Seite von der Versionsansicht aufgerufen wirdBoolean isDiffView(Boolean checkIfIsServer = false)
- isEmbedViewExplorerPrüft, ob es sich um die eingebettete Ansicht im Dateiexplorer handelt. (verfügbar am CMS-Version 011.002.284.000)Boolean isEmbedViewExplorer()
- isHTTPSPrüft, ob der aktuelle Aufruf über HTTPS erfolgt ist (verfügbar ab CMS-Version 018.007.199.000)String isHTTPS()
- isLinkCheckerPrüft, ob die aktuelle Seite von der Linkprüfung aufgerufen wirdBoolean isLinkChecker(Boolean checkIfIsServer = false)
- isPrefetchedPrüft, ob es sich um einen Vorabruf handelt (verfügbar ab CMS-Version 016.003.084.000)Boolean isPrefetched()
- isPreviewPrüft, ob es sich um die Vorschauansicht handelt. (verfügbar am CMS-Version 011.002.284.000)Boolean isPreview()
- isProbablyBotPrüft, ob die Anfrage von einer Suchmaschine stammt. Bitte beachten Sie, dass jeder Browser sich auch als Suchmaschine ausgeben kann.Boolean isProbablyBot()
- isSearchBotPrüft, ob die aktuelle Seite von der Volltextsuche aufgerufen wirdBoolean isSearchBot(Boolean checkIfIsServer = false)
- removeParameterEntfernt einen Parameter aus der Anfrage (verfügbar ab CMS-Version11.x)Void removeParameter(String key, Boolean caseInSensitive)
- setParameterSetzt einen Request-Parameter abhängig von der REQUEST-MethodeVoid setParameter(String name, String value, type = '')
- checkActionToken
-
wSearch
Die Framework-Klasse wSearch bietet die Schnittstelle zu einer Suche.- addAdditionalSearchFügt eine weitere Suche hinzu, um diese bei den Suchergebnissen zu berücksichtigen (verfügbar ab CMS Version 009.003.152.000)String addAdditionalSearch(String $path)
- addUrlToIndexFügt eine Datei dem Suchindex hinzu.String addUrlToIndex(String $url, Boolean $async)
- createIndexErstellung des Suchindexes mithilfe eines Scriptes (ab Version: 005.034.001.021)String createIndex(Array $parameters)
- cronjobErstellung des Suchindexes Mithilfe eines CronjobsString cronjob(Array $parameters)
- getDataIndexErmittelt die Daten des aktiven Index (verfügbar ab CMS Version 009.005.053.000)String getDataIndex()
- getDataRobotErmittelt die Daten des im Aufbau befindlichen Index (verfügbar ab CMS Version 009.005.053.000)String getDataRobot()
- getDescriptionErmittelt die Beschreibung aus einer Datei im Suchindex.String getDescription(Array $parameters)
- getFirstHeadlineErmittelt die erste Überschrift aus einer Datei im Suchindex. (egal welche Überschriftenhierarchie die Überschrift hat)String getFirstHeadline(Array $parameters)
- getSearchTermsForTagcloudDie Methode gibt den String zurück, der an die Framework-Funktion wTagcloud weitergegeben werden kann um eine Tagcloud zu erzeugen. Die Ergebnisse werden aus der Statistik der Suche ermittelt (Zusatzmodul Suche-Statistik).String getSearchTermsForTagcloud(Array $parameters)
- getStatusRobotErmittelt den aktuellen Status des RobotsString getStatusRobot()
- getTextDescriptionErmittelt die Beschreibung einer Seite im Suchindex und markiert die Treffer darin.String getTextDescription(Array $parameters)
- getTextMultiErmittelt einen Teil des Inhalts aus einer Seite im Index. Der Treffer im Inhalt der Seite wird als Ergebnis markiert.String getTextMulti(Array $parameters)
- getTitleErmittelt den Titel aus einer Datei im Suchindex.String getTitle(Array $parameters)
- removeUrlFromIndexEntfernt eine Datei aus dem Suchindex.String removeUrlFromIndex(String $url)
- searchFührt eine Suchanfrage aus und transformiert das Ergebnis mit einem Template.String search(Array $parameters)
- searchArrayFührt eine Suchanfrage aus und gibt ein Array mit Urls zurückArray searchArray(Array $parameters)
- searchArrayDataFührt eine Suchanfrage aus und gibt ein Array mit Urls zurück. Für jede Url wird zusätzlich die Gewichtung mitgegeben.Array searchArrayData(Array $parameters)
- searchArrayDataCompleteFührt eine Suchanfrage durch und gibt eine Array zurück, das alle von der Suche ermittelten Informationen enthältArray searchArrayDataComplete(Array $parameters)
- exportStatisticExportiert die Statistik (verfügbar ab CMS-Version 018.004.137.000 und in Verbindung mit lizenzierter Suchstatistik)String exportStatistic(String $limit, String $type, String $format)
- addAdditionalSearch
-
wServer
Server- getDiskUsageErmittelt den genutzten Speicherplatz eines Verzeichnisses in Kilobyte (NUR unter Linux, MacOS, etc. bei entsprechender Berechtigung nutzbar!) (ab Version 13)String getDiskUsage(String dir)
- getDiskUsage
-
wSession
Session- clearSessionLöscht eine Session (verfügbar ab CMS-Version 009.006.032.000)String clearSession()
- getHistoryUrlErmittelt eine zuvor aufgerufene URLString getHistoryUrl(Int index)
- getSessionIdErmittelt die aktuelle Session-IDString getSessionId()
- getUserNameErmittelt den Benutzernamen des aktuellen BenutzersString getUserName()
- getUserTypeErmittelt den Benutzertyp des aktuellen BenutzersString getUserType()
- getValueLiest einen Wert aus der Session ausString getValue(String name)
- refreshUserÜbernimmt die Benutzerdaten neu in die Session (verfügbar ab CMS-Version 015.006.082.000)Void refreshUser()
- setLanguageÄndert die Sprache des aktuellen Benutzers für die Dauer der SessionVoid setLanguage($language)
- setTimeoutSetzt ein Timeout in Sekunden, nachdem eine inaktive Session nicht mehr genutzt werden kann (verfügbar ab CMS-Version 015.005.084.000)Void setTimeout(Integer timeout)
- setValueSetzt einen Wert in der aktuellen SessionVoid setValue(String name, String value)
- clearSession
-
wSocket
HTTP-Anfrage- getUrlFührt eine GET-Anfrage durch und liefert das Ergebnis als String zurück.String getUrl(String url)
- getUrl
-
wStaticHTML
Klasse macht HTML statisch- createPageStaticErstellt eine statische SeiteString createPageStatic(String content, String path, String dirStatic)
- createPageStatic
-
wStringconverter
Zeichenkettenmanipulation- addPrologXmlFügt den XML-Prolog zu XML-Zeichenkette hinzuString addPrologXml(String str)
- applyFilterFiltert einen Wert, um keine unsicheren Zeichen zu erhalten.String applyFilter(String value, String filter)
- checkUTF8Prüft, ob eine Zeichenkette UTF-8 konform istString checkUTF8(String str)
- convertAnchorToIDErstellt eine gültige ID im Gegensatz zu convertToAnchorID werden auch Punkte und Doppelpunkte ersetzt (verfügbar ab CMS-Version 011.005.030.000)String convertAnchorToID(String str)
- convertFromBytesKonvertiert einen String mit Byte-Angabe in den enstprechenden WertString convertFromBytes(String str, Array options = array())
- convertFromXmlDemaskiert die Sonderzeichen &, ", ', <, >String convertFromXml(String str)
- convertToAnchorIDErstellt eine gültige IDString convertToAnchorID(String str)
- convertToDirNameKonvertiert eine Zeichenkette in einen gültigen und sinnvollen Verzeichnisnamen, der frei von Sonderzeichen istString convertToDirName(String str)
- convertToFileNameKonvertiert eine Zeichenkette in einen gültigen und sinnvollen Dateinamen, der frei von Sonderzeichen istString convertToFileName(String str)
- convertToRegMaskiert Zeichen für einen Regulären AusdruckString convertToReg(String str)
- convertToXmlKonvertiert einen String in XML-konformen-String, d.h die Sonderzeichen &, ", ', <, > werden in HMTL-Zeichen umgewandeltString convertToXml(String str)
- filterEmptyTagsFiltert Tags ohne InhaltString filterEmptyTags(String str, String tagName = 'p')
- getFirstCharErmittelt den ersten Buchstaben (verfügbar ab CMS-Version 011.001.366.000)String getFirstChar(String str, Boolean convertUmlaut, String convertCase)
- maskAposMaskiert einfache AnführungszeichenString maskApos(String str, Boolean full)
- maskAposJSMaskiert einfache Anführungszeichen, um diese in JS zu verwendenString maskAposJS(String str)
- maskQuotesMaskiert doppelte AnführungszeichenString maskQuotes(String str)
- maskTextBotMaskiert einen Text, so dass er von Bots nicht bzw. nur schwer lesbar ist. (verfügbar ab CMS-Version 015.007.023.000)String maskTextBot(String str)
- minimizeJSMinimiert JavaScript (verfügbar ab CMS-Version 15)String minimizeJS(String jsStr)
- prepareXmlToEmbedBereitet eine XML Datei (z.B. SVG) zum Einbetten in HTML vor (verfügbar ab CMS-Version 011.002.197.000)String prepareXmlToEmbed(String str)
- removeDoctypeEntfernt den Doctype z.B. am Anfang eines HTML-Strings.String removeDoctype(String str)
- removeDocumentElementEntfernt das Wurzelelement aus einer XML-ZeichenketteString removeDocumentElement(String str)
- removeLinebreaksLöscht alle Zeilenumbrüche aus einer Zeichenkette rausString removeLinebreaks(String str)
- removePrologXmlEntfernt aus einer XML-Zeichenkette den XML-PrologString removePrologXml(String str)
- replaceWhiteSpacesLöscht alle Leerzeichen aus einer Zeichenkette rausString replaceWhiteSpaces(String str)
- toUTF8Konvertiert eine Zeichenkette in UTF-8String toUTF8(String str)
- wrapCDATAUmschließt eine Zeichenkette mit CDATA (verfügbar ab CMS-Version 015.001.034.000)String wrapCDATA(String str)
- addPrologXml
-
wSubscriptions
Abos- autoInformSubscribersInformiert die Abonnenten eines Verzeichnisses über einen Cronjob (verfügbar ab CMS-Version 017.001.112.000)String autoInformSubscribers(String path, String pathSubscriptionmanagement)
- informSubscribersInformiert die Abonnenten eines Verzeichnisses (verfügbar ab CMS-Version 016.001.164.000)String informSubscribers(String path)
- subscribeAbonniert ein Verzeichnis (verfügbar ab CMS-Version 016.001.090.000)String subscribe(String path, String mail)
- unsubscribeBeendet ein Verzeichnisabo (verfügbar ab CMS-Version 016.005.012.000)String unsubscribe(String path, String unsubscribeId)
- unsubscribeByMailBeendet ein Verzeichnisabo (verfügbar ab CMS-Version 016.005.012.000)String unsubscribeByMail(String path, String mail)
- autoInformSubscribers
-
wTagcloud
Tag-Wolke / Tag-Cloud- createTagCloudHTMLErstellt eine Tag-Wolke als XMLString createTagCloudHTML(String tagsStr, Array options)
- createTagCloudHTML
-
wTexts
Zugriff auf globale Texte- getTextLiefert einen Text aus der Textdatei eines ProjektesString getText(String key, String project = '', String path = ''))
- getTextGlobalLiefert einen Text aus der globalen Textdatei des aktuellen Projektes (unterstützt keine Sprachen) Funktion: DEPRECATEDString getTextGlobal(String key, String project = ''))
- getTextUserLiefert einen Text in der BenutzerspracheString getTextUser(String key, String project = ''))
- getTextsLiefert alle Texte aus der angegebenen TextdateiString getTexts(String path = ''))
- setTextSetzt einen TextString setText(String key, String value = '', String project = '', String path = '')
- showTextUserGibt einen Text sprachabhängig aus (eingestellte Sprache des Benutzers in der Benutzerverwaltung)String showTextUser(String en = '', String de = '', String fr = ''))
- getText
-
wThumbnail
Erstellt verkleinerte Vorschaubilder- createThumbnailErstellt ein Vorschaubild auf Basis eines vorhandenen BildesString createThumbnail(String path, Integer width, Integer height, String mode, Array options)
- getPathOrigErmittelt den Originalpfad eines VorschaubildesString getPathOrig(String pathThumbnail)
- getPathThumbnailErmittelt den Pfad eines VorschaubildesString getPathThumbnail(String path, Integer width, Integer height, String mode)
- createThumbnail
-
wTwitter
Schnittstelle zu Twitter- createAuthTokenErstellt einen AuthentifizierungsschlüsselBoolean createAuthToken(String parameters, String consumerKey, String consumerSecret)
- deleteAuthTokenLöscht einen AuthentifizierungsschlüsselBoolean deleteAuthToken(String consumerKey, String consumerSecret)
- getAuthTokenLiest einen AuthentifizierungsschlüsselBoolean getAuthToken(String consumerKey, String consumerSecret)
- hasAuthTokenPrüft, ob ein Authentifizierungsschlüssel existiertBoolean hasAuthToken(String consumerKey, String consumerSecret)
- postMessageVeröffentlicht eine Meldung bei TwitterBoolean postMessage(String message, String consumerKey, String consumerSecret)
- requestAuthTokenFragt einen Authentifizierungsschlüssel an, der vom Benutzer bestätigt werden mussVoid requestAuthToken(String consumerKey, String consumerSecret)
- setAuthTokenSchreibt einen AuthentifizierungsschlüsselBoolean setAuthToken(Object token, String consumerKey, String consumerSecret)
- createAuthToken
-
wURL
URL Klasse- convertToAbsWandelt einen relativen in einen absoluten Link umString convertToAbs(String url, String base)
- createMailNoSpamJsFunctionSchützt eine E-Mail Adresse als JS-Funktion vor SPAM (Die E-Mail wird nur in Verbindung mit der ui.js korrekt aufgerufen) (verfügbar ab CMS-Version 011.005.062.000)String createMailNoSpamJsFunction(String mail)
- createMailNoSpamTextSchützt eine E-Mail Adresse als Text vor SPAM (Die E-Mail wird nur in Verbindung mit der design.css korrekt dargestellt) (verfügbar ab CMS-Version 011.005.062.000)String createMailNoSpamText(String mail)
- decodeUrlAliasErmittelt die Original-URL einer Alias-URLString decodeUrlAlias(String $urlAlias, String $project)
- encodeUrlAliasErmittelt den Alias einer URLString encodeUrlAlias(String url)
- getAliasErmittelt den Alias einer URL (für die Teilen-Funktion aus der Weblication® Cloud (/cloud/index.php?a=))
- getParameterErmittelt einen Parameter einer URLString getParameter(String url)
- getPathErmittelt einen Pfad einer URLString getPath(String url)
- removeParameterLöscht den Parameter einer URL (verfügbar ab CMS-Version 017.002.046.000)String removeParameter(String url, String name, String value)
- removeParametersEntfernt die Parameter einer URLString removeParameters(String url)
- setParameterSetzt den Parameter einer URLString setParameter(String url, String name, String value)
- convertToAbs
-
wUserContent
Von Benutzern generierter Inhalt, wie z.B. Kommentare und Bewertungen- addCommentFügt einen Kommentar einer Seite hinzuString addComment(String path, Array data)
- addRatingFügt eine Bewertung einer Seite hinzuString addRating(String path, Integer data, String subId, Array additionalData)
- deleteRatingLöscht eine Bewertung einer Seite (verfügbar ab CMS-Version 017.006.230.000)String deleteRating(String path, String userKey)
- getAverageRatingErmittelt die durchschnittliche Bewertung einer SeiteFloat getAverageRating(String path, String subId)
- getDataOfCommentErmittelt die Daten eines Kommentars (verfügbar ab CMS-Version 017.007.009.000)String getDataOfComment(String path, String id)
- getDateLastCommentErmittelt das Datum des neuesten KommentarsString getDateLastComment(String path)
- getNameLastCommentErmittelt den Benutzernamen des neuesten KommentatorsString getNameLastComment(String path)
- getNumberCommentsErmittelt die Anzahl der Kommentare zu einer SeiteInteger getNumberComments(String path)
- getNumberRatingsErmittelt die Anzahl der Bewertungen zu einer SeiteInteger getNumberRatings(String path)
- getNumberRatingsTypeErmittelt die Anzahl der unterschiedlichen Bewertungen (verfügbar ab CMS-Version 019.004.008.000)Integer getNumberRatingsType(String path)
- getPathCommentsErmittelt die Datei, welche die Kommentare einer Seite enthältString getPathComments(String path)
- getPathRatingsErmittelt die Datei, welche die Bewertungen einer Seite enthältString getPathRatings(String path)
- getUserNameLastCommentErmittelt den Benutzernamen des neuesten KommentatorsString getUserNameLastComment(String path)
- hasAlreadyRatedPrüft, ob der Benutzer bereits abgestimmt hatBoolean hasAlreadyRated(String path, String subId)
- updateCommentÄndert einen Kommentar einer SeiteString updateComment(String path, Array data)
- addComment
-
wUserCur
Daten zum aktuellen Benutzer- confirmMfaTANFührt eine Anmeldung über eine Bestätigungs-TAN durch (verfügbar ab CMS-Version 17, ab Version 19 auch für öffentliche Benutzer)Boolean confirmMfaTAN(String tan)
- createSessionStrErstellt eine öffentliche Benutzer-Session auf der Basis einer Benutzer-XML-Zeichenkette (verfügbar mit dem Modul externe Benutzerschnittstelle (z.B. ActiveDirectory/LDAP))Boolean createSessionStr(String userName, String userStr)
- createSessionUserErstellt eine Benutzer-Session auf der Basis eines existierenden Benutzers.Boolean createSessionUser(String userName, String password)
- executeJSFührt für den Benutzer JavaScript aus (Einsatz in Verzeichnisereignissen)Boolean executeJS(String jsString)
- getAlertsJsZeigt dem aktuellen Benutzer die noch nicht angezeigten Meldungen
- getDataErmittelt Daten des aktuellen BenutzersString getData(String data)
- getGroupStandardErmittelt die Standardgruppe des aktuellen Benutzersstring getGroupStandard()
- getGroupsErmittelt die Gruppen des aktuellen BenutzersArray getGroups(Integer inherit = '1')
- getLanguageErmittelt die Sprache des aktuellen BenutzersString getLanguage()
- getMetaErmittelt Metadaten des aktuellen Benutzers (verfügbar ab CMS-Version 008.004.026.000)String getMeta(String user = null, String name)
- getNameErmittelt den Benutzernamen des aktuellen BenutzersString getName()
- getPermissionErmittelt eine Berechtigung eines Benutzers (verfügbar ab CMS-Version 012.005.096.000)String getPermission(String permission)
- getStartPathErmittelt den Weiterleitungspfad nach dem LoginString getStartPath()
- getTypeErmittelt den Benutzertyp des aktuellen BenutzersString getType()
- hasPasswordExpiredPrüft, ob das Benutzerpasswort abgelaufen istBoolean hasPasswordExpired()
- isExistingUserPrüft, ob die Session auf einem in der Benutzerverwaltung vorhandenen Benutzer beruht. Falls nicht, handelt es sich um einen externen Benutzer, der über createSessionStr angemeldet wurde. (Lizenzabhängig)Boolean isExistingUser()
- isInGroupPrüft, ob der aktuelle Benutzer in einer bestimmten Gruppe eingetragen ist. Mehrere Gruppen können über eine oder-Verknüpfung geprüft werden (ab Version 005.049.016.000).Boolean isInGroup(String group)
- isInUserListPrüft, ob der aktuelle Benutzer in einer über | getrennten Benutzerauflistung enthalten istBoolean isInUserList(String userList)
- isLoggedInPrüft, ob der aktuelle Benutzer eingeloggt ist.Boolean isLoggedIn()
- logoutLoggt den aktuellen Benutzer ausBoolean logout(String $type)
- openEditorÖffnet den Editor (verfügbar ab CMS-Version 016.003.012.000) Einsatz: Um z.B. nach dem Anlegen eines Verzeichnisses über das Ereignis onAfterCreateDir sofort in die Bearbeitung einer enthaltenen Datei zu gelangen.Boolean openEditor(String path)
- sendAlertSchickt dem aktuellen Benutzer eine Meldung zur AnzeigeBoolean sendAlert(String message)
- sendRedirectLeitet den Benutzer auf eine URL weiter (verfügbar ab CMS-Version 018.007.179.000)Boolean sendRedirect(String url)
- setMetaSetzt Metadaten des aktuellen Benutzers (nur die Daten innerhalb der Session werden angepasst!) (verfügbar ab CMS-Version 018.005.006.000)String setMeta(String data, String value)
- confirmMfaTAN
-
wUserData
Benutzerdaten- checkPasswordPrüft das Passwort eines BenutzersString checkPassword(String user, String password)
- clearIndexLöscht den Index der Benutzerdatenvoid clearIndex()
- encryptPasswordVerschlüsselt ein Passwort (SaltLevel werden berücksichtigt) (verfügbar ab CMS Version 010.002.201.000)String encryptPassword(String password, String saltLevel)
- getDataErmittelt Daten eines Benutzers.String getData(String user = null, String data = null)
- getGroupsErmittelt die Gruppen eines BenutzersArray getGroups(String user = null))
- getMetaErmittelt Metadaten eines BenutzersString getMeta(String user = null, String name = "")
- getMetaExtErmittelt externe Metadaten eines BenutzersString getMetaExt(String user = null, String name = "")
- getXMLStrErmittelt Daten eines Benutzers als XML-String.String getXMLStr(String user = null)
- setDataSetzt Daten eines BenutzersString setData(String user = null, String data = null, String value)
- setGroupsSetzt die Gruppen eines BenutzersArray setGroups(String user = null, Array groups)
- setMetaSetzt Metadaten eines BenutzersString setMeta(String user, String name, String value)
- setMetaExt ***deprecated***Setzt externe Metadaten eines Benutzers ***deprecated***
- setPasswordSetzt das Passwort eines BenutzersString setPassword(String user, String password)
- checkPassword
-
wUsers
Benutzer- checkPasswordPolicyPrüft, ob das Passwort den globalen Passwortrichtlinien entsprichtBoolean checkPasswordPolicy(String password [, String rules])
- clearIndexGroupsLöscht den GruppenindexVoid clearIndexGroups()
- clearIndexUsersLöscht den BenutzerindexVoid clearIndexUsers()
- deleteUserLöscht einen Benutzer (verfügbar ab CMS-Version 016.005.010.000)Boolean deleteUser(String user)
- filterUsernameFiltert aus einem Benutzernamen alle nicht gültigen Zeichen herausString filterUsername($userName)
- getUserStrLiefert die Benutzerdaten als XML-ZeichenketteString getUserStr(String user)
- getUsersLiefert alle BenutzernamenArrays getUsers(String group = '')
- isInGroupPrüft, ob ein Benutzer Mitglied einer bestimmten Gruppe istBoolean isInGroup(String user, String group)
- isLockedIpUntilPrüft, ob bzw. bis wann ein Benutzer gesperrt ist (verfügbar ab CMS-Version 008.004.035.000)Boolean isLockedIpUntil(String ip, String user)
- selectUsersFührt eine bedingte Abfrage auf Benutzer ausArrays selectUsers(Array query = '')
- setUserOfflineSetzt einen Benutzer offlineBoolean setUserOffline(String user)
- setUserOnlineSetzt einen Benutzer onlineBoolean setUserOnline(String user)
- setUserStrSetzt die Benutzerdaten als XML-ZeichenketteString setUserStr(String user, String xmlStr)
- userExistsPrüft, ob ein Benutzer existiertBoolean userExists(String user)
- validateUsernamePrüft, ob ein Benutzername erlaubt istBoolean validateUsername(String user)
- checkPasswordPolicy
-
wUtils
Utils Klasse, mit allgemeinen nützlichen Funktionen- getFirstValueNotEmptyLiefert den ersten nicht leeren Wert zurückString getFirstValueNotEmpty(Array $values)
- getFirstValueNotEmpty
-
wValues
Zugriff auf Werte- getValueErmittelt einen WertString getValue(String key, String project = '', String path = '')
- getValueAsArrayErmittelt Werte als ArrayString getValueAsArray(String key, String project = '', String path = ''))
- getValuesErmittelt alle WerteString getValues($project = '', $path = ''))
- getValue
-
wVariables
Zugriff auf globale Variablen- getPathLocalErmittelt den Pfad der lokalen VariablendateiString getPathLocal(String path = '', String filename = 'default.wVariables.php'))
- getValueLiefert den Wert einer Variablen aus der globalen Variablendatei des aktuellen ProjektesString getValue(String key, String project = '', String path = '', String default = ''))
- getValuesErmittelt alle Variablen als ArrayString getValues(String path = ''))
- setValueSetzt eine Variable in der VariablendateiString setValue(String key, String value = '', String project = '', String path = '', String description = '')
- getPathLocal
-
wWeblic
Klasse für Weblic® Funktionen- renderItemDataZeigt ein Strukturelement an, welches rein über Parameter definiert wirdString renderItemData(String item, Array data, Array options)
- renderItemStrZeigt ein Strukturelement an, welches rein über Parameter definiert wirdString renderItemStr(String itemStr)
- renderItemUIDZeigt ein Strukturelement, welches über die Seite und die UID des Elementes definiert wird (verfügbar ab CMS-Version 017.006.237.000)String renderItemUID(String path, String itemUID, Array options)
- renderItemData
-
wWebstat
Webstatistic- getDataLayerAsJsonErmittelt die aktuell gesetzten Datenschichtwerte, um sie für den Google Tag Manager auszugebenString getDataLayerAsJson()
- setDataLayerSetzt Datenschichtwerte, die für Google Tag Manager ausgegeben werdenString setDataLayer(Array $data)
- getDataLayerAsJson
-
wWorkflow
Workflow-Funktionen- canApproveCurrentLevelPrüft, ob der aktuelle Benutzer die aktuelle Stufe freigeben kannBoolean canApproveCurrentLevel(String path)
- getUsersOfLevelErmittelt die Freigabebenutzer des angegebenen Levels (ab CMS-Version 012.005.065.000 verfügbar)Boolean getUsersOfLevel(String path, String level)
- getWorkflowPathErmittelt den Pfad des zugewiesenen Workflows (ab CMS-Version 013.007.039.000 verfügbar)String getWorkflowPath(String path)
- hasWorkflowPrüft, ob ein Dokument einen Workflow zugewiesen hat. (ab CMS-Version 012.005.010.000 verfügbar)Boolean hasWorkflow(String path)
- initWorkflowInitialisiert den Workflow einer Datei, falls davon eine Arbeitskopie existiertBoolean initWorkflow(String path)
- isInWorkflowPrüft, ob sich ein Dokument im Workflow befindetBoolean isInWorkflow(String path)
- startWorkflowStartet den Workflow einer Datei, falls davon eine Arbeitskopie existiertBoolean startWorkflow(String path)
- userIsInCurrentLevelPrüft, ob der aktuelle Benutzer in der aktiven Freigabestufe stehtBoolean userIsInCurrentLevel(String path)
- canApproveCurrentLevel
-
wWSL
WSL-Klasse über die wsl-Elemente simuliert werden können.- parseTagFührt für die wsl-Klasse die Methode parseTag ausMixed parseTag(String wslElement, Array attributes)
- parseTag
-
wXSLT
XSLT-Prozessor- getTextContentErmittelt den enthaltenen Text eines XML-Elementes (verfügbar ab CMS-Version 015.005.023.000)String getTextContent(Object node)
- processStringFührt eine XSLT-Transformation durchString processString(String xmlString, String xsltString, Array parameters = array())
- getTextContent
-
wZIP
Entpacken von ZIP-Archiven- unzipEntpackt ein ZIP-ArchivString unzip(String path, String destDir)
- unzipOnlyFilesEntpackt ein ZIP-Archiv ohne Unterverzeichnisse anzulegenString unzipOnlyFiles(String path, String destDir)
- zipPackt ein Verzeichnis als ZIP-ArchivString zip(String dirToZip, String pathArchive, String root)
- unzip