Home  >  Article  >  Backend Development  >  php Cookies operation class

php Cookies operation class

黄舟
黄舟Original
2017-02-18 09:14:492016browse

Cookies Operation Class

Function:

1. Save , read, update, clear cookie data.

2. Prefix can be set.

3. Forced timeout control.

4. Cookies data can be strings, arrays, objects, etc.


##Cookies.class.php

##

<?php
/** Cookies class 保存,读取,更新,清除cookies数据。可设置前缀。强制超时。数据可以是字符串,数组,对象等。
*   Date:   2013-12-22
*   Author: fdipzone
*   Ver:    1.0
*
*   Func:
*   public   set        设置cookie
*   public   get        读取cookie
*   public   update     更新cookie
*   public   clear      清除cookie
*   public   setPrefix  设置前缀
*   public   setExpire  设置过期时间
*   private  authcode   加密/解密
*   private  pack       将数据打包
*   private  unpack     将数据解包
*   private  getName    获取cookie name,增加prefix处理
*/

class Cookies{ // class start

    private $_prefix = &#39;&#39;;                                                  // cookie prefix
    private $_securekey = &#39;ekOt4_Ut0f3XE-fJcpBvRFrg506jpcuJeixezgPNyALm&#39;;   // encrypt key
    private $_expire = 3600;                                                // default expire


    /** 初始化
    * @param String $prefix     cookie prefix
    * @param int    $expire     过期时间
    * @param String $securekey  cookie secure key
    */
    public function __construct($prefix=&#39;&#39;, $expire=0, $securekey=&#39;&#39;){

        if(is_string($prefix) && $prefix!=&#39;&#39;){
            $this->_prefix = $prefix;
        }

        if(is_numeric($expire) && $expire>0){
            $this->_expire = $expire;
        }

        if(is_string($securekey) && $securekey!=&#39;&#39;){
            $this->_securekey = $securekey;
        }

    }


