Öffentliche Methoden
	__call ($function, $params)

	__construct ($site_name='', $language='', $skin='', $only_active=true, $time='', $recalc=false)

	setOnlyActive ($b)

	setTime ($time='')

	setLanguage ($language='')

	setRights ($rights=array())

	addParam ($param)

	setParam ($param)

	getHash ()

	getLanguages ()

	getSkins ($theme=false)

	getPageId ($name, $param=[])

	getOnlyActive ()

	getTime ()

	getPages ($query=array(), $param=array())

	getLostPages ($deleted=-1)

	getPage ($id, $param=[])

	getRoot ($param=array())

	getErrorPage ()

	getUrl ($param, $page=null)

	getPageUrl ($page_id, $params=array(), $page=null)

	getDataSite ($lang='')

	hasMediaSite ()

	hasDataSite ()

	getFirstSite ($type)

	getMediaUrl ($id, $param=array(), $url_param=array())

	clearCache ($id=0, $all_languages=false)

	getGlobalConfig ($type)

	useGlobalConfig ($meta)

	save ($site)

	save_admin ($admin=array())

	migrateLanguages ()

	getTypes ($flat=true, $params=array())

	getKeywords ($query=[])

	getTypeInfo ($name)

	getTypeFiles ($type)

	getSitemapRootIdArray ($param=array(), $recalc=false, $user=true, $query=array())

	hasRight ($right, $flag=false, $user_id=false, $rights=array())

	hasPermission ($right)

	isPermission ($group, $role)

	checkCondition ($condition)

	checkRight ($right, $flag=false)

	getRights ($right)

	setRight ($right, $rights)

	destroyIDs ($ids)

	hasRightsOnId ($id, $rights, $user_id=false, $cache=true)

	isMetaUrl ($path)

	isPublicSave ()

	__toString ()

	__clone ()

	enoughDiskSpace ()

	getCache ()

	getCacheExpire ()

	getCacheEntry ($key)

	setCacheEntry ($key, $value)

	getCacheLastChanged ()

	getDesklets ($rights=false, $trashcan=false)

	getCRS ()

	getUploaderPage ($page=null)

	hasDeleted ()

	clearTrashcan ($query=array())

	getPageClass ($type='page')

	updateLinks ($output=false)

	updateMediaIndex ($resume, $c_date, $skipFirst, $dryRun, $timeout)

	removeLinks ($language='')

	removeUrls ($language='')

	updateUrls ($reset=false, $verbose=false)

	getUnusedPages ()

	getNonPublicPages ($query=[], $param=[])

	getCopyrights ($start=0, $limit=0, &$m=0)

	getTemplate ($mobile=false, $name='index', $dir='', $variant='', $suffix='', $fallback=true)

	getSkinFile ($path, $skip=array('module'), $url=false, $relative=false)

	getSiteFile ($path, $skip=array('module'), $url=false, $relative=false)

	getFile ($path, $type='skin')

	getInheritedFile ($mode, $type, $path, $skip=array('module'), $url=false, $relative=false)

	getVariantFiles ($path, $skip=array())

	getLayoutFiles ($path='', $skip=array(), $conf=array())

	getBlockFiles ($path='', $skip=array())

	isDisabledBlock ($block)

	getEditorTemplates ()

	hasLiveserver ()

	getSearchCount ($weight=0)

	updatePiwikHosts ()

	getAdminText ($suffix='', $fallback=true)

	isFrontendAdmin ($check_rights=true)

	cleanup ()

	getNextReplicationDate ($page=null)

	getRewriteConf ()

	getSocialNetworks ()

	getVirtualHosts ()

	globalAllowed ()

	compressFiles ($type, $files)

Öffentliche, statische Methoden
static	createSite ($new_site)

Datenfelder
	$name

	$site

	$admin

	$global = null

	$language

	$pageTable

	$skin = ''

	$theme = ''

	$rootId = 1

	$importFlag = false

	$conf = array()

Ausführliche Beschreibung

Site.

Diese Klasse kapselt die Site-Einträge. Die Site Informationen werden in der Datei site im site Verzeichnis der jeweiligen conf.ini gespeichert.

Autor: heiko $Id$

Definiert in Zeile 29 der Datei Site.php.

Beschreibung der Konstruktoren und Destruktoren

◆ __construct()

__construct	(	$site_name = `''`,
		$language = `''`,
		$skin = `''`,
		$only_active = `true`,
		$time = `''`,
		$recalc = `false`
	)

Konstruktor.

Die Site initialisieren. Auslesen der Site Informationen aus der site Datei im jeweiligen site Verzeichnis.

Der Name der Site Konfigurationsdatei lautet conf.ini. Folgende Variablen sind in der Konfigurationsdatei und somit auch im Attribut $site vorhanden:

type Der Typ der Site kann entweder content sein für gewöhnlichen Inhalt oder media für Multimediadaten.
default_language Das Kürzel der Standardsprache.
languages Die von dieser Site unterstützten Sprachen. Die Kürzel werden per Kommata getrennt.
media Der Sitename der Multimediadaten. Diese Site muss vom Typ media sein.
default_skin Die Standardskin der Site.
skins Alle unterstützten Skins. Die Namen der Skins werden per Kommata getrennt.
description Eine Beschreibung des Siteinhalts. Diese Beschreibung kann auch in den Metabereich der Html-Ausgabe aufgenommen werden.
keywords Die in dieser Site verwendeten Schlüsselwörter.
admin_email Fehler werden dieser Emailadresse mitgeteilt.
robots Standardeinstellung für die robots Metaangabe, z.B. index,folllow.

Festlegen der Page Table aus der Sprachauswahl $lang bzw. Standardsprache.

