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

С версии: 2.0
Автор: Richard Fullmer ([email protected])
Наследование: implements Doctrine\Common\Persistence\Mapping\ClassMetadataFactory
Показать файл Открыть проект Примеры использования класса

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

Метод Описание
__construct ( Configuration $configuration, Doctrine\Common\EventManager $evm = null ) : null
getAllMetadata ( ) : array Forces the factory to load the metadata of all classes known to the underlying mapping driver.
getAllXmlNodes ( ) : array Preloads all metadata and returns an array of all known mapped node types
getCacheDriver ( ) : Doctrine\Common\Cache\Cache Gets the cache driver used by the factory to cache ClassMetadata instances.
getLoadedMetadata ( ) : array
getMetadataFor ( string $className ) : ClassMetadata Gets the class metadata descriptor for a class.
hasMetadataFor ( string $className ) : boolean Checks whether the factory has the metadata for a class loaded already.
setCacheDriver ( Doctrine\Common\Cache\Cache $cacheDriver ) Sets the cache driver used by the factory to cache Mapping instances.
setMetadataFor ( string $className, ClassMapping $class ) Sets the metadata descriptor for a specific class.

Защищенные методы

Метод Описание
getParentClasses ( string $name ) : array Get array of parent classes for the given entity class
loadMetadata ( string $name ) Loads the metadata of the class in question and all it's ancestors whose metadata is still not loaded.
newClassMetadataInstance ( string $className ) : ClassMetadata Creates a new Mapping instance for the given class name.

Приватные методы

Метод Описание
addInheritedFields ( ClassMetadata $subClass, ClassMetadata $parentClass ) Adds inherited fields to the subclass mapping.
completeIdGeneratorMapping ( ClassMetadataInfo $class ) Completes the ID generator mapping. If "auto" is specified we choose the generator most appropriate.
completeMappingTypeValidation ( string $className, ClassMetadataInfo $class ) Complete and validate type mappings
initialize ( ) Lazy initialization of this stuff, especially the metadata driver, since these are not needed at all when a metadata cache is active.

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

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

public __construct ( Configuration $configuration, Doctrine\Common\EventManager $evm = null ) : null
$configuration Doctrine\OXM\Configuration
$evm Doctrine\Common\EventManager
Результат null

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

Forces the factory to load the metadata of all classes known to the underlying mapping driver.
public getAllMetadata ( ) : array
Результат array The ClassMetadata instances of all mapped classes.

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

Preloads all metadata and returns an array of all known mapped node types
public getAllXmlNodes ( ) : array
Результат array

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

Gets the cache driver used by the factory to cache ClassMetadata instances.
public getCacheDriver ( ) : Doctrine\Common\Cache\Cache
Результат Doctrine\Common\Cache\Cache

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

public getLoadedMetadata ( ) : array
Результат array

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

Gets the class metadata descriptor for a class.
public getMetadataFor ( string $className ) : ClassMetadata
$className string The name of the class.
Результат ClassMetadata

getParentClasses() защищенный Метод

Get array of parent classes for the given entity class
protected getParentClasses ( string $name ) : array
$name string
Результат array $parentClasses

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

Checks whether the factory has the metadata for a class loaded already.
public hasMetadataFor ( string $className ) : boolean
$className string
Результат boolean TRUE if the metadata of the class in question is already loaded, FALSE otherwise.

loadMetadata() защищенный Метод

Loads the metadata of the class in question and all it's ancestors whose metadata is still not loaded.
protected loadMetadata ( string $name )
$name string The name of the class for which the metadata should get loaded.

newClassMetadataInstance() защищенный Метод

Creates a new Mapping instance for the given class name.
protected newClassMetadataInstance ( string $className ) : ClassMetadata
$className string
Результат ClassMetadata

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

Sets the cache driver used by the factory to cache Mapping instances.
public setCacheDriver ( Doctrine\Common\Cache\Cache $cacheDriver )
$cacheDriver Doctrine\Common\Cache\Cache

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

NOTE: This is only useful in very special cases, like when generating proxy classes.
public setMetadataFor ( string $className, ClassMapping $class )
$className string
$class ClassMapping