PHP Class Doctrine\ODM\CouchDB\Mapping\ClassMetadataFactory

Since: 1.0
Author: Benjamin Eberlei ([email protected])
Author: Lukas Kahwe Smith ([email protected])
Inheritance: extends Doctrine\Common\Persistence\Mapping\AbstractClassMetadataFactory
Show file Open project: doctrine/couchdb-odm Class Usage Examples

Public Methods

Method Description
__construct ( DocumentManager $dm ) Creates a new factory instance that uses the given DocumentManager instance.
getAllMetadata ( ) : array Forces the factory to load the metadata of all classes known to the underlying mapping driver.
getMetadataFor ( string $className ) : ClassMetadata Gets the class metadata descriptor for a class.

Protected Methods

Method Description
doLoadMetadata ( $class, $parent, $rootEntityFound, array $nonSuperclassParents )
getDriver ( )
getFqcnFromAlias ( $namespaceAlias, $simpleClassName )
initialize ( )
initializeReflection ( Doctrine\Common\Persistence\Mapping\ClassMetadata $class, Doctrine\Common\Persistence\Mapping\ReflectionService $reflService )
isEntity ( Doctrine\Common\Persistence\Mapping\ClassMetadata $class ) {@inheritDoc}
loadMetadata ( string $className ) : array 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 ClassMetadata instance for the given class name.
wakeupReflection ( Doctrine\Common\Persistence\Mapping\ClassMetadata $class, Doctrine\Common\Persistence\Mapping\ReflectionService $reflService )

Private Methods

Method Description
addAssociationsMapping ( Doctrine\Common\Persistence\Mapping\ClassMetadata $class, Doctrine\Common\Persistence\Mapping\ClassMetadata $parent )
addFieldMapping ( Doctrine\Common\Persistence\Mapping\ClassMetadata $class, Doctrine\Common\Persistence\Mapping\ClassMetadata $parent )
addIndexes ( ClassMetadata $class, ClassMetadata $parent )
validateMapping ( Doctrine\Common\Persistence\Mapping\ClassMetadata $class ) Check for any possible shortcomings in the class:

Method Details

__construct() public method

Creates a new factory instance that uses the given DocumentManager instance.
public __construct ( DocumentManager $dm )
$dm Doctrine\ODM\CouchDB\DocumentManager The DocumentManager instance

doLoadMetadata() protected method

protected doLoadMetadata ( $class, $parent, $rootEntityFound, array $nonSuperclassParents )
$nonSuperclassParents array

getAllMetadata() public method

Forces the factory to load the metadata of all classes known to the underlying mapping driver.
public getAllMetadata ( ) : array
return array The ClassMetadata instances of all mapped classes.

getDriver() protected method

protected getDriver ( )

getFqcnFromAlias() protected method

protected getFqcnFromAlias ( $namespaceAlias, $simpleClassName )

getMetadataFor() public method

Gets the class metadata descriptor for a class.
public getMetadataFor ( string $className ) : ClassMetadata
$className string The name of the class.
return ClassMetadata

initialize() protected method

protected initialize ( )

initializeReflection() protected method

protected initializeReflection ( Doctrine\Common\Persistence\Mapping\ClassMetadata $class, Doctrine\Common\Persistence\Mapping\ReflectionService $reflService )
$class Doctrine\Common\Persistence\Mapping\ClassMetadata
$reflService Doctrine\Common\Persistence\Mapping\ReflectionService

isEntity() protected method

{@inheritDoc}
protected isEntity ( Doctrine\Common\Persistence\Mapping\ClassMetadata $class )
$class Doctrine\Common\Persistence\Mapping\ClassMetadata

loadMetadata() protected method

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

newClassMetadataInstance() protected method

Creates a new ClassMetadata instance for the given class name.
protected newClassMetadataInstance ( string $className ) : ClassMetadata
$className string
return ClassMetadata

wakeupReflection() protected method

protected wakeupReflection ( Doctrine\Common\Persistence\Mapping\ClassMetadata $class, Doctrine\Common\Persistence\Mapping\ReflectionService $reflService )
$class Doctrine\Common\Persistence\Mapping\ClassMetadata
$reflService Doctrine\Common\Persistence\Mapping\ReflectionService