Multilinguale Sites haben den Eintrag multilang. Der Inhalt ist eine kommaseparierte Liste aller unterstützten Sprachen. Die Standardsprache steht im Eintrag lang.

Ausnahmebehandlung

SiteException falls die gewünschte Site nicht existiert.

Parameter

string	$site_name	Der Name der site ist mit dem Verzeichnisnamen identisch.
string	$language	Die zu verwendende Sprache.
string	$skin	Das gewünschte Design.
boolean	$only_active	Nur aktive Seiten anzeigen, deren Freigabezeitraum erreicht ist.
string	$time	Datum und Uhrzeit für die Ausgabe im Format 'Y-m-d H:i:s'.
boolean	$recalc	Informationen nicht aus dem Zwischenspeicher verwenden

Ausnahmebehandlung

Site_Exception

Definiert in Zeile 433 der Datei Site.php.

Benutzt $language, $skin, getSkins(), hasMediaSite(), save_admin(), setLanguage(), setTime() und Site_Exception\SITE_DOESNT_EXIST.

Hier ist ein Graph, der zeigt, was diese Funktion aufruft:

Dokumentation der Elementfunktionen

◆ __call()

__call	(	$function,
		$params
	)

Magic-Methode zum einbinden von weiteren Methoden

Parameter

String	$function
array	$params

Rückgabe: mixed

Definiert in Zeile 71 der Datei Site.php.

◆ __clone()

__clone ( )

Site Objekt klonen

Rückgabe: void

Definiert in Zeile 2924 der Datei Site.php.

◆ __toString()

__toString ( )

Site Objekt in einen String umwandeln

Rückgabe: string

Definiert in Zeile 2914 der Datei Site.php.

◆ addParam()

addParam ( $param )

Einen objektweiten Parameter für die Methode getPages() hinzufügen.

Parameter

$param array

Definiert in Zeile 595 der Datei Site.php.

◆ checkCondition()

checkCondition ( $condition )

Prüfen, ob eine oder mehrere Einstellungen im Mandanten (nicht) gesetzt sind

Beispiele:

admin.foo = 1
admin.foo.bar != "foo"
!admin.bar OR site.foo
site.foo > 1 AND admin.foo < 2

Parameter

string $condition

Rückgabe: boolean

Definiert in Zeile 2687 der Datei Site.php.

Benutzt Ego_System\getAssocValue().

Hier ist ein Graph, der zeigt, was diese Funktion aufruft:

◆ checkRight()

checkRight	(	$right,
		$flag = `false`
	)

Prüft, ob der aktuelle Benutzer das übergebene Rechte auf dieser Site besitzt und erzeugt die Ausnahme Auth_Exception, falls das nicht der Fall ist.

Parameter

	$right	string Die zu prüfende Berechtigung.
boolean	$flag	Mit Untergruppen prüfen.

Ausnahmebehandlung

Auth_Exception

Definiert in Zeile 2751 der Datei Site.php.

Benutzt Auth_Exception\PERMISSION_DENIED und Auth_Exception\PERMISSION_DENIED_TEXT.

◆ cleanup()

cleanup ( )

Die Datenbank des Mandanten aufräumen

Rückgabe: void

Definiert in Zeile 4400 der Datei Site.php.

◆ clearCache()

clearCache	(	$id = `0`,
		$all_languages = `false`
	)

Cache leeren resp. auf ungültig setzen.

Parameter

integer	$id	Wenn der Cache nur für eine bestimmte Seite (Multimedia) gelöscht werden soll, gibt man die ID an.
boolean	$all_languages	Cache für alle Sprachen ungültig setzen

cache_expire setzen. Ein Datum in der Zukunft zu dem der Cache spätestens abläuft

Definiert in Zeile 1472 der Datei Site.php.

Wird benutzt von setLanguage().

Hier ist ein Graph der zeigt, wo diese Funktion aufgerufen wird:

◆ clearTrashcan()

clearTrashcan ( $query = array() )

Papierkorb leeren

Parameter

string $query Zusätzlicher Query

Rückgabe: string

Definiert in Zeile 3284 der Datei Site.php.

Benutzt Ego_System\getCluster().

Hier ist ein Graph, der zeigt, was diese Funktion aufruft:

◆ compressFiles()

compressFiles	(	$type,
		$files
	)

Mehrere Dateien zu einer Datei zusammenführen

Parameter

string	$type
array	$files

Rückgabe: string

Definiert in Zeile 4586 der Datei Site.php.

Benutzt Ego_System\file_exists(), Ego_System\file_get_contents() und Ego_System\file_put_contents().

Hier ist ein Graph, der zeigt, was diese Funktion aufruft:

◆ createSite()

static createSite ( $new_site )

static

Erzeugt eine neue Site

Parameter

array $new_site

Rückgabe: Site

Ausnahmebehandlung

Site_Exception
Exception
Ego_Sql_Exception

Definiert in Zeile 234 der Datei Site.php.

Benutzt Ego_System\file_exists(), Ego_System\getCache(), Ego_System\mkdir(), Auth\NO_NULL_RIGHTS und Ego_Search_Factory\start().

Wird benutzt von Ego_REST_Server\getResponse().

Hier ist ein Graph, der zeigt, was diese Funktion aufruft:

Hier ist ein Graph der zeigt, wo diese Funktion aufgerufen wird:

◆ destroyIDs()

destroyIDs ( $ids )

Löscht die übergebenen IDs aus allen Tabellen.

Parameter

array $idArray Array mit Seiten IDs.

Definiert in Zeile 2813 der Datei Site.php.

◆ enoughDiskSpace()

enoughDiskSpace ( )

