<?php

/*

 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS

 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT

 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR

 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT

 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,

 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT

 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,

 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY

 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT

 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE

 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

 *

 * This software consists of voluntary contributions made by many individuals

 * and is licensed under the LGPL. For more information, see

 * <http://www.doctrine-project.org>.

 */

namespace Doctrine\ORM\Mapping;

use Doctrine\Common\Persistence\Mapping\ClassMetadata;

use ReflectionClass;

/**

 * A <tt>ClassMetadata</tt> instance holds all the object-relational mapping metadata

 * of an entity and it's associations.

 *

 * Once populated, ClassMetadata instances are usually cached in a serialized form.

 *

 * <b>IMPORTANT NOTE:</b>

 *

 * The fields of this class are only public for 2 reasons:

 * 1) To allow fast READ access.

 * 2) To drastically reduce the size of a serialized instance (private/protected members

 *    get the whole class name, namespace inclusive, prepended to every property in

 *    the serialized representation).

 *

 * @author Roman Borschel <roman@code-factory.org>

 * @author Jonathan H. Wage <jonwage@gmail.com>

 * @since 2.0

 */

class ClassMetadataInfo implements ClassMetadata

{

    /* The inheritance mapping types */

    /**

     * NONE means the class does not participate in an inheritance hierarchy

     * and therefore does not need an inheritance mapping type.

     */

    const INHERITANCE_TYPE_NONE = 1;

    /**

     * JOINED means the class will be persisted according to the rules of

     * <tt>Class Table Inheritance</tt>.

     */

    const INHERITANCE_TYPE_JOINED = 2;

    /**

     * SINGLE_TABLE means the class will be persisted according to the rules of

     * <tt>Single Table Inheritance</tt>.

     */

    const INHERITANCE_TYPE_SINGLE_TABLE = 3;

    /**

     * TABLE_PER_CLASS means the class will be persisted according to the rules

     * of <tt>Concrete Table Inheritance</tt>.

     */

    const INHERITANCE_TYPE_TABLE_PER_CLASS = 4;

    /* The Id generator types. */

    /**

     * AUTO means the generator type will depend on what the used platform prefers.

     * Offers full portability.

     */

    const GENERATOR_TYPE_AUTO = 1;

    /**

     * SEQUENCE means a separate sequence object will be used. Platforms that do

     * not have native sequence support may emulate it. Full portability is currently

     * not guaranteed.

     */

    const GENERATOR_TYPE_SEQUENCE = 2;

    /**

     * TABLE means a separate table is used for id generation.

     * Offers full portability.

     */

    const GENERATOR_TYPE_TABLE = 3;

    /**

     * IDENTITY means an identity column is used for id generation. The database

     * will fill in the id column on insertion. Platforms that do not support

     * native identity columns may emulate them. Full portability is currently

     * not guaranteed.

     */

    const GENERATOR_TYPE_IDENTITY = 4;

    /**

     * NONE means the class does not have a generated id. That means the class

     * must have a natural, manually assigned id.

     */

    const GENERATOR_TYPE_NONE = 5;

    /**

     * DEFERRED_IMPLICIT means that changes of entities are calculated at commit-time

     * by doing a property-by-property comparison with the original data. This will

     * be done for all entities that are in MANAGED state at commit-time.

     *

     * This is the default change tracking policy.

     */

    const CHANGETRACKING_DEFERRED_IMPLICIT = 1;

    /**

     * DEFERRED_EXPLICIT means that changes of entities are calculated at commit-time

     * by doing a property-by-property comparison with the original data. This will

     * be done only for entities that were explicitly saved (through persist() or a cascade).

     */

    const CHANGETRACKING_DEFERRED_EXPLICIT = 2;

    /**

     * NOTIFY means that Doctrine relies on the entities sending out notifications

     * when their properties change. Such entity classes must implement

     * the <tt>NotifyPropertyChanged</tt> interface.

     */

    const CHANGETRACKING_NOTIFY = 3;

    /**

     * Specifies that an association is to be fetched when it is first accessed.

     */

    const FETCH_LAZY = 2;

    /**

     * Specifies that an association is to be fetched when the owner of the

     * association is fetched. 

     */

    const FETCH_EAGER = 3;

    /**

     * Specifies that an association is to be fetched lazy (on first access) and that

     * commands such as Collection#count, Collection#slice are issued directly against

     * the database if the collection is not yet initialized.

     */

    const FETCH_EXTRA_LAZY = 4;

    /**

     * Identifies a one-to-one association.

     */

    const ONE_TO_ONE = 1;

    /**

     * Identifies a many-to-one association.

     */

    const MANY_TO_ONE = 2;

    /**

     * Combined bitmask for to-one (single-valued) associations.

     */

    const TO_ONE = 3;

    /**

     * Identifies a one-to-many association.

     */

    const ONE_TO_MANY = 4;

