ClassSchema.php

Go to the documentation of this file.

<?php
namespace TYPO3\CMS\Extbase\Reflection;

/*
 * This file is part of the TYPO3 CMS project.
 *
 * It is free software; you can redistribute it and/or modify it under
 * the terms of the GNU General Public License, either version 2
 * of the License, or any later version.
 *
 * For the full copyright and license information, please read the
 * LICENSE.txt file that was distributed with this source code.
 *
 * The TYPO3 project - inspiring people to share!
 */

use TYPO3\CMS\Extbase\Utility\TypeHandlingUtility;

class ClassSchema
{
    const MODELTYPE_ENTITY = 1;
    const MODELTYPE_VALUEOBJECT = 2;

    protected $className;

    protected $modelType = self::MODELTYPE_ENTITY;

    protected $aggregateRoot = false;

    protected $uuidPropertyName;

    protected $properties = [];

    protected $identityProperties = [];

    public function __construct($className)
    {
        $this->className = $className;
    }

    public function getClassName()
    {
        return $this->className;
    }

    public function addProperty($name, $type, $lazy = false, $cascade = '')
    {
        $type = TypeHandlingUtility::parseType($type);
        $this->properties[$name] = [
            'type' => $type['type'],
            'elementType' => $type['elementType'],
            'lazy' => $lazy,
            'cascade' => $cascade
        ];
    }

    public function getProperty($propertyName)
    {
        return is_array($this->properties[$propertyName]) ? $this->properties[$propertyName] : [];
    }

    public function getProperties()
    {
        return $this->properties;
    }

    public function setModelType($modelType)
    {
        if ($modelType < self::MODELTYPE_ENTITY || $modelType > self::MODELTYPE_VALUEOBJECT) {
            throw new \InvalidArgumentException('"' . $modelType . '" is an invalid model type.', 1212519195);
        }
        $this->modelType = $modelType;
    }

    public function getModelType()
    {
        return $this->modelType;
    }

    public function setAggregateRoot($isRoot)
    {
        $this->aggregateRoot = $isRoot;
    }

    public function isAggregateRoot()
    {
        return $this->aggregateRoot;
    }

    public function hasProperty($propertyName)
    {
        return array_key_exists($propertyName, $this->properties);
    }

    public function setUuidPropertyName($propertyName)
    {
        if (!array_key_exists($propertyName, $this->properties)) {
            throw new \InvalidArgumentException('Property "' . $propertyName . '" must be added to the class schema before it can be marked as UUID property.', 1233863842);
        }
        $this->uuidPropertyName = $propertyName;
    }

    public function getUuidPropertyName()
    {
        return $this->uuidPropertyName;
    }

    public function markAsIdentityProperty($propertyName)
    {
        if (!array_key_exists($propertyName, $this->properties)) {
            throw new \InvalidArgumentException('Property "' . $propertyName . '" must be added to the class schema before it can be marked as identity property.', 1233775407);
        }
        if ($this->properties[$propertyName]['lazy'] === true) {
            throw new \InvalidArgumentException('Property "' . $propertyName . '" must not be makred for lazy loading to be marked as identity property.', 1239896904);
        }
        $this->identityProperties[$propertyName] = $this->properties[$propertyName]['type'];
    }

    public function getIdentityProperties()
    {
        return $this->identityProperties;
    }
}