    /** 设置cookie
    * @param String $name   cookie name
    * @param mixed  $value  cookie value 可以是字符串,数组,对象等
    * @param int    $expire 过期时间
    */
    public function set($name, $value, $expire=0){

        $cookie_name = $this->getName($name);
        $cookie_expire = time() + ($expire? $expire : $this->_expire);
        $cookie_value = $this->pack($value, $cookie_expire);
        $cookie_value = $this->authcode($cookie_value, &#39;ENCODE&#39;);

        if($cookie_name && $cookie_value && $cookie_expire){
            setcookie($cookie_name, $cookie_value, $cookie_expire);
        }

    }


    /** 读取cookie
    * @param  String $name   cookie name
    * @return mixed          cookie value
    */
    public function get($name){

        $cookie_name = $this->getName($name);

        if(isset($_COOKIE[$cookie_name])){

            $cookie_value = $this->authcode($_COOKIE[$cookie_name], &#39;DECODE&#39;);
            $cookie_value = $this->unpack($cookie_value);

            return isset($cookie_value[0])? $cookie_value[0] : null;

        }else{
            return null;
        }

    }


    /** 更新cookie,只更新内容,如需要更新过期时间请使用set方法
    * @param  String $name   cookie name
    * @param  mixed  $value  cookie value
    * @return boolean
    */
    public function update($name, $value){

        $cookie_name = $this->getName($name);

        if(isset($_COOKIE[$cookie_name])){

            $old_cookie_value = $this->authcode($_COOKIE[$cookie_name], &#39;DECODE&#39;);
            $old_cookie_value = $this->unpack($old_cookie_value);

            if(isset($old_cookie_value[1]) && $old_cookie_value[1]>0){ // 获取之前的过期时间

                $cookie_expire = $old_cookie_value[1];

                // 更新数据
                $cookie_value = $this->pack($value, $cookie_expire);
                $cookie_value = $this->authcode($cookie_value, &#39;ENCODE&#39;);

                if($cookie_name && $cookie_value && $cookie_expire){
                    setcookie($cookie_name, $cookie_value, $cookie_expire);
                    return true;
                }

            }

        }

        return false;

    }


    /** 清除cookie
    * @param  String $name   cookie name
    */
    public function clear($name){

        $cookie_name = $this->getName($name);
        setcookie($cookie_name);

    }


    /** 设置前缀
    * @param String $prefix cookie prefix
    */
    public function setPrefix($prefix){

        if(is_string($prefix) && $prefix!=&#39;&#39;){
            $this->_prefix = $prefix;
        }

    }


    /** 设置过期时间
    * @param int $expire cookie expire
    */
    public function setExpire($expire){

        if(is_numeric($expire) && $expire>0){
            $this->_expire = $expire;
        }

    }


    /** 获取cookie name
    * @param  String $name
    * @return String
    */
    private function getName($name){
        return $this->_prefix? $this->_prefix.&#39;_&#39;.$name : $name;
    }


    /** pack
    * @param  Mixed  $data      数据
    * @param  int    $expire    过期时间 用于判断
    * @return
    */
    private function pack($data, $expire){

        if($data===&#39;&#39;){
            return &#39;&#39;;
        }

        $cookie_data = array();
        $cookie_data[&#39;value&#39;] = $data;
        $cookie_data[&#39;expire&#39;] = $expire;
        return json_encode($cookie_data);

    }


    /** unpack
    * @param  Mixed  $data 数据
    * @return              array(数据,过期时间)
    */
    private function unpack($data){

        if($data===&#39;&#39;){
            return array(&#39;&#39;, 0);
        }

        $cookie_data = json_decode($data, true);

        if(isset($cookie_data[&#39;value&#39;]) && isset($cookie_data[&#39;expire&#39;])){

            if(time()<$cookie_data[&#39;expire&#39;]){ // 未过期
                return array($cookie_data[&#39;value&#39;], $cookie_data[&#39;expire&#39;]);
            }

        }

        return array(&#39;&#39;, 0);

    }

    /** 加密/解密数据
    * @param  String $str       原文或密文
    * @param  String $operation ENCODE or DECODE
    * @return String            根据设置返回明文活密文
    */
    private function authcode($string, $operation = &#39;DECODE&#39;){

        $ckey_length = 4;   // 随机密钥长度 取值 0-32;

        $key = $this->_securekey;

        $key = md5($key);
        $keya = md5(substr($key, 0, 16));
        $keyb = md5(substr($key, 16, 16));
        $keyc = $ckey_length ? ($operation == &#39;DECODE&#39; ? substr($string, 0, $ckey_length): substr(md5(microtime()), -$ckey_length)) : &#39;&#39;;

        $cryptkey = $keya.md5($keya.$keyc);
        $key_length = strlen($cryptkey);

        $string = $operation == &#39;DECODE&#39; ? base64_decode(substr($string, $ckey_length)) : sprintf(&#39;%010d&#39;, 0).substr(md5($string.$keyb), 0, 16).$string;
        $string_length = strlen($string);

        $result = &#39;&#39;;
        $box = range(0, 255);

        $rndkey = array();
        for($i = 0; $i <= 255; $i++) {
            $rndkey[$i] = ord($cryptkey[$i % $key_length]);
        }

        for($j = $i = 0; $i < 256; $i++) {
            $j = ($j + $box[$i] + $rndkey[$i]) % 256;
            $tmp = $box[$i];
            $box[$i] = $box[$j];
            $box[$j] = $tmp;
        }

        for($a = $j = $i = 0; $i < $string_length; $i++) {
            $a = ($a + 1) % 256;
            $j = ($j + $box[$a]) % 256;
            $tmp = $box[$a];
            $box[$a] = $box[$j];
            $box[$j] = $tmp;
            $result .= chr(ord($string[$i]) ^ ($box[($box[$a] + $box[$j]) % 256]));
        }

        if($operation == &#39;DECODE&#39;) {
            if((substr($result, 0, 10) == 0 || substr($result, 0, 10) - time() > 0) && substr($result, 10, 16) == substr(md5(substr($result, 26).$keyb), 0, 16)) {
                return substr($result, 26);
            } else {
                return &#39;&#39;;
            }
        } else {
            return $keyc.str_replace(&#39;=&#39;, &#39;&#39;, base64_encode($result));
        }

    }

} // class end

?>


demo.php


##
<?php
require &#39;Cookies.class.php&#39;;

$type = isset($_GET[&#39;type&#39;])? strtolower($_GET[&#39;type&#39;]) : &#39;&#39;;

if(!in_array($type, array(&#39;set&#39;,&#39;get&#39;,&#39;update&#39;,&#39;clear&#39;))){
    exit(&#39;type not exists&#39;);
}

$obj = new Cookies(&#39;member&#39;, 10); // obj

switch($type){

    case &#39;set&#39;: // 设置
        $data = array(
            &#39;name&#39; => &#39;fdipzone&#39;,
            &#39;gender&#39; => &#39;male&#39;
        );
        $obj->set(&#39;me&#39;, $data, 5);
        echo &#39;set cookies&#39;;
        break;

    case &#39;get&#39;: // 读取
        $result = $obj->get(&#39;me&#39;);

        echo &#39;<pre class="brush:php;toolbar:false">&#39;;
        print_r($result);
        echo &#39;
'; echo 'get cookies'; break; case 'update': // 更新 $data = array( 'name' => 'angelababy', 'gender' => 'female' ); $flag = $obj->update('me', $data); if($flag){ echo 'update cookies success'; }else{ echo 'update cookies false'; } break; case 'clear': // 清除 $obj->clear('me'); echo 'clear cookies'; break; } ?>



The above is the content of php Cookies operation class. For more related content, please pay attention to the PHP Chinese website (www .php.cn)!


Statement:
The content of this article is voluntarily contributed by netizens, and the copyright belongs to the original author. This site does not assume corresponding legal responsibility. If you find any content suspected of plagiarism or infringement, please contact admin@php.cn