    /**

     * Identifies a many-to-many association.

     */

    const MANY_TO_MANY = 8;

    /**

     * Combined bitmask for to-many (collection-valued) associations.

     */

    const TO_MANY = 12;

    /**

     * READ-ONLY: The name of the entity class.

     */

    public $name;

    /**

     * READ-ONLY: The namespace the entity class is contained in.

     *

     * @var string

     * @todo Not really needed. Usage could be localized.

     */

    public $namespace;

    /**

     * READ-ONLY: The name of the entity class that is at the root of the mapped entity inheritance

     * hierarchy. If the entity is not part of a mapped inheritance hierarchy this is the same

     * as {@link $entityName}.

     *

     * @var string

     */

    public $rootEntityName;

    /**

     * The name of the custom repository class used for the entity class.

     * (Optional).

     *

     * @var string

     */

    public $customRepositoryClassName;

    /**

     * READ-ONLY: Whether this class describes the mapping of a mapped superclass.

     *

     * @var boolean

     */

    public $isMappedSuperclass = false;

    /**

     * READ-ONLY: The names of the parent classes (ancestors).

     *

     * @var array

     */

    public $parentClasses = array();

    /**

     * READ-ONLY: The names of all subclasses (descendants).

     *

     * @var array

     */

    public $subClasses = array();

    /**

     * READ-ONLY: The named queries allowed to be called directly from Repository.

     * 

     * @var array

     */

    public $namedQueries = array();

    /**

     * READ-ONLY: The field names of all fields that are part of the identifier/primary key

     * of the mapped entity class.

     *

     * @var array

     */

    public $identifier = array();

    /**

     * READ-ONLY: The inheritance mapping type used by the class.

     *

     * @var integer

     */

    public $inheritanceType = self::INHERITANCE_TYPE_NONE;

    /**

     * READ-ONLY: The Id generator type used by the class.

     *

     * @var string

     */

    public $generatorType = self::GENERATOR_TYPE_NONE;

    /**

     * READ-ONLY: The field mappings of the class.

     * Keys are field names and values are mapping definitions.

     *

     * The mapping definition array has the following values:

     *

     * - <b>fieldName</b> (string)

     * The name of the field in the Entity.

     *

     * - <b>type</b> (string)

     * The type name of the mapped field. Can be one of Doctrine's mapping types

     * or a custom mapping type.

     *

     * - <b>columnName</b> (string, optional)

     * The column name. Optional. Defaults to the field name.

     *

     * - <b>length</b> (integer, optional)

     * The database length of the column. Optional. Default value taken from

     * the type.

     *

     * - <b>id</b> (boolean, optional)

     * Marks the field as the primary key of the entity. Multiple fields of an

     * entity can have the id attribute, forming a composite key.

     *

     * - <b>nullable</b> (boolean, optional)

     * Whether the column is nullable. Defaults to FALSE.

     *

     * - <b>columnDefinition</b> (string, optional, schema-only)

     * The SQL fragment that is used when generating the DDL for the column.

     *

     * - <b>precision</b> (integer, optional, schema-only)

     * The precision of a decimal column. Only valid if the column type is decimal.

     *

     * - <b>scale</b> (integer, optional, schema-only)

     * The scale of a decimal column. Only valid if the column type is decimal.

     *

     [* - <b>'unique'] (string, optional, schema-only)</b>

     * Whether a unique constraint should be generated for the column.

     *

     * @var array

     */

    public $fieldMappings = array();

    /**

     * READ-ONLY: An array of field names. Used to look up field names from column names.

     * Keys are column names and values are field names.

     * This is the reverse lookup map of $_columnNames.

     *

     * @var array

     */

    public $fieldNames = array();

    /**

     * READ-ONLY: A map of field names to column names. Keys are field names and values column names.

     * Used to look up column names from field names.

     * This is the reverse lookup map of $_fieldNames.

     *

     * @var array

     * @todo We could get rid of this array by just using $fieldMappings[$fieldName]['columnName'].

     */

    public $columnNames = array();

    /**

     * READ-ONLY: The discriminator value of this class.

     *

     * <b>This does only apply to the JOINED and SINGLE_TABLE inheritance mapping strategies

     * where a discriminator column is used.</b>

     *

     * @var mixed

     * @see discriminatorColumn

     */

    public $discriminatorValue;

    /**

     * READ-ONLY: The discriminator map of all mapped classes in the hierarchy.

     *

     * <b>This does only apply to the JOINED and SINGLE_TABLE inheritance mapping strategies

     * where a discriminator column is used.</b>

     *

     * @var mixed

     * @see discriminatorColumn

     */

    public $discriminatorMap = array();

    /**

     * READ-ONLY: The definition of the descriminator column used in JOINED and SINGLE_TABLE

     * inheritance mappings.

     *

     * @var array

     */

    public $discriminatorColumn;

