• Главная
• Doctrine
• OXM
• Mapping
• ClassMetadataInfo

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

Показать файл Открыть проект Примеры использования класса

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

Свойство	Тип	Описание
$changeTrackingPolicy	integer	READ-ONLY: The policy used for change-tracking on entities of this class.
$customRepositoryClassName	string	(Optional).
$fieldMappings	array	The mapping definition array supports the following keys: - fieldName (string) The name of the field in the entity this mapping is associated with - id (boolean, optional) Marks this field as the identifier for this class. Used for references - type (string) The type of the field being mapped by this field mapping. Can by any of the allowed Doctrine/OXM/Types or a specific Class name. If used with collection=true, this will assume that each collection object is of the specified type. - xmlName (string, optional) The name of the xml node this class definition will be mapped to. - xmlNode (string) The type of xml object to map this field. Can be one of ('element', 'attribute', or 'text') - required (boolean, optional) Defines if this field is required or not. Checked during marshalling and unmarshalling. - nullable (boolean, optional) Defines if this field is required to be marshalled/unmarshalled if null. - getMethod (string, optional) Defines an optional get method name to use while getting and setting this field on the owning object. - setMethod (string, optional) Defines an optional set method name to use while getting and setting this field on the owning object. - collection (boolean, optional) Define the field as a "collection". This allows for the field to be an array of the above specified type. - direct (boolean, optional, defaults to true) Allow Doctrine OXM to access this field on the class with direct access.
$generatorType	integer	READ-ONLY: The Id generator type used by the class.
$idGenerator	Doctrine\OXM\Id\AbstractIdGenerator	READ-ONLY: The ID generator used for generating IDs for this class.
$identifier		READ-ONLY: The field name of the class identifier.
$isMappedSuperclass	boolean	READ-ONLY: Whether this class describes the mapping of a mapped superclass.
$isRoot	boolean	READ-ONLY: Whether this class describes the mapping xml root element.
$lifecycleCallbacks	array	READ-ONLY: The registered lifecycle callbacks for entities of this class.
$name	string	The name of the class
$parentClasses	array	READ-ONLY: The names of the parent classes (ancestors).
$reflClass	ReflectionClass	The ReflectionClass instance of the mapped class.
$rootXmlEntityName	string	READ-ONLY: The name of the entity class that is at the root of the mapped entity inheritance hierarchy. If the entity is not part of a mapped inheritance hierarchy this is the same as {@link $entityName}.
$xmlFieldMap	array	Mapping xml node names back to class fields keys are xml names
$xmlName	string	The xml node name to map this class to
$xmlNamespaces	array	The mapping definition array supports the following keys - url (required) The url containing this namespace definition. Only one URL can be present within the class which does not have a prefix. One can have any number of prefixed URL's. - prefix (optional) The prefix used by this namespace. Prefixes must be unique.

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

Метод	Описание
__construct ( string $entityName )	Initializes a new ClassMetadata instance that will hold the object-xml mapping metadata of the class with the given name.
addInheritedFieldMapping ( array $fieldMapping )	INTERNAL: Adds a field mapping without completing/validating it.
addLifecycleCallback ( string $callback, string $event )	Adds a lifecycle callback for entities of this class.
getAssociationNames ( ) : array	A numerically indexed list of association names of this persistent class.
getAssociationTargetClass ( string $assocName ) : string	Returns the target class name of the given association.
getFieldMapping ( string $fieldName ) : array	Gets the mapping of a (regular) field that holds some data but not a reference to another object.
getFieldMappings ( ) : array	Returns an array of all field mappings
getFieldName ( string $xmlName ) : string	Gets the field name for a xml name.
getFieldNames ( ) : array	A numerically indexed list of field names of this persistent class.
getFieldXmlName ( $fieldName )
getFieldXmlNode ( $fieldName ) : string	Gets the type of an xml name.
getIdentifier ( ) : string	Gets the mapped identifier field of this class.
getName ( ) : string	The name of this XmlEntity class.
getParentClasses ( ) : array
getReflectionClass ( ) : ReflectionClass	Gets the ReflectionClass instance of the mapped class.
getTypeOfField ( string $fieldName ) : string	Gets the type of a field.
getXmlName ( ) : string	Gets the xml node name used to map this class to an xml node
getXmlNamespaces ( ) : array
getXmlNodeTypes ( ) : array	Returns all bind xml node types
hasAssociation ( string $fieldName ) : boolean	Checks whether the class has a mapped association (embed or reference) with the given field name.
hasField ( $fieldName ) : boolean	Checks whether the class has a (mapped) field with a certain name.
hasFieldWrapping ( $fieldName ) : boolean
hasLifecycleCallbacks ( string $lifecycleEvent ) : boolean	Whether the class has any attached lifecycle listeners or callbacks for a lifecycle event.
hasReference ( string $fieldName ) : boolean	Checks whether the class has a mapped association with the given field name.
hasXmlField ( $xmlName ) : boolean
invokeLifecycleCallbacks ( $lifecycleEvent, XmlEntity $entity, array $arguments = null )	Dispatches the lifecycle event of the given entity to the registered lifecycle callbacks and lifecycle listeners.
isChangeTrackingDeferredExplicit ( ) : boolean	Whether the change tracking policy of this class is "deferred explicit".
isChangeTrackingDeferredImplicit ( ) : boolean	Whether the change tracking policy of this class is "deferred implicit".
isChangeTrackingNotify ( ) : boolean	Whether the change tracking policy of this class is "notify".
isCollection ( $fieldName ) : boolean
isCollectionValuedAssociation ( string $fieldName ) : boolean	Checks whether the class has a mapped reference or embed for the specified field and is a single valued association.
isDirect ( $fieldName ) : boolean
isIdGeneratorAuto ( ) : boolean	Checks whether the class will generate a new \XmlId instance for us.
isIdGeneratorIncrement ( ) : boolean	Checks whether the class will use a collection to generate incremented identifiers.
isIdGeneratorNone ( ) : boolean	Checks whether the class uses no id generator.
isIdGeneratorUuid ( ) : boolean	Checks whether the class will generate a uuid id.
isIdentifier ( string $fieldName ) : boolean	Checks whether a field is part of the identifier/primary key field(s).
isInheritedField ( $fieldName ) : boolean	Checks whether a mapped field is inherited from an entity superclass.
isNullable ( string $fieldName ) : boolean
isRequired ( $fieldName ) : boolean
isSingleValuedAssociation ( string $fieldName ) : boolean	Checks whether the class has a mapped reference or embed for the specified field and is a single valued association.
mapField ( array $mapping ) : void
setChangeTrackingPolicy ( integer $policy )	Sets the change tracking policy used by this class.
setCustomRepositoryClass ( $repositoryClassName )	Registers a custom repository class for the document class.
setIdGenerator ( AbstractIdGenerator $generator )	Sets the ID generator used to generate IDs for instances of this class.
setIdGeneratorType ( $generatorType )	Sets the type of Id generator to use for the mapped class.
setIdentifier ( string $identifier )	INTERNAL: Sets the mapped identifier field of this class.
setLifecycleCallbacks ( array $callbacks )	Sets the lifecycle callbacks for entities of this class.
setName ( string $entityName )
setParentClasses ( array $classNames )	Sets the parent class names.
setXmlName ( $xmlName ) : string	Set the xml node name to be used by this class mapping
setXmlNamespaces ( array $xmlNamespaces ) : void

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

Метод	Описание
inferGetter ( string $fieldName ) : string
inferSetter ( string $fieldName ) : string

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

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