/web/core/core.subject.php

Description
Description | Classes | Includes | Constants | Functions
  • license: COPYING
  • copyright: © 2001-2007 The FLIP Project Team
  • version: $Id: core.subject.php 1471 2007-10-07 21:15:47Z scope $
  • author: Moritz Eysholdt
Classes
Description | Classes | Includes | Constants | Functions
Class Description
Subject
RightSubject
ChildSubject
ParentSubject
User
Group
Includes
Description | Classes | Includes | Constants | Functions
require_once ("core/core.mysql.php") (line 17)
Constants
Description | Classes | Includes | Constants | Functions
CORE.SUBJECT.PHP = 1 (line 15)

Die Datei nur einmal includen

Functions
Description | Classes | Includes | Constants | Functions
AddSubjectProperties (line 412)

Fügt Subject-Properties zu einem Array, das bereits Subject-IDs enthält, hinzu.

void AddSubjectProperties ( $Type,  $List,  $Col,  $Columns)
  • $Type
  • $List
  • $Col
  • $Columns
CheckSubjectName (line 377)
void CheckSubjectName ( $aName, [ $raiseError = true])
  • $aName
  • $raiseError
CreateSubject (line 392)
void CreateSubject ( $Type,  $Name, [ $Email = NULL])
  • $Type
  • $Name
  • $Email
CreateSubjectInstance (line 563)
void &CreateSubjectInstance ( &$aIdent, [ $aForceType = "subject"])
  • &$aIdent
  • $aForceType
DeleteSubject (line 530)
void DeleteSubject ( &$aSubject)
  • &$aSubject
GetColumnDeteils (line 368)
void GetColumnDeteils ( $Type)
  • $Type
GetColumns (line 361)
void GetColumns ( $Type)
  • $Type
GetRightID (line 112)

Liefert die ID eines Rechtes zurück.

Wenn das angefragte Recht nicht existiert, wird eine Warnmeldung ausgegeben.

  • return: die ID des Rechtes.
int GetRightID (string $Ident)
  • string $Ident: entweder die ID oder der Name des Rechtes.
GetRightName (line 96)

Liefert den Namen eines Rechtes zurück.

Wenn das angefragte Recht nicht existiert, wird eine Warnmeldung ausgegeben.

  • return: Der Name des Rechtes.
string GetRightName (string $Ident)
  • string $Ident: entweder die ID oder der Name des Rechtes.
GetRightOwners (line 122)
void GetRightOwners ( $aRightIdent, [ $controlled = 0])
  • $aRightIdent
  • $controlled
GetRights (line 75)

Gibt ein assoziatives Array zurück, welches den Rechte-IDs die Rechte-Namen zuordnet.

Dabei wird das Rückgabeergebnis gecached, so dass ein häufiger Aufruf von GetRights() kein Performanceproblem darstellt.

  • return: Ein assoziatives Array, welches die ID als Key und den Namen der Rechte als Value enthält.
array GetRights ([ $ForceReload = false])
  • $ForceReload
GetSubjectID (line 146)

Gibt die ID von einem Subject zurück.

Zusätzlich wird das Rückgabeergebnis währen der Programmausführung gecached. Es wird nicht überprüft, ob die zurückgegebene Subject-ID gültig ist.

  • return: Wenn die Funktion erfolgreich war, wird die ID des Subjectes zurückgegeben, ansonsten der Wert 0.
int GetSubjectID (mixed $Subject, [boolean $DoLookupIfNecc = true])
  • mixed $Subject: Irgend etwas, dass sich als Subject interpretieren lässt:
    • Die Instanz einer Klasse vom Typ Subject oder deren Nachfahren.
    • Ein Array, welches den Key "id" enthält. (z.B. ein Datensatz aus der Tabelle TblPrefix().flip_user_subject)
    • Eine Zahl.
    • Ein String welcher ein Subject-Name oder die Email-Adrese eines Subjectes ist.
  • boolean $DoLookupIfNecc: Um die ID zu einem Namen oder einer EMail-Adresse ausfindig zu machen, ist eine Datenbankabfrage notwendig. $DoLookupIfNecc gibt an, ob diese gestattet ist.
GetSubjectName (line 170)
void GetSubjectName ( $Subject, [ $DoLookupIfNecc = true])
  • $Subject
  • $DoLookupIfNecc
GetSubjects (line 428)
void GetSubjects ( $Type, [ $Columns = array ()], [ $Where = ""], [ $OrderBy = ""])
  • $Type
  • $Columns
  • $Where
  • $OrderBy
GetTypeInfo (line 51)

Gibt Informationen über einen oder alle Subjekt-Typen zurück.

Informationen über einen Subject-Typ sind wiederum als Eigenschaften eines Subjectes gespeichert. (Das bedeutet, der Subject-Typ "type" definiert sich selbst). GetTypeInfo() cached das Rückgabeergebnis und kann daher ohne Performanceeinbussen beliebig oft aufgerufen werden.

  • return: wird $Type angegeben, ein assoziatives Array im Sinne von:
    1.  array (
    2.   'id' => '1294',
    3.   'name' => 'forum',
    4.   'rights_over_for_properties' => 'Y',
    5.   'can_be_child' => 'Y',
    6.   'can_be_parent' => 'N',
    7.  );
    ansonsten, wenn $Type nicht angegeben wird:
    1.  array (
    2.    'user' =>
    3.    array (
    4.      'id' => '1294',
    5.      'name' => 'forum',
    6.      'rights_over_for_properties' => 'Y',
    7.      'can_be_child' => 'Y',
    8.      'can_be_parent' => 'N',
    9.    ),
    10.    'group' => ...,
    11.    ...
    12.  );
array GetTypeInfo ([string $Type = ""])
  • string $Type: (optional) Der Name des Types zu dem Informationen abgefragt werden sollen.
RequireAllowCreateSubject (line 591)
void RequireAllowCreateSubject ( $Type)
  • $Type
SubjectExists (line 541)
void SubjectExists ( $aIdent, [ $aType = ""])
  • $aIdent
  • $aType
UserLogin (line 1137)
void UserLogin ( $Ident,  $Password, [ $ForceEnabled = true])
  • $Ident
  • $Password
  • $ForceEnabled
UserTryLogin (line 1127)
void UserTryLogin ()
_AddChildIDS (line 316)
void _AddChildIDS ( $Parents)
  • $Parents
_GetColumnInfo (line 338)
void _GetColumnInfo ( $Type, [ $FlushCache = false])
  • $Type
  • $FlushCache
_readSubject (line 552)
void _readSubject ( $aIdent,  $tryOnly)
  • $aIdent
  • $tryOnly

Documentation generated on Mon, 22 Oct 2007 17:17:19 +0200 by phpDocumentor 1.3.1