Globale Funktionen

Aus MAXcms

Inhaltsverzeichnis 1 CMS-Funktionen 1.1 tableName() 1.2 setSiteConfig() 1.3 getSiteConfig() 1.4 getSiteConfigLong() 1.5 getPageUrl() 1.6 getPageMenuTitle() 1.7 cmsThisPage() 1.8 addMAXcmsVar() 1.9 getMAXcmsVar() 1.10 getLanguageName() 1.11 getHostByAddrCMS() 1.12 setS() 1.13 getS() 1.14 getAllPagesUnder() 1.15 getFilePathArray(int) : array 1.16 getPageData(int[, string]) : array 1.17 replaceLinks($html, $short=false) 2 Datenbank 2.1 Datenbankobjekt $DC 2.2 Auslesen einer Datenbankzeile 2.3 Auslesen von allen Zeilen 2.4 Auslesen von Zahl der Datensätze 2.5 Senden eines SQL-Query 3 Dateisystem 3.1 cmsMail() 3.2 copyfiles() 4 Textbearbeitung 4.1 str_bis 4.2 str_nach 4.3 str_zwischen 4.4 str_beginn 5 Datumsfunktionen 5.1 cmsString2Date 5.2 cmsDate2String 6 Sonstiges 6.1 checkForArray()

[bearbeiten] CMS-Funktionen

[bearbeiten] tableName()

tableName($tablename) Hängt an $tablename den String "_work" an, wenn der User sich gerade eingeloggt im CMS bewegt. Datenbankzugriffe in Modulen können so auf die Tabellen mit den entsprechenden Arbeitsversionen der Daten zugreifen, ohne das der Einlogg-Zustand jedesmal abgefragt werden muß.

Beispiel:

$data = $DC->getByQuery("SELECT * FROM ".tableName("datentabelle")." WHERE 1");

greift je nach ob der User gerade im CMS eingeloggt ist oder nicht auf die Tabelle "datentabelle" oder "datentabelle_work" zu.

[bearbeiten] setSiteConfig()

setSiteConfig($name, $value, $longvalue=""); legt einen zentralen Konfigrationswert unter dem Schlüssel $name ab. Dabei können ein kurzer Text bis 255 Zeichen in $value oder ein beliebiger Wert (auch Array-Struktur) in $longvalue übergeben werden.

[bearbeiten] getSiteConfig()

$value = getSiteConfig($name) Liefert den zentralen Wert der unter dem Namen $name gespeichert wurde zurück. Dabei wird der Wert zurückgeliefert der bei setSiteConfig unter $value übergeben wurde.

[bearbeiten] getSiteConfigLong()

$value = getSiteConfig($name) Liefert den zentralen Wert der unter dem Namen $name gespeichert wurde zurück. Dabei wird der Wert zurückgeliefert der bei setSiteConfig unter $longvalue übergeben wurde. Dies kann auch eine Array-Struktur sein.

[bearbeiten] getPageUrl()

$url = getPageUrl($pd_pk ,$lang="",$short=false, $realName=false, $withFileDir=true);

[bearbeiten] getPageMenuTitle()

[bearbeiten] cmsThisPage()

$url = cmsThisPage($pd_pk=""); Liefert den kompletten Pfad zur Datei mit $pd_pk zurück. Beispiel: echo cmsThisPage(5); ergibt z.B. http://www.maxcms.de/de/test/5.html

[bearbeiten] addMAXcmsVar()

addMAXcmsVar($name, $value);

[bearbeiten] getMAXcmsVar()

$value = getMAXcmsVar($name);

[bearbeiten] getLanguageName()

$value = getLanguageName($lang, $part="long");

[bearbeiten] getHostByAddrCMS()

$host = getHostByAddrCMS($IP);

[bearbeiten] setS()

setS($name, $value); Schreibt den Wert $value in die Session-Variable $name.

[bearbeiten] getS()

$value = getS($name); Liest den Wert aus der SessionVariable $name

[bearbeiten] getAllPagesUnder()

$arrSiteIds = getAllPagesUnder(0, $seiten_id, $sprache, $tiefe) Liefert alle Unterseiten-IDs zur übergebenen Seiten-ID

[bearbeiten] getFilePathArray(int) : array

Liefert den Pfad zur Root-Seite des übergebenen Parameters. Dabei entspricht der letzte Eintrag im zurückgegebenen Array der Wurzelseite, Zugriff ist also per $tree[count($tree) - 1] möglich.

[bearbeiten] getPageData(int[, string]) : array

Gibt die Daten einer MAXcms-Seite als Assoziativarray zurück. Wird der optionale Parameter nicht übergeben (Sprachkürzel), wird die Seite anhand der aktuellen Sprache ermittelt.

