EGOCMS  24.0
EGOTEC Content-Managament-System
Ego_Combo Klassenreferenz

Öffentliche Methoden

 __construct ($value='')
 
 getValue ()
 
 setValue ($value)
 
 getString ()
 
 getPages ($no_rights=false, $only_active=false, $lang='', $user_id=null)
 
 setPages ($pages)
 
 addPage ($page)
 
 hasPage ($page)
 
 getUsers ()
 
 setUsers ($users)
 
 addUser ($user_id)
 
 hasUser ($user_id)
 
 getRights ()
 
 getRightsUsers ()
 
 setRights ($rights)
 
 addRight ($group, $role)
 
 hasRight (string $user_id)
 
 getText ()
 
 setText ($text)
 
 addText ($text)
 
 getData ()
 
 getDataBy ($key, $value)
 
 getDataByKey ($key)
 
 setData ($data)
 
 addData ($data)
 
 getMailAddresses ($params=array())
 

Datenfelder

const EMPTY_VALUE = '{"pages":[],"users":[],"rights":[],"text":[],"data":[]}'
 

Ausführliche Beschreibung

Eine Helfer Klasse für das Smarty Input Plugin "Combo".

Autor
dg

Definiert in Zeile 59 der Datei Ego_Combo.php.

Beschreibung der Konstruktoren und Destruktoren

◆ __construct()

__construct (   $value = '')

Konstruktor

Parameter
string$value

Definiert in Zeile 79 der Datei Ego_Combo.php.

Benutzt setValue().

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

Dokumentation der Elementfunktionen

◆ addData()

addData (   $data)

Daten hinzufügen

Parameter
mixed$data
Rückgabe
boolean

Definiert in Zeile 521 der Datei Ego_Combo.php.

◆ addPage()

addPage (   $page)

Seite hinzufügen

Parameter
Page$page
Rückgabe
boolean

Definiert in Zeile 223 der Datei Ego_Combo.php.

◆ addRight()

addRight (   $group,
  $role 
)

Gruppe/Rolle hinzufügen

Parameter
string$group
string$role
Rückgabe
boolean

Definiert in Zeile 391 der Datei Ego_Combo.php.

◆ addText()

addText (   $text)

Direkteingabe hinzufügen

Parameter
string$text
Rückgabe
boolean

Definiert in Zeile 456 der Datei Ego_Combo.php.

◆ addUser()

addUser (   $user_id)

Benutzer hinzufügen

Parameter
string$user_id
Rückgabe
boolean

Definiert in Zeile 297 der Datei Ego_Combo.php.

◆ getData()

getData ( )

Alle Daten liefern

Rückgabe
array

Definiert in Zeile 469 der Datei Ego_Combo.php.

◆ getDataBy()

getDataBy (   $key,
  $value 
)

Liefert alle Daten die für einen bestimmten Schlüssel einen bestimmten Wert haben

Parameter
mixed$key
mixed$value
Rückgabe
array

Definiert in Zeile 480 der Datei Ego_Combo.php.

◆ getDataByKey()

getDataByKey (   $key)

Liefert die Daten für einen bestimmten Schlüssel

Parameter
string$key
Rückgabe
array

Definiert in Zeile 496 der Datei Ego_Combo.php.

◆ getMailAddresses()

getMailAddresses (   $params = array())

Alle E-Mail Adressen ermitteln

  • Zurückgegebene Werte: username, salutation, firstname, lastname, email.
  • Benutzer Vertreter werden berücksichtigt.
  • Nur gültige und keine doppelten E-Mail Adressen.
  • Über $params können E-Mail Adressen gefiltert werden:
    • pages = E-Mail Adresse aus Seiten filtern, bei denen. > type = Der Seitentyp entspricht (oder * für jeden Seitentyp). > values = Die Werte werden jeweils ermittelt über [field].key.
    • children = Wie pages, allerdings werden jeweils die Unterseiten der eingetragenen Seiten gefiltert.
    • users = Benutzer filtern. > no_admin = Auch Benutzer, die nicht in den Adminbereich dürfen (Standard: true).
    • data = Die Werte werden jeweils ermittelt über [field] => key.
