Библиотека сессии 

Инициализация сессии 

Сессии, как правило доступны глобально с каждой загрузкой страницы, поэтому класс сессии должен быть инициализирован в конструкторе контроллера или он может быть загружен автоматически системой. По большей части класс сессии будет запускаться автоматически в фоновом режиме, так что после инициализации класса можно будет читать, создавать и обновлять сессии при необходимости.

Для инициализации класса сессии вручную в конструкторе контроллера, используйте $this->load->library() метод:

$this->load->library('session');

После загрузки класса сессий, объекты библиотеки будут доступны через:

$this->session

Как работаю сессии? 

При загрузке страницы, класс сессии проверит действительна ли сессия отправленная пользователем в браузере. Если сессия НЕ существует (или не совпадает с сессией созданной на сервере или истекла) новая сессия будет создана и сохранена.

Если сессия существует, её информация будет обновлена. С каждым обновлением, идентификатор сессии может быть сгенерирован при соответствующей настройке.

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

Что такое данные сессии? 

Данные сессии - просто массив, связанный с конкретным ID сессии (куки).

Если вы использовали сессий в PHP ранее, то должны быть знакомы с PHP $_SESSION superglobal (если нет, пожалуйста, прочитайте содержание этой ссылки).

CodeIgniter дает доступ к данным сессии используя те же средства, что использует механизм обработки сессий предусмотренный в PHP. Используя данные сессии так же просто, как манипулирование (чтение, запись и удаление значений) $_SESSION массивом.

Кроме того, CodeIgniter имеет 2 специальных типа данных сессии, которые будут описаны ниже: flashdata и tempdata.

Получение данных сессии 

Любой кусок информации из массива сессии доступен через суперглобальную $_SESSION:

$_SESSION['item']

Или сквозь магический получатель:

$this->session->item

И для обратной совместимости, через userdata() метод:

$this->session->userdata('item');

Где item - это ключ массива, соответствующий пункту, который вы желаете извлеч. Например, чтобы присвоить ранее сохраненный пункт ‘name’ переменной $name следует так:

$name = $_SESSION['name'];

// or:

$name = $this->session->name

// or:

$name = $this->session->userdata('name');

Если вы хотите получить все существующие пользовательские данные, вы можете просто опустить ключ элемента (магический получатель работает только для свойств):

$_SESSION

// или:

$this->session->userdata();

Добавление данных сессии 

Пусть определенный пользователь входит на ваш сайт. После авторизации, можете добавить имя пользователя и email адрес в сессию, что избавит от необходимости запуска запроса к базе данных, когда вам это нужно.

Вы можете просто присваивать данные $_SESSION массиву, как и любой другой переменной. Или как свойство $this->session.

Кроме того, старый способ присвоения его как “userdata” также доступен. Передает в массив ваши новые данные set_userdata() метод:

$this->session->set_userdata($array);

Где $array ассоциативный массив. Вот пример:

$newdata = array(
        'username'  => 'johndoe',
        'email'     => 'johndoe@some-site.com',
        'logged_in' => TRUE
);

$this->session->set_userdata($newdata);

Если вы хотите добавить значения одного пользователя за раз, set_userdata() также поддерживает такой синтаксис:

$this->session->set_userdata('some_name', 'some_value');

Если вы хотите проверить, существует ли значение сессии, просто используйте isset():

// возвращает FALSE если 'some_name' не существует или NULL,
// TRUE в остальных случаях:
isset($_SESSION['some_name'])

Или можете вызвать has_userdata():

$this->session->has_userdata('some_name');

Удаление данных сессии 

Так же, как с любой другой переменной, удаление значения в $_SESSION можно сделать через unset():

unset($_SESSION['some_name']);

// или несколько значений:

unset(
        $_SESSION['some_name'],
        $_SESSION['another_name']
);

Как set_userdata() может использоваться для добавления информации к сессии, unset_userdata() может использоваться, для её удаления, путем передачи ключа сессии. Например, если вы захотели удалить ‘some_name’ из массив данных сессии:

$this->session->unset_userdata('some_name');

Этот метод принимает массив ключей для удаления:

$array_items = array('username', 'email');

$this->session->unset_userdata($array_items);

Flashdata 

CodeIgniter поддерживает “flashdata” или сеанс передачи данных, которые будут доступны только для следующего запроса, а затем удаляются автоматически.