Prüft ob genügend Speicherplatz für eine Datensicherung verfügbar ist. Dazu wird die letzte Datensicherung * 3 als Mindestplatz genommen. Falls keine Datensicherung existiert, wird pauschal 2 GB genommen.

#90133

Definiert in Zeile 2941 der Datei Site.php.

Benutzt Ego_System\file_exists() und Ego_System\mkdir().

Hier ist ein Graph, der zeigt, was diese Funktion aufruft:

◆ getAdminText()

getAdminText	(	$suffix = `''`,
		$fallback = `true`
	)

Den Hinweistext für diesen Mandanten ermitteln

Parameter

string	$suffix
boolean	$fallback

Rückgabe: array

Definiert in Zeile 4358 der Datei Site.php.

◆ getBlockFiles()

getBlockFiles	(	$path = `''`,
		$skip = `array()`
	)

Alle Blöcke ermitteln (skin)

Parameter

string	$path	Pfad zu den block.*.html Dateien
array	$skip	(custom\|global\|system\|module) überspringen

Rückgabe: array

Definiert in Zeile 4148 der Datei Site.php.

Benutzt Ego_System\getFiles().

Hier ist ein Graph, der zeigt, was diese Funktion aufruft:

◆ getCache()

getCache ( )

Das Cacheobjekt zurückgeben.

Rückgabe: Ego_Cache

Definiert in Zeile 2993 der Datei Site.php.

◆ getCacheEntry()

getCacheEntry ( $key )

Einen Cacheeintrag zurückgeben.

Rückgabe: Object

Definiert in Zeile 3017 der Datei Site.php.

◆ getCacheExpire()

getCacheExpire ( )

Einstellung für das Browser Cache Timeout ermitteln (Standard: 1 Stunde)

Rückgabe: integer

Definiert in Zeile 3003 der Datei Site.php.

◆ getCacheLastChanged()

getCacheLastChanged ( )

Letztes Änderungsdatum des Cache.

Definiert in Zeile 3049 der Datei Site.php.

◆ getCopyrights()

getCopyrights	(		$start = `0`,
			$limit = `0`,
		&	$m = `0`
	)

Liefert alle Copyrights der verwendeten Bilder auf dieser Site

Rückgabe: [ title : Copyright pages (Dateien mit diesem Copyright) : [ page (zugehöriges Page Objekt), pool (null für Multimedia, array für Mediapool), linked (alle Page Objekte, die auf dieses Page Obejkt verweisen) : [ Page ] ] ]

Achtung: Die Ausgabe sollte innerhalb eines {cache} Blocks erfolgen

Rückgabe: array

Definiert in Zeile 3805 der Datei Site.php.

◆ getCRS()

getCRS ( )

Leaflet CRS Informationen ermitteln

Rückgabe: array

Definiert in Zeile 3166 der Datei Site.php.

Benutzt Ego_System\file_get_contents().

Hier ist ein Graph, der zeigt, was diese Funktion aufruft:

◆ getDataSite()

getDataSite ( $lang = '' )

Liefert den Datenmandanten, der dem aktuellen Mandanten zugeordnet ist

Parameter

string $lang

Rückgabe: Site|null

Ausnahmebehandlung

Site_Exception

Definiert in Zeile 1373 der Datei Site.php.

◆ getDesklets()

getDesklets	(	$rights = `false`,
		$trashcan = `false`
	)

Alle Desklets ermitteln

@params boolean $rights @params boolean $trashcan

Rückgabe: array

Definiert in Zeile 3061 der Datei Site.php.

◆ getEditorTemplates()

getEditorTemplates ( )

Alle Vorlagen für den Editor ermitteln

Rückgabe: array

Definiert in Zeile 4195 der Datei Site.php.

Benutzt Ego_System\file_exists() und Ego_System\file_get_contents().

Hier ist ein Graph, der zeigt, was diese Funktion aufruft:

◆ getErrorPage()

getErrorPage ( )

Gibt die Fehlerseite als Objekt zurück.

Diese Methode erzeugt ein Page Objekt der Fehlerseite. Falls keine Id für eine Fehlerseite in der Konfigurationsdatei eingetragen ist, wird die Startseite zurückgegeben.

Rückgabe: Page Fehlerseite.

Definiert in Zeile 1249 der Datei Site.php.

◆ getFile()

getFile	(	$path,
		$type = `'skin'`
	)

Eine Datei mit Fallback ermitteln (liefert relative Pfade für den Gebrauch in Templates)

Siehe auch: Ego_System::getFallbackFile

Parameter

string	$path	Pfad zur Datei
string	$type	(skin\|site)

Rückgabe: string

Definiert in Zeile 4058 der Datei Site.php.

◆ getFirstSite()

getFirstSite ( $type )

Liefert den ersten Mandanten von einem bestimmten Typ, der diesem Mandanten zugehörig ist

Der zugewiesene Mandant (z.B. Multimedia (media), Daten (data))
Der erste Mandant, auf dem der aktuelle Benutzer das "Desktop" Recht besitzt

Parameter

string $type

Rückgabe: Site

Definiert in Zeile 1435 der Datei Site.php.

◆ getGlobalConfig()

getGlobalConfig ( $type )

Globale Konfigurationen zurückliefern

Rückgabe: mixed|null

Definiert in Zeile 1559 der Datei Site.php.

◆ getHash()

getHash ( )

Einen MD5 Hash zur Identifizierung zurückgeben.

Definiert in Zeile 618 der Datei Site.php.

◆ getInheritedFile()

getInheritedFile	(	$mode,
		$type,
		$path,
		$skip = `array('module')`,
		$url = `false`,
		$relative = `false`
	)

Ein Template/Skript mit Fallback ermitteln Dabei werden die übergeordneten Seitentypen ebenfalls durchsucht