Parameter
array$params
Rückgabe
array

Definiert in Zeile 545 der Datei Ego_Combo.php.

Benutzt Ego_System\getAssocValue() und Ego_System\isEmail().

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

◆ getPages()

getPages (   $no_rights = false,
  $only_active = false,
  $lang = '',
  $user_id = null 
)

Alle Seiten liefern

Parameter
boolean$no_rights
boolean$only_active
string$lang
string | null$user_id
Rückgabe
array

Definiert in Zeile 149 der Datei Ego_Combo.php.

◆ getRights()

getRights ( )

Alle Gruppen/Rollen liefern

Rückgabe
array

Definiert in Zeile 325 der Datei Ego_Combo.php.

◆ getRightsUsers()

getRightsUsers ( )

Alle Benutzer liefern die den Gruppen/Rollen angehören

Rückgabe
array

Definiert in Zeile 345 der Datei Ego_Combo.php.

◆ getString()

getString ( )

Das JSON Objekt als String liefern

Rückgabe
string

Definiert in Zeile 136 der Datei Ego_Combo.php.

◆ getText()

getText ( )

Alle Direkteingaben liefern

Rückgabe
array

Definiert in Zeile 432 der Datei Ego_Combo.php.

◆ getUsers()

getUsers ( )

Alle Benutzer liefern

Rückgabe
array

Definiert in Zeile 263 der Datei Ego_Combo.php.

◆ getValue()

getValue ( )

Das JSON Objekt liefern

Rückgabe
object

Definiert in Zeile 93 der Datei Ego_Combo.php.

◆ hasPage()

hasPage (   $page)

Prüfen ob eine Seite existiert

Parameter
Page$page
Rückgabe
boolean

Definiert in Zeile 242 der Datei Ego_Combo.php.

◆ hasRight()

hasRight ( string  $user_id)

Prüft, ob ein Benutzer eines der aktuellen Rechte hat

Parameter
string$user_id
Rückgabe
bool

Definiert in Zeile 411 der Datei Ego_Combo.php.

◆ hasUser()

hasUser (   $user_id)

Prüfen ob ein Benutzer existiert

Parameter
string$user_id
Rückgabe
boolean

Definiert in Zeile 311 der Datei Ego_Combo.php.

◆ setData()

setData (   $data)

Daten setzen

Parameter
array$data
Rückgabe
void

Definiert in Zeile 511 der Datei Ego_Combo.php.

◆ setPages()

setPages (   $pages)

Seiten setzen

Parameter
array$pages
Rückgabe
void

Definiert in Zeile 213 der Datei Ego_Combo.php.

◆ setRights()

setRights (   $rights)

Gruppen/Rollen setzen

Parameter
array$rights
Rückgabe
void

Definiert in Zeile 380 der Datei Ego_Combo.php.

◆ setText()

setText (   $text)

Direkteingaben setzen

Parameter
array$data
Rückgabe
void

Definiert in Zeile 446 der Datei Ego_Combo.php.

◆ setUsers()

setUsers (   $users)

Benutzer setzen

Parameter
array$users
Rückgabe
void

Definiert in Zeile 287 der Datei Ego_Combo.php.

◆ setValue()

setValue (   $value)

Wert überschreiben

Parameter
string$value
Rückgabe
void
Ausnahmebehandlung
Ego_Combo_Exception

Definiert in Zeile 104 der Datei Ego_Combo.php.

Benutzt Ego_Combo_Exception\INVALID_VALUE.

Wird benutzt von __construct().

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

Dokumentation der Felder

◆ EMPTY_VALUE

const EMPTY_VALUE = '{"pages":[],"users":[],"rights":[],"text":[],"data":[]}'

Definiert in Zeile 65 der Datei Ego_Combo.php.


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