Это может быть очень полезно для разовых уведомлений об ошибках или сообщений о состоянии (например: “Запись 2 удалена”).

Следует отметить, что переменные flashdata обычные переменные сессии, только помеченные определенным образом под ‘__ci_vars’ ключом (пожалуйста, не трогайте его, вас предупредят).

Чтобы отметить существующий элемент как “flashdata”:

$this->session->mark_as_flash('item');

Если вы хотите отметить несколько элементов, как flashdata, просто передайте ключи в виде массива:

$this->session->mark_as_flash(array('item', 'item2'));

Чтобы добавить flashdata:

$_SESSION['item'] = 'value';
$this->session->mark_as_flash('item');

Или, альтернативно, с помощью set_flashdata() метода:

$this->session->set_flashdata('item', 'value');

Вы также можете передать массив в set_flashdata(), таким же образом, как set_userdata().

Чтение данных flashdata такое же, как чтение обычных данных сессии через $_SESSION:

$_SESSION['item']

Если вы хотите быть уверены, что вы читаете “flashdata” (и никакие другие), вы можете также использовать flashdata() метод:

$this->session->flashdata('item');

Или получить массив со всеми flashdata данными, просто опустив ключ:

$this->session->flashdata();

Если вы обнаружите, что вам нужно сохранить переменную flashdata через дополнительный запрос, вы можете сделать это, используя keep_flashdata() метод. Вы можете передать один элемент или массив элементов flashdata.

$this->session->keep_flashdata('item');
$this->session->keep_flashdata(array('item1', 'item2', 'item3'));

Tempdata 

CodeIgniter также поддерживает “tempdata”, или сессии данных с определенным сроком действия. По истечению срока действия или истечения срока действия сессии или при удалении, значение будет автоматически удалено.

Аналогично flashdata, tempdata переменные сессии, помечены определенным ключом ‘__ci_vars’ (и снова, это не трогаем).

Чтобы отметить существующий элемент как “tempdata”, просто передайте свой ключ и время истечения (в секундах!) в mark_as_temp() метод:

// 'item' будет удален через 300 секунд
$this->session->mark_as_temp('item', 300);

Вы можете пометить несколько элементов как tempdata двумя способами, в зависимости от того, хотите ли вы, чтобы все они были одного время истечения или нет:

// Оба 'item' и 'item2' истекают через 300 секунд
$this->session->mark_as_temp(array('item', 'item2'), 300);

// 'item' будет удален через 300 секунд, в то время как 'item2'
// будет удален только через 240 секунд
$this->session->mark_as_temp(array(
        'item'  => 300,
        'item2' => 240
));

Чтобы добавить tempdata:

$_SESSION['item'] = 'value';
$this->session->mark_as_temp('item', 300); // Истекает через 5 минут

Или, альтернативно, с помощью set_tempdata() метода:

$this->session->set_tempdata('item', 'value', 300);

Вы также можете передать массив set_tempdata():

$tempdata = array('newuser' => TRUE, 'message' => 'Thanks for joining!');

$this->session->set_tempdata($tempdata, NULL, $expire);

Читать переменную tempdata, опять же вы можете просто открыть его через суперглобальный массив $_SESSION:

$_SESSION['item']

Если вы хотите быть уверены, что вы читаете “tempdata” (и никакие другие), вы можете также использовать tempdata() метод:

$this->session->tempdata('item');

И конечно же если вы хотите получить все существующие tempdata:

$this->session->tempdata();

Если вам нужно удалить значение tempdata до истечения срока его действия, вы можете удалить его напрямую из $_SESSION массива:

unset($_SESSION['item']);

Однако это не удаляет маркер, сделанный для конкретного элемента tempdata (он будет недействительным в следующем HTTP запросе), поэтому, если вы намерены повторно использовать этот же ключ в том же запросе, поступайте так unset_tempdata():

$this->session->unset_tempdata('item');

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

Для очистки текущей сессии (например, во время выхода из системы), вы можете просто использовать любую PHP функцию session_destroy() или sess_destroy() метож. Оба они делают одно действие:

session_destroy();

// или

$this->session->sess_destroy();

Доступ к метаданным сессии 

В предыдущих версиях CodeIgniter, массив данных сессии включал 4 элемента по умолчанию: ‘session_id’, ‘ip_address’, ‘user_agent’, ‘last_activity’.

