An instance of Cookies operation class implemented by php
- 2021-07-21 07:48:53
- OfStack
This article describes the example of PHP implementation of Cookies operation class and its usage, to share for your reference. The specific analysis is as follows:
1. Functions:
1. Save, read, update and clear cookies data.
2. You can set prefixes.
3. Force timeout control.
4. cookies data can be strings, arrays, objects, and so on.
2. Usage:
The Cookies. class. php class files are as follows:
<?php
/** Cookies class Save , Read , Update , Clear cookies Data. Prefixes can be set. Force timeout. The data can be a string , Array , Objects, and so on.
* Date: 2013-12-22
* Author: fdipzone
* Ver: 1.0
*
* Func:
* public set Settings cookie
* public get Read cookie
* public update Update cookie
* public clear Clear cookie
* public setPrefix Set prefix
* public setExpire Set expiration time
* private authcode Encryption / Decryption
* private pack Packaging data
* private unpack Unpack data
* private getName Get cookie name, Increase prefix Deal with
*/
class Cookies{ // class start
private $_prefix = ''; // cookie prefix
private $_securekey = 'ekOt4_Ut0f3XE-fJcpBvRFrg506jpcuJeixezgPNyALm'; // encrypt key
private $_expire = 3600; // default expire
/** Initialization
* @param String $prefix cookie prefix
* @param int $expire Expired time
* @param String $securekey cookie secure key
*/
public function __construct($prefix='', $expire=0, $securekey=''){
if(is_string($prefix) && $prefix!=''){
$this->_prefix = $prefix;
}
if(is_numeric($expire) && $expire>0){
$this->_expire = $expire;
}
if(is_string($securekey) && $securekey!=''){
$this->_securekey = $securekey;
}
}
/** Settings cookie
* @param String $name cookie name
* @param mixed $value cookie value Can be a string , Array , Object, etc
* @param int $expire Expired time
*/
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, 'ENCODE', $this->_securekey);
if($cookie_name && $cookie_value && $cookie_expire){
setcookie($cookie_name, $cookie_value, $cookie_expire);
}
}
/** Read 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], 'DECODE', $this->_securekey);
$cookie_value = $this->unpack($cookie_value);
return isset($cookie_value[0])? $cookie_value[0] : null;
}else{
return null;
}
}
/** Update cookie, Update content only , If you need to update the expiration time, please use set Method
* @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], 'DECODE', $this->_securekey);
$old_cookie_value = $this->unpack($old_cookie_value);
if(isset($old_cookie_value[1]) && $old_cookie_vlaue[1]>0){ // Gets the previous expiration time
$cookie_expire = $old_cookie_value[1];
// Update data
$cookie_value = $this->pack($value, $cookie_expire);
$cookie_value = $this->authcode($cookie_value, 'ENCODE', $this->_securekey);
if($cookie_name && $cookie_value && $cookie_expire){
setcookie($cookie_name, $cookie_value, $cookie_expire);
return true;
}
}
}
return false;
}
/** Clear cookie
* @param String $name cookie name
*/
public function clear($name){
$cookie_name = $this->getName($name);
setcookie($cookie_name);
}
/** Set prefix
* @param String $prefix cookie prefix
*/
public function setPrefix($prefix){
if(is_string($prefix) && $prefix!=''){
$this->_prefix = $prefix;
}
}
/** Set expiration time
* @param int $expire cookie expire
*/
public function setExpire($expire){
if(is_numeric($expire) && $expire>0){
$this->_expire = $expire;
}
}
/** Get cookie name
* @param String $name
* @return String
*/
private function getName($name){
return $this->_prefix? $this->_prefix.'_'.$name : $name;
}
/** pack
* @param Mixed $data Data
* @param int $expire Expired time Used to judge
* @return
*/
private function pack($data, $expire){
if($data===''){
return '';
}
$cookie_data = array();
$cookie_data['value'] = $data;
$cookie_data['expire'] = $expire;
return json_encode($cookie_data);
}
/** unpack
* @param Mixed $data Data
* @return array( Data , Expired time )
*/
private function unpack($data){
if($data===''){
return array('', 0);
}
$cookie_data = json_decode($data, true);
if(isset($cookie_data['value']) && isset($cookie_data['expire'])){
if(time()<$cookie_data['expire']){ // Not expired
return array($cookie_data['value'], $cookie_data['expire']);
}
}
return array('', 0);
}
/** Encryption / Decrypt data
* @param String $str Original or ciphertext
* @param String $operation ENCODE or DECODE
* @return String Return plaintext live ciphertext according to settings
*/
private function authcode($string, $operation = 'DECODE'){
$ckey_length = 4; // Random key length Value 0-32;
$key = $this->_securekey;
$key = md5($key);
$keya = md5(substr($key, 0, 16));
$keyb = md5(substr($key, 16, 16));
$keyc = $ckey_length ? ($operation == 'DECODE' ? substr($string, 0, $ckey_length): substr(md5(microtime()), -$ckey_length)) : '';
$cryptkey = $keya.md5($keya.$keyc);
$key_length = strlen($cryptkey);
$string = $operation == 'DECODE' ? base64_decode(substr($string, $ckey_length)) : sprintf('%010d', 0).substr(md5($string.$keyb), 0, 16).$string;
$string_length = strlen($string);
$result = '';
$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 == 'DECODE') {
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 '';
}
} else {
return $keyc.str_replace('=', '', base64_encode($result));
}
}
} // class end
?>
The sample program for demo. php is as follows:
<?php
require 'Cookies.class.php';
$type = isset($_GET['type'])? strtolower($_GET['type']) : '';
if(!in_array($type, array('set','get','update','clear'))){
exit('type not exists');
}
$obj = new Cookies('member', 10); // obj
switch($type){
case 'set': // Settings
$data = array(
'name' => 'fdipzone',
'gender' => 'male'
);
$obj->set('me', $data, 5);
echo 'set cookies';
break;
case 'get': // Read
$result = $obj->get('me');
echo '<pre>';
print_r($result);
echo '</pre>';
echo 'get cookies';
break;
case 'update': // 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': // Clear
$obj->clear('me');
echo 'clear cookies';
break;
}
?>
The complete example of this source code click here to download this site.
I hope this article is helpful to everyone's PHP programming.