[bearbeiten] replaceLinks($html, $short=false)

$html= replaceLinks($html) Kann im Backend genutzt werden um Links(z.B. [url=2]) trotz Backend-Ansicht aufzulösen.

[bearbeiten] Datenbank

[bearbeiten] Datenbankobjekt $DC

$DC = newDC(); erstellt ein neues Datenbankobjekt mit dem auf die in der Datei inc.thcms_var.php eingerichteten Datenbank zugegriffen werden kann.

[bearbeiten] Auslesen einer Datenbankzeile

$data = $DC->getByQuery("SELECT * FROM TABELLE WHERE pk=1 ");

Gibt ein Assoziativ-Array eines Datensatzes zurück. Auch wenn der SQL-Query mehr als eine Ergebniszeile zurückliefert, wird davon nur die erste Zeile verwendet und als Array zurückgeliefert.

[bearbeiten] Auslesen von allen Zeilen

$data = $DC->getAllByQuery("SELECT * FROM TABELLE WHERE 1 ");

Gibt alle Ergebniszeilen in einem durchnummerierten Array zurück, wobei jeder Eintrag wiederrum ein Assoziativ-Array mit den Ergebnisspalten darstellt.

[bearbeiten] Auslesen von Zahl der Datensätze

$q="SELECT count(*) FROM table_name"
$wievieledatensätze= $DC->countByQuery($q);

Diese Funktion funktioniert nur wenn in der Query ein count(*) steht.

[bearbeiten] Senden eines SQL-Query

Um z.B. einen DELETE-Befehl an die Datenbank zu senden kann folgendes verwendet werden.

$DC->sendQuery("DELETE FROM TABELLE WHERE pk=1");

[bearbeiten] Dateisystem

[bearbeiten] cmsMail()

Generiert und sendet eine Html-Mail.

cmsMail($empfänger,$bestreff,$html, "FROM:$from\nContent-Type:text/html");

$empfänger: Email-Adresse der Empfänger.
$bestreff: Betreff der Mail.
$html: HTML-Template der Mail.
$from: Email-Adresse der Absender.

[bearbeiten] copyfiles()

Kopiert alle Dateien vom Quellordner in den Zielordner. copyfiles($source,$dest, $ext="");

als $ext kann z.B. ".jpg" angegeben werden um nur Dateien mit der Endung .jpg zu kopieren. Wenn das Zielverzeichnis nicht existiert wird es angelegt. Existiert die Datei im Zielverzeichnis bereits wird sie nur kopiert, wenn Sie neueren Datums ist. Es kann das globale Array $GLOBALS["CopyFilesExclude"] gefüllt werden mit Dateien die beim Kopiervorgang ausgeschlossen sein sollen.

[bearbeiten] Textbearbeitung

[bearbeiten] str_bis

$string = str_bis($haystack, $needle);

Liefert den Teil des Strings innerhalb von $haystack vom Anfang bis zum gefundenen $needle.
Beispiel: $string = str_bis("abc123", "2"); ergibt "abc1"

[bearbeiten] str_nach

$string = str_nach($haystack, $needle);

Liefert den Teil des Strings innerhalb von $haystack vom gefundenen $needle bis zum Ende.
Beispiel: $string = str_bis("abc123", "b"); ergibt "c123"

[bearbeiten] str_zwischen

$string = str_zwischen($haystack, $needle1, $needle2);

Liefert den Teil des Strings innerhalb von $haystack zwischen $needle1 und $neddle2.
Beispiel: $string = str_bis("abc123", "b", "2"); ergibt "c1"

[bearbeiten] str_beginn

$bool = str_beginn($haystack, $needle1);

gibt true zurück, wenn $haystack mit $needle beginnt.
Beispiel: str_beginn("abc123", "abc"); ergibt true.
str_beginn("abc123", "123"); ergibt false.

[bearbeiten] Datumsfunktionen

[bearbeiten] cmsString2Date

$date = str_cmsString2Date($dateString);

Wandelt ein Datum aus dem Format 1.2.1980 in das Datumsformat 1980-02-01 um. Wird als $dateString = "" übergeben wird es in "0000-00-00" umgewandelt.

[bearbeiten] cmsDate2String

$string = str_cmsString2Date($date);

Wandelt ein Datum aus dem Format 1980-02-01 in das Textformat 01.02.1980 um. Wird als $dateString = "" oder 0000-00-00 übergeben wird ein Leerstring zurüchgeliefert

[bearbeiten] Sonstiges

[bearbeiten] checkForArray()

$array = checkForArray($array);

Prüft ob der Parameter von Typ array ist. Wenn nicht, wird ein array() zurückgeliefert.

zurück zur MAXcms-Dokumentation