Parameter

string	$mode	(skin\|site)
string	$type	Seitentyp
string	$path
array	$skip
boolean	$url
boolean	$relative

Rückgabe: string

Definiert in Zeile 4080 der Datei Site.php.

◆ getKeywords()

getKeywords ( $query = [] )

Liefert alle Schlagwörter des Mandanten inklusieve deren Tiefe zurück

Rückgabe: array

Definiert in Zeile 2352 der Datei Site.php.

◆ getLanguages()

getLanguages ( )

Alle von dieser Site unterstützte Sprachen als Array zurückgeben.

Rückgabe: array Alle Kürzel der unterstützten Sprachen.

Definiert in Zeile 628 der Datei Site.php.

Wird benutzt von setLanguage().

Hier ist ein Graph der zeigt, wo diese Funktion aufgerufen wird:

◆ getLayoutFiles()

getLayoutFiles	(	$path = `''`,
		$skip = `array()`,
		$conf = `array()`
	)

Alle Layouts ermitteln (skin)

Parameter

string	$path	Pfad zu den layout.*.html Dateien
array	$skip	(custom\|global\|system\|module) überspringen
array	$conf	Übergebene Konfiguration verwenden

Rückgabe: array

Definiert in Zeile 4116 der Datei Site.php.

Benutzt Ego_System\getFiles().

Hier ist ein Graph, der zeigt, was diese Funktion aufruft:

◆ getLostPages()

getLostPages ( $deleted = -1 )

Ermittelt alle verlorenen Seiten dieses Mandanten

Parameter

integer $deleted

Rückgabe: Iterator

Definiert in Zeile 1154 der Datei Site.php.

◆ getMediaUrl()

getMediaUrl	(	$id,
		$param = `array()`,
		$url_param = `array()`
	)

Eine Url auf eine Multimediadatei erzeugen

Parameter

$id	integer Die ID der Datei, auf die verlinkt werden soll.
$param	array Parameter für die Datenbankabfrage.
$url_param	array Die Parameter in der Form $key=>$value für die Url.

Definiert in Zeile 1456 der Datei Site.php.

◆ getNextReplicationDate()

getNextReplicationDate ( $page = null )

Das Datum des nächsten inkrementellen Live-/Clusterupdate ermitteln

Parameter

Page $page In Abhängigkeit dieser Page

Rückgabe: string

Definiert in Zeile 4437 der Datei Site.php.

Benutzt Ego_System\file_exists(), Ego_System\file_get_contents() und Ego_System\getCluster().

Hier ist ein Graph, der zeigt, was diese Funktion aufruft:

◆ getNonPublicPages()

getNonPublicPages	(	$query = `[]`,
		$param = `[]`
	)

Alle Seiten ermitteln, die von diesem Benutzer zuletzt bearbeitet, aber nicht veröffentlicht wurden

Parameter

array	$query
array	$param

Rückgabe: array

Definiert in Zeile 3733 der Datei Site.php.

◆ getOnlyActive()

getOnlyActive ( )

_onlyActive ermitteln

Rückgabe: boolean

Definiert in Zeile 708 der Datei Site.php.

◆ getPage()

getPage	(	$id,
		$param = `[]`
	)

Erwartet einen Seitennamen oder eine Seitenurl und gibt das zugehörige Page Objekt aus.

Parameter

string	$id	Id, Name oder Url der Seite.
array	$param	Zusätzliche Parameter: string language Sprache boolean deleted true, wenn gelöschte Seiten ausgegeben werden sollen, sonst false array rights Auflistung der benötigten Rechte.

Rückgabe: Page Page

Definiert in Zeile 1182 der Datei Site.php.

◆ getPageClass()

getPageClass ( $type = 'page' )

Page Erweiterung suchen

Parameter

string $type

Rückgabe: string

Definiert in Zeile 3350 der Datei Site.php.

◆ getPageId()

getPageId	(	$name,
		$param = `[]`
	)

Erwartet einen Seitennamen oder eine Seitenurl und gibt die zugehörige ID aus.

Parameter

string	$name	Name bzw. Url der Seite,
array	$param

Rückgabe: int Seiten-ID

Definiert in Zeile 666 der Datei Site.php.

Benutzt $name und $rootId.

◆ getPages()

getPages	(	$query = `array()`,
		$param = `array()`
	)

Parameter

array	$query	zusätzliche Abfrage-Parameter (where), auch fields kann gesetzt werden
array	$param	Zusätzliche Parameter: string lang Sprache boolean deleted 1 - nur gelöschte Seiten, 0 - nur nicht gelöschte Seiten, -1 - alle Seiten, ob gelöscht oder nicht array rights Auflistung der bnötigten Rechte. string auth_or Die Bedingungen, die eine Seite erfüllen muss, damit sie trotz fehlender Rechte ausgegeben wird. string deleted_or Die Bedingungen, die eine Seite erfüllen muss, damit sie ausgegeben wird, obwohl sie gelöscht bzw. nicht gelöscht ist. string c_date Die Seiteninhalte zum festgesetzten Datum aus dem Archiv holen. string only_active Nur aktive und freigegebene Seiten anzeigen. string inactive Aktive und inaktive Seiten anzeigen. string fulltext Volltextsuchanfrage. string has_children Das Feld has_children ist null, wenn kein Kind existiert, ansonsten enthält es eine Zahl >0. string children_count Wenn "false", dann enthält has_children nicht die Anzahl der Kinder, sondern nur 1.

Definiert in Zeile 755 der Datei Site.php.

Benutzt $language, $site, Site_Exception\LANG_DOESNT_EXIST und Ego_Search_Factory\start().

