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: 274: 275: 276: 277: 278: 279: 280: 281: 282: 283: 284: 285: 286: 287: 288: 289: 290: 291: 292: 293: 294: 295: 296: 297: 298: 299: 300: 301: 302: 303: 304: 305: 306: 307: 308: 309: 310: 311: 312: 313: 314: 315: 316: 317: 318: 319: 320: 321: 322: 323: 324: 325: 326: 327: 328: 329: 330: 331: 332: 333: 334: 335: 336: 337: 338: 339: 340: 341: 342: 343: 344: 345: 346: 347: 348: 349: 350: 351: 352: 353: 354: 355: 356: 357: 358: 359: 360: 361: 362: 363: 364: 365: 366: 367: 368: 369: 370: 371: 372: 373: 374: 375: 376: 377: 378: 379: 380: 381: 382: 383: 384: 385: 386: 387: 388: 389: 390: 391: 392: 393: 394: 395: 396: 397: 398: 399: 400: 401: 402: 403: 404: 405: 406: 407: 408: 409: 410: 411: 412: 413: 414: 415: 416: 417: 418: 419: 420: 421: 422: 423: 424: 425: 426: 427: 428: 429: 430: 431: 432: 433: 434: 435: 436: 437: 438: 439: 440: 441: 442: 443: 444: 445: 446: 447: 448: 449: 450: 451: 452: 453: 454: 455: 456: 457: 458: 459: 460: 461: 462: 463: 464: 465: 466: 467: 468: 469: 470: 471: 472: 473: 474: 475: 476: 477: 478: 479: 480: 481: 

<?php

/**
 * This file is part of the Lean Mapper library (http://www.leanmapper.com)
 *
 * Copyright (c) 2013 Vojtěch Kohout (aka Tharos)
 *
 * For the full copyright and license information, please view the file
 * license-mit.txt that was distributed with this source code.
 */

namespace LeanMapper;

use Closure;
use DibiConnection;
use DibiFluent;
use LeanMapper\Exception\InvalidArgumentException;
use LeanMapper\Exception\InvalidMethodCallException;
use LeanMapper\Exception\InvalidValueException;
use LeanMapper\Exception\MemberAccessException;
use LeanMapper\Exception\RuntimeException;
use LeanMapper\Reflection\EntityReflection;
use LeanMapper\Reflection\Property;
use LeanMapper\Relationship;
use LeanMapper\Row;
use ReflectionMethod;
use Traversable;

/**
 * Base class for custom entities
 *
 * @author Vojtěch Kohout
 */
abstract class Entity
{

    /** @var Row */
    protected $row;

    /** @var EntityReflection[] */
    protected static $reflections = array();

    /** @var array */
    private $internalGetters = array('getData', 'getRowData', 'getModifiedRowData', 'getReflection');


    /**
     * @param Row|Traversable|array|null $arg
     * @throws InvalidArgumentException
     */
    public function __construct($arg = null)
    {
        if ($arg instanceof Row) {
            if ($arg->isDetached()) {
                throw new InvalidArgumentException('It is not allowed to create entity from detached instance of LeanMapper\Row.');
            }
            $this->row = $arg;
        } else {
            $this->row = Result::getDetachedInstance()->getRow();
            if ($arg !== null) {
                if (!is_array($arg) and !($arg instanceof Traversable)) {
                    throw new InvalidArgumentException('Argument $arg in entity constructor must be either null, array, instance of LeanMapper\Row or instance of Traversable, ' . gettype($arg) . ' given.');
                }
                $this->assign($arg);
            }
        }
    }

