class Cookie

Represents a cookie

@author Johannes M. Schmitt <schmittjoh@gmail.com>

@api

Hierarchy

  • class \Symfony\Component\HttpFoundation\Cookie

Expanded class hierarchy of Cookie

5 files declare their use of Cookie
ClientTest.php in drupal/core/vendor/symfony/http-kernel/Symfony/Component/HttpKernel/Tests/ClientTest.php
CookieTest.php in drupal/core/vendor/symfony/http-foundation/Symfony/Component/HttpFoundation/Tests/CookieTest.php
RequestDataCollector.php in drupal/core/vendor/symfony/http-kernel/Symfony/Component/HttpKernel/DataCollector/RequestDataCollector.php
RequestDataCollectorTest.php in drupal/core/vendor/symfony/http-kernel/Symfony/Component/HttpKernel/Tests/DataCollector/RequestDataCollectorTest.php
ResponseHeaderBagTest.php in drupal/core/vendor/symfony/http-foundation/Symfony/Component/HttpFoundation/Tests/ResponseHeaderBagTest.php
6 string references to 'Cookie'
HttpCache::__construct in drupal/core/vendor/symfony/http-kernel/Symfony/Component/HttpKernel/HttpCache/HttpCache.php
Constructor.
PageCacheTest::testPageCache in drupal/core/modules/system/lib/Drupal/system/Tests/Bootstrap/PageCacheTest.php
Tests cache headers.
Request::addCookie in drupal/core/vendor/guzzle/http/Guzzle/Http/Message/Request.php
Add a Cookie value by name to the Cookie header
Request::getCookies in drupal/core/vendor/guzzle/http/Guzzle/Http/Message/Request.php
Get an array of Cookies
Request::removeCookie in drupal/core/vendor/guzzle/http/Guzzle/Http/Message/Request.php
Remove a specific cookie value by name

... See full list

File

drupal/core/vendor/symfony/http-foundation/Symfony/Component/HttpFoundation/Cookie.php, line 21

Namespace

Symfony\Component\HttpFoundation
View source
class Cookie {
  protected $name;
  protected $value;
  protected $domain;
  protected $expire;
  protected $path;
  protected $secure;
  protected $httpOnly;

  /**
   * Constructor.
   *
   * @param string                   $name     The name of the cookie
   * @param string                   $value    The value of the cookie
   * @param integer|string|\DateTime $expire   The time the cookie expires
   * @param string                   $path     The path on the server in which the cookie will be available on
   * @param string                   $domain   The domain that the cookie is available to
   * @param Boolean                  $secure   Whether the cookie should only be transmitted over a secure HTTPS connection from the client
   * @param Boolean                  $httpOnly Whether the cookie will be made accessible only through the HTTP protocol
   *
   * @api
   */
  public function __construct($name, $value = null, $expire = 0, $path = '/', $domain = null, $secure = false, $httpOnly = true) {

    // from PHP source code
    if (preg_match("/[=,; \t\r\n\v\f]/", $name)) {
      throw new \InvalidArgumentException(sprintf('The cookie name "%s" contains invalid characters.', $name));
    }
    if (empty($name)) {
      throw new \InvalidArgumentException('The cookie name cannot be empty.');
    }

    // convert expiration time to a Unix timestamp
    if ($expire instanceof \DateTime) {
      $expire = $expire
        ->format('U');
    }
    elseif (!is_numeric($expire)) {
      $expire = strtotime($expire);
      if (false === $expire || -1 === $expire) {
        throw new \InvalidArgumentException('The cookie expiration time is not valid.');
      }
    }
    $this->name = $name;
    $this->value = $value;
    $this->domain = $domain;
    $this->expire = $expire;
    $this->path = empty($path) ? '/' : $path;
    $this->secure = (bool) $secure;
    $this->httpOnly = (bool) $httpOnly;
  }

  /**
   * Returns the cookie as a string.
   *
   * @return string The cookie
   */
  public function __toString() {
    $str = urlencode($this
      ->getName()) . '=';
    if ('' === (string) $this
      ->getValue()) {
      $str .= 'deleted; expires=' . gmdate("D, d-M-Y H:i:s T", time() - 31536001);
    }
    else {
      $str .= urlencode($this
        ->getValue());
      if ($this
        ->getExpiresTime() !== 0) {
        $str .= '; expires=' . gmdate("D, d-M-Y H:i:s T", $this
          ->getExpiresTime());
      }
    }
    if ('/' !== $this->path) {
      $str .= '; path=' . $this->path;
    }
    if (null !== $this
      ->getDomain()) {
      $str .= '; domain=' . $this
        ->getDomain();
    }
    if (true === $this
      ->isSecure()) {
      $str .= '; secure';
    }
    if (true === $this
      ->isHttpOnly()) {
      $str .= '; httponly';
    }
    return $str;
  }

  /**
   * Gets the name of the cookie.
   *
   * @return string
   *
   * @api
   */
  public function getName() {
    return $this->name;
  }

  /**
   * Gets the value of the cookie.
   *
   * @return string
   *
   * @api
   */
  public function getValue() {
    return $this->value;
  }

  /**
   * Gets the domain that the cookie is available to.
   *
   * @return string
   *
   * @api
   */
  public function getDomain() {
    return $this->domain;
  }

  /**
   * Gets the time the cookie expires.
   *
   * @return integer
   *
   * @api
   */
  public function getExpiresTime() {
    return $this->expire;
  }

  /**
   * Gets the path on the server in which the cookie will be available on.
   *
   * @return string
   *
   * @api
   */
  public function getPath() {
    return $this->path;
  }

  /**
   * Checks whether the cookie should only be transmitted over a secure HTTPS connection from the client.
   *
   * @return Boolean
   *
   * @api
   */
  public function isSecure() {
    return $this->secure;
  }

  /**
   * Checks whether the cookie will be made accessible only through the HTTP protocol.
   *
   * @return Boolean
   *
   * @api
   */
  public function isHttpOnly() {
    return $this->httpOnly;
  }

  /**
   * Whether this cookie is about to be cleared
   *
   * @return Boolean
   *
   * @api
   */
  public function isCleared() {
    return $this->expire < time();
  }

}

Members

Namesort descending Modifiers Type Description Overrides
Cookie::$domain protected property
Cookie::$expire protected property
Cookie::$httpOnly protected property
Cookie::$name protected property
Cookie::$path protected property
Cookie::$secure protected property
Cookie::$value protected property
Cookie::getDomain public function Gets the domain that the cookie is available to.
Cookie::getExpiresTime public function Gets the time the cookie expires.
Cookie::getName public function Gets the name of the cookie.
Cookie::getPath public function Gets the path on the server in which the cookie will be available on.
Cookie::getValue public function Gets the value of the cookie.
Cookie::isCleared public function Whether this cookie is about to be cleared
Cookie::isHttpOnly public function Checks whether the cookie will be made accessible only through the HTTP protocol.
Cookie::isSecure public function Checks whether the cookie should only be transmitted over a secure HTTPS connection from the client.
Cookie::__construct public function Constructor.
Cookie::__toString public function Returns the cookie as a string.