Hier ist ein Graph, der zeigt, was diese Funktion aufruft:

◆ getPageUrl()

getPageUrl	(	$page_id,
		$params = `array()`,
		$page = `null`
	)

Eine Url auf eine Seite erzeugen.

Parameter

$page_id	integer Die ID der Seite, auf die verlinkt werden soll.
$params	array Die Parameter in der Form $key=>$value.
$page	Page Das zugehörige Page Objekt

Definiert in Zeile 1305 der Datei Site.php.

◆ getRewriteConf()

getRewriteConf ( )

Die für diesen Mandanten anzuwendende Rewrite2 Einstellungen ermitteln

Rückgabe: array

Definiert in Zeile 4499 der Datei Site.php.

◆ getRights()

getRights ( $right )

Alle Gruppen/Rollen für ein Recht ermitteln

Parameter

string $right

Rückgabe: array

Definiert in Zeile 2767 der Datei Site.php.

◆ getRoot()

getRoot ( $param = array() )

Gibt die Startseite als Objekt zurück.

Diese Methode erzeugt ein Page Objekt der Startseite.

Parameter

array

$param

Zusätzliche Parameter:

string language
Sprache
boolean deleted
true, wenn gelöschte Seiten ausgegeben werden sollen, sonst false
array rights
Auflistung der bnötigten Rechte.

Rückgabe: Page Startseite

Definiert in Zeile 1236 der Datei Site.php.

◆ getSearchCount()

getSearchCount ( $weight = 0 )

Einstellungen für die Suchrelevanz ermitteln

Parameter

integer $weight Suchgewichtung von -100 bis 100.

Rückgabe: array

Definiert in Zeile 4262 der Datei Site.php.

◆ getSiteFile()

getSiteFile	(	$path,
		$skip = `array('module')`,
		$url = `false`,
		$relative = `false`
	)

Ein Skript mit Fallback ermitteln (site)

Siehe auch: Ego_System::getFallbackFile

Parameter

string	$path	Pfad zur Datei
array	$skip	(custom\|global\|system\|module) überspringen
boolean	$url	URL für den Gebrauch in Templates zurückliefern
boolean	$relative	Relativen Pfad zurückgeben

Rückgabe: string

Definiert in Zeile 4040 der Datei Site.php.

Benutzt Ego_System\getFallbackFile().

Hier ist ein Graph, der zeigt, was diese Funktion aufruft:

◆ getSitemapRootIdArray()

getSitemapRootIdArray	(	$param = `array()`,
		$recalc = `false`,
		$user = `true`,
		$query = `array()`
	)

Bestimmt die Wurzeln aller Seiten, für die der Benutzer eine Berechtigung besitzt.

Parameter

array $param Zusätzliche Parameter

Siehe auch: getPages.

Parameter

boolean	$recalc	Neu berechnen
boolean	$user	Aus dem User Objekt holen und speichern
array	$query

Rückgabe: array Die Wurzeln aller Seiten, für die der Benutzer eine Berechtigung besitzt.

Definiert in Zeile 2480 der Datei Site.php.

◆ getSkinFile()

getSkinFile	(	$path,
		$skip = `array('module')`,
		$url = `false`,
		$relative = `false`
	)

Ein Template mit Fallback ermitteln (skin)

Siehe auch: Ego_System::getFallbackFile

Parameter

string	$path	Pfad zur Datei
array	$skip	(custom\|global\|system\|module) überspringen
boolean	$url	URL für den Gebrauch in Templates zurückliefern
boolean	$relative	Relativen Pfad zurückgeben

Rückgabe: string

Definiert in Zeile 4022 der Datei Site.php.

Benutzt Ego_System\getFallbackFile().

Hier ist ein Graph, der zeigt, was diese Funktion aufruft:

◆ getSkins()

getSkins ( $theme = false )

Alle von dieser Site unterstützte Designs als Array zurückgeben.

Parameter

array $theme Designvorlage ebenfalls anführen

Rückgabe: array Alle Namen der unterstützten Designs.

Definiert in Zeile 642 der Datei Site.php.

Benutzt $theme.

Wird benutzt von __construct().

Hier ist ein Graph der zeigt, wo diese Funktion aufgerufen wird:

◆ getSocialNetworks()

getSocialNetworks ( )

Alle sozialen Netzwerke ermitteln, in die dieser Mandanten Inhalte teilen darf

Rückgabe: array

Definiert in Zeile 4513 der Datei Site.php.

◆ getTemplate()

getTemplate	(	$mobile = `false`,
		$name = `'index'`,
		$dir = `''`,
		$variant = `''`,
		$suffix = `''`,
		$fallback = `true`
	)

Template dieser Site ermitteln

Parameter

boolean	$mobile
string	$name
string	$dir
string	$variant
string	$suffix
boolean	$fallback	Wird kein Template gefunden, Fallback auf das Standard Template

Rückgabe: string

Ausnahmebehandlung

Site_Exception

Definiert in Zeile 3931 der Datei Site.php.

Benutzt Ego_System\file_exists() und Site_Exception\MISSING_TEMPLATE.

Hier ist ein Graph, der zeigt, was diese Funktion aufruft:

◆ getTime()

getTime ( )

_time ermitteln

Rückgabe: mixed

Definiert in Zeile 717 der Datei Site.php.

◆ getTypeFiles()

getTypeFiles ( $type )

Findet heraus welche Dateien ein bestimmter Seitentyp verwendet und gibt ein Array mit den Pfaden zurück

Parameter

String $type Der Seitentyp

Rückgabe: Array Alle Dateien mit komplettem Pfad (Value) und einem eindeutigem Key pro Datei

Definiert in Zeile 2420 der Datei Site.php.