    /**
     * Returns value of given field
     *
     * @param string $name
     * @return mixed
     * @throws InvalidValueException
     * @throws MemberAccessException
     * @throws RuntimeException
     */
    public function __get($name/*, array $filterArgs*/)
    {
        $property = $this->getReflection()->getEntityProperty($name);
        if ($property === null) {
            $method = 'get' . ucfirst($name);
            $internalGetters = array_flip($this->internalGetters);
            if (method_exists($this, $method) and !isset($internalGetters[$method])) {  // TODO: find better solution (using reflection)
                return call_user_func(array($this, $method)); // $filterArgs are not relevant here
            }
            throw new MemberAccessException("Undefined property: $name");
        }
        $column = $property->getColumn();
        if ($property->isBasicType()) {
            $value = $this->row->$column;
            if ($value === null) {
                if (!$property->isNullable()) {
                    throw new InvalidValueException("Property '$name' cannot be null.");
                }
                return null;
            }
            if (!settype($value, $property->getType())) {
                throw new InvalidValueException("Cannot convert value '$value' to " . $property->getType() . '.');
            }
            if ($property->containsEnumeration() and !$property->isValueFromEnum($value)) {
                throw new InvalidValueException("Value '$value' is not from possible values enumeration.");
            }
        } else {
            if ($property->hasRelationship()) {

                $filter = ($set = $property->getFilters(0)) ? $this->getFilterCallback($set, func_get_args()) : null;
                $relationship = $property->getRelationship();

                $method = explode('\\', get_class($relationship));
                $method = 'get' . array_pop($method) . 'Value';
                $args = array($property, $filter);

                if ($method === 'getHasManyValue') {
                    $args[] = ($set = $property->getFilters(1)) ? $this->getFilterCallback($set, func_get_args()) : null;
                }
                $value = call_user_func_array(array($this, $method), $args);

            } else {
                $value = $this->row->$column;
                if ($value === null) {
                    if (!$property->isNullable()) {
                        throw new InvalidValueException("Property '$name' cannot be null.");
                    }
                    return null;
                }
                if (!$property->containsCollection()) {
                    $type = $property->getType();
                    if (!($value instanceof $type)) {
                        throw new InvalidValueException("Property '$name' is expected to contain an instance of '{$property->getType()}', instance of '" . get_class($value) . "' given.");
                    }
                } else {
                    if (!is_array($value)) {
                        throw new InvalidValueException("Property '$name' is expected to contain an array of '{$property->getType()}' instances.");
                    }
                }
            }
        }
        return $value;
    }

    /**
     * Sets value of given field
     *
     * @param string $name
     * @param mixed $value
     * @throws InvalidMethodCallException
     * @throws InvalidValueException
     * @throws MemberAccessException
     */
    function __set($name, $value)
    {
        $property = $this->getReflection()->getEntityProperty($name);
        if ($property === null) {
            $method = 'set' . ucfirst($name);
            if (method_exists($this, $method)) { // TODO: find better solution (using reflection)
                call_user_func(array($this, $method), $value);
            } else {
                throw new MemberAccessException("Undefined property: $name");
            }
        } else {
            if (!$property->isWritable()) {
                throw new MemberAccessException("Cannot write to read only property '$name'.");
            }
            $column = $property->getColumn();
            if ($value === null) {
                if (!$property->isNullable()) {
                    throw new InvalidValueException("Property '$name' cannot be null.");
                }
                $this->row->$column = null;
            } else {
                if ($property->isBasicType()) {
                    if (!settype($value, $property->getType())) {
                        throw new InvalidValueException("Cannot convert value '$value' to " . $property->getType() . '.');
                    }
                    if ($property->containsEnumeration() and !$property->isValueFromEnum($value)) {
                        throw new InvalidValueException("Value '$value' is not from possible values enumeration.");
                    }
                    $this->row->$column = $value;
                } else {
                    if ($property->hasRelationship()) {
                        if (!($value instanceof Entity)) {
                            throw new InvalidValueException("Only entities can be set via magic __set on field with relationships.");
                        }
                        $relationship = $property->getRelationship();
                        if (!($relationship instanceof Relationship\HasOne)) {
                            throw new InvalidMethodCallException('Only fields with m:hasOne relationship can be set via magic __set.');
                        }
                        $column = $relationship->getColumnReferencingTargetTable();
                        $table = $relationship->getTargetTable();

                        if ($value->isDetached()) {
                            throw new InvalidValueException('Detached entity must be stored in database before use in relationships.');
                        }
                        $this->row->$column = $value->id;
                        $this->row->cleanReferencedRowsCache($table, $column);
                    } else {
                        if (!is_object($value)) {
                            throw new InvalidValueException("Unexpected value type: " . $property->getType() . " expected, " . gettype($value) . " given.");
                        }
                        $type = $property->getType();
                        if (!($value instanceof $type)) {
                            throw new InvalidValueException("Unexpected value type: " . $property->getType() . " expected, " . get_class($value) . " given.");
                        }
                        $this->row->$column = $value;
                    }
                }
            }
        }
    }

