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

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

Открытые члены
	getPayload ($in_base64=false)

	getAuthKey ()

	getAuthLink ()

	getQrCodeImageLink ($width=300, $height=300, $auth_link=null)

	getExpireLeftSeconds ()

	getUser ()

Открытые статические члены
static	makeByUser (User $user)

static	makeByKey ($key)

Поля данных
const	USER_SEARCH_KEY_LENGTH = 15

const	RANDOM_STRING_LENGTH = 10

Методы

getAuthKey ( )

Возвращает ключ авторизации

Возвращает: string

getAuthLink ( )

Возвращает ссылку на авторизацию на сайте

Возвращает: string

getExpireLeftSeconds ( )

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

Возвращает: integer

getPayload ( $in_base64 = false )

Возвращает полезную нагрузку

Аргументы

bool $in_base64 Если true, то результат будет строка base64

Возвращает: array|string

getQrCodeImageLink	(	$width = `300`,
		$height = `300`,
		$auth_link = `null`
	)

Возвращает ссылку на картинку с QR-кодом для авторизации под текущим пользователем. Зашитая в QR-код ссылка будет действовать ограниченное время.

Аргументы

int	$width	Ширина картинки
int	$height	Высота картинки

Возвращает: string

getUser ( )

Возвращает объект пользователя, связанного с авторизационным ключем

Возвращает: User

static makeByKey ( $key )

static

Создает объект текущего класса по строковому авторизационному ключу

Аргументы

string $key

Возвращает: self

Исключения

Exception

static makeByUser ( User $user )

static

Создает новый ключ авторизации для пользователя

Аргументы

User $user

Возвращает: self

Поля

const RANDOM_STRING_LENGTH = 10

const USER_SEARCH_KEY_LENGTH = 15

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

Открытые члены

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

Поля данных

Методы

Поля