energine
[ class tree: energine ] [ index: energine ] [ all elements ]

Class: User

Source Location: /framework/User.class.php

Class Overview

Object
   |
   --DBWorker
      |
      --User

Класс для работы с пользователем Возвращает информацию о пользователе, сохраняет данные


Author(s):

  • dr.Pavka

Variables

Constants

Methods


Child classes:

AuthUser
Аутентифицированный пользователь.

Inherited Constants

Inherited Variables

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:   dr.Pavka


[ Top ]


Class Variables

$id =  false

[line 42]

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



Tags:

access:   private

Type:   int


[ Top ]

$info = array()

[line 57]

Информация о пользователе



Tags:

access:   private

Type:   array


[ Top ]

$userGroup =

[line 49]

Объект по работе с пользователями



Tags:

access:   protected

Type:   UserGroup


[ Top ]



Class Methods


static method generatePassword [line 236]

static string generatePassword( [int $length = 8])

Генерирует пароль заданной длины из случайных буквенно-цифровых символов.



Tags:

access:   public


Parameters:

int   $length  

[ Top ]

constructor __construct [line 65]

void __construct( [int $id = false])

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



Tags:

access:   public


Overridden in child classes as:

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

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

Parameters:

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

[ Top ]

method create [line 148]

void create( array $data)

Создание нового пользователя



Tags:

access:   public


Parameters:

array   $data  

[ Top ]

method getFields [line 136]

array getFields( )

Возвращает перечень полей



Tags:

access:   public


[ Top ]

method getGroups [line 99]

mixed getGroups( )

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



Tags:

access:   public


[ Top ]

method getID [line 112]

mixed getID( )

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



Tags:

access:   public


[ Top ]

method getValue [line 122]

mixed getValue( $fieldName)

Возвращает значение поля



Tags:

access:   public


Parameters:

   $fieldName  

[ Top ]

method loadInfo [line 83]

void loadInfo( int $UID)

Загрузка информации из БД



Tags:

access:   protected


Parameters:

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

[ Top ]

method setGroups [line 209]

void setGroups( array $groups)

Устанавливает перечень групп в которые будет входить пользователь



Tags:

access:   public


Parameters:

array   $groups  

[ Top ]

method update [line 193]

boolean update( array $data)

Обновление данных о пользователе



Tags:

access:   public


Parameters:

array   $data  

[ Top ]


Class Constants

GROUP_TABLE_NAME =  'user_user_groups'

[line 34]

Имя таблицы групп


[ Top ]

USER_TABLE_NAME =  'user_users'

[line 28]

Имя таблицы пользователей


[ Top ]


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