◆ getTypeInfo()

getTypeInfo ( $name )

Ermittelt die Informationen zu einem Seitentyp

Parameter

string $name

Rückgabe: array

Definiert in Zeile 2380 der Datei Site.php.

◆ getTypes()

getTypes	(	$flat = `true`,
		$params = `array()`
	)

Die Seitentypen als assoziatives Feld zurückgeben.

Parameter

boolean $flat getTypes kann sowohl eine flache als auch eine Baumstruktur zurückliefern.

Rückgabe

array assoziatives Feld der Seitentypen. Jeder Seitentyp besitzt einen Eintrag. Der Schlüssel ist der interne Typname und der Eintrag ist ein assoziatives Feld mit folgenden Schlüsseln:

depth integer die Tiefe
type der interne Name
name der sprechende Name.
fullname der sprechende Name mit komplettem Pfad.
active Aktivierung; false, wenn der 'Typ' nur als Kategorie gilt.
children Bei $flat=false stehen in diesem Feld die untergeordneten Typen.

Definiert in Zeile 2230 der Datei Site.php.

◆ getUnusedPages()

getUnusedPages ( )

Alle Multimedia Seiten ermitteln die nicht verwendet werden

Rückgabe: Page_Iterator

Definiert in Zeile 3700 der Datei Site.php.

◆ getUploaderPage()

getUploaderPage ( $page = null )

Upload Page für diese Site ermitteln

Parameter

Page $page Die Page für welche die Upload Page ermittelt werden soll

Rückgabe: Page

Definiert in Zeile 3180 der Datei Site.php.

◆ getUrl()

getUrl	(	$param,
		$page = `null`
	)

Eine Url erzeugen.

Parameter

$param	array Die Parameter in der Form $key=>$value.
$page	Page Das zugehörige Page Objekt

Definiert in Zeile 1265 der Datei Site.php.

◆ getVariantFiles()

getVariantFiles	(	$path,
		$skip = `array()`
	)

Alle Template Varianten ermitteln (skin)

Parameter

string	$path	Pfad zur Datei
array	$skip	(custom\|global\|system\|module) überspringen

Rückgabe: array

Definiert in Zeile 4098 der Datei Site.php.

Benutzt Ego_System\getVariantFiles().

Hier ist ein Graph, der zeigt, was diese Funktion aufruft:

◆ getVirtualHosts()

getVirtualHosts ( )

Alle virtuellen Hosts dieses Mandanten ermitteln

Rückgabe: array

Definiert in Zeile 4534 der Datei Site.php.

Benutzt Ego_System\getVirtualHosts().

Hier ist ein Graph, der zeigt, was diese Funktion aufruft:

◆ globalAllowed()

globalAllowed ( )

Prüfen, ob für diesen Mandanten die Verwendungen von globalen Skripten/Templates erlaubt ist

Rückgabe: boolean

Definiert in Zeile 4573 der Datei Site.php.

◆ hasDataSite()

hasDataSite ( )

Prüfen, ob diese Site eine zugewiesene Data Site besitzt

Rückgabe: bool

Definiert in Zeile 1421 der Datei Site.php.

◆ hasDeleted()

hasDeleted ( )

Prüfen ob diese Site gelöschte Seiten besitzt

Rückgabe: void

Definiert in Zeile 3270 der Datei Site.php.

◆ hasLiveserver()

hasLiveserver ( )

Prüfen, ob es für diese Site einen Liveserver gibt

Rückgabe: bool

Definiert in Zeile 4247 der Datei Site.php.

Benutzt Ego_System\getCluster().

Hier ist ein Graph, der zeigt, was diese Funktion aufruft:

◆ hasMediaSite()

hasMediaSite ( )

Prüfen, ob diese Site eine zugewiesene Multimedia Site besitzt

Rückgabe: boolean

Definiert in Zeile 1412 der Datei Site.php.

Wird benutzt von __construct().

Hier ist ein Graph der zeigt, wo diese Funktion aufgerufen wird:

◆ hasPermission()

hasPermission ( $right )

Prüft, ob der aktuelle Mandant eingetragen Rechte besitzt

Parameter

$right string Die zu prüfende Berechtigung.

Rückgabe: boolean true

Definiert in Zeile 2612 der Datei Site.php.

◆ hasRight()

hasRight	(	$right,
		$flag = `false`,
		$user_id = `false`,
		$rights = `array()`
	)

Prüft, ob der aktuelle Benutzer das übergebene Rechte auf dieser Site besitzt.

Parameter

	$right	string Die zu prüfende Berechtigung.
boolean	$flag	Mit Untergruppen prüfen.
	$user_id	string Die ID des zu prüfenden Benutzers
	array	Diese Rechte verwenden

Rückgabe: boolean true, falls der Benutzer die Berechtigung besitzt.

Definiert in Zeile 2581 der Datei Site.php.

◆ hasRightsOnId()

hasRightsOnId	(	$id,
		$rights,
		$user_id = `false`,
		$cache = `true`
	)

Prüft, ob der aktuelle Benutzer bestimmte Rechte auf die Seite mit der übergebenen ID hat.

Parameter

$id	integer Seitenid.
$rights	array Die zu prüfende Berechtigungen.
$user_id	string Die ID des zu prüfenden Benutzers
$cache	boolean

Definiert in Zeile 2839 der Datei Site.php.

◆ isDisabledBlock()

isDisabledBlock ( $block )

Prüfen, ob ein Design Block deaktiviert ist

Parameter

string $block

Rückgabe: boolean

Definiert in Zeile 4167 der Datei Site.php.

◆ isFrontendAdmin()

isFrontendAdmin ( $check_rights = true )

