interface ClassMetadata in Plug 7

Contract for a Doctrine persistence layer ClassMetadata class to implement.

@link www.doctrine-project.org @since 2.1 @author Benjamin Eberlei <[e-mail]> @author Jonathan Wage <[e-mail]>

Hierarchy

• interface \Doctrine\Common\Persistence\Mapping\ClassMetadata

15 files declare their use of ClassMetadata

AbstractProxyFactory.php in lib/doctrine/common/lib/Doctrine/Common/Proxy/AbstractProxyFactory.php

AnnotationDriverTest.php in lib/doctrine/common/tests/Doctrine/Tests/Common/Persistence/Mapping/AnnotationDriverTest.php

ClassMetadataFactoryTest.php in lib/doctrine/common/tests/Doctrine/Tests/Common/Persistence/Mapping/ClassMetadataFactoryTest.php

FileDriverTest.php in lib/doctrine/common/tests/Doctrine/Tests/Common/Persistence/Mapping/FileDriverTest.php

LazyLoadableObjectClassMetadata.php in lib/doctrine/common/tests/Doctrine/Tests/Common/Proxy/LazyLoadableObjectClassMetadata.php

... See full list

File

lib/doctrine/common/lib/Doctrine/Common/Persistence/Mapping/ClassMetadata.php, line 30

Namespace

Doctrine\Common\Persistence\Mapping

interface ClassMetadata {

  /**
   * Gets the fully-qualified class name of this persistent class.
   *
   * @return string
   */
  public function getName();

  /**
   * Gets the mapped identifier field name.
   *
   * The returned structure is an array of the identifier field names.
   *
   * @return array
   */
  public function getIdentifier();

  /**
   * Gets the ReflectionClass instance for this mapped class.
   *
   * @return \ReflectionClass
   */
  public function getReflectionClass();

  /**
   * Checks if the given field name is a mapped identifier for this class.
   *
   * @param string $fieldName
   *
   * @return boolean
   */
  public function isIdentifier($fieldName);

  /**
   * Checks if the given field is a mapped property for this class.
   *
   * @param string $fieldName
   *
   * @return boolean
   */
  public function hasField($fieldName);

  /**
   * Checks if the given field is a mapped association for this class.
   *
   * @param string $fieldName
   *
   * @return boolean
   */
  public function hasAssociation($fieldName);

  /**
   * Checks if the given field is a mapped single valued association for this class.
   *
   * @param string $fieldName
   *
   * @return boolean
   */
  public function isSingleValuedAssociation($fieldName);

  /**
   * Checks if the given field is a mapped collection valued association for this class.
   *
   * @param string $fieldName
   *
   * @return boolean
   */
  public function isCollectionValuedAssociation($fieldName);

  /**
   * A numerically indexed list of field names of this persistent class.
   *
   * This array includes identifier fields if present on this class.
   *
   * @return array
   */
  public function getFieldNames();

  /**
   * Returns an array of identifier field names numerically indexed.
   *
   * @return array
   */
  public function getIdentifierFieldNames();

  /**
   * Returns a numerically indexed list of association names of this persistent class.
   *
   * This array includes identifier associations if present on this class.
   *
   * @return array
   */
  public function getAssociationNames();

  /**
   * Returns a type name of this field.
   *
   * This type names can be implementation specific but should at least include the php types:
   * integer, string, boolean, float/double, datetime.
   *
   * @param string $fieldName
   *
   * @return string
   */
  public function getTypeOfField($fieldName);

  /**
   * Returns the target class name of the given association.
   *
   * @param string $assocName
   *
   * @return string
   */
  public function getAssociationTargetClass($assocName);

  /**
   * Checks if the association is the inverse side of a bidirectional association.
   *
   * @param string $assocName
   *
   * @return boolean
   */
  public function isAssociationInverseSide($assocName);

  /**
   * Returns the target field of the owning side of the association.
   *
   * @param string $assocName
   *
   * @return string
   */
  public function getAssociationMappedByTargetField($assocName);

  /**
   * Returns the identifier of this object as an array with field name as key.
   *
   * Has to return an empty array if no identifier isset.
   *
   * @param object $object
   *
   * @return array
   */
  public function getIdentifierValues($object);

}

Members

Name	Modifiers	Type	Description	Overrides
ClassMetadata::getAssociationMappedByTargetField	public	function	Returns the target field of the owning side of the association.	2
ClassMetadata::getAssociationNames	public	function	Returns a numerically indexed list of association names of this persistent class.	2
ClassMetadata::getAssociationTargetClass	public	function	Returns the target class name of the given association.	2
ClassMetadata::getFieldNames	public	function	A numerically indexed list of field names of this persistent class.	2
ClassMetadata::getIdentifier	public	function	Gets the mapped identifier field name.	2
ClassMetadata::getIdentifierFieldNames	public	function	Returns an array of identifier field names numerically indexed.	2
ClassMetadata::getIdentifierValues	public	function	Returns the identifier of this object as an array with field name as key.	2
ClassMetadata::getName	public	function	Gets the fully-qualified class name of this persistent class.	2
ClassMetadata::getReflectionClass	public	function	Gets the ReflectionClass instance for this mapped class.	2
ClassMetadata::getTypeOfField	public	function	Returns a type name of this field.	2
ClassMetadata::hasAssociation	public	function	Checks if the given field is a mapped association for this class.	2
ClassMetadata::hasField	public	function	Checks if the given field is a mapped property for this class.	2
ClassMetadata::isAssociationInverseSide	public	function	Checks if the association is the inverse side of a bidirectional association.	2
ClassMetadata::isCollectionValuedAssociation	public	function	Checks if the given field is a mapped collection valued association for this class.	2
ClassMetadata::isIdentifier	public	function	Checks if the given field name is a mapped identifier for this class.	2
ClassMetadata::isSingleValuedAssociation	public	function	Checks if the given field is a mapped single valued association for this class.	2