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 <?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;
use ICanBoogie\OffsetNotDefined;
/**
* Representation of a database table schema.
*
* @property-read SchemaColumn[] $columns The columns of the schema.
* @property-read array $indexes The indexes of the schema.
* @property-read array $unique_indexes The unique indexes of the schema.
* @property-read array|string $primary The primary key of the schema. The primary key is an
* array if it uses multiple columns.
*/
class Schema implements \ArrayAccess, \IteratorAggregate
{
use AccessorTrait;
/**
* @var SchemaColumn[]
*/
protected $columns = [];
/**
* @return SchemaColumn[]
*/
protected function get_columns()
{
return $this->columns;
}
/**
* Returns the primary key of the schema.
*
* @return array|string|null A multi-dimensional primary key is returned as an array.
*/
protected function get_primary()
{
$primary = [];
foreach ($this->columns as $column_id => $column)
{
if (!$column->primary)
{
continue;
}
$primary[] = $column_id;
}
switch (count($primary))
{
case 0: return null;
case 1: return reset($primary);
default: return $primary;
}
}
/**
* Returns the indexes of the schema.
*
* @return array
*/
protected function get_indexes()
{
return $this->collect_indexes_by_type('indexed');
}
/**
* Returns unique indexes.
*
* @return array
*/
protected function get_unique_indexes()
{
return $this->collect_indexes_by_type('unique');
}
/**
* @param array $options Schema options.
*/
public function __construct(array $options)
{
foreach ($options as $column_id => $column_options)
{
$this[$column_id] = $column_options;
}
}
/**
* Checks if a column exists.
*
* @param string $column_id Column identifier.
*
* @return bool
*/
public function offsetExists($column_id)
{
return isset($this->columns[$column_id]);
}
/**
* Returns a column.
*
* @param string $column_id
*
* @return SchemaColumn
*
* @throws OffsetNotDefined if the column is not defined.
*/
public function offsetGet($column_id)
{
if (!$this->offsetExists($column_id))
{
throw new OffsetNotDefined([ $column_id, $this ]);
}
return $this->columns[$column_id];
}
/**
* Adds a column to the schema.
*
* @param string $column_id
* @param string|array|SchemaColumn $column_options
*/
public function offsetSet($column_id, $column_options)
{
if (is_string($column_options))
{
$column_options = [ $column_options ];
}
if (!$column_options instanceof SchemaColumn)
{
$column_options = new SchemaColumn($column_options);
}
$this->columns[$column_id] = $column_options;
}
/**
* Removes a column from the schema.
*
* @param string $column_id
*/
public function offsetUnset($column_id)
{
unset($this->columns[$column_id]);
}
/**
* Returns columns iterator.
*
* @return \ArrayIterator
*/
public function getIterator()
{
return new \ArrayIterator($this->columns);
}
/**
* Collect index name by type.
*
* @param string $type One of [ "indexed, "unique" ].
*
* @return array
*/
private function collect_indexes_by_type($type)
{
$indexes = [];
foreach ($this->columns as $column_id => $column)
{
$name = $column->$type;
if (!$name)
{
continue;
}
$indexes[ $name === true ? $column_id : $name ][] = $column_id;
}
return $indexes;
}
/**
* Filters values according to the schema columns.
*
* @param array $values
*
* @return array
*/
public function filter(array $values)
{
return array_intersect_key($values, $this->columns);
}
}