Blame view

Slim/Http/Cookies.php 3.05 KB
219b8036   luigser   DEEP
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
  <?php
  /**
   * Slim - a micro PHP 5 framework
   *
   * @author      Josh Lockhart <info@slimframework.com>
   * @copyright   2011 Josh Lockhart
   * @link        http://www.slimframework.com
   * @license     http://www.slimframework.com/license
   * @version     2.6.1
   * @package     Slim
   *
   * MIT LICENSE
   *
   * Permission is hereby granted, free of charge, to any person obtaining
   * a copy of this software and associated documentation files (the
   * "Software"), to deal in the Software without restriction, including
   * without limitation the rights to use, copy, modify, merge, publish,
   * distribute, sublicense, and/or sell copies of the Software, and to
   * permit persons to whom the Software is furnished to do so, subject to
   * the following conditions:
   *
   * The above copyright notice and this permission notice shall be
   * included in all copies or substantial portions of the Software.
   *
   * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
   * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
   * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
   * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
   * LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
   * OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
   * WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
   */
  namespace Slim\Http;
  
  class Cookies extends \Slim\Helper\Set
  {
      /**
       * Default cookie settings
       * @var array
       */
      protected $defaults = array(
          'value' => '',
          'domain' => null,
          'path' => null,
          'expires' => null,
          'secure' => false,
          'httponly' => false
      );
  
      /**
       * Set cookie
       *
       * The second argument may be a single scalar value, in which case
       * it will be merged with the default settings and considered the `value`
       * of the merged result.
       *
       * The second argument may also be an array containing any or all of
       * the keys shown in the default settings above. This array will be
       * merged with the defaults shown above.
       *
       * @param string $key   Cookie name
       * @param mixed  $value Cookie settings
       */
      public function set($key, $value)
      {
          if (is_array($value)) {
              $cookieSettings = array_replace($this->defaults, $value);
          } else {
              $cookieSettings = array_replace($this->defaults, array('value' => $value));
          }
          parent::set($key, $cookieSettings);
      }
  
      /**
       * Remove cookie
       *
       * Unlike \Slim\Helper\Set, this will actually *set* a cookie with
       * an expiration date in the past. This expiration date will force
       * the client-side cache to remove its cookie with the given name
       * and settings.
       *
       * @param  string $key      Cookie name
       * @param  array  $settings Optional cookie settings
       */
      public function remove($key, $settings = array())
      {
          $settings['value'] = '';
          $settings['expires'] = time() - 86400;
          $this->set($key, array_replace($this->defaults, $settings));
      }
  }