    /**
     * Calls __get() or __set() method when get<$name> or set<$name> methods don't exist
     *
     * @param string $name
     * @param array $arguments
     * @param array $arguments
     * @return mixed
     * @throws InvalidMethodCallException
     */
    public function __call($name, array $arguments)
    {
        $e = new InvalidMethodCallException("Method '$name' is not callable.");
        if (strlen($name) < 4) {
            throw $e;
        }
        $prefix = substr($name, 0, 3);
        if ($prefix === 'get') {
            return $this->__get(lcfirst(substr($name, 3)), $arguments);
        } elseif ($prefix === 'set') {
            $this->__set(lcfirst(substr($name, 3)), $arguments);
        } else {
            throw $e;
        }
    }

    /**
     * Performs a mass value assignment (using setters)
     *
     * @param array|Traversable $values
     * @param array|null $whitelist
     * @throws InvalidArgumentException
     */
    public function assign($values, array $whitelist = null)
    {
        if ($whitelist !== null) {
            $whitelist = array_flip($whitelist);
        }
        if (!is_array($values) and !($values instanceof Traversable)) {
            throw new InvalidArgumentException('Argument $values must be either array or instance of Traversable, ' . gettype($values) . ' given.');
        }
        foreach ($values as $field => $value) {
            if ($whitelist === null or isset($whitelist[$field])) {
                $this->__set($field, $value);
            }
        }
    }

    /**
     * Tells whether entity is in modified state
     *
     * @return bool
     */
    public function isModified()
    {
        return $this->row->isModified();
    }

    /**
     * Tells whether entity is in detached state (like newly created entity)
     *
     * @return bool
     */
    public function isDetached()
    {
        return $this->row->isDetached();
    }

    /**
     * Marks entity as detached (it means non-persisted)
     */
    public function detach()
    {
        $this->row->detach();
    }

    /**
     * Returns array of high-level fields with values
     *
     * @return array
     */
    public function getData()
    {
        $data = array();
        foreach ($this->getReflection()->getEntityProperties() as $property) {
            $data[$property->getName()] = $this->__get($property->getName());
        }
        $internalGetters = array_flip($this->internalGetters);
        foreach ($this->getReflection()->getMethods(ReflectionMethod::IS_PUBLIC) as $method) {
            $name = $method->getName();
            if (substr($name, 0, 3) === 'get' and !isset($internalGetters[$name])) {
                if ($method->getNumberOfRequiredParameters() === 0) {
                    $data[lcfirst(substr($name, 3))] = $method->invoke($this);
                }
            }
        }
        return $data;
    }

    /**
     * Returns array of low-level fields with values
     *
     * @return array
     */
    public function getRowData()
    {
        return $this->row->getData();
    }

    /**
     * Returns array of modified low-level fields with new values
     *
     * @return array
     */
    public function getModifiedRowData()
    {
        return $this->row->getModifiedData();
    }

    /**
     * Marks entity as non-updated (isModified() returns false right after this method call)
     */
    public function markAsUpdated()
    {
        $this->row->markAsUpdated();
    }

    /**
     * Marks entity as persisted
     *
     * @param int $id
     * @param string $table
     * @param DibiConnection $connection
     */
    public function markAsCreated($id, $table, DibiConnection $connection)
    {
        $this->row->markAsCreated($id, $table, $connection);
    }

