Class: AuthUser

Source Location: /framework/AuthUser.class.php

Inherited Constants

Class: User

User::GROUP_TABLE_NAME
User::USER_TABLE_NAME

Class: Object

Object::CONFIG_DIR
Object::CONFIG_FILE

Inherited Variables

Inherited Methods

Class: User

User::__construct(): Конструктор класса
User::create(): Создание нового пользователя
User::generatePassword(): Генерирует пароль заданной длины из случайных буквенно-цифровых символов.
User::getFields(): Возвращает перечень полей
User::getGroups(): Возвращает перечень групп в которые входит пользователь
User::getID(): Возвращает идентфикатор пользователя
User::getValue(): Возвращает значение поля
User::loadInfo(): Загрузка информации из БД
User::setGroups(): Устанавливает перечень групп в которые будет входить пользователь
User::update(): Обновление данных о пользователе

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 36]

Tags:

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

Type:

AuthUser

[ Top ]

$isJustNowAuthenticated = false

[line 30]

Флаг показывающий залогинился ли пользователь только что

Tags:

access:

private

Type:

bool

[ Top ]

Class Methods

static method getInstance [line 46]

static AuthUser getInstance(
)

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

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

Tags:

access:

public

[ Top ]

constructor __construct [line 62]

void __construct(
[false
$id = false])

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

параметр введен только для избежания strict ошибки

Tags:

todo:	избавиться от hardcoded имен полей формы?
access:	public

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

Parameters:

false

$id

[ Top ]

method authenticate [line 136]

mixed authenticate(
string
$username, string
$password, [boolean
$remember = false])

Аутентифицирует пользователя по его имени и SHA-1 хэшу пароля.

Если флаг $remember установлен в true, при успешной аутентификации клиенту устанавливаются cookie с информацией о его аккаунте на 30 дней, для автоматизации процедуры входа при последующих посещениях сайта. Возвращает флаг успеха аутентификации.

Tags:

access:

public

Parameters:

string	$username	имя пользовате
string	$password	SHA-1 хэш пароля
boolean	$remember

[ Top ]

method clearInfo [line 171]

boolean clearInfo(
)

Очищает всю информацию о пользователе из сессии, cookie.

Tags:

access:

public

[ Top ]

method isAuthenticated [line 119]

boolean isAuthenticated(
)

Возвращает флаг успеха аутентификации: true - пользователь успешно аутентифицирован; false - пользователь является гостем.

Tags:

access:

public

[ Top ]

method isNowAuthenticated [line 107]

bool isNowAuthenticated(
)

Возвращает значение isJustNowAuthenticated

Tags:

access:

public

[ Top ]

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

Class: AuthUser

Class Overview

Author(s):

Variables

Methods

Inherited Constants

Class: User

Class: Object

Inherited Variables

Class: User

Class: DBWorker

Class: Object

Inherited Methods

Class: User

Class: DBWorker

Class: Object

Class Details

Tags:

Class Variables

static $instance =

Tags:

$isJustNowAuthenticated = false

Tags:

Class Methods

static method getInstance [line 46]

Tags:

constructor __construct [line 62]

Tags:

Parameters:

method authenticate [line 136]

Tags:

Parameters:

method clearInfo [line 171]

Tags:

method isAuthenticated [line 119]

Tags:

method isNowAuthenticated [line 107]

Tags: