Class: UserGroup

Source Location: /framework/UserGroup.class.php

Class Overview

Object
   |
   --DBWorker
      |
      --UserGroup

Группы пользователей.

Author(s):

1m.dm

Variables

Methods

Inherited Constants

Class: Object

Object::CONFIG_DIR
Object::CONFIG_FILE

Inherited Variables

Class: DBWorker

DBWorker::$dbh
DBWorker::$dbhInstance
DBWorker::$translations

Class: Object

Object::$executionTime
Object::$systemConfig
Object::$values

Inherited Methods

Class: DBWorker

DBWorker::__construct(): Конструктор класса.
DBWorker::dateToString(): Дата прописью Обертка над DBWorker::_dateToString
DBWorker::translate(): Нестатический метод-обёртка над DBWorker::_translate - для удобства использования внутри производных классов.
DBWorker::_dateToString(): Возвращает дату в виде строки прописью
DBWorker::_translate(): Возвращает перевод текстовой константы из таблицы переводов для указанного языка. Если язык явно не указан - используется текущий язык.

Class: Object

Object::__construct(): Пустой конструктор
Object::getConfigValue(): Нестатический метод-обёртка над Object::_getConfigValue - для удобства использования внутри производных классов.
Object::getTimer(): Возвращает значение счетчика времени выполнения.
Object::resetTimer(): Сбрасывает счетчик времени, возвращает предыдущее значение счетчика
Object::startTimer(): Запускает счетчик времени выполнения.
Object::stopTimer(): Останавливает счетчик времени выполнения.
Object::_getConfigValue(): Возвращает значение указанного параметра конфигурации.

Class Details

[line 23]
Группы пользователей.

Tags:

author:	1m.dm
final:

[ Top ]

Class Variables

static $instance =

[line 49]

Tags:

var:	единый для всей системы экземпляр класса UserGroup
access:	private

Type:

UserGroup

[ Top ]

$defaultGuestGroup = false

[line 29]

Tags:

var:	идентификатор группы для гостей
access:	private

Type:

int

[ Top ]

$defaultUserGroup = false

[line 35]

Tags:

var:	идентификатор группы для аутентифицированных пользователей
access:	private

Type:

int

[ Top ]

$groups =

[line 42]

Tags:

var:	информация о всех существующих группах пользователей
see:	UserGroup::__construct()
access:	private

Type:

array

[ Top ]

Class Methods

static method getInstance [line 76]

static UserGroup getInstance(
)

Возвращает единый для всей системы экземпляр класса UserGroup.

См. паттерн проектирования Singleton.

Tags:

access:

public

[ Top ]

constructor __construct [line 57]

void __construct(
)

Конструктор класса.

Tags:

access:

public

Overrides DBWorker::__construct() (Конструктор класса.)

[ Top ]

method asArray [line 90]

array asArray(
)

Возвращает перечень групп

Tags:

access:

public

[ Top ]

method getDefaultGuestGroup [line 100]

int getDefaultGuestGroup(
)

Возвращает идентификатор группы для гостей.

Tags:

access:

public

[ Top ]

method getDefaultUserGroup [line 123]

int getDefaultUserGroup(
)

Возвращает идентификатор группы для аутентифицированных пользователей.

Tags:

access:

public

[ Top ]

method getInfo [line 168]

array getInfo(

$groupId)

Возвращает информацию о группе.

Tags:

access:

public

Parameters:

$groupId

[ Top ]

method getMembers [line 183]

array getMembers(

$groupID)

Возвращает перечень идентификаторов пользователей в группе

Tags:

access:

public

Parameters:

$groupID

[ Top ]

method getUserGroups [line 147]

array getUserGroups(
[int
$userId = false])

Возвращает набор групп, к которым принадлежит пользователь.

Tags:

access:

public

Parameters:

int

$userId

идентификатор пользователя

[ Top ]

В создании документации нам помог: phpDocumentor