Iris CRM documentation
\

\IrisSession

Класс для работы с сессией

Сессия создается при входе в систему и завершается в момент выхода из ситсемы (разлогинивания). Сессию целесообразно использовать для экономии ресурсов. В сессии целесообразно хранить параметры, которые с большой вероятностью не поменяются в процессе работы пользователя. Этот класс выполнен по шаблону Singleton.

Summary

Methods
Properties
Constants
getInstance()
exists()
get()
set()
userLogin()
userId()
userName()
language()
templateName()
useOktell()
useOktellVoice()
useOktellPanel()
No public properties found
No constants found
No protected methods found
No protected properties found
N/A
No private methods found
No private properties found
N/A

Methods

getInstance()

getInstance() : \IrisSession

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

Returns

\IrisSession —

Единственный экземпляр

Пример

  $Session = IrisSession::getInstance();
  $language = $Session->language();

exists()

exists(string$parameter_name) : bool

Проверить наличие параметра в сессии

Parameters

string $parameter_name

Название параметра

Returns

bool —

true, если параметр в сессии присутствует, иначе - false.

get()

get(string$parameter_name) : mixed|null

Получить значение параметра сессии

Parameters

string $parameter_name

Название параметра

Returns

mixed|null —

Значение параметра. Если параметр не найден, то null. Поэтому, чтобы различить случаи, когда параметр в сессии отсутствует и когда он равен null, используйте метод exists().

Пример

  $Session = IrisSession::getInstance();
  $Session->set('myparam', 'test value');
  if ($Session->exists('myparam')) {
      $myparam = $Session->get('myparam');
  }
  else {
      return false;
  }

set()

set(string$parameter_name, mixed$value) : void

Присвоить значение параметру сессии

Parameters

string $parameter_name

Название параметра
mixed $value

Значение параметра

userLogin()

userLogin() : string

Логин текущего пользователя

Более предпочтительный вариант - IrisUser::property('login')

Returns

string —

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

userId()

userId() : string

Идентификатор текущего пользователя (id в iris_contact)

Более предпочтительный вариант - IrisUser::property('id')

Returns

string —

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

userName()

userName() : string

Имя (ФИО) текущего пользователя (name в iris_contact)

Более предпочтительный вариант - IrisUser::property('name')

Returns

string —

ФИО пользователя

language()

language() : string

Получить текущий язык интерфейса

Этот параметр устанавливается в момент логина в систему. Язык по умолчанию настраивается в settings.xml.

Returns

string —

Текущий язык интерфейса (ru, en, de, ...)

templateName()

templateName() : string

Получить название текущего шаблона

Этот параметр устанавливается в момент логина в систему. Шаблон по умолчанию настраивается в settings.xml.

Returns

string —

Название шаблона (classic, bootstrap, ...)

useOktell()

useOktell() : bool

Используем ли Oktell

Этот параметр устанавливается в момент логина в систему. Значение параметра настраивается в settings.xml.

Returns

bool

useOktellVoice()

useOktellVoice() : bool

Используем ли Oktell voice

Этот параметр устанавливается в момент логина в систему. Значение параметра настраивается в settings.xml.

Returns

bool

useOktellPanel()

useOktellPanel() : bool

Используем ли Oktell panel

Этот параметр устанавливается в момент логина в систему. Значение параметра настраивается в settings.xml.

Returns

bool