    /**
     * @return EntityReflection
     */
    protected static function getReflection()
    {
        $class = get_called_class();
        if (!isset(static::$reflections[$class])) {
            static::$reflections[$class] = new EntityReflection($class);
        }

        return static::$reflections[$class];
    }

    /**
     * @param array $entities
     * @return array
     */
    protected function createCollection(array $entities)
    {
        return $entities;
    }

    ////////////////////
    ////////////////////

    /**
     * @param Property $property
     * @param Closure|null $filter
     * @return mixed
     * @throws InvalidValueException
     */
    private function getHasOneValue(Property $property, Closure $filter = null)
    {
        $relationship = $property->getRelationship();
        $row = $this->row->referenced($relationship->getTargetTable(), $filter, $relationship->getColumnReferencingTargetTable());
        if ($row === null) {
            if (!$property->isNullable()) {
                $name = $property->getName();
                throw new InvalidValueException("Property '$name' cannot be null.");
            }
            return null;
        } else {
            $class = $property->getType();
            return new $class($row);
        }
    }

    /**
     * @param Property $property
     * @param Closure|null $relTableFilter
     * @param Closure|null $targetTableFilter
     * @return array
     */
    private function getHasManyValue(Property $property, Closure $relTableFilter = null, Closure $targetTableFilter = null)
    {
        $relationship = $property->getRelationship();
        $rows = $this->row->referencing($relationship->getRelationshipTable(), $relTableFilter, $relationship->getColumnReferencingSourceTable(), $relationship->getStrategy());
        $class = $property->getType();
        $value = array();
        foreach ($rows as $row) {
            $valueRow = $row->referenced($relationship->getTargetTable(), $targetTableFilter, $relationship->getColumnReferencingTargetTable());
            if ($valueRow !== null) {
                $value[] = new $class($valueRow);
            }
        }
        return $this->createCollection($value);
    }

    /**
     * @param Property $property
     * @param Closure|null $filter
     * @return mixed
     * @throws InvalidValueException
     */
    private function getBelongsToOneValue(Property $property, Closure $filter = null)
    {
        $relationship = $property->getRelationship();
        $rows = $this->row->referencing($relationship->getTargetTable(), $filter, $relationship->getColumnReferencingSourceTable(), $relationship->getStrategy());
        $count = count($rows);
        if ($count > 1) {
            throw new InvalidValueException('There cannot be more than one entity referencing to entity with m:belongToOne relationship.');
        } elseif ($count === 0) {
            if (!$property->isNullable()) {
                $name = $property->getName();
                throw new InvalidValueException("Property '$name' cannot be null.");
            }
            return null;
        } else {
            $row = reset($rows);
            $class = $property->getType();
            return new $class($row);
        }
    }

    /**
     * @param Property $property
     * @param Closure|null $filter
     * @return array
     */
    private function getBelongsToManyValue(Property $property, Closure $filter = null)
    {
        $relationship = $property->getRelationship();
        $rows = $this->row->referencing($relationship->getTargetTable(), $filter, $relationship->getColumnReferencingSourceTable(), $relationship->getStrategy());
        $class = $property->getType();
        $value = array();
        foreach ($rows as $row) {
            $value[] = new $class($row);
        }
        return $this->createCollection($value);
    }

    /**
     * @param array $propertyFilters
     * @param array $filterArgs
     * @return callable|null
     */
    private function getFilterCallback(array $propertyFilters, array $filterArgs)
    {
        $filterCallback = null;
        if (!empty($propertyFilters)) {
            $filterArgs = isset($filterArgs[1]) ? $filterArgs[1] : array();
            $filterCallback = function (DibiFluent $statement) use ($propertyFilters, $filterArgs) {
                foreach ($propertyFilters as $propertyFilter) {
                    call_user_func_array($propertyFilter, array_merge(array($statement), $filterArgs));
                }
            };
        }
        return $filterCallback;
    }
    
}