Doctrine\Common\Persistence\Mapping\ClassMetadata
Contract for a Doctrine persistence layer ClassMetadata class to implement.
- Author: Benjamin Eberlei <kontakt@beberlei.de>
- License: http://www.opensource.org/licenses/lgpl-license.php LGPL
Synopsis
interface ClassMetadata
{
- // methods
- public string getName()
- public array getIdentifier()
- public ReflectionClass getReflectionClass()
- public boolean isIdentifier()
- public boolean hasField()
- public boolean hasAssociation()
- public boolean isSingleValuedAssociation()
- public boolean isCollectionValuedAssociation()
- public array getFieldNames()
- public array getIdentifierFieldNames()
- public array getAssociationNames()
- public string getTypeOfField()
- public string getAssociationTargetClass()
- public boolean isAssociationInverseSide()
- public string getAssociationMappedByTargetField()
- public array getIdentifierValues()
Methods
public
- getAssociationMappedByTargetField() — Returns the target field of the owning side of the association
- getAssociationNames() — A numerically indexed list of association names of this persistent class.
- getAssociationTargetClass() — Returns the target class name of the given association.
- getFieldNames() — A numerically indexed list of field names of this persistent class.
- getIdentifier() — Gets the mapped identifier field name.
- getIdentifierFieldNames() — Returns an array of identifier field names numerically indexed.
- getIdentifierValues() — Return the identifier of this object as an array with field name as key.
- getName() — Get fully-qualified class name of this persistent class.
- getReflectionClass() — Gets the ReflectionClass instance for this mapped class.
- getTypeOfField() — Returns a type name of this field.
- hasAssociation() — Checks if the given field is a mapped association for this class.
- hasField() — Checks if the given field is a mapped property for this class.
- isAssociationInverseSide() — Checks if the association is the inverse side of a bidirectional association
- isCollectionValuedAssociation() — Checks if the given field is a mapped collection valued association for this class.
- isIdentifier() — Checks if the given field name is a mapped identifier for this class.
- isSingleValuedAssociation() — Checks if the given field is a mapped single valued association for this class.