    /**

     * READ-ONLY: The primary table definition. The definition is an array with the

     * following entries:

     *

     * name => <tableName>

     * schema => <schemaName>

     * indexes => array

     * uniqueConstraints => array

     *

     * @var array

     */

    public $table;

    /**

     * READ-ONLY: The registered lifecycle callbacks for entities of this class.

     *

     * @var array

     */

    public $lifecycleCallbacks = array();

    /**

     * READ-ONLY: The association mappings of this class.

     *

     * The mapping definition array supports the following keys:

     *

     * - <b>fieldName</b> (string)

     * The name of the field in the entity the association is mapped to.

     *

     * - <b>targetEntity</b> (string)

     * The class name of the target entity. If it is fully-qualified it is used as is.

     * If it is a simple, unqualified class name the namespace is assumed to be the same

     * as the namespace of the source entity.

     *

     * - <b>mappedBy</b> (string, required for bidirectional associations)

     * The name of the field that completes the bidirectional association on the owning side.

     * This key must be specified on the inverse side of a bidirectional association.

     * 

     * - <b>inversedBy</b> (string, required for bidirectional associations)

     * The name of the field that completes the bidirectional association on the inverse side.

     * This key must be specified on the owning side of a bidirectional association.

     *

     * - <b>cascade</b> (array, optional)

     * The names of persistence operations to cascade on the association. The set of possible

     * values are: "persist", "remove", "detach", "merge", "refresh", "all" (implies all others).

     *

     * - <b>orderBy</b> (array, one-to-many/many-to-many only)

     * A map of field names (of the target entity) to sorting directions (ASC/DESC).

     * Example: array('priority' => 'desc')

     *

     * - <b>fetch</b> (integer, optional)

     * The fetching strategy to use for the association, usually defaults to FETCH_LAZY.

     * Possible values are: ClassMetadata::FETCH_EAGER, ClassMetadata::FETCH_LAZY.

     *

     * - <b>joinTable</b> (array, optional, many-to-many only)

     * Specification of the join table and its join columns (foreign keys).

     * Only valid for many-to-many mappings. Note that one-to-many associations can be mapped

     * through a join table by simply mapping the association as many-to-many with a unique

     * constraint on the join table.

     *

     * - <b>indexBy</b> (string, optional, to-many only)

     * Specification of a field on target-entity that is used to index the collection by.

     * This field HAS to be either the primary key or a unique column. Otherwise the collection

     * does not contain all the entities that are actually related.

     * 

     * A join table definition has the following structure:

     * <pre>

     * array(

     *     'name' => <join table name>,

     *      'joinColumns' => array(<join column mapping from join table to source table>),

     *      'inverseJoinColumns' => array(<join column mapping from join table to target table>)

     * )

     * </pre>

     *

     *

     * @var array

     */

    public $associationMappings = array();

    /**

     * READ-ONLY: Flag indicating whether the identifier/primary key of the class is composite.

     *

     * @var boolean

     */

    public $isIdentifierComposite = false;

    /**

     * READ-ONLY: Flag indicating wheather the identifier/primary key contains at least one foreign key association.

     *

     * This flag is necessary because some code blocks require special treatment of this cases.

     *

     * @var boolean

     */

    public $containsForeignIdentifier = false;

    /**

     * READ-ONLY: The ID generator used for generating IDs for this class.

     *

     * @var AbstractIdGenerator

     * @todo Remove!

     */

    public $idGenerator;

    /**

     * READ-ONLY: The definition of the sequence generator of this class. Only used for the

     * SEQUENCE generation strategy.

     * 

     * The definition has the following structure:

     * <code>

     * array(

     *     'sequenceName' => 'name',

     *     'allocationSize' => 20,

     *     'initialValue' => 1

     * )

     * </code>

     *

     * @var array

     * @todo Merge with tableGeneratorDefinition into generic generatorDefinition

     */

    public $sequenceGeneratorDefinition;

    /**

     * READ-ONLY: The definition of the table generator of this class. Only used for the

     * TABLE generation strategy.

     *

     * @var array

     * @todo Merge with tableGeneratorDefinition into generic generatorDefinition

     */

    public $tableGeneratorDefinition;

    /**

     * READ-ONLY: The policy used for change-tracking on entities of this class.

     *

     * @var integer

     */

    public $changeTrackingPolicy = self::CHANGETRACKING_DEFERRED_IMPLICIT;

    /**

     * READ-ONLY: A flag for whether or not instances of this class are to be versioned

     * with optimistic locking.

     *

     * @var boolean $isVersioned

     */

    public $isVersioned;

    /**

     * READ-ONLY: The name of the field which is used for versioning in optimistic locking (if any).

     *

     * @var mixed $versionField

     */

    public $versionField;

    /**

     * The ReflectionClass instance of the mapped class.

     *

     * @var ReflectionClass

     */

    public $reflClass;

    /**