25.3. Продвинутое использование
Пред. | Глава 25. Zend_Session | След.

## 25.3. Продвинутое использование

Хотя базовое использование является совершенно допустимым вариантом использования сессий Zend Framework, стоит рассмотреть другие возможности их использования. См. пример на `Zend_Auth`, который по умолчанию неявно использует Zend_Session_Namespace для сохранения меток аутентификации. Этот пример показывает один из способов быстрой и легкой интеграции Zend_Session_Namespace и Zend_Auth.

### 25.3.1. Старт сессии

Если вы хотите, чтобы все запросы имели сессии и использовали сессии Zend Framework, то стартуйте сессию в файле загрузки:

Пример 25.6. Старт общей сессии

    <?php
    ...
    require_once 'Zend/Session.php';
    Zend_Session::start();
    ...
    ?>

Стартуя сессию в файле загрузки, вы исключаете вероятность того, что старт сессии произойдет после того, как заголовки будут отправлены броузеру, что вызвовет исключение и, возможно, отображение испорченной страницы посетителю сайта. Некоторые расширенные возможности Zend_Session требуют вызова `Zend_Session_Core::start()` в начале (больше о расширенных возможностях будет написано позднее).

Есть четыре способа стартовать сессию, используя Zend_Session. Два из них - неправильные.

