Dokumentation - Server Grundfunktionen (public)

`$string id`	UserGroup ID
`$string name`	UserGroup Name
`$array users = array()`	die in der Gruppe gespeicherten User IDs
`$bool adminRights = false`	Benutzer haben Administratorrechte
`$bool verifyRequire = true`	Benutzer müssen sich stets verifizieren

__construct ($string $input = null)

$input übergibt die UserGroup ID oder den Namen der Gruppe

erstellt das new client\userGroup() Objekt, welches alle Informationen enthält


      $userGroup = new client\userGroup('family');

__get ($string $name)

$name übergibt den Variablennamen

gibt die Variablen zurück, null wenn die Variable nicht vorhanden ist


      $userGroup = new client\userGroup('family');

      echo $userGroup->name;

__set ($string $name, $mixed $value)

`$name`	übergibt den Variablennamen
`$value`	übergibt den Wert der Variable

gibt immer false zurück, da alle Variablen nicht gesetzt werden können

__debugInfo ()

gibt ein $array mit allen Eigenschaften zurück


      $userGroup = new client\userGroup('family');

      print_r($userGroup);

isValid ()

gibt true zurück, wenn eine gültige Benutzergruppe geladen wurde; ansonsten false


      $userGroup = new client\userGroup('family');

      $userGroup->isValid();

addUser ()

gibt true zurück, wenn der Benutzer erfolgreich der Gruppe hinzugefügt wurde; ansonsten false


      user::login('mail@xenec.com');


      $userGroup = new client\userGroup('family');

      $userGroup->addUser();

removeUser ()

gibt true zurück, wenn der Benutzer erfolgreich aus der Gruppe entfernt wurde; ansonsten false


      user::login('mail@xenec.com');


      $userGroup = new client\userGroup('family');

      $userGroup->removeUser();

containUser ()

gibt true zurück, wenn der Benutzer in der Gruppe vorhanden ist; ansonsten false


      user::login('mail@xenec.com');


      $userGroup = new client\userGroup('family');

      $userGroup->containUser();

Überprüfungen

static client\userGroup::isUserGroup ($mixed $userGroup = null)

$userGroup übergibt die zu prüfende Variable

gibt true zurück, wenn die Variable ein new client\userGroup() Objekt ist; ansonsten false


    client\userGroup::isUserGroup(new client\userGroup());

static client\userGroup::isUserGroupId ($string $userGroupId = null)

$userGroupId übergibt die UserGroup ID

gibt true zurück, wenn die Variable eine UserGroup ID ist; ansonsten false


    client\userGroup::isUserGroupId('USERGROUPID__e09a250c0f557d35624eed7a72672cebb81851dc');

static client\userGroup::userGroupExists ($string $input = null)

$input übergibt die UserGroup ID oder den Namen der Gruppe

gibt true zurück, wenn die UserGroup existiert; ansonsten false


    client\userGroup::userGroupExists('USERGROUPID__e09a250c0f557d35624eed7a72672cebb81851dc');


    client\userGroup::userGroupExists('family');

static client\userGroup::getUserGroup ($string $input = null)

$input übergibt die UserGroup ID oder den Namen der Gruppe

gibt ein array zurück, welches Informationen zur UserGroup enthält; ansonsten null


    client\userGroup::getUserGroup('family');

static client\userGroup::getByUser ()

gibt ein array zurück, mit allen UserGroup IDs in denen der Benutzer enthalten ist; ansonsten null


    user::login('mail@xenec.com');


    client\userGroup::getByUser();

static client\userGroup::create ($string $name = null[, $bool $verifyRequire = false])

`$name`	Name der UserGroup
`$verifyRequire`	true gibt an, dass eine Verifizierung des Benutzers zwingend erforderlich ist

gibt true zurück, wenn die UserGroup erfolgreich erstellt wurde; ansonsten false


    client\userGroup::create('administration', true);

static client\userGroup::delete ($string $input = null)

$input übergibt die UserGroup ID oder den Namen der Gruppe

gibt true zurück, wenn die Benutzergruppe erfolgreich gelöscht wurde; ansonsten false


    client\userGroup::delete('administration');