Overview

Namespaces

  • LeanCloud
    • Engine
    • Operation
    • Storage
    • Uploader

Classes

  • LeanCloud\ACL
  • LeanCloud\AppRouter
  • LeanCloud\Bytes
  • LeanCloud\Client
  • LeanCloud\Engine\Cloud
  • LeanCloud\Engine\LaravelEngine
  • LeanCloud\Engine\LeanEngine
  • LeanCloud\Engine\SlimEngine
  • LeanCloud\File
  • LeanCloud\GeoPoint
  • LeanCloud\LeanObject
  • LeanCloud\MIMEType
  • LeanCloud\Operation\ArrayOperation
  • LeanCloud\Operation\DeleteOperation
  • LeanCloud\Operation\IncrementOperation
  • LeanCloud\Operation\RelationOperation
  • LeanCloud\Operation\SetOperation
  • LeanCloud\Push
  • LeanCloud\Query
  • LeanCloud\Region
  • LeanCloud\Relation
  • LeanCloud\Role
  • LeanCloud\RouteCache
  • LeanCloud\SaveOption
  • LeanCloud\SMS
  • LeanCloud\Storage\CookieStorage
  • LeanCloud\Storage\SessionStorage
  • LeanCloud\Uploader\QCloudUploader
  • LeanCloud\Uploader\QiniuUploader
  • LeanCloud\Uploader\S3Uploader
  • LeanCloud\Uploader\SimpleUploader
  • LeanCloud\User

Interfaces

  • LeanCloud\Operation\IOperation
  • LeanCloud\Storage\IStorage

Exceptions

  • LeanCloud\BatchRequestError
  • LeanCloud\CloudException
  • LeanCloud\Engine\FunctionError
  • Overview
  • Namespace
  • Class
  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: 
<?php

namespace LeanCloud\Storage;

/**
 * Cookie Storage
 *
 * Persist key value in client (web browser) cookies.
 *
 * Notes:
 *
 * 1. Since it uses PHP built-in setcookie, set value will fail
 *    after headers being sent.
 * 2. There are limits on number of bytes per cookie, and number of
 *    keys per client.
 * 3. And other caveats with setcookie.
 *
 * @see http://php.net/manual/en/function.setcookie.php
 */
class CookieStorage implements IStorage {
    /**
     * Domain scope for cookie availability.
     *
     * @var string
     */
    private $domain;

    /**
     * Path scope for cookie availability.
     *
     * @var string
     */
    private $path;

    /**
     * When to expire the cookie.
     *
     * It is number of seconds since epoch time.
     *
     * @var int
     */
    private $expireIn;

    /**
     * Initilize cookie storage
     *
     * @param int    $seconds Number of seconds to live
     * @param string $path    Cookie path scope
     * @param string $domain  Cookie domain scope
     */
    public function __construct($seconds=0, $path="/", $domain=null) {
        if ($seconds <= 0) {
            // default to 7 days from now
            $seconds = 60 * 60 * 24 * 7;
        }
        $this->expireIn = time() + $seconds;
        $this->path     = $path;
        $this->domain   = $domain;
    }

    /**
     * Set value by key
     *
     * @param string $key
     * @param mixed  $val
     * @param int    $seconds Number of seconds to live
     * @return $this
     */
    public function set($key, $val, $seconds=null) {
        $expire = $seconds ? (time() + seconds) : $this->expireIn;
        setcookie($key, $val, $expire, $this->path, $this->domain);
    }

    /**
     * Get value by key
     *
     * @param string $key
     * @return mixed
     */
    public function get($key) {
        if (isset($_COOKIE[$key])) {
            return $_COOKIE[$key];
        }
        return null;
    }

    /**
     * Remove key from storage
     *
     * @param string $key
     */
    public function remove($key) {
        setcookie($key, false, 1);
    }

    /**
     * Clear all data in storage
     *
     * @throws RuntimeException
     */
    public function clear() {
        throw new \RuntimeException("Not implemented error.");
    }
}

API documentation generated by ApiGen