Prüfen, ob die Frontend Administration für diesen Mandanten verwendet wird

Parameter

boolean $check_rights

Rückgabe: boolean

Definiert in Zeile 4383 der Datei Site.php.

◆ isMetaUrl()

isMetaUrl ( $path )

Prüfen, ob ein Name als Meta URL verwendet wird.

Es werden hierbei alle Sprachen des Mandanten geprüft.

Parameter

string $path Der zu überprüfende Name inklusive Pfad.

Rückgabe: boolean true, wenn der übergebene Name als Meta URL verwendet wird.

Definiert in Zeile 2884 der Datei Site.php.

◆ isPermission()

isPermission	(	$group,
		$role
	)

Prüft ob eingetragene Gruppen/Rollen Kombination gültig ist

Definiert in Zeile 2638 der Datei Site.php.

◆ isPublicSave()

isPublicSave ( )

Für diesen Mandanten soll "Speichern und Veröffentlichen" verwendet werden

Rückgabe: boolean

Definiert in Zeile 2905 der Datei Site.php.

◆ migrateLanguages()

migrateLanguages ( )

Sprachverweise in allen Seiten anpssen

Rückgabe: void

Definiert in Zeile 1898 der Datei Site.php.

◆ removeLinks()

removeLinks ( $language = '' )

Alle Verweise dieser Site löschen

Parameter

string $language Nur in dieser Sprache

Rückgabe: void

Definiert in Zeile 3620 der Datei Site.php.

◆ removeUrls()

removeUrls ( $language = '' )

Alle URLs dieser Site löschen

Parameter

string $language

Rückgabe: void

Definiert in Zeile 3648 der Datei Site.php.

◆ save()

save ( $site )

Änderungen in der Konfiguration speichern.

Parameter

array $site Änderungen der Konfiguration. Es müssen nicht alle Parameter übergeben werden.

Rückgabe: boolean Sitemap muss neu geladen werden

Definiert in Zeile 1714 der Datei Site.php.

◆ save_admin()

save_admin ( $admin = array() )

Änderungen in der Admin-Konfiguration speichern.

Parameter

array $admin Änderungen der Konfiguration. Es müssen nicht alle Parameter übergeben werden.

Rückgabe: boolean Sitemap muss neu geladen werden

Nur die aktivierten Typen sichern

Definiert in Zeile 1757 der Datei Site.php.

Wird benutzt von __construct().

Hier ist ein Graph der zeigt, wo diese Funktion aufgerufen wird:

◆ setCacheEntry()

setCacheEntry	(	$key,
		$value
	)

Einen Cacheeintrag schreiben.

Parameter

string	$key	Schlüssel
mixed	$value	Wert

Rückgabe: void

Definiert in Zeile 3035 der Datei Site.php.

◆ setLanguage()

setLanguage ( $language = '' )

Setzt die Sprache.

Parameter

string $language Die Sprache wird für die Ausgabe der Seiten benötigt. Sie kann jederzeit geändert werden. Wird keine Sprache übergeben, dann wird die Standardsprache benutzt.

Definiert in Zeile 519 der Datei Site.php.

Benutzt $language, clearCache(), getLanguages() und Site_Exception\LANG_DOESNT_EXIST.

Wird benutzt von __construct().

Hier ist ein Graph, der zeigt, was diese Funktion aufruft:

Hier ist ein Graph der zeigt, wo diese Funktion aufgerufen wird:

◆ setOnlyActive()

setOnlyActive ( $b )

Flag setzen, um nur aktive Seiten, deren Freigabezeitraum erreicht ist, anzuzeigen.

Parameter

boolean $b

Rückgabe: void

Definiert in Zeile 488 der Datei Site.php.

◆ setParam()

setParam ( $param )

Setzt die objektweiten Parameter für die Methode getPages().

Parameter

$param array

Definiert in Zeile 610 der Datei Site.php.

Wird benutzt von setRights().

Hier ist ein Graph der zeigt, wo diese Funktion aufgerufen wird:

◆ setRight()

setRight	(	$right,
		$rights
	)

Alle Gruppen/Rollen für ein Recht setzen

Parameter

string	$right
array	$rights

Definiert in Zeile 2788 der Datei Site.php.

◆ setRights()

setRights ( $rights = array() )

Setzt die zu prüfenden Rechte

Parameter

$rights array

Definiert in Zeile 584 der Datei Site.php.

Benutzt setParam().

Hier ist ein Graph, der zeigt, was diese Funktion aufruft:

◆ setTime()

setTime ( $time = '' )

Setzt den Zeitstempel für die Abfrage nach Freigabe ab/bis.

Der Zeitstempel kann theoretisch verwendet werden um den Zustand eines Mandanten in der Zukunft darzustellen (wenn release_from/release_until aufgelöst sind). Standardmäßig ist es aber das Expire Datum des Mandanten oder, falls es das Expire Datum nicht gibt, der aktuelle Zeitstempel. Dadurch wird die Datenbank Cache für SELECTs verhindert, da sich im SELECT der Teil mit der release_until/release_from regelmäßig ändert.

Parameter

integer $time Wird der Zeitstempel übergeben, dann wird dieser Wert direkt gesetzt, ansonsten wird der cache_expire Zeitstempel verwendet.

Definiert in Zeile 502 der Datei Site.php.

Wird benutzt von __construct().

Hier ist ein Graph der zeigt, wo diese Funktion aufgerufen wird:

◆ updateLinks()

updateLinks ( $output = false )

Alle Verweise dieser Site sammeln

Parameter

boolean $output Ausgabe an den Client

Rückgabe: void

Definiert in Zeile 3421 der Datei Site.php.

Benutzt Ego_System\flush().