- 1. Неправильно: Устанавливать опцию session.auto_start в php.ini или .htaccess (http://www.php.net/manual/en/ref.session.php#ini.session.auto-start). Если вы не имеете возможность отключить эту опцию в php.ini, то, если используется mod_php (или его эквивалент) и в php.ini уже установлена эта опция, добавьте строку `php_value session.auto_start 0` в ваш файл .htaccess (обычно находится в корневой директории для HTML-документов).

- 2. Неправильно: Непосредственно использовать функцию `session_start()`. Если вы вызываете `session_start()` напрямую и начинаете использование Zend_Session_Namespace, то при вызове метода `Zend_Session::start()` будет сгенерировано исключение ("session has already been started"). Если вы вызываете `session_start()` после использования Zend_Session_Namespace или явного вызова `Zend_Session::start()`, то будет сгенерирована ошибка уровня E_NOTICE и проигнорирован вызов функции.

- 3. Правильно: Используйте `Zend_Session::start()`. Если необходимо, чтобы все запросы имели и использовали сессии, то поместите вызов этой функции в коде загрузки близко к точке входа и без условной логики. При этом присутствуют некоторые издержки за счет сессий. Если для одних запросов нужны сессии, а для других - нет, то:

  - Установите опцию `strict` в true (см. `Zend_Session::setOptions()`) в коде загрузки.

  - Вызывайте `Zend_Session::start()` только при тех запросах, для которых нужны сессии, и до того, как будет произведен первый вызов `new Zend_Session_Namespace()`.

  - Используйте `new Zend_Session_Namespace()` как обычно и там, где это нужно, но при этом необходимо убедиться, что `Zend_Session::start()` был вызван ранее.

  Опция `strict` предотвращает автоматический старт сессии с использованием `Zend_Session::start()` при вызове `new Zend_Session_Namespace()`. Эта опция помогает разработчикам пользовательских областей приложений ZF следовать принятому при проектировании решению не использовать сессии для определенных запросов, т.к. при установке этой опции и последующем инстанцировании Zend_Session_Namespace до явного вызова `Zend_Session::start()` будет сгенерировано исключение. Не используйте эту опцию в коде библиотек ZF, поскольку проектные решения должны принимать только разработчики пользовательской области. Аналогичным образом, все разработчики "библиотек" должны осторожно подходить к использованию `Zend_Session::setOptions()` в коде их библиотек, поскольку эти опции имеют глобальную область действия (как и лежащие в основе опции расширения ext/session).

- 4. Правильно: Просто используйте `new Zend_Session_Namespace()` где необходимо, и сессия будет автоматически запущена в Zend_Session. Это наиболее простой вариант использования, подходящий для большинства случаев. Но необходимо будет следить за тем, чтобы первый вызов `new Zend_Session_Namespace()()` всегда происходил до того, как выходные данные будут отправлены клиенту (т.е. до того, как агенту пользователя будут отправлены HTTP-заголовки), если используются основанные на куках сессии (очень рекомендуется). Использование буферизации вывода может быть удачным решением, при этом может быть улучшена производительность. Например, в `php.ini` "`output_buffering = 65535`" включает буферизацию вывода с размером буфера 64K.

### 25.3.2. Блокировка пространств имен

Можно применять блокировку к пространствам имен для предотвращения изменения данных в этом пространстве имен. Используйте метод `Zend_Session_Namespace::lock()` для того, чтобы сделать определенное пространство имен доступным только для чтения, `unLock()` - чтобы сделать пространство имен доступным для чтения и изменений, а `isLocked()` для проверки того, не было ли пространство имен заблокировано ранее. Блокировка не сохраняется от одного запроса к другому. Блокировка пространства имен не действует на методы установки (setter methods) в объектах, сохраненных в пространстве имен, но предотвращает использование методов установки пространства имен сессии для удаления или замены объектов, сохраненных непосредственно в пространстве имен. Также блокирование пространств имен Zend_Session_Namespace не препятствует использованию ссылок на те же данные (см. PHP references).

Пример 25.7. Блокировка пространств имен

    <?php
        // assuming:
        $userProfileNamespace = new Zend_Session_Namespace('userProfileNamespace');

        // marking session as read only locked
        $userProfileNamespace->lock();

        // unlocking read-only lock
        if ($userProfileNamespace->isLocked()) {
            $userProfileNamespace->unLock();
        }
    ?>

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

Пример 25.8. Блокировка сессий в видах

    <?php
    class FooModule_View extends Zend_View
    {
        public function show($name)
        {
            if (!isset($this->mySessionNamespace)) {
                $this->mySessionNamespace = Zend::registry('FooModule');
            }

            if ($this->mySessionNamespace->isLocked()) {
                return parent::render($name);
            }

            $this->mySessionNamespace->lock();
            $return = parent::render($name);
            $this->mySessionNamespace->unLock();

            return $return;
        }
    }
    ?>

### 25.3.3. Инкапсуляция сессий и контроллеры

Пространства имен могут также использоваться для разделения доступа контроллеров к сессиям, чтобы защитить переменные от повреждения. Например, контроллер 'Zend_Auth' может хранить свои постоянные данные сессии отдельно от всех остальных контроллеров.

Пример 25.9. Сессии с пространствами имен для контроллеров с автоматическим истечением времени

    <?php
    require_once 'Zend/Session.php';
    // контроллер для вывода вопроса
    $testSpace = new Zend_Session_Namespace('testSpace');
    // установка времени жизни только для этой переменной
    $testSpace->setExpirationSeconds(300, "accept_answer");
    $testSpace->accept_answer = true;

    --

    // контроллер для обработки ответа на вопрос
    $testSpace = new Zend_Session_Namespace('testSpace');

    if ($testSpace->accept_answer === true) {
        // время не истекло
    }
    else {
        // время истекло
    }
    ?>

### 25.3.4. Ограничение количества экземпляров Zend_Session_Namespace до одного на каждое пространство имен

Мы рекомендуем использовать блокировку сессии (см. выше) вместо этой функциональной возможности, которая накладывает дополнительное бремя на разработчика, состоящее в передаче экземпляров Zend_Session_Namespace во все функции и объекты, нуждающихся в использовании этих пространств имен.

Когда создается первый экземпляр Zend_Session_Namespace, связанный с определенным пространством имен, вы можете дать команду Zend_Session_Namespace больше не создавать объекты для этого пространства имен. Таким образом, в дальнейшем попытка создать экземпляр Zend_Session_Namespace для того же пространства имен вызовет генерацию исключения. Это поведение является опциональным и не принято по умолчанию, но остается доступным для тех, кто предпочитает передавать по коду единственный объект для каждого пространства имен. Это повышает защиту пространства имен от изменений компонентами, которые не должны делать этого, поскольку тогда они не будут иметь свободного доступа к пространствам имен. Тем не менее, ограничение пространства имен до одного экземпляра модет привести к большему объему кода или к его усложнению, поскольку он отменяет возможность использования директив вида `$aNamespace = new Zend_Session_Namespace('aNamespace');` после того, как был создан первый экземпляр. Это продемонстрировано в примере ниже:

Пример 25.10. Ограничение до единичных экземпляров

    <?php
        require_once 'Zend/Session.php';
        $authSpaceAccessor1 = new Zend_Session_Namespace('Zend_Auth');
        $authSpaceAccessor2 = new Zend_Session_Namespace('Zend_Auth', Zend_Session_Namespace::SINGLE_INSTANCE);
        $authSpaceAccessor1->foo = 'bar';
        assert($authSpaceAccessor2->foo, 'bar');
        doSomething($options, $authSpaceAccessor2);
        .
        .
        .
        $aNamespaceObject = new Zend_Session_Namespace('Zend_Auth'); // это вызовет ошибку
    ?>

Второй параметр в конструкторе выше говорит Zend_Session, что в будущем создание любых других экземпляров Zend_Session_Namespace с пространством имен 'Zend_Auth' не допустимо. Поскольку директиву `new Zend_Session_Namespace('Zend_Auth')` нельзя использовать после того, как будет выполнен приведенный выше код, то разработчику нужно будет где-либо сохранять объект (`$authSpaceAccessor2` в примере выше), если в дальнейшем при обработке того же запроса необходим доступ к этому пространству имен сессии. Например, вы можете сохранять экземпляр в статической переменной или передавать его другим методам, которым нужен доступ к данному пространству имен.

### 25.3.5. Работа с массивами в пространствах имен

Изменение массива внутри пространства имен невозможно. Простейшим решением является сохранение массивов после того, как все желаемые значения были установлены. ZF-800 подтверждает известный баг, затрагивающий многие PHP-приложения, использующие "магические" методы и массивы.

Пример 25.11. Известные проблемы с массивами

    <?php
        $sessionNamespace = new Zend_Session_Namespace('Foo');
        $sessionNamespace->array = array();
        $sessionNamespace->array['testKey'] = 1; // Не работает в версиях ниже PHP 5.2.1
    ?>

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

Пример 25.12. Обходной путь: извлечение, изменение и сохранение

    <?php
        $sessionNamespace = new Zend_Session_Namespace('Foo');
        $sessionNamespace->array = array('tree' => 'apple');
        $tmp = $sessionNamespace->array;
        $tmp['fruit'] = 'peach';
        $sessionNamespace->array = $tmp;
    ?>

Можно также сохранить массив, содержащий ссылку на желаемый массив и косвенно работать с ним.

Пример 25.13. Обходной путь: сохранение массива, содержащего ссылку

    <?php
        $myNamespace = new Zend_Session_Namespace('mySpace');

        // работает даже с версиями PHP, содержащими баг
        $a = array(1,2,3);
        $myNamespace->someArray = array( & $a ) ;
        $a['foo'] = 'bar';
    ?>

### 25.3.6. Использование сессий вместе с аутентификацией

Если ваш адаптер аутентификации для `Zend_Auth` возвращает результат, в котором идетификатором авторизации является объект (не рекомендуется) вместо массива, то выполняйте проверку класса идентификатора авторизации до того, как стартовать сессию. Вместо этого мы рекомендуем хранить идентификаторы авторизации, вычисленные в адаптере авторизации, под хорошо известным ключом в пространстве имен сессии. Например, по умолчанию `Zend_Auth` размещает идентификаторы под ключом 'storage' пространства имен 'Zend_Auth'.

Если вы приказали `Zend_Auth` не сохранять метку сессии в сессиях, то можете вручную сохранить ID авторизации под хорошо известным ключом в любом пространстве имен сессии на ваш выбор. Часто приложения имеют особые требования к тому, где хранить "мандат" (учетная запись с праметрами доступа пользователя) и идентификатор авторизации. Приложения часто устанавливают соответствие идентификаторов аутентификации (например, имена пользователей) и идентификаторов авторизации (например, присвоенное уникальное целое число) во время аутентификации, которая должна производится в методе `authenticate()` адаптера аутентификации Zend_Auth.

Пример 25.14. Пример: Простой доступ к ID авторизации

    <?php
        // pre-authentication request
        require_once 'Zend/Auth/Result.php';
        require_once 'Zend/Auth/Adapter/Digest.php';
        $adapter = new Zend_Auth_Adapter_Digest($filename, $realm, $username, $password);
        $result = $adapter->authenticate();
        require_once 'Zend/Session/Namespace.php';
        $namespace = Zend_Session_Namespace('Zend_Auth');
        if ($result->isValid()) {
            $namespace->authorizationId = $result->getIdentity();
            $namespace->date = time();
        } else {
            $namespace->attempts++;
        }

        // subsequent requests
        require_once 'Zend/Session.php';
        Zend_Session::start();
        $namespace = Zend_Session_Namespace('Zend_Auth');

        echo "Valid: ", (empty($namespace->authorizationId) ? 'No' : 'Yes'), "\n"';
        echo "Authorization / user Id: ", (empty($namespace->authorizationId)
            ? 'none' : print_r($namespace->authorizationId, true)), "\n"';
        echo "Authentication attempts: ", (empty($namespace->attempts)
            ? '0' : $namespace->attempts), "\n"';
        echo "Authenticated on: ",
            (empty($namespace->date) ? 'No' : date(DATE_ATOM, $namespace->date), "\n"';
    ?>

### 25.3.7. Использование сессий с юнит-тестами

Zend Framework использует PHPUnit для своего тестирования. Многие разработчики расширяют существующие наборы юнит-тестов для покрытия кода в своих приложениях. Если при выполнении юнит-тестирований после завершения сессии были использованы любые связанные с записью методы, то генерируется исключение "Zend_Session is currently marked as read-only" ("Zend_Session помечен как доступный только для чтения"). Тем не менее, юнит-тесты, использующие Zend_Session, требуют особого внимания, поскольку закрытие (`Zend_Session::writeClose()`) или уничтожение сессии (`Zend_Session::destroy()`) не дает впоследствии устанавливать или сбрасывать ключи в любом объекте Zend_Session_Namespace. Это поведение является прямым следствием использования лежащего в основе мехнанизма расширения ext/session и функций `session_destroy()` и `session_write_close()`, которые не имеют механизма "отмены" для облегчения установки/демонтажа в юнит-тестировании.

Чтобы обойти это, см. юнит-тест `testSetExpirationSeconds()` в `tests/Zend/Session/SessionTest.php` и `SessionTestHelper.php`, которые используют `exec()` для запуска отдельного процесса. Новый процесс более точно имитирует второй, последующий, запрос из броузера. Отдельный процесс начинается с "чистой" сессии, так же, как при выполнении любого PHP-скрипта для веб-запроса. Кроме этого, любые изменения в `$_SESSION[]`, произведенные при вызове процесса, становятся доступными и в дочернем процессе, что дает родительскому процессу возможность закрыть сессию до использования `exec()`.

Пример 25.15. Использование PHPUnit для тестирования кода, написанного с использованием Zend_Session*

    <?php
            // testing setExpirationSeconds()
            require 'tests/Zend/Session/SessionTestHelper.php'; // also see SessionTest.php in trunk/
            $script = 'SessionTestHelper.php';
            $s = new Zend_Session_Namespace('space');
            $s->a = 'apple';
            $s->o = 'orange';
            $s->setExpirationSeconds(5);

            Zend_Session::regenerateId();
            $id = Zend_Session::getId();
            session_write_close(); // release session so process below can use it
            sleep(4); // not long enough for things to expire
            exec($script . "expireAll $id expireAll", $result);
            $result = $this->sortResult($result);
            $expect = ';a === apple;o === orange;p === pear';
            $this->assertTrue($result === $expect,
                "iteration over default Zend_Session namespace failed; expecting result === '$expect', but got '$result'");

            sleep(2); // long enough for things to expire (total of 6 seconds waiting, but expires in 5)
            exec($script . "expireAll $id expireAll", $result);
            $result = array_pop($result);
            $this->assertTrue($result === '',
                "iteration over default Zend_Session namespace failed; expecting result === '', but got '$result')");
            session_start(); // resume artificially suspended session

            // We could split this into a separate test, but actually, if anything leftover from above
            // contaminates the tests below, that is also a bug that we want to know about.
            $s = new Zend_Session_Namespace('expireGuava');
            $s->setExpirationSeconds(5, 'g'); // now try to expire only 1 of the keys in the namespace
            $s->g = 'guava';
            $s->p = 'peach';
            $s->p = 'plum';

            session_write_close(); // release session so process below can use it
            sleep(6); // not long enough for things to expire
            exec($script . "expireAll $id expireGuava", $result);
            $result = $this->sortResult($result);
            session_start(); // resume artificially suspended session
            $this->assertTrue($result === ';p === plum',
                "iteration over named Zend_Session namespace failed (result=$result)");
    ?>

Пред. | Уровень выше | След.
25.2. Базовое использование | Начало | 25.4. Общее управление сессиями