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: 

<?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.md that was distributed with this source code.
 */

namespace LeanMapper\Reflection;

use LeanMapper\Exception\InvalidArgumentException;
use LeanMapper\Exception\InvalidMethodCallException;
use LeanMapper\Relationship;

/**
 * Reflection of entity's property
 *
 * @author Vojtěch Kohout
 */
class Property
{

    /** @var string */
    private $name;

    /** @var string|null */
    private $column;

    /** @var EntityReflection */
    private $entityReflection;

    /** @var PropertyType */
    private $type;

    /** @var bool */
    private $isWritable;

    /** @var bool */
    private $isNullable;

    /** @var bool */
    private $hasDefaultValue;

    /** @var mixed|null */
    private $defaultValue;

    /** @var bool */
    private $containsCollection;

    /** @var Relationship\HasOne|Relationship\HasMany|Relationship\BelongsToOne|Relationship\BelongsToMany|null */
    private $relationship;

    /** @var PropertyMethods|null */
    private $propertyMethods;

    /** @var PropertyFilters|null */
    private $propertyFilters;

    /** @var PropertyPasses|null */
    private $propertyPasses;

    /** @var PropertyValuesEnum|null */
    private $propertyValuesEnum;

    /** @var array */
    private $customFlags;



    /**
     * @param string $name
     * @param EntityReflection $entityReflection
     * @param string|null $column
     * @param PropertyType $type
     * @param bool $isWritable
     * @param bool $isNullable
     * @param bool $containsCollection
     * @param bool $hasDefaultValue
     * @param mixed|null $defaultValue
     * @param Relationship\HasOne|Relationship\HasMany|Relationship\BelongsToOne|Relationship\BelongsToMany|null $relationship
     * @param PropertyMethods|null $propertyMethods
     * @param PropertyFilters|null $propertyFilters
     * @param PropertyPasses|null $propertyPasses
     * @param PropertyValuesEnum|null $propertyValuesEnum
     * @param array $customFlags
     * @throws InvalidArgumentException
     */
    public function __construct(
        $name,
        EntityReflection $entityReflection,
        $column,
        PropertyType $type,
        $isWritable,
        $isNullable,
        $containsCollection,
        $hasDefaultValue,
        $defaultValue = null,
        $relationship = null,
        PropertyMethods $propertyMethods = null,
        PropertyFilters $propertyFilters = null,
        PropertyPasses $propertyPasses = null,
        PropertyValuesEnum $propertyValuesEnum = null,
        array $customFlags = []
    ) {
        if ($relationship !== null) {
            if (!is_subclass_of($type->getType(), 'LeanMapper\Entity')) {
                throw new InvalidArgumentException(
                    "Property '$name' in entity {$entityReflection->getName()} cannot contain relationship since it doesn't contain entity (or collection of entities)."
                );
            }
            if (($relationship instanceof Relationship\HasMany) or ($relationship instanceof Relationship\BelongsToMany)) {
                if (!$containsCollection) {
                    throw new InvalidArgumentException(
                        "Property '$name' with HasMany or BelongsToMany in entity {$entityReflection->getName()} relationship must contain collection."
                    );
                }
            } else {
                if ($containsCollection) {
                    throw new InvalidArgumentException(
                        "Property '$name' with HasOne or BelongsToOne in entity {$entityReflection->getName()} relationship cannot contain collection."
                    );
                }
            }
            if ($propertyPasses !== null) {
                throw new InvalidArgumentException(
                    "Property '$name' in entity {$entityReflection->getName()} cannot have defined m:passThru since it contains relationship."
                );
            }
        } elseif ($propertyFilters !== null) {
            throw new InvalidArgumentException(
                "Cannot bind filter to property '$name' in entity {$entityReflection->getName()} since it doesn't contain relationship."
            );
        }
        if ($propertyValuesEnum !== null and (!$type->isBasicType() or $type->getType() === 'array' or $containsCollection)) {
            throw new InvalidArgumentException("Values of property '$name' in entity {$entityReflection->getName()} cannot be enumerated.");
        }
        $this->name = $name;
        $this->entityReflection = $entityReflection;
        $this->column = $column;
        $this->type = $type;
        $this->isWritable = $isWritable;
        $this->isNullable = $isNullable;
        $this->containsCollection = $containsCollection;
        $this->hasDefaultValue = $hasDefaultValue;
        $this->defaultValue = $defaultValue;
        $this->relationship = $relationship;
        $this->propertyMethods = $propertyMethods;
        $this->propertyFilters = $propertyFilters;
        $this->propertyPasses = $propertyPasses;
        $this->propertyValuesEnum = $propertyValuesEnum;
        $this->customFlags = $customFlags;

    }



