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
    • query
      Fü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)

  • wAnalyzer

    Analyse
    • createReportLastMonth
      Generiert einen Report für den letzten Monat (verfügbar ab CMS-Version 017.001.079.000)
      String createReportLastMonth(String project, Array options)
    • getData
      Ermittelt Statistikdaten innerhalb eines angegebenen Zeitraums (verfügbar ab CMS-Version 016.001.131.000)
      Int getData(String $project, Array $options)
    • getDataPages
      Ermittelt die Aufrufe nach Seiten innerhalb eines angegebenen Zeitraums (verfügbar ab CMS-Version 017.001.055.000)
      Array getDataPages(String project, Array options)
    • getNumberRequests
      Ermittelt 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)
    • prepareDataStatistic
      Generiert die Statistikdaten aus den Request- bzw. RAW-Daten (verfügbar ab CMS-Version 017.005.030.000)
      Void prepareDataStatistic(String projecct)
    • sendReportLastMonth
      Sendet einen Report für den letzten Monat (verfügbar ab CMS-Version 017.001.079.000)
      Void sendReportLastMonth(String receiver, String project, Array options)

  • wApplication

    Die aktuelle Installation
    • clearLogs
      Säubert Log-Dateien des Systems (verfügbar ab CMS-Version 015.005.100.000)
      Void clearLogs(String dir, Int limitDays = 31)
    • clearTmp
      Säubert das temporäre Verzeichnis
      Void clearTmp(Int possibility = 1, Int $expires = 86400, Boolean $useAsync = true)
    • clearTmpHTTP
      Säubert das temporäre Downloadverzeichnis
      Void clearTmpHTTP(Int possibility = 1, Int $expires = 3600, Boolean $useAsync = true)
    • getDataProjects
      Ermittelt die verfügbaren Projekte (verfügbar ab CMS-Version 008.004.022.00)
      Array getDataProjects(String type = '')
    • getOptionPath
      Ermittelt eine Systemeinstellung
      String getOptionPath(String xPath)
    • getVersion
      Ermittelt die aktuelle Software-Version
      String getVersion()
    • preparePackages
      Lädt die aktuellen BASE-Pakete vom Server (verfügbar ab CMS-Version 015.005.163.000)
      Boolean preparePackages()
    • setOptionPath
      Setzt den Wert einer Systemeinstellung (verfügbar ab CMS-Version 017.006.281.000)
      String setOptionPath(String xPath, String value)

  • wArchiving

    Archivierungsfunktionen
    • archiveFiles
      Archiviert alle zur Archivierung vorgemerkten Dateien
      Array archiveFiles(String path = '', String ifExists = '')

  • wBackup

    Klasse für Backups
    • clearBackups
      Löscht alte bzw. überflüssige Backups (verfügbar ab CMS-Version 017.003.000.000)
      Array clearBackups(Int filterAgeDays, String filterPath = '')
    • createBackup
      Erstellt ein Backup (verfügbar ab CMS-Version 013.006.020.000)
      String createBackup(String path, String excludeStr = '')

  • wBenchmark

    Klasse mit Informationen zur Ermittlung des Ressourcenverbrauchs
    • getMemoryPeakUsage
      Ermittelt den maximal genutzten Speicher in MB
      Float getMemoryPeakUsage()
    • getTimeScript
      Ermittelt die Zeit des Skriptes
      Float getTimeScript()

  • wBrowseEdit

    Erstellt Schaltflächen in der Webseite
    • createButton
      Erstellt eine allgemeine Schaltfläche
      String createButton(String onclick = '', String icon = '', String caption = '', String title = '')
    • createButtonApproveDocument
      Gibt ein Dokument aus dem Workflow frei
      String createButtonApproveDocument(String path = '', String icon = '', String caption = '', String title = '', Array options = array())
    • createButtonBackend
      Erstellt eine Schaltfläche, um die Weblication Obefläche zu öffnen, falls der Benutzer Administrator ist
      String createButtonBackend(String icon = '', String caption = '', String title = '', Array attributes = array())
    • createButtonCreateDirectory
      Erstellt eine Schaltfläche zur Erstellung eines neuen Verzeichnisses
      String createButtonCreateDirectory(String destDir = '', String icon = '', String caption = '', String title = '', Array options = array())
    • createButtonCreateDocument
      Erstellt eine Schaltfläche zur Erstellung eines neuen Dokumentes (einer neuen Seite)
      String createButtonCreateDocument(String destDir = '', String icon = '', String caption = '', String title = '', Array options = array())
    • createButtonDelete
      Erstellt eine Schaltfläche, um eine Seite zu löschen
      String createButtonDelete(String path = '', String icon = '', String caption = '', String title = '', Array attributes = array())
    • createButtonEdit
      Erstellt eine Schaltfläche zum Bearbeiten einer Seite
      String createButtonEdit(String path = '', String icon = '', String caption = '', String title = '')
    • createButtonFilemanager
      Erstellt eine Schaltfläche mit Funktionen zum Öffnen der Dateiverwaltung
      String 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 = '')
    • createButtonLogout
      Erstellt eine Schaltfläche, um sich abzumelden
      String createButtonLogout(String icon = '', String caption = '', String title = '')
    • createButtonOnlineStatus
      Erstellt eine Schaltfläche, um den Online-Status einer Datei zu ändern
      String createButtonOnlineStatus(String path = '', String icon = '', String caption = '', String title = '', Array attributes = array())
    • createButtonRejectDocument
      Weist ein Dokument aus dem Workflow zurück
      String createButtonRejectDocument(String path = '', String icon = '', String caption = '', String title = '', Array options = array())
    • createButtonUpload
      Erstellt eine Schaltfläche, um Dateien hochzuladen
      String createButtonUpload(String destDir = '', String icon = '', String caption = '', String title = '', Array attributes = array())
    • createButtonWeblics
      Erstellt eine Schaltfläche, um die Weblics-Verwaltung zu öffnen, falls der Benutzer Administrator ist
      String createButtonWeblics(String project = '', String icon = '', String caption = '', String title = '', Array attributes = array())
    • isInEditor
      Überprüft, ob der aktuelle Pfad im Editor aufgerufen ist
      Boolean isInEditor()

  • wCache

    Stellt Cache-Funktionen zur Verfügung
    • clearCache
      Säubert den Projekt-Cache
      Void clearCache(String project, Int probability = 1, Int expires = 3600)
    • clearCachePath
      Löscht den Cache einer Datei (ab Version 006.000.000.000)
      Void clearCachePath(String path, String project = '', Int expires = -1)
    • clearCacheProject
      Löscht den gesamten Projekt-Cache
      Boolean clearCacheProject(String project, Array options = array())
    • clearCacheURL
      Löscht den Cache einer URL (ab Version 006.000.000.000 einsetzbar)
      Void clearCacheURL(String url, String project = '', Int expires = -1)
    • getFilesTdpExpires
      Ermittelt, für welche Dateien der Cache aufgrund der zeitgesteuerten Veröffentlichung gelöscht werden muss
      Array getFilesTdpExpires(String project)
    • getTimeCachedURL
      Ermittelt das Erstellungsdatum des Caches einer URL als Zeitstempel. Falls keine Cache-Datei vorliegt, wird 0 zurückgegeben.
      Int getTimeCachedURL(String url, String project = '')
    • rebuildCacheURL
      Erneuert den Cache einer URL (ab Version 014.003.041.000 einsetzbar)
      Void rebuildCacheURL(String url, Array options = array())
    • tdpExpires
      Prüft, ob der Cache aufgrund der zeitgesteuerten Veröffentlichung gelöscht werden muss
      Boolean tdpExpires(String project)

  • wCaptcha

    Stellt Funktionen zur Generierung von Bildern aus Text zur Verfügung, um das automatisierte Versenden von Formularen zu verhindern
    • createCaptcha
      Erstellt ein Bild aus einer Zeichenkette, um Spam in Formularen zu verhindern
      String createCaptcha(String text, Array options = array)

  • wCart

    Warenkorb
    • addArticle
      Fügt dem Warenkorb einen Artikel hinzu
      Void addArticle(String path, Int amount = 1, Array attributes = null, String cartId = 'default')
    • addArticles
      Ermittelt den Inhalt des Warenkorbs
    • clearCart
      Löscht den Warenkorb
      Void clearCart(String cartId = 'default')
    • deleteArticle
      Löscht einen Artikel aus dem Warenkorb
      Void deleteArticle(String path, String cartId = 'default')
    • getAmountOfArticle
      Ermittelt die Anzahl eines Artikels im Warenkorb
      Int getAmountOfArticle(String path, String cartId = 'default')
    • getArticle
      Ermittelt die Daten eines Artikels
      Mixed getArticle(String path, String cartId = 'default')
    • getArticles
      Ermittelt den Inhalt des Warenkorbs
      Array getArticles(String cartId = 'default')
    • getAttributeOfArticle
      Ermittelt ein Attribut eines Artikels
      Int getAttributeOfArticle(String path, String name, String cartId = 'default')
    • setAttributeOfArticle
      Setzt ein Attribut eines Artikels
      Void setAttributeOfArticle(String path, String name, String value, String cartId = 'default')
    • updateArticle
      Ändert einen Artikel im Warenkorb
      Void updateArticle(String path, Int amount = 1, Array attributes = null, String cartId = 'default')

  • wCategories

    Klasse für Kategorien
    • createCategoriesHtmlOfDocument
      Zeigt die Categorien eines Dokumentes an (verfügbar ab CMS-Version 013.007.043.000)
      String createCategoriesHtmlOfDocument(String pathDocument, String xPathCategories, String pathCategories)
    • getCategoriesAsArray
      Ermittelt die Kategorien als Array. (verfügbar ab CMS-Version 017.006.151.000)
      String getCategoriesAsArray(String path, Int deep = 16)
    • getCategoryText
      Ermittelt den Text einer Kategorie (verfügbar ab CMS-Version 017.006.151.000)
      String getCategoryText(String path, String id, String lang = '')
    • mergeCategories
      Fügt mehrere Kategoriendateien zu einer zusammen
      Boolean mergeCategories(String pathDest, Array pathesSource, Array options = array())

  • wCron

    Cron-Skripte
    • execute
      Führt ein Cron-Skript aus (verfügbar ab CMS-Version 016.003.169.000)
      void execute(string $cronId, bool $forceExecute = false)

  • wCSS

    Zugriff auf CSS-Daten
    • deleteVariantOfCssStr
      Löscht eine CSS-Only Variante (verfügbar ab CMS-Version 014.003.081.000)
      String deleteVariantOfCssStr(String cssStr, String variant)
    • getDiffWidthElement
      Ermittelt die Differenz der inneren und der äußeren Breite eines Elementes
      String getDiffWidthElement(String file, String selector)
    • getEditmaskExtended
      Ermittelt den Wert für ein pflegbares Feld
      String getEditmaskExtended(String file, String variantName, String variantId, String editmask, String default = '')
    • getValue
      Ermittelt einen Wert aus einer CSS-Datei
      String getValue(String file, String selector, String key, String default = null, Boolelan inherit = false)
    • getWidthBlock
      Ermittelt eine Breite eines Blockes aus einer CSS-Datei
      String getWidthBlock(String file, String selector, String key = '(int)width', String objectClass = '')
    • getWidthCol
      Ermittelt die angegebene Breite einer Klasse aus einer CSS-Datei
      String getWidthCol(String file, String selector, String key, String widthCurrent = null)
    • getWidthElement
      Ermittelt eine Breite eines Elementes aus einer CSS-Datei
      String getWidthElement(String file, String selector, String withTop = '', Array parents = array())
    • getWidthInner
      Ermittelt die innere Breite eines Elementes
      String getWidthInner(String file, String selector, String withTop = '', Array parents = array())
    • optimizeCSS
      Optimiert CSS
      String optimizeCSS(String cssStr, Array options = array())
    • setWidthBlock
      Setzt die Breite eines Blocks für CSS-Only manuell (ab CMS-Version 008.000.107.000 verfügbar)
      String setWidthBlock(String block, String width)

  • wDate

    Datumsfunktionen
    • displayFromTo
      Gibt ein Von- / Bis-Datum formatiert aus
      String displayFromTo(String from, String to = '', Array options)
    • formatDate
      Formatiert 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)
    • prepareObjectdata
      Bereitet Objekdaten zur Ausgabe innerhalb des Objektwizards vor.
      Array prepareObjectdata(Array $dateData, Array options = array())
    • sortObjectdata
      Sortiert Objedaten chonologisch from/to
      Array sortObjectdata(Array $dateData, Array options = array())

  • wDB

    Dabenbank-Objekt
    • checkConnection
      Prüft, ob die aktuelle Verbindung korrekt hergestellt wurde
    • getPDOObject
      Liefert das PDO-Objekt der aktuellen Verbindung, um damit weitere Funktionen ausführen zu können
      PDOObject getPDOObject()
    • isSelectStatement
      Prüft, ob ein SQL-Statement eine reine SELECT-Abfrage ist (verfügbar ab CMS-Version 019.001.026.000)
    • query
      Führt eine Datenbank-Abfrage durch
      PDOStatement query(String sql)

  • wDiff

    Versionsvergleich
    • getDiffItemsOfLastVersion
      Ermittelt Unterschiede der Elemente eines Dokumentes
      Array getDiffItemsOfLastVersion(String path, Array options = array())

  • wDirectoryData

    Klasse ermöglicht den Zugriff auf Verzeichniseinstellungen
    • getData
      Ermittelt Daten eines Verzeichnisses
      String getData(String directory, String data, Array options = array())
    • setData
      Setzt Daten eines Verzeichnisses
      Boolean setData(String directory, String data, String value)

  • wDocument

    Dokumenten-Objekt
    • setStatusOnline
      Setzt den Online-Status eines Dokumentes
      Boolean setStatusOnline(String status)
    • getNavId
      Ermittelt die Navigations-ID des Dokumentes
      String getNavId()
    • getOwner
      Ermittelt den Besitzer (verfügbar ab CMS-Version 017.002.068.000)
      Boolean getOwner()
    • getTemplateView
      Ermittelt den Pfad des Ansichtstemplates
      String getTemplateView()
    • getUsers
      Ermittelt die Benutzer (verfügbar ab CMS-Version 017.002.077.000)
      Array getUsers()
    • isCheckedIn
      Prüft, ob ein Dokument eingecheckt ist, dass heißt, ob es eine eigene Dokumentenerweiterung besitzt.
      Boolean isCheckedIn()
    • isOfflineFuture
      Prüft, ob das zeitgesteuerte Dokument in Zukunft offline geschaltet wird (verfügbar ab CMS-Version 016.005.071.001)
      Boolean isOfflineFuture()
    • isOnline
      Prüft, ob das Dokument online ist
      Boolean isOnline()
    • isOnlineFuture
      Prüft, ob das zeitgesteuerte Dokument in Zukunft online geschaltet wird (verfügbar ab CMS-Version 016.005.071.001)
      Boolean isOnlineFuture()
    • isPersonalized
      Prüft, ob das Dokument personalisiert ist.
      Boolean isPersonalized()
    • isTimeDependentPublished
      Prüft, ob das Dokument zeitgesteuert ist (verfügbar ab CMS-Version 016.005.071.001)
      Boolean isTimeDependentPublished()
    • isTimer
      Prüft, ob das Dokument zeitgesteuert veröffentlicht ist
      Boolean isTimer()

  • wDocumentData

    Zugriff auf Daten eines Dokumentes
    • addCategory
      Setzt Kategorien eines Dokumentes. Ab CMS-Version 012.005.077.000 unterstützt die Funktion auch die Möglichkeit, Kategorien für beliebige Objektdaten zu setzen
      Boolean addCategory(String document, String category, String dataID = '')
    • deleteCategory
      Löscht eine Kategorie (verfügbar ab CMS-Version 016.003.019.000)
      Boolean deleteCategory(String document, String category, String dataID = '')
    • getData
      Ermittelt Daten eines Dokumentes als Zeichenkette
      String getData(String document, String data, Array options = array())
    • getDataAsHTML
      Ermittelt Daten eines Dokumentes als HTML-Zeichenkette
      String getDataAsHTML(String document, String wPath, Array options = array())
    • getDataEmbedInvoicePDF
      Ermittelt die Daten einer eingebetteten E-Rechnung (verfügbar ab CMS-Version 019.001.086.000)
      Array getDataEmbedInvoicePDF(String document)
    • getDataObject
      Ermittelt Objektdaten eines Dokumentes (ab Version 007.004.040.000 verfügbar)
      String getDataObject(String document, String id)
    • getDataObjectAsArray
      Ermittelt alle Objektdaten als Array
      Array getDataObjectAsArray(String document, Boolean full)
    • getNodes
      Ermittelt Daten eines Dokumentes
      DOMNodeList getNodes(String document, String wPath)
    • getSize
      Ermittelt die Dateigröße eines Dokumentes
      Float getSize(String document, String unit, Int precision = 2)
    • getValueOfDefaultExtension
      Ermittelt den Wert der Standard-Dateieinstellung
      String getValueOfDefaultExtension(String document, String data, Boolean force)
    • getViewGroups
      Ermittelt die Ansichtsgruppen (Modul Personalisierung)
      Array getViewGroups(String document)
    • getViewUsers
      Ermittelt die Ansichtsbenutzer (Modul Personalisierung)
      Array getViewUsers(String document)
    • replaceCurrentObjectdata
      Ersetzt Objektdaten der aktuellen Seite (verfügbar ab CMS-Version 14)
      String replaceCurrentObjectdata(String str, Boolean disableOutputEscaping = false)
    • setData
      Setzt Daten eines Dokumentes
      Boolean setData(String document, String data, String value, Array options = array())
    • setDataObject
      Setzt Objektdaten eines Dokumentes (ab Version 007.004.040.000 verfügbar)
      Boolean setDataObject(String document, String id, String value, Array options = array())

  • wDOM

    DOM zur Verarbeitung von XML-Daten
    • dom2Array
      Wandelt ein DOM-Objekt in eine PHP-Datenstruktur um
      Array dom2Array(&DOMNode $node)
    • executeXPath
      Führt eine xPath-Abfrage auf ein DOM-Objekt aus
      DomNodeList executeXPath(DOMDocument dom, String xPathExpression)
    • getValueOf
      Ermittelt einen Wert aus einem XML-Baum
      String getValueOf(DomDocument dom, String xPathExpression)
    • parseFile
      Erstellt ein DOM-Objekt auf Basis einer XML-Datei
      DOMDocument parseFile(String path)
    • parseString
      Erstellt ein DOM-Objekt auf Basis einer XML-Zeichenkette
      DOMDocument parseString(String xmlString)

  • wEnv

    Umgebung des aktuellen Skriptaufrufs
    • getCookieValue
      Ermittelt einen Cookie-Wert
      String getCookieValue(String key)
    • getGlobalValue
      Ermittelt einen globalen Wert
      String getGlobalValue(String key)
    • getHttpHost
      Ermittelt den Host (verfügbar ab CMS-Version 018.007.213.000)
      String getHttpHost()
    • getLanguageUserAgent
      Ermittelt die Hauptsprache des Browsers
      String getLanguageUserAgent()
    • getLanguagesUserAgent
      Ermittelt alle Sprachen des Browsers
      String getLanguagesUserAgent()
    • getTimeScript
      Ermittelt die aktuelle Ausführzeit des Skriptes
      Float getTimeScript(String round = null)
    • getUrlHost
      Ermittelt den Host der aktuell aufgerufenen URL
      String getUrlHost()
    • includeOnce
      Bindet eine Datei ein (verfügbar ab CMS-Version 017.005.082.000)
      String includeOnce(String path)
    • initMobileVersion
      Initialisiert alle notwendigen Werte, falls die Seite mobil angezeigt werden soll.
      String initMobileVersion()
    • isMobileUserAgent
      Ermittelt, ob der Besucher ein mobiles Endgerät nutzt (z.B. Blackberry|Android|iPod|Windows CE|Phone|Palm|Opera Mini|Nokia)
      String isMobileUserAgent(String matches)
    • setCookieValue
      Setzt einen Cookie-Wert
      String setCookieValue(String key, String value, String expires, String path, String domain, Boolean secure, Boolean httponly, String samesite)
    • setGlobalValue
      Setzt einen globalen Wert
      String setGlobalValue(String key, Mixed value)

  • wEvent

    Ereignis
    • fire
      Feuert ein Ereignis auf ein Verzeichnis
      Boolean fire(String eventName, String path, Array param = array())
    • setUploadedFileName
      Setzt den Namen der hochgeladenen Datei neu, falls sich dieser im Ereignis geändert hat
      Boolean setUploadedFileName($filename)
    • stopTransaction
      Unterbricht eine Transaktion auf Ereignisebene
      Boolean stopTransaction()

  • wFacebook

    Klasse für Facebook Funktionen
    • createAuthToken
      Erstellt einen Authentifizierungsschlüssel
      Boolean createAuthToken(String parameters, String consumerKey, String consumerSecret, String code)
    • deleteAuthToken
      Löscht einen Authentifizierungsschlüssel
      Boolean deleteAuthToken(String consumerKey, String consumerSecret)
    • getAuthToken
      Liest einen Authentifizierungsschlüssel
      Boolean getAuthToken(String consumerKey, String consumerSecret)
    • hasAuthToken
      Prüft, ob ein Authentifizierungsschlüssel existiert
      Boolean hasAuthToken(String consumerKey, String consumerSecret)
    • postMessage
      Veröffentlicht eine Meldung bei Facebook
      Boolean postMessage(String message, String name, String consumerKey, String consumerSecret, Array data)
    • requestAuthToken
      Fragt einen Authentifizierungsschlüssel an, der vom Benutzer bestätigt werden muss
      Void requestAuthToken(String consumerKey)
    • setAuthToken
      Schreibt einen Authentifizierungsschlüssel
      Boolean setAuthToken(Object token, String consumerKey, String consumerSecret)

  • wForm

    Stellt Formular Funktionen zur Verfügung
    • addElement
      Fügt dem Formular ein Eingabefeld bzw. Element hinzu
      Boolean addElement(String type, String name = null, label = null, options = array())
    • addEventServer
      Fügt dem Formular ein Server-Ereignis hinzu
      Boolean addEventServer(String eventName, Function function)
    • addOption
      Fügt ein Auswahlfeld hinzu
      String addOption(String value, String text, Boolean selected, String optgroup)
    • deleteElement
      Löscht ein Element aus dem Formular
      Boolean deleteElement(String name)
    • deleteOption
      Löscht ein Auswahlfeld
      String deleteOption(Array option)
    • fireEventServer
      Führt innerhalb eines Formulares ein Server-Ereignis aus
      Boolean fireEventServer(String eventName)
    • getMailDataStr
      Ermittelt die Formulardaten als Zeichenkette
      String getMailDataStr()
    • modifyOption
      Ändert ein Auswahlfeld

  • wGeoData

    Ermittelt GEO-Daten
    • getCoordinatesOfLocation
      Ermittelt die Koordination eines Ortes über die HERE GEO-API (verfügbar ab CMS-Version 018.004.106.000)
      String getCoordinatesOfLocation(String location, Array options)
    • getCountryOfIp
      Ermittelt 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)

  • wGroupData

    Ermöglicht den Zugriff auf Gruppendaten
    • clearIndex
      Löscht den Index der Gruppendaten
      void clearIndex()
    • getData
      Ermittelt Daten einer Gruppe
      String getData(String user = null, String data = null))

  • wGroups

    Ermöglicht den Zugriff auf Gruppen
    • getGroups
      Liefert alle Gruppennamen
      Arrays getGroups()

  • wImage

    Klasse für Bildfunktionen
    • convertToJPEG
      Konvertiert ein Bild in eine JPEG-Bild
      Boolean convertToJPEG(String path)
    • getDataUrlPlaceholder
      Ermittelt eine Data-URL für einen transparenten Platzhalter
      String getDataUrlPlaceholder(String path, Integer width, Integer height)
    • getHeight
      Ermittelt die Höhe eines Bildes
      String getHeight(String path, Boolean useCache)
    • getWidth
      Ermittelt die Breite eines Bildes
      String getWidth(String path, Boolean useCache)
    • resize
      Ändert die Bildgröße
      String resize(String path, String pathDest, Integer width, Integer height, String mode)
    • rotate
      Dreht ein Bild. (ab CMS-Version 011.002.222.000)
      String rotate(String path, String pathDest, Integer deg)

  • wLanguages

    Klasse für Sprachverwaltung
    • dissolveFileLanguage
      Löscht einen Pfad aus der Sprachknotendatei (verfügbar ab CMS-Version 015.006.009.000)
      String dissolveFileLanguage(String path, String pathToDissolve)
    • isTranslatable
      Prü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)
    • removeStructureReference
      Löscht in einer Datei die Strukturreferenz (ab CMS-Version 017.002.212.000)
      String removeStructureReference(String path, String pathReference)
    • setStructureReference
      Setzt 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)

  • wLinkchecker

    Klasse für Linkprüfung
    • cronjob
      Linkprü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)
    • getLinksNotAvailable
      Ermittelt nicht verfügbare Links innerhalb einer Datei (verfügbar ab CMS-Version 015.005.106.000)
      String getLinksNotAvailable(string $path)
    • getStatus
      Ermittelt den aktuellen Status einer Linkchecker-Instanz (verfügbar ab CMS-Version 014.004.107.000)
      String getStatus(string $checkerid)

  • wList

    Stellt Funktionen zur Generierung von Listen zur Verfügung
    • createList
      Generiert eine Dateiliste über ein Template
      String createList(String template, Array options = array())
    • createListArray
      Generiert eine Dateiliste und gibt das Ergebnis als Array zurück
      String createListArray(Array options = array(), String $resultValue = 'path')
    • createListArrayData
      Generiert eine Liste als Assoziatives Array
      String createListArrayData(Array options = array())
    • createListDir
      Generiert eine Liste von Verzeichnissen in HTML
      String createListDir(String template, Array options = array())
    • createListFromXML
      Generiert eine Liste auf Basis einer XML-Zeichenkette
      String createListFromXML(String template, String xmlStr, Array options = array())
    • createListXML
      Generiert eine Dateiliste und gibt das Ergebnis als XML-String zurück
      String createListXML(Array options = array())
    • createXsltEditbuttons
      Erstellt das notwendige XSLT, um Pflegeschaltflächen für einen Eintrag anzuzeigen
      String createXsltEditbuttons(Array options){
    • getListData
      Ermittelt einen Wert aus den aktuellen Listendaten (XML-Datei)
      String getListData(String name)
    • setListData
      Generiert eine Liste als Assoziatives Array
      String setListData(String name, String value){

  • wMailer

    Stellt E-Mail Funktionen zur Verfügung
    • addPlaceholders
      Verarbeitet die Platzhalter einer E-Mail
      Boolean addPlaceholders(String mailStr, Array placeholders = array(), Array placeholderExt = array())
    • getDefaultMail
      Ermittelt die Standard E-Mail Adresse der aktuellen Domain
      String getDefaultMail(String name = 'info')
    • getLastError
      Gibt den letzten aufgetretenden Fehler zurück
      String getLastError()
    • getUsersWithEncryptedInbox
      Liefert alle Benutzer mit einem verschlüsselten Briefkasten (ab CMS-Version 12.x verfügbar)
      String getUsersWithEncryptedInbox()
    • sendMailAlternative
      Sendet eine E-mail als Text und HTML(multipart/alternative)
      Boolean sendMailAlternative(Array header, String text, String html, Array attachment = null)
    • sendMailHtml
      Sendet eine E-Mail im HTML-Format
      Boolean sendMailHtml(Array header, String text, Array attachment = null)
    • sendMailStr
      Sendet eine E-Mail basierend auf einem String
      Boolean sendMailStr(String mailStr, Array placeholders = array(), Array placeholders = array(), Array attachment = array(), Array options = array())
    • sendMailText
      Sendet eine E-Mail im Textformat
      Boolean sendMailText(Array header, String text, Array attachment = null, Array options = null)
    • sendOutbox
      Sendet den Postausgang (verfügbar ab CMS-Version 017.001.189.000)
      Boolean sendOutbox(Array options)

  • wMessagecenter

    Nachrichtenzentrum
    • createNote
      Erstellt eine Notiz
      Boolean createNote(String pathMessageObject, String receiver, String text, Array data = array())
    • createTodo
      Erstellt eine Aufgabe
      Boolean createTodo(String pathMessageObject, String receiver, String text, Array data = array())
    • purgeMessages
      Bereinigt die Aufgaben und Notizen (verfügbar ab CMS-Version 017.001.157.000)
      Boolean purgeMessages()
    • registerMessagesOfPath
      Registriert die Aufgaben und Notizen eines Objektes (verfügbar ab CMS-Version 015.007.006.000)
      Boolean registerMessagesOfPath(String path)

  • wNavigation

    Navigationsgenerator
    • createNavigationHTML
      Generiert eine Navigation
      String createNavigationHTML(String data, String template, String mode, String navId, Array options = array())
    • createNavigationHTMLFromXML
      Generiert eine Navigation auf Basis einer XML-Zeichenkette
      String createNavigationHTMLFromXML(String navigationStr, String template, String mode, String navId, Array options = array())
    • createNavigationXML
      Generiert eine Navigation
      String createNavigationXML(String data, String mode, String navId, Array options = array())
    • getNavId
      Ermittelt die navid der angegebenen Seite
      String getNavId(String data, String url)
    • getPathesOfSubpoints
      Ermittelt die Pfade von Unterpunkten
      String getPathesOfSubpoints(String data, String navId)
    • getUrlOfNavId
      Ermittelt die URL einer Navigations-ID
      String getUrlOfNavId(String data, String navId)
    • mergeNavigations
      Fügt mehrere Navigationen zu einer Navigation zusammen
      String mergeNavigations(String pathDest, Array pathesSource, Array options)
    • setNavId
      Setzt die Navigations-ID der aktuellen Seite (verfübar ab CMS-Version 018.007.127.000)
      String setNavId(String navId)

  • wNet

    HTTP-Anfragen
    • getUrl
      Führt eine GET-Anfrage aus und liefert die Header-Daten und den Inhalt
      String getUrl(String url, Array options)
    • getUrlAsync
      Führt eine asynchrone GET-Anfrage aus. (verfügbar ab CMS-Version 011.001.252.000)
      String getUrlAsync(String url)
    • getUrlContent
      Führt eine GET-Anfrage aus und liefert den Inhalt
      String getUrlContent(String url, Array options)
    • getUrlHeader
      Führt eine GET-Anfrage aus und liefert die Header-Daten
      String getUrlHeader(String url, Array options)

  • wNewsletter

    Stellt Newsletter Funktionen zur Verfügung
    • autosendNewsletters
      Sendet 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)
    • clearPresubscribedCSV
      Lö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)
    • confirmSubscriptionCSV
      Bestätigt die Eintragung in einen Newsletter
      Boolean confirmSubscriptionCSV(String pathCSV, String receiversId, String email, String unsubscribeId)
    • getDataEntryCSV
      Ermittelt die Daten eines Eintrages auf Basis der E-Mail
      String getDataEntryCSV(String $pathCSV, String $email)
    • getDataNewsletter
      Ermittelt Daten aus einem Newsletter
      String getDataNewsletter(String path, String data)
    • getLinkConfirmSubscription
      Generiert einen Link, über den eine Newsletter-Registrierung bestätigt werden kann
      Boolean getLinkConfirmSubscription(String urlScript, String pathCSV, String email, String unsubscribeId)
    • getMailOfUnsubscribeId
      Ermittelt die E-Mail eines Eintrags auf Basis der Austragungs-ID
      String getMailOfUnsubscribeId(String $path, String $newsletterID, String $unsubscribeID)
    • getMailOfUnsubscribeIdCSV
      Ermittelt 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)
    • getPathCSV
      Ermittelt den Pfad der Empfänger CSV-Datei
      String getPathCSV(String $dirCSV, String $receiversId)
    • getPathCSVOfNewsletterId
      Ermittelt eine CSV-Datei auf Basis einer Newsletter-ID
      Boolean getPathCSVOfNewsletterId(String $newsletterId)
    • getPathNewsletter
      Ermittelt das Newsletterverzeichnis basierend auf der zu versendenen E-Mail
      String getPathNewsletter(String path)
    • getSubscriptionsCSV
      Ermittelt alle Abos eines Newsletter Verteilers (verfügbar ab CMS-Version 016.003.061.000)
      Boolean getSubscriptionsCSV(String path)
    • importReceivers
      Importiert die Empfängerliste in einen Newsletter (verfügbar ab CMS-Version 015.006.037.000)
      String importReceivers(String path)
    • logRequest
      Protokolliert einen Seitenaufruf, der über einen Link aus dem Newsletter gemacht wurde
      String logRequest()
    • prepareNewsletter
      Bereitet 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)
    • setSubscriptionsCSV
      Setzt 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)
    • setValueOfEntry
      Setzt den Wert eines Eintrags
      Boolean setValueOfEntry(String path, String newsletterID, String email, String col, String value)
    • setValueOfEntryCSV
      Setzt den Wert eines Eintrags (verfügbar ab CMS-Version 016.001.124.000)
      Boolean setValueOfEntryCSV(String path, String email, String col, String value)
    • subscribeCSV
      Trägt einen Empfänger in eine CSV-Datei ein
      Boolean subscribeCSV(String pathCSV, Array data)
    • unsubscribe
      Löscht einen Benutzer aus der Empfängerliste
      Boolean unsubscribe(String path, String newsletterID, String email, String unsubscribeID, Array options)
    • unsubscribeCSV
      Löscht einen Benutzer aus der Empfängerliste
      Boolean unsubscribeCSV(String pathCSV, String email, String unsubscribeID, Array options)

  • wOutput

    Stellt Funktionen zur Generierung von Seiten und zur Manipulation der Ausgabe zur Verfügung.
    • deactivateJavaScript
      Deaktiviert das Laden von externen JavaScript Ressourcen (verfügbar ab CMS-Version 016.001.133.000)
      String deactivateJavaScript(String str, String class)
    • filterLinksOffline
      Filtert Links aus der Seite heraus, die nicht online sind
      String filterLinksOffline(String pageStr, Array options = array())
    • getNumberItemsDisplayed
      Ermittelt die bisher angezeigten Strukturelemente, falls diese über isViewableItem eingebunden wurden
    • getRedirect
      Ermittelt das Weiterleitungsziel für eine umbenannte bzw. verschobene Datei. Manuell eingerichtete Weiterleitungen werden vorrangig berücksichtigt.
      String getRedirect(String url)
    • isViewableItem
      Prüft, ob das aktuelle Element (wd:item) angzeigt werden darf
      Boolean isViewableItem(Node wItemNode, String viewMode = '')
    • loadWithoutCache
      Sorgt dafür, dass die angegebene URL vom Benutzer ohne Cache aufgerufen wird
      Boolean loadWithoutCache(String url)
    • maskEmails
      Maskiert E-Mail Adressen
      String maskEmails(String html, Int level)
    • parseString
      Ersetzt Platzhalter und interpretiert Bedingungen (ab CMS-Version 012.006.124.000)
      String parseString(String $path, Array $placeholders, Boolean $htmlspecialchars)
    • processPageStr
      Generiert eine Seite
      String processPageStr(String pageStr, String templateStr, Array parameters = array(), Array options = array())
    • sendFormularsOverHTTPS
      Sorgt dafür, dass Formulardaten generell über HTTPS gesendet werden
      String sendFormularsOverHTTPS(String pageStr)
    • setNumberItemsDisplayed
      Setzt den Wert für die Anzahl der bisher angezeigten Strukturelemente
      Void setNumberItemsDisplayed(String value)

  • wPageAccelerator

    Seitenbeschleuniger
    • solveListItems
      Schreibt das Listenergebnis als Dateien fix in die Liste (verfügbar ab CMS-Version 017.007.011.000)
      Void solveListItems($path)

  • wPageCur

    Aktuelle Seite
    • addRanking
      Speichert das aktuelle Ranking zur Seite ab
      void addRanking(Array options)
    • appendCss
      Fügt eine CSS-Datei zur design.css hinzu. (verfügbar ab CMS-Version 015.001.011.000)
      Void appendCss(String path)
    • doNotAddToCache
      Verhindert, dass die aktuelle Seite dem Cache hinzugefügt wird. Diese Funktion steht erst in der XSLT-Transformation zur Verfügung
      String doNotAddToCache()
    • getCorrespondentLanguageFiles
      Ermittelt die Daten als Array zu korrespondierenden Sprachversionen
      Array getCorrespondentLanguageFiles(String path = '', Array options = array())
    • getDataLanguageFile
      Ermittelt Daten zu einer bestimmten Sprachversion
      Array getDataLanguageFile()
    • getLastForm
      Liefert das zuletzt erstellte Formularobjekt
      wForm getLastForm()
    • getPath
      Ermittelt den Pfad der aktuellen Datei
      String getPath()
    • getPathCSS
      Ermittelt den Pfad der aktuellen CSS-Datei (ab CMS-Version 011.001.271.000)
      String getPathCSS()
    • getVar
      Ermittelt eine Variable der aktuellen Seite
      String getVar(String name, String value)
    • insertBeforeCss
      Fügt eine CSS-Datei zur design.css hinzu. (verfügbar ab CMS-Version 015.001.011.000)
      Void insertBeforeCss(String path, String insertBeforePath)
    • logRequest
      Protokolliert alle Zugriffe auf Seiten in einer täglichen Protokolldatei
      Boolean logRequest(Array options)
    • registerCss
      Registriert eine CSS Datei, um diese im HTML-Kopf über wsl:includeCssRessources einbinden zu können.
      Void registerCss(String path, String media)
    • registerJs
      Registriert eine JS Datei, um diese im HTML-Kopf über wsl:includeJsRessources einbinden zu können.
      Void registerJs(String path, String target, String allowMerge)
    • setVar
      Setzt eine Variable der aktuellen Seite
      Void setVar(String name, String value)
    • wasCached
      Ermittelt, ob die aktuelle Seite aus dem Cache kommt
      String wasCached()
    • willAddToCache
      Ermittelt, ob die aktuelle Seite dem Cache hinzugefügt wird. Diese Funktion steht erst in der XSLT-Transformation zur Verfügung
      String willAddToCache()

  • wPageProcessor

    Aktuelle Seiten-Transformation
    • addCurrentWidthPath
      Erweitert den eindeutigen Pfad der aktuellen Breite
      String addCurrentWidthPath($path)
    • getCurrentWidthPath
      Ermittelt den eindeutigen Pfad der aktuellen Breite
      String getCurrentWidthPath()
    • getVariantsData
      Ermittelt alle Variantendaten
      String getVariantsData()
    • isInEditor
      Überprüft, ob der aktuelle Aufruf im Editor stattfindet
      Boolean isInEditor()
    • restoreCurrentWidthPath
      Stellt den aktuellen, eindeutigen Breitenpfad (UID) der übergebenen ID wieder her
      String restoreCurrentWidthPath($id)
    • setCurrentWidthPath
      Setzt den aktuellen, eindeutigen Breitenpfad (UID)
      String setCurrentWidthPath($path)
    • storeCurrentWidthPath
      Speichert den aktuellen, eindeutigen Breitenpfad (UID) im Wert mit der übergebenen ID
      String storeCurrentWidthPath($id)

  • wPathName

    Stellt Funktionen für die Verarbeitung von Dateipfaden zur Verfügung
    • addSlashAfter
      Fügt einen Schrägstrich hinter einen Pfad, falls noch kein Schrägstrich vorhanden ist.
      String addSlashAfter(String path)
    • addSlashBefore
      Fügt einen Schrägstrich vor einen Pfad, falls noch kein Schrägstrich vorhanden ist.
    • createPathSecure
      Verhindert Pfade, über die darüberliegende Verzeichnisse angesprochen werden können
      String createPathSecure(String path)
    • getDirFile
      Ermittelt den Verzeichnispfad einer Datei
      String getDirFile(String path)
    • getDirName
      Ermittelt den Namen eines Verzeichnisses auf Basis eines Verzeichnispfades
      String getDirName(String path)
    • getDirNameFile
      Ermittelt den Verzeichnisnamen einer Datei
      String getDirNameFile(String path)
    • getDirParent
      Ermittelt den Pfad des Elternverzeichnisses eines Verzeichnisses
      String getDirParent(String path)
    • getDirTop
      Ermittelt das Hauptverzeichnis eines Pfades
      String getDirTop(String path, Integer deep = 1)
    • getFileExtension
      Ermittelt die Dateiendung einer Datei
      String getFileExtension(String path)
    • getFileName
      Ermittelt den Dateinamen einer Datei
      String getFileName(String path)
    • getFileNameOnly
      Ermittelt den Dateiname ohne Dateiendung
      String getFileNameOnly(String path)
    • getObjectId
      Ermittelt aus dem Dateipfad nur die ObjektId
      String getObjectId(String path)
    • getPathDraft
      Liefert den Pfad der Arbeitskopie
      String getPathDraft(String path)
    • interpretePath
      Interpretiert 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)
    • isDraft
      Prüft, ob es sich bei einem Pfad um eine Arbeitskopie handelt
      String isDraft(String path)
    • removeDocumentRoot
      Entfernt die DOCUMENT_ROOT aus einem Pfad.
      String removeDocumentRoot(String path)
    • removeSlashAfter
      Entfernt den Slash am Ende eines Verzeichnisses
      String removeSlashAfter(String path)
    • removeSlashBefore
      Entfernt einen Schrägstrich am Anfang eines Pfades
      String removeSlashBefore(String path)

  • wPDF

    Klasse zur Generierung von PDF-Dokumenten über XSL-FO
    • createPDFFromXSLFO
      Generiert ein PDF auf Basis einer XSL-Fo
      Void createPDFFromXSLFO(String pdfPath, Strig foStr)
    • createThumbnail
      Erstellt 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)
    • createXSLFOFromXHTML
      Generiert ein XSL-Fo Template auf Basis einer XHTML-Seite
      Void createXSLFOFromXHTML(String xslFoPath, Strig XHTMLStr)

  • wPicture

    Klasse, um responsive Bilder über das PICTURE-Element zu generieren
    • createPicture
      Erstellt ein Bild über ein PICTURE-Element
      String createPicture(String path, Array data, Array, options)

  • wProject

    Verwaltet Informationen eines Projektes
    • clearLanguage
      Löscht die Sprachknoten für eine Sprache (verfügbar ab CMS-Version 013.006.015.012)
      String clearLanguage(String project, String language)
    • clearLogs
      Löscht alte Logdateien
      String clearLogs(String project, Int limit)
    • getLanguage
      Ermittelt die Sprache das aktuellen Projektes
      String getLanguage(String project)
    • getLanguageCodeISO
      Ermittelt das ISO-Sprachkürzel der Projektsprache
      String getLanguageCodeISO(String projectLanguage, Array languagesArray)
    • getLanguageCodeISOExt
      Ermittelt das erweiterte ISO-Sprachkürzel der Projektsprache (ab CMS-Version 012.007.035.000)
      String getLanguageCodeISOExt(String projectLanguage, Array languagesArray)
    • getPathAssets
      Ermittelt den Projektpfad des Asset-Projektes. (verfügbar ab CMS-Version 011.002.118.000)
      String getPathAssets(String project)
    • getPathGlobal
      Ermittelt den globalen Projektpfad des angegebenen Projektes
      String getPathGlobal(String project)
    • getPathLayout
      Ermittelt den Projektpfad des angegebenen Layoutprojektes. Falls kein spezielles Layoutprojekt angegeben wurde, wird das globale Projekt verwendet.
      String getPathLayout(String project)
    • getValueOf
      Ermittelt einen Wert aus den Projekteinstellungen
      String getValueOf(String project, String xPath)

  • wProjectCur

    Verwaltet Informationen des aktuellen Projektes
    • getCorrespondentLanguageDirs
      Ermittelt die Daten der korrespondierenden Sprachversionen zu einem Verzeichnis.
      Array getCorrespondentLanguageDirs(String path = '', Array options = array())
    • getLanguage
      Ermittelt die Sprache das aktuellen Projektes
      String getLanguage()
    • getPath
      Ermittelt den aktuellen Projektpfad
      String getPath()
    • getPathAssets
      Ermittelt den Projektpfad des Asset-Projektes
      String getPathAssets()
    • getPathGlobal
      Ermittelt den Projektpfad des aktuellen globalen Projektes
      String getPathGlobal()
    • getPathLayout
      Ermittelt den Projektpfad des aktuellen Layoutprojektes. Falls kein spezielles Layoutprojekt angegeben wurde, wird das globale Projekt verwendet.
      String getPathLayout()

  • wReadWrite

    Ermöglicht das Schreiben und Lesen von Dateiinhalten
    • readFile
      Liest den Inhalt einer Datei
      String readFile(String filePath)
    • readFileArray
      Liest den Inhalt einer Datei zeilenweise in ein Array
      Array readFileArray(String filePath, String option = 'r')
    • readFileCSVArray
      Liest den Inhalt einer CSV-Datei zeilenweise in ein Array
      Array readFileCSVArray(String filePath, Boolean encodeUTF8)
    • writeFile
      Schreibt den Inhalt einer Datei
      Boolean writeFile(String filePath, String fileStr, String option = 'w')
    • writeFileCSVArray
      Schreibt 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())

  • wRepository

    Stellt Zugriffsmöglichkeiten auf Dateien und Verzeichnisse bereit
    • checkInDir
      Checkt ein Verzeichnis ein
      void checkInDir(String dir)
    • checkInDocument
      Checkt ein Dokument ein
      void checkInDocument(String path, Array options)
    • checkInProject
      Checkt ein Projekt ein
      void checkInProject(String dir)
    • checkOutDir
      Checkt ein Verezeichnis aus
      Boolean checkOutDir(String dir)
    • checkOutDocument
      Checkt ein Dokument aus
      Boolean checkOutDocument(String path, Array options)
    • checkPermissionDirectory
      Prüft, ob der aktuelle Benutzer ein bestimmtes Recht an einem Verzeichnis besitzt
      Boolean checkPermissionDirectory(String path, String permission)
    • checkPermissionDocument
      Prüft, ob der aktuelle Benutzer ein bestimmtes Recht an einem Dokument besitzt
      Boolean checkPermissionDocument(String path, String permission)
    • checkPermissionGroupDirectory
      Prüft, ob eine Gruppe ein bestimmtes Recht auf ein Verzeichnis hat
      Boolean checkPermissionGroupDirectory(String path, String group, String permission)
    • checkPermissionGroupDocument
      Prüft, ob eine Gruppe ein bestimmtes Recht auf ein Dokument hat
      Boolean checkPermissionGroupDocument(String path, String group, String permission)
    • checkPermissionUserDirectory
      Prüft, ob ein Benutzer ein bestimmtes Recht auf ein Verzeichnis hat
      Boolean checkPermissionUserDirectory(String path, String user, String permission)
    • checkPermissionUserDocument
      Prüft, ob ein Benutzer ein bestimmtes Recht auf ein Dokument hat
      Boolean checkPermissionUserDocument(String path, String user, String permission)
    • checkPermissionViewDocument
      Prüft, ob der aktuelle Benutzer das Recht zur Ansicht eines Dokuments hat. (Modul Personalisierte Ausgabe erforderlich)
      Boolean checkPermissionViewDocument(String path)
    • clearIndexDir
      Löscht den Verzeichnisindex
      void clearIndexDir(String dir)
    • connectDirWithLanguage
      Stellt eine Sprachverknüpfung zwischen zwei Verzeichnissen her (ab CMS-Version 009.003.190.000)
      Array connectDirWithLanguage(String sourcePath, String destPath)
    • connectFileWithLanguage
      Stellt eine Sprachverknüpfung zwischen zwei Dateien her (ab CMS-Version 009.003.190.000)
      Array connectFileWithLanguage(String sourcePath, String destPath)
    • copyDirectory
      Kopiert ein Verzeichnis
      Boolean copyDirectory(String source, String dest, Array options)
    • copyDocument
      Kopiert ein Dokument
      Boolean copyDocument(String source, String dest, Array options)
    • createAccessToken
      Erstellt 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 = 1
      String createAccessToken(String path, Array options)
    • createDir
      Erstellt ein Verzeichnis
      Boolean createDir(String dir, String template)
    • createDocumentLanguage
      Erstellt eine Sprachversion
      Boolean createDocumentLanguage(String source, String dest)
    • createDocumentVersion
      Erstellt eine Version eines Dokumentes
      String createDocumentVersion(String path)
    • createDocumentXtDefault
      Erstellt eine Standarddateierweiterung für ein Verzeichnis, falls diese noch nicht existiert (verfügbar ab CMS-Version 018.009.058.000)
      Boolean createDocumentXtDefault(String dir)
    • createDraft
      Erstellt eine Arbeitskopie
      wDocument createDraft(String path, createEditorIds = false)
    • deleteDir
      Löscht ein Verzeichnis
      Boolean deleteDir(String path)
    • deleteDocument
      Löscht ein Dokument
      Boolean deleteDocument(String path, Array options)
    • deleteDraft
      Löscht die Arbeitskopie eines Dokumentes
      Boolean deleteDraft(String path)
    • deleteThumbnailsDir
      Löscht die Vorschaubilder eines Verzeichnisses
      void deleteThumbnailsDir(String dir, Boolean keepPicturedatas)
    • deleteVersions
      Löscht die Versionen eines Dokumentes
      Integer deleteVersions(String path, Integer remainingVersions)
    • directoryExists
      Prüft, ob ein Verzeichnis existiert.
      Boolean directoryExists(String path)
    • documentExists
      Prüft, ob ein Dokument existiert.
      Boolean documentExists(String path)
    • emptyTrash
      Löscht den Papierkorb (verfügbar ab CMS-Version 013.008.014.000)
      Array emptyTrash(String project, String limit)
    • getContentDir
      Liefert 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)
    • getDocument
      Gibt ein Dokumenten-Objekt zurück
      wDocument getDocument(String path)
    • getDocumentContent
      Gibt den Inhalt eines Dokumente zurück.
      String getDocumentContent(String path)
    • getDocumentSize
      Ermittelt die Dateigröße in Bytes
      wDocument getDocumentSize(String path, Boolean format)
    • getDocumentVersions
      Ermittelt alle Versionen eines Dokumentes
      Array getDocumentVersions(String path)
    • getDocumentsDir
      Liefert eine Liste aller Dokumente eines Verzeichnisses
      Array getDocumentsDir(String dir, Array options)
    • getDocumentsDirRecursive
      Liefert eine Liste aller Dateien eines Verzeichnisses und dessen Unterverzeichnisse.
      Array getDocumentsDirRecursive(String dir, Array options)
    • getDraft
      Gibt ein Dokumenten-Objekt der Arbeitskopie zurück
      wDocument getDraft(String path)
    • getFilesWithLinksToDocument
      Ermittelt alle Seiten, in denen das Dokument verlinkt ist
      Array getFilesWithLinksToDocument(String path)
    • getSubdirsDir
      Liefert eine Listen aller Unterverzeichnisse eines Verzeichnisses
      Array getSubdirsDir(String dir)
    • getSubdirsDirRecursive
      Liefert eine Listen aller Unterverzeichnisse eines Verzeichnisses rekursiv
      Array getSubdirsDirRecursive(String dir, Array options)
    • getUsersWithPermissionToViewDocument
      Ermittelt alle Benutzer, die ein personalisiertes Dokument sehen dürfen. (Modul Personalisierte Ausgabe erforderlich)
      Array getUsersWithPermissionToViewDocument(String path)
    • grepDocumentsDir
      Liefert alle Dateien eines Verzeichnisses zurück, die dem regulären Ausdruck entsprechen
      Array grepDocumentsDir(String dir, String grepString, Array options)
    • grepDocumentsDirRecursive
      Ermittelt alle Dokumente eines Verzeichnisses und dessen Unterverzeichnisse, deren Namen auf einen Regulären Ausdruck passen
      Array grepDocumentsDirRecursive(String dir, String grepString, Array options)
    • hasDraft
      Prüft, ob eine Arbeitskopie besteht
      wDocument hasDraft(String path)
    • importCsvToObjects
      Objekte aus einer CSV-Datei erstellen (verfügbar ab CMS-Version 017.005.093.000)
      Array importCsvToObjects(String dirDest, String pathCSV, String objectTemplate)
    • isCheckedInDir
      Prüft, ob ein Verzeichnis eingecheckt ist (verfügbar ab CMS-Version 015.001.064.000)
      Boolean isCheckedInDir(String path)
    • isCheckedInDocument
      Prüft, ob ein Dokument eingecheckt ist (verfügbar ab CMS-Version 015.001.066.000)
      Boolean isCheckedInDocument(String path)
    • isOnlineDocument
      Prüft, ob ein Dokument online ist.
      Boolean isOnlineDocument(String path)
    • isPersonalizedDocument
      Prüft, ob ein Dokument personalisiert ist
      Boolean isPersonalizedDocument(String path)
    • isTimeDependendPublished
      Prüft, ob ein Dokument zeitgesteuert veröffentlicht ist
      Boolean isTimeDependendPublished(String path, Boolean default)
    • mayAccessDocument
      Prüft, ob ein Dokument vom aktuellen Benutzer abrufbar ist.
      Boolean mayAccessDocument(String path)
    • moveDirectory
      Verschiebt ein Verzeichnis
      Boolean moveDirectory(String source, String dest, Array options)
    • moveDocument
      Verschiebt ein Dokument
      Boolean moveDocument(String source, String dest, Array options)
    • protectDir
      Sperrt ein Verzeichnis über .htaccess
      Boolean protectDir(String path)
    • rebuildLinks
      Baut das Linkverzeichnis neu auf
      void rebuildLinks(String project)
    • registerLinksFromDocument
      Registriert die verlinkten Dateien im Projekt
      Boolean registerLinksFromDocument(String path)
    • renameDirectory
      Benennt ein Verzeichnis um
      Boolean renameDirectory(String path, String nameNew, Array options)
    • renameDocument
      Benennt ein Dokument um
      Boolean renameDocument(String path, String nameNew, Array options)
    • renameProjectGlobal
      Benennt ein globales Verzeichnis um (verfügbar ab CMS-Version 017.006.051.000)
      Boolean renameProjectGlobal(String path, String nameNew, Array options)
    • selectDocuments
      Liefert eine Listen von Dokumenten, die der Abfragebedingung entsprechen
      Array selectDocuments(Array query)
    • setPermissionsDirectory
      Setzt die Berechtigungen für ein Verzeichnis, falls dieses eingecheckt ist (verfügbar ab Version 007.005.189.000)
      Boolean setPermissionsDirectory(String path, Array permissions)
    • setPermissionsDocument
      Setzt 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)
    • setPermissionsInheritDocument
      Setzt die Berechtigungen für ein Dokument auf erben, falls dieses eingecheckt ist (verfügbar ab Version 010.002.202.000)
      Boolean setPermissionsInheritDocument(String path)
    • setPermissionsInheritViewDocument
      Setzt die Berechtigungen zur Ansicht eines Dokumentes auf erben, falls dieses eingecheckt ist (verfügbar ab Version 010.002.202.000)
      Boolean setPermissionsInheritViewDocument(String path)
    • setPermissionsViewDocument
      Setzt die Berechtigungen zur Ansicht eines Dokumentes, falls dieses eingecheckt ist (verfügbar ab Version 010.002.202.000)
      Boolean setPermissionsViewDocument(String path, Array permissions)
    • setPublicDocument
      Macht ein Dokument öffentlich zugänglich (bei Bedarf wird das Dokument eingecheckt) (verfügbar ab CMS-Version 018.004.036.000)
      Boolean setPublicDocument(String path)

  • wRequest

    Anfrage-Objekt
    • checkActionToken
      Prüft einen Action-Token (verfügbar ab CMS-Version 017.001.070.000)
      Void checkActionToken(String actionToken = '')
    • checkFormToken
      Prüft einen Form-Token (verfügbar ab CMS-Version 018.004.161.000)
      Void checkFormToken(String formToken = '')
    • createActionToken
      Erstellt einen Action-Token um eine Aktion einmalig auszuführen (verfügbar ab CMS-Version 017.001.070.000)
      Void createActionToken()
    • getClientIP
      Ermittelt die IP-Adresse des Clients
      Void getClientIP()
    • getCookie
      Ermittelt die Cookies
      String getCookie()
    • getDomain
      Ermittelt die aktuelle Domain
      String getDomain()
    • getMethod
      Ermittelt die Methode der aktuellen Anfrage
      String getMethod()
    • getParameter
      Ermittelt den Wert eines Request-Parameters
      Mixed getParameter(String name, String filter = '')
    • getParameterInt
      Ermittelt den Wert eines Request-Parameters als Integer
      String getParameterInt(String name)
    • getParameterPathSecure
      Ermittelt den Wert eines Request-Parameters als sicheren Pfad
      String getParameterPathSecure(String name)
    • getParameterSecure
      Ermittelt den Wert eines Parameters und verhindert das Einschleußen von Code, ohne ' und " zu ersetzen
      String getParameterSecure(String name)
    • getParameterSecureStrict
      Ermittelt den Wert eines Parameters und verhindert das Einschleussen von Code. Der Einsatz dieser Funktion wird an XSS kritischen Stellen empfohlen
      String getParameterSecureStrict(String name)
    • getParameterText
      Ermittelt den Wert eines Request-Parameters als Text (führt bei Bedarf eine Umwandlung in UTF-8 durch)
      String getParameterText(String name)
    • getPath
      Ermittelt den Pfad der aktuellen Anfrage
      String getPath()
    • getSearchengineTerm
      Gibt den Suchbegriff zurück, über den man auf diese Seite gelangt ist (Google oder Bing)
      String getSearchengineTerm()
    • getUrl
      Ermittelt die URL der aktuellen Anfrage
      String getUrl()
    • getUrlRel
      Gibt die vollständige aktuelle URL ohne Domain zurück
      String getUrlRel()
    • includePage
      Zeigt eine beliebige Seite innerhalb der aktuellen Domain an (verfügbar ab CMS-Version 008.004.103.000)
      Void includePage(String $path, String $queryString = '')
    • isAI
      Prüft, ob die aktuelle Seite von der KI aufgerufen wird (ab CMS-Version 018.009.102.000 verfügbar)
      Boolean isAI(Boolean checkIfIsServer = false)
    • isCron
      Prüft, ob die aktuelle Seite über ein Cron-Skript aufgerufen wurde
      Boolean isCron()
    • isDiffView
      Prüft, ob die aktuelle Seite von der Versionsansicht aufgerufen wird
      Boolean isDiffView(Boolean checkIfIsServer = false)
    • isEmbedViewExplorer
      Prüft, ob es sich um die eingebettete Ansicht im Dateiexplorer handelt. (verfügbar am CMS-Version 011.002.284.000)
      Boolean isEmbedViewExplorer()
    • isHTTPS
      Prüft, ob der aktuelle Aufruf über HTTPS erfolgt ist (verfügbar ab CMS-Version 018.007.199.000)
      String isHTTPS()
    • isLinkChecker
      Prüft, ob die aktuelle Seite von der Linkprüfung aufgerufen wird
      Boolean isLinkChecker(Boolean checkIfIsServer = false)
    • isPrefetched
      Prüft, ob es sich um einen Vorabruf handelt (verfügbar ab CMS-Version 016.003.084.000)
      Boolean isPrefetched()
    • isPreview
      Prüft, ob es sich um die Vorschauansicht handelt. (verfügbar am CMS-Version 011.002.284.000)
      Boolean isPreview()
    • isProbablyBot
      Prüft, ob die Anfrage von einer Suchmaschine stammt. Bitte beachten Sie, dass jeder Browser sich auch als Suchmaschine ausgeben kann.
      Boolean isProbablyBot()
    • isSearchBot
      Prüft, ob die aktuelle Seite von der Volltextsuche aufgerufen wird
      Boolean isSearchBot(Boolean checkIfIsServer = false)
    • removeParameter
      Entfernt einen Parameter aus der Anfrage (verfügbar ab CMS-Version11.x)
      Void removeParameter(String key, Boolean caseInSensitive)
    • setParameter
      Setzt einen Request-Parameter abhängig von der REQUEST-Methode
      Void setParameter(String name, String value, type = '')

  • wResponse

    Stellt Funktionen zu HTTP-Antworten zur Verfügung
    • redirect
      Führt eine Weiterleitung durch (prüft auf schon gesendete Header)
      Void redirect(String url, Boolean movedPermanently)

  • wSearch

    Die Framework-Klasse wSearch bietet die Schnittstelle zu einer Suche.
    • addAdditionalSearch
      Fü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)
    • addUrlToIndex
      Fügt eine Datei dem Suchindex hinzu.
      String addUrlToIndex(String $url, Boolean $async)
    • createIndex
      Erstellung des Suchindexes mithilfe eines Scriptes (ab Version: 005.034.001.021)
      String createIndex(Array $parameters)
    • cronjob
      Erstellung des Suchindexes Mithilfe eines Cronjobs
      String cronjob(Array $parameters)
    • getDataIndex
      Ermittelt die Daten des aktiven Index (verfügbar ab CMS Version 009.005.053.000)
      String getDataIndex()
    • getDataRobot
      Ermittelt die Daten des im Aufbau befindlichen Index (verfügbar ab CMS Version 009.005.053.000)
      String getDataRobot()
    • getDescription
      Ermittelt die Beschreibung aus einer Datei im Suchindex.
      String getDescription(Array $parameters)
    • getFirstHeadline
      Ermittelt die erste Überschrift aus einer Datei im Suchindex. (egal welche Überschriftenhierarchie die Überschrift hat)
      String getFirstHeadline(Array $parameters)
    • getSearchTermsForTagcloud
      Die 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)
    • getStatusRobot
      Ermittelt den aktuellen Status des Robots
      String getStatusRobot()
    • getTextDescription
      Ermittelt die Beschreibung einer Seite im Suchindex und markiert die Treffer darin.
      String getTextDescription(Array $parameters)
    • getTextMulti
      Ermittelt einen Teil des Inhalts aus einer Seite im Index. Der Treffer im Inhalt der Seite wird als Ergebnis markiert.
      String getTextMulti(Array $parameters)
    • getTitle
      Ermittelt den Titel aus einer Datei im Suchindex.
      String getTitle(Array $parameters)
    • removeUrlFromIndex
      Entfernt eine Datei aus dem Suchindex.
      String removeUrlFromIndex(String $url)
    • search
      Führt eine Suchanfrage aus und transformiert das Ergebnis mit einem Template.
      String search(Array $parameters)
    • searchArray
      Führt eine Suchanfrage aus und gibt ein Array mit Urls zurück
      Array searchArray(Array $parameters)
    • searchArrayData
      Fü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)
    • searchArrayDataComplete
      Führt eine Suchanfrage durch und gibt eine Array zurück, das alle von der Suche ermittelten Informationen enthält
      Array searchArrayDataComplete(Array $parameters)
    • exportStatistic
      Exportiert die Statistik (verfügbar ab CMS-Version 018.004.137.000)
      String exportStatistic(String $limit, String $type, String $format)

  • wServer

    Server
    • getDiskUsage
      Ermittelt den genutzten Speicherplatz eines Verzeichnisses in Kilobyte (NUR unter Linux, MacOS, etc. bei entsprechender Berechtigung nutzbar!) (ab Version 13)
      String getDiskUsage(String dir)

  • wSession

    Session
    • clearSession
      Löscht eine Session (verfügbar ab CMS-Version 009.006.032.000)
      String clearSession()
    • getHistoryUrl
      Ermittelt eine zuvor aufgerufene URL
      String getHistoryUrl(Int index)
    • getSessionId
      Ermittelt die aktuelle Session-ID
      String getSessionId()
    • getUserName
      Ermittelt den Benutzernamen des aktuellen Benutzers
      String getUserName()
    • getUserType
      Ermittelt den Benutzertyp des aktuellen Benutzers
      String getUserType()
    • getValue
      Liest einen Wert aus der Session aus
      String 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 Session
      Void setLanguage($language)
    • setTimeout
      Setzt 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)
    • setValue
      Setzt einen Wert in der aktuellen Session
      Void setValue(String name, String value)

  • wSocket

    HTTP-Anfrage
    • getUrl
      Führt eine GET-Anfrage durch und liefert das Ergebnis als String zurück.
      String getUrl(String url)

  • wStaticHTML

    Klasse macht HTML statisch
    • createPageStatic
      Erstellt eine statische Seite
      String createPageStatic(String content, String path, String dirStatic)

  • wStringconverter

    Zeichenkettenmanipulation
    • addPrologXml
      Fügt den XML-Prolog zu XML-Zeichenkette hinzu
      String addPrologXml(String str)
    • applyFilter
      Filtert einen Wert, um keine unsicheren Zeichen zu erhalten.
      String applyFilter(String value, String filter)
    • checkUTF8
      Prüft, ob eine Zeichenkette UTF-8 konform ist
      String checkUTF8(String str)
    • convertAnchorToID
      Erstellt 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)
    • convertFromBytes
      Konvertiert einen String mit Byte-Angabe in den enstprechenden Wert
      String convertFromBytes(String str, Array options = array())
    • convertFromXml
      Demaskiert die Sonderzeichen &, ", ', <, >
      String convertFromXml(String str)
    • convertToAnchorID
      Erstellt eine gültige ID
      String convertToAnchorID(String str)
    • convertToDirName
      Konvertiert eine Zeichenkette in einen gültigen und sinnvollen Verzeichnisnamen, der frei von Sonderzeichen ist
      String convertToDirName(String str)
    • convertToFileName
      Konvertiert eine Zeichenkette in einen gültigen und sinnvollen Dateinamen, der frei von Sonderzeichen ist
      String convertToFileName(String str)
    • convertToReg
      Maskiert Zeichen für einen Regulären Ausdruck
      String convertToReg(String str)
    • convertToXml
      Konvertiert einen String in XML-konformen-String, d.h die Sonderzeichen &, ", ', <, > werden in HMTL-Zeichen umgewandelt
      String convertToXml(String str)
    • filterEmptyTags
      Filtert Tags ohne Inhalt
      String filterEmptyTags(String str, String tagName = 'p')
    • getFirstChar
      Ermittelt den ersten Buchstaben (verfügbar ab CMS-Version 011.001.366.000)
      String getFirstChar(String str, Boolean convertUmlaut, String convertCase)
    • maskApos
      Maskiert einfache Anführungszeichen
      String maskApos(String str, Boolean full)
    • maskAposJS
      Maskiert einfache Anführungszeichen, um diese in JS zu verwenden
      String maskAposJS(String str)
    • maskQuotes
      Maskiert doppelte Anführungszeichen
      String maskQuotes(String str)
    • maskTextBot
      Maskiert 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)
    • minimizeJS
      Minimiert JavaScript (verfügbar ab CMS-Version 15)
      String minimizeJS(String jsStr)
    • prepareXmlToEmbed
      Bereitet eine XML Datei (z.B. SVG) zum Einbetten in HTML vor (verfügbar ab CMS-Version 011.002.197.000)
      String prepareXmlToEmbed(String str)
    • removeDoctype
      Entfernt den Doctype z.B. am Anfang eines HTML-Strings.
      String removeDoctype(String str)
    • removeDocumentElement
      Entfernt das Wurzelelement aus einer XML-Zeichenkette
      String removeDocumentElement(String str)
    • removeLinebreaks
      Löscht alle Zeilenumbrüche aus einer Zeichenkette raus
      String removeLinebreaks(String str)
    • removePrologXml
      Entfernt aus einer XML-Zeichenkette den XML-Prolog
      String removePrologXml(String str)
    • replaceWhiteSpaces
      Löscht alle Leerzeichen aus einer Zeichenkette raus
      String replaceWhiteSpaces(String str)
    • toUTF8
      Konvertiert eine Zeichenkette in UTF-8
      String toUTF8(String str)
    • wrapCDATA
      Umschließt eine Zeichenkette mit CDATA (verfügbar ab CMS-Version 015.001.034.000)
      String wrapCDATA(String str)

  • wSubscriptions

    Abos
    • autoInformSubscribers
      Informiert die Abonnenten eines Verzeichnisses über einen Cronjob (verfügbar ab CMS-Version 017.001.112.000)
      String autoInformSubscribers(String path, String pathSubscriptionmanagement)
    • informSubscribers
      Informiert die Abonnenten eines Verzeichnisses (verfügbar ab CMS-Version 016.001.164.000)
      String informSubscribers(String path)
    • subscribe
      Abonniert ein Verzeichnis (verfügbar ab CMS-Version 016.001.090.000)
      String subscribe(String path, String mail)
    • unsubscribe
      Beendet ein Verzeichnisabo (verfügbar ab CMS-Version 016.005.012.000)
      String unsubscribe(String path, String unsubscribeId)
    • unsubscribeByMail
      Beendet ein Verzeichnisabo (verfügbar ab CMS-Version 016.005.012.000)
      String unsubscribeByMail(String path, String mail)

  • wTagcloud

    Tag-Wolke / Tag-Cloud
    • createTagCloudHTML
      Erstellt eine Tag-Wolke als XML
      String createTagCloudHTML(String tagsStr, Array options)

  • wTexts

    Zugriff auf globale Texte
    • getText
      Liefert einen Text aus der Textdatei eines Projektes
      String getText(String key, String project = '', String path = ''))
    • getTextGlobal
      Liefert einen Text aus der globalen Textdatei des aktuellen Projektes (unterstützt keine Sprachen) Funktion: DEPRECATED
      String getTextGlobal(String key, String project = ''))
    • getTextUser
      Liefert einen Text in der Benutzersprache
      String getTextUser(String key, String project = ''))
    • getTexts
      Liefert alle Texte aus der angegebenen Textdatei
      String getTexts(String path = ''))
    • setText
      Setzt einen Text
      String setText(String key, String value = '', String project = '', String path = '')
    • showTextUser
      Gibt einen Text sprachabhängig aus (eingestellte Sprache des Benutzers in der Benutzerverwaltung)
      String showTextUser(String en = '', String de = '', String fr = ''))

  • wThumbnail

    Erstellt verkleinerte Vorschaubilder
    • createThumbnail
      Erstellt ein Vorschaubild auf Basis eines vorhandenen Bildes
      String createThumbnail(String path, Integer width, Integer height, String mode, Array options)
    • getPathOrig
      Ermittelt den Originalpfad eines Vorschaubildes
      String getPathOrig(String pathThumbnail)
    • getPathThumbnail
      Ermittelt den Pfad eines Vorschaubildes
      String getPathThumbnail(String path, Integer width, Integer height, String mode)

  • wTwitter

    Schnittstelle zu Twitter
    • createAuthToken
      Erstellt einen Authentifizierungsschlüssel
      Boolean createAuthToken(String parameters, String consumerKey, String consumerSecret)
    • deleteAuthToken
      Löscht einen Authentifizierungsschlüssel
      Boolean deleteAuthToken(String consumerKey, String consumerSecret)
    • getAuthToken
      Liest einen Authentifizierungsschlüssel
      Boolean getAuthToken(String consumerKey, String consumerSecret)
    • hasAuthToken
      Prüft, ob ein Authentifizierungsschlüssel existiert
      Boolean hasAuthToken(String consumerKey, String consumerSecret)
    • postMessage
      Veröffentlicht eine Meldung bei Twitter
      Boolean postMessage(String message, String consumerKey, String consumerSecret)
    • requestAuthToken
      Fragt einen Authentifizierungsschlüssel an, der vom Benutzer bestätigt werden muss
      Void requestAuthToken(String consumerKey, String consumerSecret)
    • setAuthToken
      Schreibt einen Authentifizierungsschlüssel
      Boolean setAuthToken(Object token, String consumerKey, String consumerSecret)

  • wURL

    URL Klasse
    • convertToAbs
      Wandelt einen relativen in einen absoluten Link um
      String convertToAbs(String url, String base)
    • createMailNoSpamJsFunction
      Schü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)
    • createMailNoSpamText
      Schü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)
    • decodeUrlAlias
      Ermittelt die Original-URL einer Alias-URL
      String decodeUrlAlias(String $urlAlias, String $project)
    • encodeUrlAlias
      Ermittelt den Alias einer URL
      String encodeUrlAlias(String url)
    • getAlias
      Ermittelt den Alias einer URL (für die Teilen-Funktion aus der Weblication® Cloud (/cloud/index.php?a=))
    • getParameter
      Ermittelt einen Parameter einer URL
      String getParameter(String url)
    • removeParameter
      Löscht den Parameter einer URL (verfügbar ab CMS-Version 017.002.046.000)
      String removeParameter(String url, String name, String value)
    • removeParameters
      Entfernt die Parameter einer URL
      String removeParameters(String url)
    • setParameter
      Setzt den Parameter einer URL
      String setParameter(String url, String name, String value)

  • wUserContent

    Von Benutzern generierter Inhalt, wie z.B. Kommentare und Bewertungen
    • addComment
      Fügt einen Kommentar einer Seite hinzu
      String addComment(String path, Array data)
    • addRating
      Fügt eine Bewertung einer Seite hinzu
      String addRating(String path, Integer data, String subId, Array additionalData)
    • deleteRating
      Löscht eine Bewertung einer Seite (verfügbar ab CMS-Version 017.006.230.000)
      String deleteRating(String path, String userKey)
    • getAverageRating
      Ermittelt die durchschnittliche Bewertung einer Seite
      Float getAverageRating(String path, String subId)
    • getDataOfComment
      Ermittelt die Daten eines Kommentars (verfügbar ab CMS-Version 017.007.009.000)
      String getDataOfComment(String path, String id)
    • getDateLastComment
      Ermittelt das Datum des neuesten Kommentars
      String getDateLastComment(String path)
    • getNameLastComment
      Ermittelt den Benutzernamen des neuesten Kommentators
      String getNameLastComment(String path)
    • getNumberComments
      Ermittelt die Anzahl der Kommentare zu einer Seite
      Integer getNumberComments(String path)
    • getNumberRatings
      Ermittelt die Anzahl der Bewertungen zu einer Seite
      Integer getNumberRatings(String path)
    • getPathComments
      Ermittelt die Datei, welche die Kommentare einer Seite enthält
      String getPathComments(String path)
    • getPathRatings
      Ermittelt die Datei, welche die Bewertungen einer Seite enthält
      String getPathRatings(String path)
    • getUserNameLastComment
      Ermittelt den Benutzernamen des neuesten Kommentators
      String getUserNameLastComment(String path)
    • hasAlreadyRated
      Prüft, ob der Benutzer bereits abgestimmt hat
      Boolean hasAlreadyRated(String path, String subId)
    • updateComment
      Ändert einen Kommentar einer Seite
      String updateComment(String path, Array data)

  • wUserCur

    Daten zum aktuellen Benutzer
    • createSessionStr
      Erstellt 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)
    • createSessionUser
      Erstellt eine Benutzer-Session auf der Basis eines existierenden Benutzers.
      Boolean createSessionUser(String userName, String password)
    • executeJS
      Führt für den Benutzer JavaScript aus (Einsatz in Verzeichnisereignissen)
      Boolean executeJS(String jsString)
    • getAlertsJs
      Zeigt dem aktuellen Benutzer die noch nicht angezeigten Meldungen
    • getData
      Ermittelt Daten des aktuellen Benutzers
      String getData(String data)
    • getGroupStandard
      Ermittelt die Standardgruppe des aktuellen Benutzers
      string getGroupStandard()
    • getGroups
      Ermittelt die Gruppen des aktuellen Benutzers
      Array getGroups(Integer inherit = '1')
    • getLanguage
      Ermittelt die Sprache des aktuellen Benutzers
      String getLanguage()
    • getMeta
      Ermittelt Metadaten des aktuellen Benutzers (verfügbar ab CMS-Version 008.004.026.000)
      String getMeta(String user = null, String name)
    • getName
      Ermittelt den Benutzernamen des aktuellen Benutzers
      String getName()
    • getPermission
      Ermittelt eine Berechtigung eines Benutzers (verfügbar ab CMS-Version 012.005.096.000)
      String getPermission(String permission)
    • getStartPath
      Ermittelt den Weiterleitungspfad nach dem Login
      String getStartPath()
    • getType
      Ermittelt den Benutzertyp des aktuellen Benutzers
      String getType()
    • hasPasswordExpired
      Prüft, ob das Benutzerpasswort abgelaufen ist
      Boolean hasPasswordExpired()
    • isExistingUser
      Prü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()
    • isInGroup
      Prü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)
    • isInUserList
      Prüft, ob der aktuelle Benutzer in einer über | getrennten Benutzerauflistung enthalten ist
      Boolean isInUserList(String userList)
    • isLoggedIn
      Prüft, ob der aktuelle Benutzer eingeloggt ist.
      Boolean isLoggedIn()
    • logout
      Loggt den aktuellen Benutzer aus
      Boolean 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)
    • sendAlert
      Schickt dem aktuellen Benutzer eine Meldung zur Anzeige
      Boolean sendAlert(String message)
    • sendRedirect
      Leitet den Benutzer auf eine URL weiter (verfügbar ab CMS-Version 018.007.179.000)
      Boolean sendRedirect(String url)
    • setMeta
      Setzt 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)

  • wUserData

    Benutzerdaten
    • checkPassword
      Prüft das Passwort eines Benutzers
      String checkPassword(String user, String password)
    • clearIndex
      Löscht den Index der Benutzerdaten
      void clearIndex()
    • encryptPassword
      Verschlüsselt ein Passwort (SaltLevel werden berücksichtigt) (verfügbar ab CMS Version 010.002.201.000)
      String encryptPassword(String password, String saltLevel)
    • getData
      Ermittelt Daten eines Benutzers.
      String getData(String user = null, String data = null)
    • getGroups
      Ermittelt die Gruppen eines Benutzers
      Array getGroups(String user = null))
    • getMeta
      Ermittelt Metadaten eines Benutzers
      String getMeta(String user = null, String name = "")
    • getMetaExt
      Ermittelt externe Metadaten eines Benutzers
      String getMetaExt(String user = null, String name = "")
    • getXMLStr
      Ermittelt Daten eines Benutzers als XML-String.
      String getXMLStr(String user = null)
    • setData
      Setzt Daten eines Benutzers
      String setData(String user = null, String data = null, String value)
    • setGroups
      Setzt die Gruppen eines Benutzers
      Array setGroups(String user = null, Array groups)
    • setMeta
      Setzt Metadaten eines Benutzers
      String setMeta(String user, String name, String value)
    • setMetaExt ***deprecated***
      Setzt externe Metadaten eines Benutzers ***deprecated***
    • setPassword
      Setzt das Passwort eines Benutzers
      String setPassword(String user, String password)

  • wUsers

    Benutzer
    • checkPasswordPolicy
      Prüft, ob das Passwort den globalen Passwortrichtlinien entspricht
      Boolean checkPasswordPolicy(String password [, String rules])
    • clearIndexGroups
      Löscht den Gruppenindex
      Void clearIndexGroups()
    • clearIndexUsers
      Löscht den Benutzerindex
      Void clearIndexUsers()
    • deleteUser
      Löscht einen Benutzer (verfügbar ab CMS-Version 016.005.010.000)
      Boolean deleteUser(String user)
    • filterUsername
      Filtert aus einem Benutzernamen alle nicht gültigen Zeichen heraus
      String filterUsername($userName)
    • getUserStr
      Liefert die Benutzerdaten als XML-Zeichenkette
      String getUserStr(String user)
    • getUsers
      Liefert alle Benutzernamen
      Arrays getUsers(String group = '')
    • isInGroup
      Prüft, ob ein Benutzer Mitglied einer bestimmten Gruppe ist
      Boolean isInGroup(String user, String group)
    • isLockedIpUntil
      Prüft, ob bzw. bis wann ein Benutzer gesperrt ist (verfügbar ab CMS-Version 008.004.035.000)
      Boolean isLockedIpUntil(String ip, String user)
    • selectUsers
      Führt eine bedingte Abfrage auf Benutzer aus
      Arrays selectUsers(Array query = '')
    • setUserOffline
      Setzt einen Benutzer offline
      Boolean setUserOffline(String user)
    • setUserOnline
      Setzt einen Benutzer online
      Boolean setUserOnline(String user)
    • setUserStr
      Setzt die Benutzerdaten als XML-Zeichenkette
      String setUserStr(String user, String xmlStr)
    • userExists
      Prüft, ob ein Benutzer existiert
      Boolean userExists(String user)
    • validateUsername
      Prüft, ob ein Benutzername erlaubt ist
      Boolean validateUsername(String user)

  • wUtils

    Utils Klasse, mit allgemeinen nützlichen Funktionen
    • getFirstValueNotEmpty
      Liefert den ersten nicht leeren Wert zurück
      String getFirstValueNotEmpty(Array $values)

  • wValues

    Zugriff auf Werte
    • getValue
      Ermittelt einen Wert
      String getValue(String key, String project = '', String path = '')
    • getValueAsArray
      Ermittelt Werte als Array
      String getValueAsArray(String key, String project = '', String path = ''))
    • getValues
      Ermittelt alle Werte
      String getValues($project = '', $path = ''))

  • wVariables

    Zugriff auf globale Variablen
    • getPathLocal
      Ermittelt den Pfad der lokalen Variablendatei
      String getPathLocal(String path = '', String filename = 'default.wVariables.php'))
    • getValue
      Liefert den Wert einer Variablen aus der globalen Variablendatei des aktuellen Projektes
      String getValue(String key, String project = '', String path = '', String default = ''))
    • getValues
      Ermittelt alle Variablen als Array
      String getValues(String path = ''))
    • setValue
      Setzt eine Variable in der Variablendatei
      String setValue(String key, String value = '', String project = '', String path = '', String description = '')

  • wWeblic

    Klasse für Weblic® Funktionen
    • renderItemData
      Zeigt ein Strukturelement an, welches rein über Parameter definiert wird
      String renderItemData(String item, Array data, Array options)
    • renderItemStr
      Zeigt ein Strukturelement an, welches rein über Parameter definiert wird
      String renderItemStr(String itemStr)
    • renderItemUID
      Zeigt 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)

  • wWebstat

    Webstatistic
    • getDataLayerAsJson
      Ermittelt die aktuell gesetzten Datenschichtwerte, um sie für den Google Tag Manager auszugeben
      String getDataLayerAsJson()
    • setDataLayer
      Setzt Datenschichtwerte, die für Google Tag Manager ausgegeben werden
      String setDataLayer(Array $data)

  • wWorkflow

    Workflow-Funktionen
    • canApproveCurrentLevel
      Prüft, ob der aktuelle Benutzer die aktuelle Stufe freigeben kann
      Boolean canApproveCurrentLevel(String path)
    • getUsersOfLevel
      Ermittelt die Freigabebenutzer des angegebenen Levels (ab CMS-Version 012.005.065.000 verfügbar)
      Boolean getUsersOfLevel(String path, String level)
    • getWorkflowPath
      Ermittelt den Pfad des zugewiesenen Workflows (ab CMS-Version 013.007.039.000 verfügbar)
      String getWorkflowPath(String path)
    • hasWorkflow
      Prüft, ob ein Dokument einen Workflow zugewiesen hat. (ab CMS-Version 012.005.010.000 verfügbar)
      Boolean hasWorkflow(String path)
    • initWorkflow
      Initialisiert den Workflow einer Datei, falls davon eine Arbeitskopie existiert
      Boolean initWorkflow(String path)
    • isInWorkflow
      Prüft, ob sich ein Dokument im Workflow befindet
      Boolean isInWorkflow(String path)
    • startWorkflow
      Startet den Workflow einer Datei, falls davon eine Arbeitskopie existiert
      Boolean startWorkflow(String path)
    • userIsInCurrentLevel
      Prüft, ob der aktuelle Benutzer in der aktiven Freigabestufe steht
      Boolean userIsInCurrentLevel(String path)

  • wWSL

    WSL-Klasse über die wsl-Elemente simuliert werden können.
    • parseTag
      Führt für die wsl-Klasse die Methode parseTag aus
      Mixed parseTag(String wslElement, Array attributes)

  • wXSLT

    XSLT-Prozessor
    • getTextContent
      Ermittelt den enthaltenen Text eines XML-Elementes (verfügbar ab CMS-Version 015.005.023.000)
      String getTextContent(Object node)
    • processString
      Führt eine XSLT-Transformation durch
      String processString(String xmlString, String xsltString, Array parameters = array())

  • wZIP

    Entpacken von ZIP-Archiven
    • unzip
      Entpackt ein ZIP-Archiv
      String unzip(String path, String destDir)
    • unzipOnlyFiles
      Entpackt ein ZIP-Archiv ohne Unterverzeichnisse anzulegen
      String unzipOnlyFiles(String path, String destDir)
    • zip
      Packt ein Verzeichnis als ZIP-Archiv
      String zip(String dirToZip, String pathArchive, String root)