ClassSchema.php

Go to the documentation of this file.

<?php
/***************************************************************
*  Copyright notice
*
*  (c) 2009 Jochen Rau <jochen.rau@typoplanet.de>
*  All rights reserved
*
*  This class is a backport of the corresponding class of FLOW3.
*  All credits go to the v5 team.
*
*  This script is part of the TYPO3 project. The TYPO3 project is
*  free software; you can redistribute it and/or modify
*  it under the terms of the GNU General Public License as published by
*  the Free Software Foundation; either version 2 of the License, or
*  (at your option) any later version.
*
*  The GNU General Public License can be found at
*  http://www.gnu.org/copyleft/gpl.html.
*
*  This script is distributed in the hope that it will be useful,
*  but WITHOUT ANY WARRANTY; without even the implied warranty of
*  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
*  GNU General Public License for more details.
*
*  This copyright notice MUST APPEAR in all copies of the script!
***************************************************************/

/**
 * A class schema
 *
 * @version $Id: ClassSchema.php 2180 2010-04-08 09:23:09Z jocrau $
 * @license http://www.gnu.org/licenses/lgpl.html GNU Lesser General Public License, version 3 or later
 */
class Tx_Extbase_Reflection_ClassSchema {

    /**
     * Available model types
     */
    const MODELTYPE_ENTITY = 1;
    const MODELTYPE_VALUEOBJECT = 2;

    /**
     * Name of the class this schema is referring to
     *
     * @var string
     */
    protected $className;

    /**
     * Model type of the class this schema is referring to
     *
     * @var integer
     */
    protected $modelType = self::MODELTYPE_ENTITY;

    /**
     * Whether a repository exists for the class this schema is referring to
     * @var boolean
     */
    protected $aggregateRoot = FALSE;

    /**
     * The name of the property holding the uuid of an entity, if any.
     *
     * @var string
     */
    protected $uuidPropertyName;

    /**
     * Properties of the class which need to be persisted
     *
     * @var array
     */
    protected $properties = array();

    /**
     * The properties forming the identity of an object
     *
     * @var array
     */
    protected $identityProperties = array();

    /**
     * Constructs this class schema
     *
     * @param string $className Name of the class this schema is referring to
     * @author Robert Lemke <robert@typo3.org>
     */
    public function __construct($className) {
        $this->className = $className;
    }

    /**
     * Returns the class name this schema is referring to
     *
     * @return string The class name
     * @author Robert Lemke <robert@typo3.org>
     */
    public function getClassName() {
        return $this->className;
    }

    /**
     * Adds (defines) a specific property and its type.
     *
     * @param string $name Name of the property
     * @param string $type Type of the property
     * @param boolean $lazy Whether the property should be lazy-loaded when reconstituting
     * @param string $cascade Strategy to cascade the object graph.
     * @return void
     */
    public function addProperty($name, $type, $lazy = FALSE, $cascade = '') {
        $type = Tx_Extbase_Utility_TypeHandling::parseType($type);
        $this->properties[$name] = array(
            'type' => $type['type'],
            'elementType' => $type['elementType'],
            'lazy' => $lazy,
            'cascade' => $cascade
        );
    }

    /**
     * Returns the given property defined in this schema. Check with
     * hasProperty($propertyName) before!
     *
     * @return array
     * @author Karsten Dambekalns <karsten@typo3.org>
     */
    public function getProperty($propertyName) {
        return is_array($this->properties[$propertyName]) ? $this->properties[$propertyName] : array();
    }

    /**
     * Returns all properties defined in this schema
     *
     * @return array
     * @author Robert Lemke <robert@typo3.org>
     */
    public function getProperties() {
        return $this->properties;
    }

    /**
     * Sets the model type of the class this schema is referring to.
     *
     * @param integer The model type, one of the MODELTYPE_* constants.
     * @return void
     * @author Robert Lemke <robert@typo3.org>
     */
    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;
    }

    /**
     * Returns the model type of the class this schema is referring to.
     *
     * @return integer The model type, one of the MODELTYPE_* constants.
     * @author Robert Lemke <robert@typo3.org>
     */
    public function getModelType() {
        return $this->modelType;
    }

    /**
     * Marks the class if it is root of an aggregate and therefore accessible
     * through a repository - or not.
     *
     * @param boolean $isRoot TRUE if it is the root of an aggregate
     * @return void
     * @author Karsten Dambekalns <karsten@typo3.org>
     */
    public function setAggregateRoot($isRoot) {
        $this->aggregateRoot = $isRoot;
    }

    /**
     * Whether the class is an aggregate root and therefore accessible through
     * a repository.
     *
     * @return boolean TRUE if it is managed
     * @author Karsten Dambekalns <karsten@typo3.org>
     */
    public function isAggregateRoot() {
        return $this->aggregateRoot;
    }

    /**
     * If the class schema has a certain property.
     *
     * @param string $propertyName Name of the property
     * @return boolean
     * @author Robert Lemke <robert@typo3.org>
     */
    public function hasProperty($propertyName) {
        return array_key_exists($propertyName, $this->properties);
    }

    /**
     * Sets the property marked as uuid of an object with @uuid
     *
     * @param string $propertyName
     * @return void
     * @author Karsten Dambekalns <karsten@typo3.org>
     */
    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;
    }

    /**
     * Gets the name of the property marked as uuid of an object
     *
     * @return string
     * @author Karsten Dambekalns <karsten@typo3.org>
     */
    public function getUUIDPropertyName() {
        return $this->uuidPropertyName;
    }

    /**
     * Marks the given property as one of properties forming the identity
     * of an object. The property must already be registered in the class
     * schema.
     *
     * @param string $propertyName
     * @return void
     * @author Karsten Dambekalns <karsten@typo3.org>
     */
    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'];
    }

    /**
     * Gets the properties (names and types) forming the identity of an object.
     *
     * @return array
     * @author Karsten Dambekalns <karsten@typo3.org>
     * @see markAsIdentityProperty()
     */
    public function getIdentityProperties() {
        return $this->identityProperties;
    }

}
?>