Версия: 6.x
burger close
Открытые статические члены | Поля данных | Защищенные статические члены | Статические защищенные данные
Класс Auth

Подробное описание

Класс, содржит методы - авторизовать, получить текущего пользователя, сбросить авторизацию, перебросить на авторизацию.

Открытые статические члены

static staticInit ()
 
static checkUserRight ($needGroup=null, $needAdmin=false)
 
static login ($login, $pass, $remember=false, $pass_encrypted=false, $no_set_current_user=false)
 
static onSuccessLogin ($user, $remember=false)
 
static getUserByLogin ($login)
 
static loginByCookie ($auth_ticket)
 
static getAuthTicket (User $user)
 
static getError ()
 
static logout ()
 
static isAuthorize ()
 
static getCurrentUser ()
 
static getGuestId ()
 
static generateGuestId ()
 
static setCurrentUser (User $user)
 

Поля данных

const COOKIE_AUTH_TICKET = 'user_ticket'
 
const COOKIE_GUEST_ID = 'guest'
 
const COOKIE_AUTH_TICKET_LIFETIME = 63072000
 

Защищенные статические члены

static getSecretNumber ()
 

Статические защищенные данные

static $session_var = 'user_id'
 
static $user
 
static $error = ''
 
static $try_ticket = true
 

Методы

static checkUserRight (   $needGroup = null,
  $needAdmin = false 
)
static

Возвращает true, в случае если у пользователя хватает запрошенных прав, иначе - текст ошибки, если пользователь неавторизован - то пустая строка

Аргументы
string$needGroup- alias требуемой у пользователя группы
bool$needAdmin- требуется наличие группы с пометкой "Администратор"
Возвращает
boolean (true) | string
static generateGuestId ( )
static

Генерирует уникальный ID браузера один раз за PHP сессию. Этот ID будет сохраняться у пользователя на прояжении 2х лет.

Возвращает
string
static getAuthTicket ( User  $user)
static

Возвращает уникальный идентификатор пользователя, по которому тот сможет авторизоваться

Аргументы
\Users\Model\Orm\User$user- пользователь
Возвращает
string
static getCurrentUser ( )
static

Возвращает объект текущего пользователя

Возвращает
static getError ( )
static

Возвращает причину, по которой не удалось авторизоваться или восстановить пароль

Возвращает
string
static getGuestId ( )
static

Возвращает ID гостя (или ID браузера). Этот ID будет оставаться неизменным у пользователя, если он пользуется одним и тем же браузером.

Возвращает
string
static getSecretNumber ( )
staticprotected

Возвращает цифру, основанную на секретном ключе, который задан в настройках

Возвращает
integer
static getUserByLogin (   $login)
static

Возвращает пользователя по логину, согласно настройкам авторизации в системе

Аргументы
string$loginлогин пользователя
Возвращает
bool|
static isAuthorize ( )
static

Возвращает true, если пользователь авторизован, иначе false

Возвращает
boolean
static login (   $login,
  $pass,
  $remember = false,
  $pass_encrypted = false,
  $no_set_current_user = false 
)
static

Авторизовывает пользователя по логину и паролю.

Аргументы
string$login- логин
string$pass- пароль
boolean$remember- если true, значит будет задействован функция "запомнить меня"
bool$pass_encrypted- если true, значит аргументом $pass передан hash пароля, иначе ожидается пароль в открытом виде
bool$no_set_current_user- если установлено true, то метод просто возвращает true или false, при этом не устанавливает пользователя в сессию
Возвращает
bool|User - Возвращает true если авторизация прошла успешно. Если $no_set_current_user = true, возвращается объект пользователя в случае успеха.
Исключения
\RS\Event\Exception
\RS\Orm\Exception
\Users\Model\Exception\UsersLog
static loginByCookie (   $auth_ticket)
static

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

Аргументы
string$auth_ticket- идентификатор, установленны в cookie
Возвращает
boolean
Исключения
\RS\Orm\Exception
static logout ( )
static

Отменяет авторизацию.

static onSuccessLogin (   $user,
  $remember = false 
)
static

Устанавливает флаг "Запомнить меня" в cookie браузера, а также вызывает событие об успешной авторизации user.auth

Аргументы
User$userобъект авторизованного пользователя
bool$rememberЕсли true, то значит будет установлена cookie для автоавторизации
Возвращает
bool
static setCurrentUser ( User  $user)
static

Обновляет текущего пользователя в сессии.

Аргументы
\Users\Model\Orm\User$user
Возвращает
void
static staticInit ( )
static

Инициализирует класс авторизации

Исключения
\RS\Orm\Exception

Поля

$error = ''
staticprotected
$session_var = 'user_id'
staticprotected
$try_ticket = true
staticprotected
$user
staticprotected
const COOKIE_AUTH_TICKET = 'user_ticket'
const COOKIE_AUTH_TICKET_LIFETIME = 63072000
const COOKIE_GUEST_ID = 'guest'