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 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 <?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\ActiveRecord;
use ICanBoogie\Accessor\AccessorTrait;
/**
* Model collection.
*
* @property-read ConnectionCollection $connections
* @property-read array $definitions
* @property-read Model[] $instances
*/
class ModelCollection implements \ArrayAccess
{
use AccessorTrait;
/**
* Instantiated models.
*
* @var Model[]
*/
protected $instances = [];
protected function get_instances()
{
return $this->instances;
}
/**
* Models definitions.
*
* @var array
*/
protected $definitions = [];
protected function get_definitions()
{
return $this->definitions;
}
/**
* @var ConnectionCollection
*/
protected $connections;
protected function get_connections()
{
return $this->connections;
}
/**
* Initializes the {@link $connections} and {@link $definitions} properties.
*
* @param ConnectionCollection $connections
* @param array $definitions Model definitions.
*/
public function __construct(ConnectionCollection $connections, array $definitions = [])
{
$this->connections = $connections;
foreach ($definitions as $id => $definition)
{
$this[$id] = $definition;
}
}
/**
* Checks if a model is defined.
*
* @param string $id Model identifier.
*
* @return bool
*/
public function offsetExists($id)
{
return isset($this->definitions[$id]);
}
/**
* Sets the definition of a model.
*
* The {@link Model::ID} and {@link Model::NAME} are set to the provided id if they are not
* defined.
*
* @param string $id Model identifier.
* @param array $definition Model definition.
*
* @throws ModelAlreadyInstantiated in attempt to write a model already instantiated.
*/
public function offsetSet($id, $definition)
{
if (isset($this->instances[$id]))
{
throw new ModelAlreadyInstantiated($id);
}
$this->definitions[$id] = $definition + [
Model::ID => $id,
Model::NAME => $id
];
}
/**
* Returns a {@link Model} instance.
*
* @param string $id Model identifier.
*
* @return Model
*
* @throws ModelNotDefined when the model is not defined.
*/
public function offsetGet($id)
{
if (isset($this->instances[$id]))
{
return $this->instances[$id];
}
if (!isset($this->definitions[$id]))
{
throw new ModelNotDefined($id);
}
return $this->instances[$id] = $this
->instantiate_model($this
->resolve_model_attributes($this->definitions[$id]));
}
/**
* Unset the definition of a model.
*
* @param string $id Model identifier.
*
* @throws ModelAlreadyInstantiated in attempt to unset the definition of an already
* instantiated model.
*/
public function offsetUnset($id)
{
if (isset($this->instances[$id]))
{
throw new ModelAlreadyInstantiated($id);
}
unset($this->definitions[$id]);
}
/**
* Resolves model attributes.
*
* The methods replaces {@link Model::CONNECTION} and {@link Model::EXTENDING} identifier
* with instances.
*
* @param array $attributes
*
* @return array
*/
protected function resolve_model_attributes(array $attributes)
{
$attributes += [
Model::CLASSNAME => Model::class,
Model::CONNECTION => 'primary',
Model::EXTENDING => null
];
$connection = &$attributes[Model::CONNECTION];
if ($connection && !($connection instanceof Connection))
{
$connection = $this->connections[$connection];
}
$extending = &$attributes[Model::EXTENDING];
if ($extending && !($extending instanceof Model))
{
$extending = $this[$extending];
}
return $attributes;
}
/**
* Instantiate a model with the specified attributes.
*
* @param array $attributes
*
* @return Model
*/
protected function instantiate_model(array $attributes)
{
$class = $attributes[Model::CLASSNAME];
return new $class($this, $attributes);
}
/**
* Install all the models.
*
* @return ModelCollection
*/
public function install()
{
foreach (array_keys($this->definitions) as $id)
{
$model = $this[$id];
if ($model->is_installed())
{
continue;
}
$model->install();
}
return $this;
}
/**
* Uninstall all the models.
*
* @return ModelCollection
*/
public function uninstall()
{
foreach (array_keys($this->definitions) as $id)
{
$model = $this[$id];
if (!$model->is_installed())
{
continue;
}
$model->uninstall();
}
return $this;
}
/**
* Check if models are installed.
*
* @return array An array of key/value pair where _key_ is a model identifier and
* _value_ `true` if the model is installed, `false` otherwise.
*/
public function is_installed()
{
$rc = [];
foreach (array_keys($this->definitions) as $id)
{
$rc[$id] = $this[$id]->is_installed();
}
return $rc;
}
}