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: 

<?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\InvalidStateException;
use LeanMapper\DefaultEntityReflectionProvider;
use LeanMapper\IEntityReflectionProvider;
use LeanMapper\IMapper;
use ReflectionMethod;

/**
 * Entity reflection
 *
 * @author Vojtěch Kohout
 */
class EntityReflection extends \ReflectionClass
{

    /** @var IMapper|null */
    private $mapper;

    /** @var IEntityReflectionProvider */
    private $entityReflectionProvider;

    /** @var Property[] */
    private $properties = null;

    /** @var array */
    private $getters = null;

    /** @var array */
    private $setters = null;

    /** @var Aliases|null */
    private $aliases;

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



    /**
     * @param mixed $argument
     * @param IMapper|null $mapper
     * @param IEntityReflectionProvider|null $entityReflectionProvider
     */
    public function __construct($argument, IMapper $mapper = null, IEntityReflectionProvider $entityReflectionProvider = null)
    {
        parent::__construct($argument);
        $this->mapper = $mapper;
        $this->entityReflectionProvider = $entityReflectionProvider !== null ? $entityReflectionProvider : new DefaultEntityReflectionProvider;
    }



    /**
     * Gets requested entity's property
     *
     * @param string $name
     * @return Property|null
     */
    public function getEntityProperty($name)
    {
        if ($this->properties === null) {
            $this->createProperties();
        }
        return isset($this->properties[$name]) ? $this->properties[$name] : null;
    }



    /**
     * Gets array of all entity's properties
     *
     * @return Property[]
     */
    public function getEntityProperties()
    {
        if ($this->properties === null) {
            $this->createProperties();
        }
        return $this->properties;
    }



    /**
     * Gets Aliases instance relevant to current class
     *
     * @return Aliases
     */
    public function getAliases()
    {
        if ($this->aliases === null) {
            $this->aliases = AliasesParser::parseSource(file_get_contents($this->getFileName()), $this->getNamespaceName());
        }
        return $this->aliases;
    }



    /**
     * Gets parent entity's reflection
     *
     * @return self|null
     */
    public function getParentClass()
    {
        return ($reflection = parent::getParentClass()) ? new self($reflection->getName(), $this->mapper, $this->entityReflectionProvider) : null;
    }



    /**
     * Gets doc comment of current class
     *
     * @return string
     */
    public function getDocComment()
    {
        if ($this->docComment === null) {
            $this->docComment = parent::getDocComment();
        }
        return $this->docComment;
    }



    /**
     * Gets requested getter's reflection
     *
     * @param string $name
     * @return ReflectionMethod|null
     */
    public function getGetter($name)
    {
        if ($this->getters === null) {
            $this->createGetters();
        }
        return isset($this->getters[$name]) ? $this->getters[$name] : null;
    }



    /**
     * Gets array of getter's reflections
     *
     * @return ReflectionMethod[]
     */
    public function getGetters()
    {
        if ($this->getters === null) {
            $this->createGetters();
        }
        return $this->getters;
    }



    /**
     * Gets requested setter's reflection
     *
     * @param string $name
     * @return ReflectionMethod|null
     */
    public function getSetter($name)
    {
        if ($this->setters === null) {
            $this->createSetters();
        }
        return isset($this->setters[$name]) ? $this->setters[$name] : null;
    }

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

    /**
     * @throws InvalidStateException
     */
    private function createGetters()
    {
        $this->getters = [];
        $getters = $this->entityReflectionProvider->getGetters($this);

        foreach ($getters as $getter) {
            $name = $getter->getName();
            // collision check
            if (isset($this->getters[$name])) {
                throw new InvalidStateException("Duplicated getter '{$name}' for entity {$this->getName()}.");
            }
            $this->getters[$name] = $getter;
        }
    }


    /**
     * @throws InvalidStateException
     */
    private function createSetters()
    {
        $this->setters = [];
        $setters = $this->entityReflectionProvider->getSetters($this);

        foreach ($setters as $setter) {
            $name = $setter->getName();
            // collision check
            if (isset($this->setters[$name])) {
                throw new InvalidStateException("Duplicated setter '{$name}' for entity {$this->getName()}.");
            }
            $this->setters[$name] = $setter;
        }
    }


    /**
     * @throws InvalidStateException
     */
    private function createProperties()
    {
        $this->properties = [];
        $properties = $this->entityReflectionProvider->getProperties($this, $this->mapper);
        $columns = [];
        foreach ($properties as $property) {
            // collision check
            if (isset($this->properties[$property->getName()])) {
                throw new InvalidStateException(
                    "Duplicated property '{$property->getName()}' in entity {$this->getName()}. Please fix property name."
                );
            }

            $column = $property->getColumn();
            if ($column !== null and $property->isWritable()) {
                if (isset($columns[$column])) {
                    throw new InvalidStateException(
                        "Mapping collision in property '{$property->getName()}' (column '$column') in entity {$this->getName()}. Please fix mapping or make chosen properties read only (using property-read)."
                    );
                }
                $columns[$column] = true;
            }
            $this->properties[$property->getName()] = $property;
        }
    }

}