Entity.php

<?php
/**
 * Webiny Framework (http://www.webiny.com/framework)
 *
 * @copyright Copyright Webiny LTD
 */

namespace Webiny\Component\Entity;

use Webiny\Component\Entity\Attribute\AbstractAttribute;
use Webiny\Component\Entity\Attribute\Validation\ValidatorInterface;
use Webiny\Component\Entity\Attribute\Validation\Validators\CountryCode;
use Webiny\Component\Entity\Attribute\Validation\Validators\CreditCardNumber;
use Webiny\Component\Entity\Attribute\Validation\Validators\Email;
use Webiny\Component\Entity\Attribute\Validation\Validators\EuVatNumber;
use Webiny\Component\Entity\Attribute\Validation\Validators\GeoLocation;
use Webiny\Component\Entity\Attribute\Validation\Validators\GreaterThan;
use Webiny\Component\Entity\Attribute\Validation\Validators\GreaterThanOrEqual;
use Webiny\Component\Entity\Attribute\Validation\Validators\InArray;
use Webiny\Component\Entity\Attribute\Validation\Validators\Integer;
use Webiny\Component\Entity\Attribute\Validation\Validators\LessThan;
use Webiny\Component\Entity\Attribute\Validation\Validators\LessThanOrEqual;
use Webiny\Component\Entity\Attribute\Validation\Validators\MaxLength;
use Webiny\Component\Entity\Attribute\Validation\Validators\MinLength;
use Webiny\Component\Entity\Attribute\Validation\Validators\Number;
use Webiny\Component\Entity\Attribute\Validation\Validators\Password;
use Webiny\Component\Entity\Attribute\Validation\Validators\Phone;
use Webiny\Component\Entity\Attribute\Validation\Validators\Regex;
use Webiny\Component\Entity\Attribute\Validation\Validators\Required;
use Webiny\Component\Entity\Attribute\Validation\Validators\Unique;
use Webiny\Component\Entity\Attribute\Validation\Validators\Url;
use Webiny\Component\Mongo\Mongo;
use Webiny\Component\Mongo\MongoTrait;
use Webiny\Component\ServiceManager\ServiceManagerTrait;
use Webiny\Component\StdLib\ComponentTrait;
use Webiny\Component\StdLib\SingletonTrait;
use Webiny\Component\StdLib\StdLibTrait;


/**
 * Entity component main class
 * Use this class to configure Entity component.
 *
 * @package \Webiny\Component\Entity
 */
class Entity
{
    use MongoTrait, ComponentTrait, SingletonTrait, ServiceManagerTrait, StdLibTrait;

    /**
     * @var null|Mongo
     */
    protected static $database = null;

    /**
     * @var array
     */
    private $validators = [];

    /**
     * @var array
     */
    public $pool;

    /**
     * Get entity database
     * @return Mongo
     */
    public function getDatabase()
    {
        if (self::$database === null) {
            self::$database = self::mongo(self::getConfig()->Database);
        }

        return self::$database;
    }

    /**
     * Set entity database
     *
     * @param Mongo $mongoDatabase
     */
    public function setDatabase(Mongo $mongoDatabase)
    {
        self::$database = $mongoDatabase;
    }

    /**
     * Get entity instance or false if entity does not exist
     *
     * @param $class
     * @param $id
     *
     * @return bool|AbstractEntity
     */
    public function get($class, $id)
    {
        return $this->pool[$class][$id] ?? false;
    }

    /**
     * Add instance to the pool
     *
     * @param $instance
     *
     * @return mixed
     */
    public function add($instance)
    {
        $class = get_class($instance);
        $entityPool = $this->pool[$class] ?? [];
        $entityPool[$instance->id] = $instance;
        $this->pool[$class] = $entityPool;

        return $instance;
    }

    /**
     * Add attribute validator to Entity component
     *
     * @param ValidatorInterface $validator
     *
     * @return $this
     */
    public function addValidator(ValidatorInterface $validator)
    {
        $this->validators[$validator->getName()] = $validator;

        return $this;
    }

    public function getValidator($name)
    {
        return $this->validators[$name];
    }

    /**
     * Remove instance from pool
     *
     * @param $instance
     *
     * @return bool
     */
    public function remove(AbstractEntity $instance)
    {
        $class = get_class($instance);
        $entityPool = $this->pool[$class] ?? [];
        $id = '' . $instance->id;
        if (isset($entityPool[$id])) {
            unset($entityPool[$id]);
            $this->pool[$class] = $entityPool;
        }
        unset($instance);

        return true;
    }

    /**
     * Remove all loaded instances from pool
     */
    public function reset()
    {
        $this->pool = [];
    }

    protected function init()
    {
        // Create entity cache pool
        $this->pool = [];

        // Load built-in validators
        $builtInValidators = [
            new Email(),
            new GreaterThan(),
            new GreaterThanOrEqual(),
            new GeoLocation(),
            new LessThan(),
            new LessThanOrEqual(),
            new MinLength(),
            new MaxLength(),
            new InArray(),
            new Number(),
            new Integer(),
            new Url(),
            new Password(),
            new Required(),
            new Phone(),
            new CountryCode(),
            new CreditCardNumber(),
            new EuVatNumber(),
            new Unique(),
            new Regex()
        ];

        /* @var $v ValidatorInterface */
        foreach ($builtInValidators as $v) {
            $this->validators[$v->getName()] = $v;
        }

        // Load validators registered as a service
        $validators = $this->servicesByTag('entity-validator', ValidatorInterface::class);
        foreach ($validators as $v) {
            $this->validators[$v->getName()] = $v;
        }
    }

    protected static function postSetConfig()
    {
        // If attribute class maps are defined - set them into EntityAttributeBuilder
        $classMap = Entity::getConfig()->get('Attributes');
        if ($classMap) {
            foreach ($classMap as $attr => $class) {
                if (!in_array(AbstractAttribute::class, class_parents($class))) {
                    $message = 'Attribute class for attribute "%s" must extend %s';
                    throw new EntityException($message, [$attr, AbstractAttribute::class]);
                }
                EntityAttributeContainer::$classMap[$attr] = $class;
            }
        }
    }
}