    /**
     * Gets property name
     *
     * @return string
     */
    public function getName()
    {
        return $this->name;
    }



    /**
     * Gets name of column holding low-level value
     *
     * @return string|null
     */
    public function getColumn()
    {
        return $this->column;
    }



    /**
     * Tells whether property is assumed to contain collection
     *
     * @return bool
     */
    public function containsCollection()
    {
        return $this->containsCollection;
    }



    /**
     * Tells whether property has default value (defined in annotation)
     *
     * @return bool
     */
    public function hasDefaultValue()
    {
        return $this->hasDefaultValue;
    }



    /**
     * Gets default value of property (as defined in annotation)
     *
     * @return mixed|null
     */
    public function getDefaultValue()
    {
        return $this->defaultValue;
    }



    /**
     * Gets property type
     *
     * @return string
     */
    public function getType()
    {
        return $this->type->getType();
    }



    /**
     * Tells whether property type is basic type (boolean|integer|float|string|array)
     *
     * @return bool
     */
    public function isBasicType()
    {
        return $this->type->isBasicType();
    }



    /**
     * Tells whether property is writable
     *
     * @return bool
     */
    public function isWritable()
    {
        return $this->isWritable;
    }



    /**
     * Tells whether property can be null
     *
     * @return bool
     */
    public function isNullable()
    {
        return $this->isNullable;
    }



    /**
     * Tells whether property represents relationship
     *
     * @return bool
     */
    public function hasRelationship()
    {
        return $this->relationship !== null;
    }



    /**
     * Returns relationship that property represents
     *
     * @return Relationship\BelongsToMany|Relationship\BelongsToOne|Relationship\HasMany|Relationship\HasOne|null
     */
    public function getRelationship()
    {
        return $this->relationship;
    }



    /**
     * Gets getter method
     *
     * @return string|null
     */
    public function getGetter()
    {
        return $this->propertyMethods !== null ? $this->propertyMethods->getGetter() : null;
    }



    /**
     * Gets setter method
     *
     * @return string|null
     */
    public function getSetter()
    {
        return $this->propertyMethods !== null ? $this->propertyMethods->getSetter() : null;
    }



    /**
     * Gets property filters
     *
     * @param int $index
     * @return array|null
     */
    public function getFilters($index = 0)
    {
        return $this->propertyFilters !== null ? $this->propertyFilters->getFilters($index) : null;
    }



    /**
     * Gets filters arguments hard-coded in annotation
     *
     * @param int $index
     * @return array|null
     */
    public function getFiltersTargetedArgs($index = 0)
    {
        return $this->propertyFilters !== null ? $this->propertyFilters->getFiltersTargetedArgs($index) : null;
    }



    /**
     * Gets getter pass
     *
     * @return string|null
     */
    public function getGetterPass()
    {
        return $this->propertyPasses !== null ? $this->propertyPasses->getGetterPass() : null;
    }



    /**
     * Gets setter pass
     *
     * @return string|null
     */
    public function getSetterPass()
    {
        return $this->propertyPasses !== null ? $this->propertyPasses->getSetterPass() : null;
    }



    /**
     * Tells whether property contains enumeration
     *
     * @return bool
     */
    public function containsEnumeration()
    {
        return $this->propertyValuesEnum !== null;
    }



    /**
     * Tells wheter given value is from enumeration
     *
     * @param mixed $value
     * @return bool
     * @throws InvalidMethodCallException
     */
    public function isValueFromEnum($value)
    {
        $this->checkContainsEnumeration();
        return $this->propertyValuesEnum->isValueFromEnum($value);
    }



    /**
     * Gets possible enumeration values
     *
     * @return array
     */
    public function getEnumValues()
    {
        $this->checkContainsEnumeration();
        return $this->propertyValuesEnum->getValues();
    }



    /**
     * Tells whether property has custom flag
     *
     * @param string $name
     * @return bool
     */
    public function hasCustomFlag($name)
    {
        return array_key_exists($name, $this->customFlags);
    }



    /**
     * Gets value of requested custom flag
     *
     * @param string $name
     * @return string
     * @throws InvalidArgumentException
     */
    public function getCustomFlagValue($name)
    {
        if (!$this->hasCustomFlag($name)) {
            throw new InvalidArgumentException(
                "Property '{$this->name}' in entity {$this->entityReflection->getName()} doesn't have custom flag '$name'."
            );
        }
        return $this->customFlags[$name];
    }

    //////////

    /**
     * @throws InvalidMethodCallException
     */
    private function checkContainsEnumeration()
    {
        if (!$this->containsEnumeration()) {
            throw new InvalidMethodCallException(
                "It doesn't make sense to call enumeration related method on property '{$this->name}' in entity {$this->entityReflection->getName()} since it doesn't contain enumeration."
            );
        }
    }

}