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 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 <?php
/*
* This file is part of the ICanBoogie package.
*
* (c) Olivier Laviale <olivier.laviale@gmail.com>
*
* For the full copyright and license information, please view the LICENSE
* file that was distributed with this source code.
*/
namespace ICanBoogie;
use ICanBoogie\Accessor\AccessorReflection;
use ICanBoogie\Accessor\SerializableTrait;
/**
* Together with the {@link Prototype} class the {@link Prototyped} class provides means to
* define getters and setters, as well as define getters, setters, and method at runtime.
*
* The class also provides a method to create instances in the same fashion PDO creates instances
* with the `FETCH_CLASS` mode, that is the properties of the instance are set *before* its
* constructor is invoked.
*/
class Prototyped implements ToArrayRecursive
{
use ToArrayRecursiveTrait;
use PrototypeTrait;
use SerializableTrait;
/**
* Creates a new instance of the class using the supplied properties.
*
* The method tries to create the instance in the same fashion as [PDO](http://www.php.net/manual/en/book.pdo.php)
* with the `FETCH_CLASS` mode, that is the properties of the instance are set *before* its
* constructor is invoked.
*
* @param array $properties Properties to be set before the constructor is invoked.
* @param array $construct_args Arguments passed to the constructor.
* @param string|null $class_name The name of the instance class. If empty, the name of the
* called class is used.
*
* @return mixed The new instance.
*/
static public function from($properties = null, array $construct_args = [], $class_name = null)
{
if (!$class_name)
{
$class_name = get_called_class();
}
$class_reflection = self::get_class_reflection($class_name);
if (!$properties)
{
return $class_reflection->newInstanceArgs($construct_args);
}
$instance = $class_reflection->newInstanceWithoutConstructor();
if ($instance instanceof self)
{
$instance->assign($properties);
}
else
{
foreach ($properties as $property => $value)
{
$instance->$property = $value;
}
}
if ($class_reflection->hasMethod('__construct') && is_callable([ $instance, '__construct' ]))
{
call_user_func_array([ $instance, '__construct' ], $construct_args);
}
return $instance;
}
static private $class_reflection_cache = [];
/**
* Returns cached class reflection.
*
* @param string $class_name
*
* @return \ReflectionClass
*/
static private function get_class_reflection($class_name)
{
if (isset(self::$class_reflection_cache[$class_name]))
{
return self::$class_reflection_cache[$class_name];
}
return self::$class_reflection_cache[$class_name] = new \ReflectionClass($class_name);
}
/**
* Returns the public properties of an instance.
*
* @param mixed $object
*
* @return array
*/
static private function get_object_vars($object)
{
static $get_object_vars;
if (!$get_object_vars)
{
$get_object_vars = \Closure::bind(function($object) {
return get_object_vars($object);
}, null, Prototype\Dummy::class); // Because `stdClass` is a no-no in PHP7
}
return $get_object_vars($object);
}
/**
* The method returns an array of key/key pairs.
*
* Properties for which a lazy getter is defined are discarded. For instance, if the property
* `next` is defined and the class of the instance defines the getter `lazy_get_next()`, the
* property is discarded.
*
* Note that façade properties are also included.
*
* Warning: The code used to export private properties seams to produce frameless exception on
* session close. If you encounter this problem you might want to override the method. Don't
* forget to remove the prototype property!
*
* @return array
*/
public function __sleep()
{
$keys = $this->accessor_sleep();
unset($keys['prototype']);
return $keys;
}
/**
* Assigns properties to an object.
*
* @param array $properties The properties to assign.
*
* @return $this
*/
public function assign(array $properties)
{
foreach ($properties as $property => $value)
{
$this->$property = $value;
}
return $this;
}
/**
* Converts the object into an array.
*
* Only public properties and façade properties are included.
*
* @return array
*/
public function to_array()
{
$array = self::get_object_vars($this);
foreach (array_keys(AccessorReflection::resolve_facade_properties($this)) as $name)
{
$array[$name] = $this->$name;
}
return $array;
}
/**
* Converts the object into a JSON string.
*
* @return string
*/
public function to_json()
{
return json_encode($this->to_array_recursive());
}
}