Hier ist ein Graph, der zeigt, was diese Funktion aufruft:

◆ updateMediaIndex()

updateMediaIndex	(	$resume,
		$c_date,
		$skipFirst,
		$dryRun,
		$timeout
	)

Index con Media Dateien (Office / txt / pdf etc ...)

Parameter

$resume	wenn true beim letzten ende weitermachen
$c_date	c_date in DB ändern
$skipFirst	das erste überspringen
$dryRun	ohne update
$timeout	die Indizierung bricht nach timeout Sekunden ab

Rückgabe: void

Definiert in Zeile 3456 der Datei Site.php.

Benutzt Ego_System\file_exists(), Ego_System\file_get_contents(), Ego_System\file_put_contents(), Ego_System\filterNonUtf8() und Ego_System\getMimeTypes().

Hier ist ein Graph, der zeigt, was diese Funktion aufruft:

◆ updatePiwikHosts()

updatePiwikHosts ( )

Setzt innerhalb der Piwikkonfiguration die URLs neu

Parameter

$piwik

Rückgabe: void;

Definiert in Zeile 4291 der Datei Site.php.

◆ updateUrls()

updateUrls	(	$reset = `false`,
		$verbose = `false`
	)

Die URL aller Seiten aktualisieren

Parameter

boolean	$reset
boolean	$verbose

Rückgabe: void

Definiert in Zeile 3679 der Datei Site.php.

◆ useGlobalConfig()

useGlobalConfig ( $meta )

Prüfen, ob die globale Konfiguration verwendet werden soll

Parameter

array $meta

Rückgabe: boolean

Definiert in Zeile 1672 der Datei Site.php.

Dokumentation der Felder

◆ $admin

$admin

array

Konfigurationsdaten für den Adminbereich.

Definiert in Zeile 46 der Datei Site.php.

◆ $conf

$conf = array()

array

Alle Konfigurationen für diese Site.

Definiert in Zeile 55 der Datei Site.php.

◆ $global

$global = null

array

Globale Konfigurationen.

Definiert in Zeile 47 der Datei Site.php.

◆ $importFlag

$importFlag = false

bool

Zeigt an, ob ein Import durchgeführt. Die mandanten spezifischen Update Skripte können darauf reagieren.

Definiert in Zeile 53 der Datei Site.php.

◆ $language

$language

string

Die aktuelle Sprache.

Definiert in Zeile 48 der Datei Site.php.

Wird benutzt von __construct(), getPages() und setLanguage().

◆ $name

$name

string

Name der Site.

Definiert in Zeile 44 der Datei Site.php.

Wird benutzt von getPageId().

◆ $pageTable

$pageTable

string

Der aktuelle Tabellenname.

Definiert in Zeile 49 der Datei Site.php.

◆ $rootId

$rootId = 1

integer

Seiten ID der Hauptseite.

Definiert in Zeile 52 der Datei Site.php.

Wird benutzt von getPageId().

◆ $site

$site

array

Die Daten der Site.

Definiert in Zeile 45 der Datei Site.php.

Wird benutzt von getPages().

◆ $skin

$skin = ''

string

Das aktuelle Design.

Definiert in Zeile 50 der Datei Site.php.

Wird benutzt von __construct().

◆ $theme

$theme = ''

string

Die aktuelle Designvorlage.

Definiert in Zeile 51 der Datei Site.php.

Wird benutzt von getSkins().

Die Dokumentation für diese Klasse wurde erzeugt aufgrund der Datei:

/media/ssd/workspace/egocms/develop/lib/base/Site.php

Öffentliche Methoden

Öffentliche, statische Methoden

Datenfelder

Ausführliche Beschreibung

Beschreibung der Konstruktoren und Destruktoren

◆ __construct()

Dokumentation der Elementfunktionen

◆ __call()

◆ __clone()

◆ __toString()

◆ addParam()

◆ checkCondition()

◆ checkRight()

◆ cleanup()

◆ clearCache()

◆ clearTrashcan()

◆ compressFiles()

◆ createSite()

◆ destroyIDs()

◆ enoughDiskSpace()

◆ getAdminText()

◆ getBlockFiles()

◆ getCache()

◆ getCacheEntry()

◆ getCacheExpire()

◆ getCacheLastChanged()

◆ getCopyrights()

◆ getCRS()

◆ getDataSite()

◆ getDesklets()

◆ getEditorTemplates()

◆ getErrorPage()

◆ getFile()

◆ getFirstSite()

◆ getGlobalConfig()

◆ getHash()

◆ getInheritedFile()

◆ getKeywords()

◆ getLanguages()

◆ getLayoutFiles()

◆ getLostPages()

◆ getMediaUrl()

◆ getNextReplicationDate()

◆ getNonPublicPages()

◆ getOnlyActive()

◆ getPage()

◆ getPageClass()

◆ getPageId()

◆ getPages()

◆ getPageUrl()

◆ getRewriteConf()

◆ getRights()

◆ getRoot()

◆ getSearchCount()

◆ getSiteFile()

◆ getSitemapRootIdArray()

◆ getSkinFile()

◆ getSkins()

◆ getSocialNetworks()

◆ getTemplate()

◆ getTime()

◆ getTypeFiles()

◆ getTypeInfo()

◆ getTypes()

◆ getUnusedPages()

◆ getUploaderPage()

◆ getUrl()

◆ getVariantFiles()

◆ getVirtualHosts()

◆ globalAllowed()

◆ hasDataSite()

◆ hasDeleted()

◆ hasLiveserver()

◆ hasMediaSite()

◆ hasPermission()

◆ hasRight()

◆ hasRightsOnId()

◆ isDisabledBlock()

◆ isFrontendAdmin()

◆ isMetaUrl()