PHP Класс Doctrine\OXM\Mapping\ClassMetadata

Once populated, ClassMetadata instances are usually cached in a serialized form. IMPORTANT NOTE: 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).
См. ссылку: www.doctrine-project.com
С версии: 2.0
Автор: Jonathan H. Wage ([email protected])
Автор: Richard Fullmer ([email protected])
Наследование: extends ClassMetadataInfo
Показать файл Открыть проект Примеры использования класса

Открытые свойства

Свойство Тип Описание
$reflFields array The ReflectionProperty instances of the mapped class.

Открытые методы

Метод Описание
__construct ( string $entityName ) Initializes a new ClassMetadata instance that will hold the object-document mapping metadata of the class with the given name.
__sleep ( ) : array Determines which fields get serialized.
__wakeup ( ) : void Restores some state that can not be serialized/unserialized.
getFieldValue ( object $entity, string $fieldName ) Gets the specified field's value off the given entity.
getIdentifierValue ( object $xmlEntity ) : string Gets the document identifier.
getReflectionProperties ( ) : ReflectionProperty[] Gets the ReflectionPropertys of the mapped class.
getReflectionProperty ( string $name ) : ReflectionProperty Gets a ReflectionProperty for a specific field of the mapped class.
mapField ( array $mapping ) Map a field.
newInstance ( ) : object Creates a new instance of the mapped class, without invoking the constructor.
setFieldValue ( object $entity, string $fieldName, mixed $value ) Sets the specified field to the specified value on the given entity.
setIdentifierValue ( object $xmlEntity, array $id ) Populates the entity identifier of an entity.

Описание методов

__construct() публичный Метод

Initializes a new ClassMetadata instance that will hold the object-document mapping metadata of the class with the given name.
public __construct ( string $entityName )
$entityName string The name of the document class the new instance is used for.

__sleep() публичный Метод

It is only serialized what is necessary for best unserialization performance. That means any metadata properties that are not set or empty or simply have their default value are NOT serialized. Parts that are also NOT serialized because they can not be properly unserialized: - reflClass (ReflectionClass) - reflFields (ReflectionProperty array)
public __sleep ( ) : array
Результат array The names of all the fields that should be serialized.

__wakeup() публичный Метод

Restores some state that can not be serialized/unserialized.
public __wakeup ( ) : void
Результат void

getFieldValue() публичный Метод

Gets the specified field's value off the given entity.
public getFieldValue ( object $entity, string $fieldName )
$entity object
$fieldName string

getIdentifierValue() публичный Метод

Gets the document identifier.
public getIdentifierValue ( object $xmlEntity ) : string
$xmlEntity object
Результат string $id

getReflectionProperties() публичный Метод

Gets the ReflectionPropertys of the mapped class.
public getReflectionProperties ( ) : ReflectionProperty[]
Результат ReflectionProperty[] An array of ReflectionProperty instances.

getReflectionProperty() публичный Метод

Gets a ReflectionProperty for a specific field of the mapped class.
public getReflectionProperty ( string $name ) : ReflectionProperty
$name string
Результат ReflectionProperty

mapField() публичный Метод

Map a field.
public mapField ( array $mapping )
$mapping array The mapping information.

newInstance() публичный Метод

Creates a new instance of the mapped class, without invoking the constructor.
public newInstance ( ) : object
Результат object

setFieldValue() публичный Метод

Sets the specified field to the specified value on the given entity.
public setFieldValue ( object $entity, string $fieldName, mixed $value )
$entity object
$fieldName string
$value mixed

setIdentifierValue() публичный Метод

Populates the entity identifier of an entity.
public setIdentifierValue ( object $xmlEntity, array $id )
$xmlEntity object
$id array

Описание свойств

$reflFields публичное свойство

The ReflectionProperty instances of the mapped class.
public array $reflFields
Результат array