158 lines
3.7 KiB
PHP
158 lines
3.7 KiB
PHP
<?php
|
|
|
|
namespace Doctrine\Persistence\Mapping;
|
|
|
|
use ReflectionClass;
|
|
use function interface_exists;
|
|
|
|
/**
|
|
* Contract for a Doctrine persistence layer ClassMetadata class to implement.
|
|
*/
|
|
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 mixed[]
|
|
*/
|
|
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 bool
|
|
*/
|
|
public function isIdentifier($fieldName);
|
|
|
|
/**
|
|
* Checks if the given field is a mapped property for this class.
|
|
*
|
|
* @param string $fieldName
|
|
*
|
|
* @return bool
|
|
*/
|
|
public function hasField($fieldName);
|
|
|
|
/**
|
|
* Checks if the given field is a mapped association for this class.
|
|
*
|
|
* @param string $fieldName
|
|
*
|
|
* @return bool
|
|
*/
|
|
public function hasAssociation($fieldName);
|
|
|
|
/**
|
|
* Checks if the given field is a mapped single valued association for this class.
|
|
*
|
|
* @param string $fieldName
|
|
*
|
|
* @return bool
|
|
*/
|
|
public function isSingleValuedAssociation($fieldName);
|
|
|
|
/**
|
|
* Checks if the given field is a mapped collection valued association for this class.
|
|
*
|
|
* @param string $fieldName
|
|
*
|
|
* @return bool
|
|
*/
|
|
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 string[]
|
|
*/
|
|
public function getFieldNames();
|
|
|
|
/**
|
|
* Returns an array of identifier field names numerically indexed.
|
|
*
|
|
* @return string[]
|
|
*/
|
|
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 string[]
|
|
*/
|
|
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 bool
|
|
*/
|
|
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 mixed[]
|
|
*/
|
|
public function getIdentifierValues($object);
|
|
}
|
|
|
|
interface_exists(\Doctrine\Common\Persistence\Mapping\ClassMetadata::class);
|