mirror of
https://github.com/YunoHost-Apps/z-push_ynh.git
synced 2024-09-03 18:05:58 +02:00
268 lines
No EOL
7.9 KiB
PHP
268 lines
No EOL
7.9 KiB
PHP
<?php
|
|
/***********************************************
|
|
* File : stateobject.php
|
|
* Project : Z-Push
|
|
* Descr : simple data object with some php magic
|
|
*
|
|
* Created : 02.01.2012
|
|
*
|
|
* Copyright 2007 - 2013 Zarafa Deutschland GmbH
|
|
*
|
|
* This program is free software: you can redistribute it and/or modify
|
|
* it under the terms of the GNU Affero General Public License, version 3,
|
|
* as published by the Free Software Foundation with the following additional
|
|
* term according to sec. 7:
|
|
*
|
|
* According to sec. 7 of the GNU Affero General Public License, version 3,
|
|
* the terms of the AGPL are supplemented with the following terms:
|
|
*
|
|
* "Zarafa" is a registered trademark of Zarafa B.V.
|
|
* "Z-Push" is a registered trademark of Zarafa Deutschland GmbH
|
|
* The licensing of the Program under the AGPL does not imply a trademark license.
|
|
* Therefore any rights, title and interest in our trademarks remain entirely with us.
|
|
*
|
|
* However, if you propagate an unmodified version of the Program you are
|
|
* allowed to use the term "Z-Push" to indicate that you distribute the Program.
|
|
* Furthermore you may use our trademarks where it is necessary to indicate
|
|
* the intended purpose of a product or service provided you use it in accordance
|
|
* with honest practices in industrial or commercial matters.
|
|
* If you want to propagate modified versions of the Program under the name "Z-Push",
|
|
* you may only do so if you have a written permission by Zarafa Deutschland GmbH
|
|
* (to acquire a permission please contact Zarafa at trademark@zarafa.com).
|
|
*
|
|
* This program is distributed in the hope that it will be useful,
|
|
* but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
|
* GNU Affero General Public License for more details.
|
|
*
|
|
* You should have received a copy of the GNU Affero General Public License
|
|
* along with this program. If not, see <http://www.gnu.org/licenses/>.
|
|
*
|
|
* Consult LICENSE file for details
|
|
************************************************/
|
|
|
|
class StateObject implements Serializable {
|
|
private $SO_internalid;
|
|
protected $data = array();
|
|
protected $unsetdata = array();
|
|
protected $changed = false;
|
|
|
|
/**
|
|
* Returns the unique id of that data object
|
|
*
|
|
* @access public
|
|
* @return array
|
|
*/
|
|
public function GetID() {
|
|
if (!isset($this->SO_internalid))
|
|
$this->SO_internalid = sprintf('%04x%04x%04x', mt_rand(0, 0xffff), mt_rand(0, 0xffff), mt_rand(0, 0xffff));
|
|
|
|
return $this->SO_internalid;
|
|
}
|
|
|
|
/**
|
|
* Returns the internal array which contains all data of this object
|
|
*
|
|
* @access public
|
|
* @return array
|
|
*/
|
|
public function GetDataArray() {
|
|
return $this->data;
|
|
}
|
|
|
|
/**
|
|
* Sets the internal array which contains all data of this object
|
|
*
|
|
* @param array $data the data to be written
|
|
* @param boolean $markAsChanged (opt) indicates if the object should be marked as "changed", default false
|
|
*
|
|
* @access public
|
|
* @return array
|
|
*/
|
|
public function SetDataArray($data, $markAsChanged = false) {
|
|
$this->data = $data;
|
|
$this->changed = $markAsChanged;
|
|
}
|
|
|
|
/**
|
|
* Indicates if the data contained in this object was modified
|
|
*
|
|
* @access public
|
|
* @return array
|
|
*/
|
|
public function IsDataChanged() {
|
|
return $this->changed;
|
|
}
|
|
|
|
/**
|
|
* PHP magic to set an instance variable
|
|
*
|
|
* @access public
|
|
* @return
|
|
*/
|
|
public function __set($name, $value) {
|
|
$lname = strtolower($name);
|
|
if (isset($this->data[$lname]) && is_scalar($value) && !is_array($value) && $this->data[$lname] === $value)
|
|
return false;
|
|
|
|
$this->data[$lname] = $value;
|
|
$this->changed = true;
|
|
}
|
|
|
|
/**
|
|
* PHP magic to get an instance variable
|
|
* if the variable was not set previousely, the value of the
|
|
* Unsetdata array is returned
|
|
*
|
|
* @access public
|
|
* @return
|
|
*/
|
|
public function __get($name) {
|
|
$lname = strtolower($name);
|
|
|
|
if (array_key_exists($lname, $this->data))
|
|
return $this->data[$lname];
|
|
|
|
if (isset($this->unsetdata) && is_array($this->unsetdata) && array_key_exists($lname, $this->unsetdata))
|
|
return $this->unsetdata[$lname];
|
|
|
|
return null;
|
|
}
|
|
|
|
/**
|
|
* PHP magic to check if an instance variable is set
|
|
*
|
|
* @access public
|
|
* @return
|
|
*/
|
|
public function __isset($name) {
|
|
return isset($this->data[strtolower($name)]);
|
|
}
|
|
|
|
/**
|
|
* PHP magic to remove an instance variable
|
|
*
|
|
* @access public
|
|
* @return
|
|
*/
|
|
public function __unset($name) {
|
|
if (isset($this->$name)) {
|
|
unset($this->data[strtolower($name)]);
|
|
$this->changed = true;
|
|
}
|
|
}
|
|
|
|
/**
|
|
* PHP magic to implement any getter, setter, has and delete operations
|
|
* on an instance variable.
|
|
* Methods like e.g. "SetVariableName($x)" and "GetVariableName()" are supported
|
|
*
|
|
* @access public
|
|
* @return mixed
|
|
*/
|
|
public function __call($name, $arguments) {
|
|
$name = strtolower($name);
|
|
$operator = substr($name, 0,3);
|
|
$var = substr($name,3);
|
|
|
|
if ($operator == "set" && count($arguments) == 1){
|
|
$this->$var = $arguments[0];
|
|
return true;
|
|
}
|
|
|
|
if ($operator == "set" && count($arguments) == 2 && $arguments[1] === false){
|
|
$this->data[$var] = $arguments[0];
|
|
return true;
|
|
}
|
|
|
|
// getter without argument = return variable, null if not set
|
|
if ($operator == "get" && count($arguments) == 0) {
|
|
return $this->$var;
|
|
}
|
|
|
|
// getter with one argument = return variable if set, else the argument
|
|
else if ($operator == "get" && count($arguments) == 1) {
|
|
if (isset($this->$var)) {
|
|
return $this->$var;
|
|
}
|
|
else
|
|
return $arguments[0];
|
|
}
|
|
|
|
if ($operator == "has" && count($arguments) == 0)
|
|
return isset($this->$var);
|
|
|
|
if ($operator == "del" && count($arguments) == 0) {
|
|
unset($this->$var);
|
|
return true;
|
|
}
|
|
|
|
throw new FatalNotImplementedException(sprintf("StateObject->__call('%s'): not implemented. op: {$operator} args:". count($arguments), $name));
|
|
}
|
|
|
|
/**
|
|
* Method to serialize a StateObject
|
|
*
|
|
* @access public
|
|
* @return array
|
|
*/
|
|
public function serialize() {
|
|
// perform tasks just before serialization
|
|
$this->preSerialize();
|
|
|
|
return serialize(array($this->SO_internalid,$this->data));
|
|
}
|
|
|
|
/**
|
|
* Method to unserialize a StateObject
|
|
*
|
|
* @access public
|
|
* @return array
|
|
* @throws StateInvalidException
|
|
*/
|
|
public function unserialize($data) {
|
|
// throw a StateInvalidException if unserialize fails
|
|
ini_set('unserialize_callback_func', 'StateObject::ThrowStateInvalidException');
|
|
|
|
list($this->SO_internalid, $this->data) = unserialize($data);
|
|
|
|
// perform tasks just after unserialization
|
|
$this->postUnserialize();
|
|
return true;
|
|
}
|
|
|
|
/**
|
|
* Called before the StateObject is serialized
|
|
*
|
|
* @access protected
|
|
* @return boolean
|
|
*/
|
|
protected function preSerialize() {
|
|
// make sure the object has an id before serialization
|
|
$this->GetID();
|
|
|
|
return true;
|
|
}
|
|
|
|
/**
|
|
* Called after the StateObject was unserialized
|
|
*
|
|
* @access protected
|
|
* @return boolean
|
|
*/
|
|
protected function postUnserialize() {
|
|
return true;
|
|
}
|
|
|
|
/**
|
|
* Callback function for failed unserialize
|
|
*
|
|
* @access public
|
|
* @throws StateInvalidException
|
|
*/
|
|
public static function ThrowStateInvalidException() {
|
|
throw new StateInvalidException("Unserialization failed as class was not found or not compatible");
|
|
}
|
|
}
|
|
|
|
?>
|