Это было обусловлено спецификой работы сессий, но сейчас в этом уже нет необходимости с нашей новой реализацией. Однако, может случиться так, что ваше предыдущее приложение опиралось на эти установки, так вот альтернативные методы доступа к ним:

• session_id: session_id()
• ip_address: $_SERVER['REMOTE_ADDR']
• user_agent: $this->input->user_agent() (неиспользуется сессиями)
• last_activity: Зависит от хранения, не прямолинейно. К сожалению!

Параметры сессии 

Для CodeIgniter обычно, чтобы все работало из коробки. Однако сессии очень чувствительный компонент любого приложения, поэтому некоторые настройки необходимо выполнить. Пожалуйста, не торопитесь, рассмотрите все варианты и их последствия.

Вы найдете следующие настройки сессии, в application/config/config.php файле:

Кроме вышеуказанных значений, куки (cookies) и родные драйвера принимают следующие значения конфигурации классов вводный и безопасности:

Драйверы сессии 

Как уже говорилось, библиотека сессия содержит 4 драйвера или движка хранения, которые можно использовать:

• файлы
• база данных
• redis
• memcached

По умолчанию будет использоваться драйвер файлов при инициализации сессии, потому что это самый безопасный вариант и должен работать везде (так как практически в каждой ОС имеется файловая система).

Любой другой драйвер может быть выбран в строке $config['sess_driver'] файла application/config/config.php, если вы решили сделать это. Имейте это в виду, каждый драйвер имеет свои недостатки, поэтому обязательно ознакомтесь с ними ниже, прежде чем сделать выбор.

Кроме того, вы можете создавать и использовать собственные драйвера, если наши не удовлетворяют ваши потребности.

mkdir /<path to your application directory>/sessions/
chmod 0700 /<path to your application directory>/sessions/
chown www-data /<path to your application directory>/sessions/

$config['sess_driver'] = 'database';
$config['sess_save_path'] = 'ci_sessions';

CREATE TABLE IF NOT EXISTS `ci_sessions` (
        `id` varchar(40) NOT NULL,
        `ip_address` varchar(45) NOT NULL,
        `timestamp` int(10) unsigned DEFAULT 0 NOT NULL,
        `data` blob NOT NULL,
        KEY `ci_sessions_timestamp` (`timestamp`)
);

CREATE TABLE "ci_sessions" (
        "id" varchar(40) NOT NULL,
        "ip_address" varchar(45) NOT NULL,
        "timestamp" bigint DEFAULT 0 NOT NULL,
        "data" text DEFAULT '' NOT NULL
);

CREATE INDEX "ci_sessions_timestamp" ON "ci_sessions" ("timestamp");

// Когда sess_match_ip = TRUE
ALTER TABLE ci_sessions ADD PRIMARY KEY (id, ip_address);

// Когда sess_match_ip = FALSE
ALTER TABLE ci_sessions ADD PRIMARY KEY (id);

// До удаления ранее созданного первичного ключа (используется при изменении параметра)
ALTER TABLE ci_sessions DROP PRIMARY KEY;

$config['sess_driver'] = 'redis';
$config['sess_save_path'] = 'tcp://localhost:6379';

$config['sess_driver'] = 'memcached';
$config['sess_save_path'] = 'localhost:11211';

// localhost будет иметь повышенный приоритет (5),
// по сравнению с 192.0.2.1 с weight равным 1.
$config['sess_save_path'] = 'localhost:11211:5,192.0.2.1:11211:1';

// application/libraries/Session/drivers/Session_dummy_driver.php:

class CI_Session_dummy_driver extends CI_Session_driver implements SessionHandlerInterface
{

        public function __construct(&$params)
        {
                // НЕ забудьте это
                parent::__construct($params);

                // Конфигурация и остальные настройки
        }

        public function open($save_path, $name)
        {
                // Инициализируем механизм установки (подключение)
        }

        public function read($session_id)
        {
                // Чтение данных сессии (если есть), создаем блокировки
        }

        public function write($session_id, $session_data)
        {
                // Создать / обновить данные сессии (она не может существовать!)
        }

        public function close()
        {
                // Снимаем блокировку, закрываем соединение / потоки / и тд.
        }

        public function destroy($session_id)
        {
                // Вызываем close() метод и уничтожаем данные для текущей сессии (порядок может отличаться)
        }

        public function gc($maxlifetime)
        {
                // Удалить данные стекших сессий
        }

}