Blame view

vendor/yiisoft/yii2/web/CacheSession.php 3.42 KB
abf1649b   andryeyev   Чистая установка ...
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
  <?php
  /**
   * @link http://www.yiiframework.com/
   * @copyright Copyright (c) 2008 Yii Software LLC
   * @license http://www.yiiframework.com/license/
   */
  
  namespace yii\web;
  
  use Yii;
  use yii\caching\Cache;
  use yii\di\Instance;
  
  /**
   * CacheSession implements a session component using cache as storage medium.
   *
   * The cache being used can be any cache application component.
   * The ID of the cache application component is specified via [[cache]], which defaults to 'cache'.
   *
   * Beware, by definition cache storage are volatile, which means the data stored on them
   * may be swapped out and get lost. Therefore, you must make sure the cache used by this component
   * is NOT volatile. If you want to use database as storage medium, [[DbSession]] is a better choice.
   *
   * The following example shows how you can configure the application to use CacheSession:
   * Add the following to your application config under `components`:
   *
   * ~~~
   * 'session' => [
   *     'class' => 'yii\web\CacheSession',
   *     // 'cache' => 'mycache',
   * ]
   * ~~~
   *
   * @property boolean $useCustomStorage Whether to use custom storage. This property is read-only.
   *
   * @author Qiang Xue <qiang.xue@gmail.com>
   * @since 2.0
   */
  class CacheSession extends Session
  {
      /**
       * @var Cache|array|string the cache object or the application component ID of the cache object.
       * The session data will be stored using this cache object.
       *
       * After the CacheSession object is created, if you want to change this property,
       * you should only assign it with a cache object.
       *
       * Starting from version 2.0.2, this can also be a configuration array for creating the object.
       */
      public $cache = 'cache';
  
  
      /**
       * Initializes the application component.
       */
      public function init()
      {
          parent::init();
          $this->cache = Instance::ensure($this->cache, Cache::className());
      }
  
      /**
       * Returns a value indicating whether to use custom session storage.
       * This method overrides the parent implementation and always returns true.
       * @return boolean whether to use custom storage.
       */
      public function getUseCustomStorage()
      {
          return true;
      }
  
      /**
       * Session read handler.
       * Do not call this method directly.
       * @param string $id session ID
       * @return string the session data
       */
      public function readSession($id)
      {
          $data = $this->cache->get($this->calculateKey($id));
  
          return $data === false ? '' : $data;
      }
  
      /**
       * Session write handler.
       * Do not call this method directly.
       * @param string $id session ID
       * @param string $data session data
       * @return boolean whether session write is successful
       */
      public function writeSession($id, $data)
      {
          return $this->cache->set($this->calculateKey($id), $data, $this->getTimeout());
      }
  
      /**
       * Session destroy handler.
       * Do not call this method directly.
       * @param string $id session ID
       * @return boolean whether session is destroyed successfully
       */
      public function destroySession($id)
      {
          return $this->cache->delete($this->calculateKey($id));
      }
  
      /**
       * Generates a unique key used for storing session data in cache.
       * @param string $id session variable name
       * @return mixed a safe cache key associated with the session variable name
       */
      protected function calculateKey($id)
      {
          return [__CLASS__, $id];
      }
  }