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

Class: UserSession

Source Location: /framework/UserSession.class.php

Class Overview

Object
   |
   --DBWorker
      |
      --UserSession

Класс управления сеансами пользователей.


Author(s):

  • dr.Pavka

Variables

Constants

Methods


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 21]
Класс управления сеансами пользователей.



Tags:

author:   dr.Pavka
final:  


[ Top ]


Class Variables

static $instance =

[line 68]



Tags:

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

Type:   UserSession


[ Top ]

$dataCache =

[line 88]



Tags:

access:   private

Type:   mixed


[ Top ]

$id =  false

[line 45]



Tags:

var:   идентификатор сеанса в БД
access:   private

Type:   int


[ Top ]

$lifespan =

[line 61]

Используется для настройки времени жизни cookie и сборки мусора.



Tags:

var:   максимальное время жизни сеанса
access:   private

Type:   int


[ Top ]

$name =

[line 80]



Tags:

var:   имя сеанса
access:   private

Type:   string


[ Top ]

$phpSessId =

[line 39]



Tags:

var:   идентификатор сеанса
access:   private

Type:   string


[ Top ]

$tableName =

[line 86]



Tags:

var:   имя таблицы сеансов в БД
access:   private

Type:   string


[ Top ]

$timeout =

[line 53]

Если период между запросами превышает эту величину, сеанс становится недействительным.



Tags:

var:   время ожидания
access:   private

Type:   int


[ Top ]

$userAgent =

[line 74]



Tags:

var:   пользовательский агент
access:   private

Type:   string


[ Top ]



Class Methods


static method getInstance [line 162]

static UserSession getInstance( )

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



Tags:

access:   public


[ Top ]

constructor __construct [line 96]

void __construct( )

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



Tags:

access:   public


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

[ Top ]

method close [line 187]

bool close( )

Закрывает сеанс.



Tags:

access:   public


[ Top ]

method destroy [line 254]

bool destroy( string $phpSessId)

Уничтожает сеанс.



Tags:

access:   public


Parameters:

string   $phpSessId   идентификатор сеанса

[ Top ]

method gc [line 265]

bool gc( int $maxLifeTime)

Сборщик мусора.



Tags:

access:   public


Parameters:

int   $maxLifeTime   максимальное время жизни сеанса

[ Top ]

method getID [line 293]

int getID( )

Возвращает идентификатор сеанса.



Tags:

access:   public


[ Top ]

method open [line 177]

boolean open( string $savePath, string $sessionName)

Открывает сеанс.



Tags:

access:   public


Parameters:

string   $savePath  
string   $sessionName  

[ Top ]

method read [line 200]

mixed read( string $phpSessId)

Читает данные сеанса.

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




Tags:

access:   public


Parameters:

string   $phpSessId   идентификатор сеанса

[ Top ]

method start [line 281]

void start( )

Стартует сеанс.



Tags:

access:   public


[ Top ]

method write [line 242]

mixed write( string $phpSessId, mixed $data)

Записывает данные сеанса.



Tags:

access:   public


Parameters:

string   $phpSessId   идентификатор сеанса
mixed   $data   данные

[ Top ]


Class Constants

DEFAULT_PROBABILITY =  10

[line 33]

Вероятность вызова сборщика мусора.

Вычисляется как DEFAULT_PROBABILITY / session.gc_divisor (defaults to 100). Например, 10 / 100 означает 10%-вероятность вызова СМ.



[ Top ]

DEFAULT_SESSION_NAME =  'NRGNSID'

[line 26]

Имя сеанса по-умолчанию.


[ Top ]


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