ClassMetadataBuilder
in package
Builder Object for ClassMetadata
Tags
Table of Contents
- $cm : ClassMetadataInfo
- __construct() : mixed
- addDiscriminatorMapClass() : $this
- Adds a subclass to this inheritance hierarchy.
- addEmbedded() : $this
- Adds and embedded class
- addField() : $this
- Adds Field.
- addIndex() : $this
- Adds Index.
- addInverseManyToMany() : ClassMetadataBuilder
- Adds a simple inverse many to many association.
- addInverseOneToOne() : ClassMetadataBuilder
- Adds simple inverse one-to-one association.
- addLifecycleEvent() : $this
- Adds lifecycle event.
- addManyToOne() : ClassMetadataBuilder
- Adds a simple many to one association, optionally with the inversed by field.
- addNamedQuery() : $this
- Adds named query.
- addOneToMany() : ClassMetadataBuilder
- Adds simple OneToMany association.
- addOwningManyToMany() : ClassMetadataBuilder
- Adds a simple owning many to many association.
- addOwningOneToOne() : ClassMetadataBuilder
- Adds simple owning one-to-one association.
- addUniqueConstraint() : $this
- Adds Unique Constraint.
- createEmbedded() : EmbeddedBuilder
- Creates an embedded builder.
- createField() : FieldBuilder
- Creates a field builder.
- createManyToMany() : ManyToManyAssociationBuilder
- Creates a ManyToMany Association Builder.
- createManyToOne() : AssociationBuilder
- Creates a ManyToOne Association Builder.
- createOneToMany() : OneToManyAssociationBuilder
- Creates a one to many association builder.
- createOneToOne() : AssociationBuilder
- Creates a OneToOne Association Builder.
- getClassMetadata() : ClassMetadataInfo
- setChangeTrackingPolicyDeferredExplicit() : $this
- Sets deferred explicit change tracking policy.
- setChangeTrackingPolicyNotify() : $this
- Sets notify change tracking policy.
- setCustomRepositoryClass() : $this
- Sets custom Repository class name.
- setDiscriminatorColumn() : $this
- Sets the discriminator column details.
- setEmbeddable() : $this
- Marks the class as embeddable.
- setJoinedTableInheritance() : $this
- Sets class as root of a joined table inheritance hierarchy.
- setMappedSuperClass() : $this
- Marks the class as mapped superclass.
- setReadOnly() : $this
- Marks class read only.
- setSingleTableInheritance() : $this
- Sets class as root of a single table inheritance hierarchy.
- setTable() : $this
- Sets the table name.
Properties
$cm
private
ClassMetadataInfo
$cm
Methods
__construct()
public
__construct(ClassMetadataInfo $cm) : mixed
Parameters
- $cm : ClassMetadataInfo
Return values
mixed —addDiscriminatorMapClass()
Adds a subclass to this inheritance hierarchy.
public
addDiscriminatorMapClass(string $name, string $class) : $this
Parameters
- $name : string
- $class : string
Return values
$this —addEmbedded()
Adds and embedded class
public
addEmbedded(string $fieldName, string $class[, string|null $columnPrefix = null ]) : $this
Parameters
- $fieldName : string
- $class : string
- $columnPrefix : string|null = null
Return values
$this —addField()
Adds Field.
public
addField(string $name, string $type[, array<string|int, mixed> $mapping = [] ]) : $this
Parameters
- $name : string
- $type : string
- $mapping : array<string|int, mixed> = []
Tags
Return values
$this —addIndex()
Adds Index.
public
addIndex(array<string|int, mixed> $columns, string $name) : $this
Parameters
- $columns : array<string|int, mixed>
- $name : string
Tags
Return values
$this —addInverseManyToMany()
Adds a simple inverse many to many association.
public
addInverseManyToMany(string $name, string $targetEntity, string $mappedBy) : ClassMetadataBuilder
Parameters
- $name : string
- $targetEntity : string
- $mappedBy : string
Return values
ClassMetadataBuilder —addInverseOneToOne()
Adds simple inverse one-to-one association.
public
addInverseOneToOne(string $name, string $targetEntity, string $mappedBy) : ClassMetadataBuilder
Parameters
- $name : string
- $targetEntity : string
- $mappedBy : string
Return values
ClassMetadataBuilder —addLifecycleEvent()
Adds lifecycle event.
public
addLifecycleEvent(string $methodName, string $event) : $this
Parameters
- $methodName : string
- $event : string
Return values
$this —addManyToOne()
Adds a simple many to one association, optionally with the inversed by field.
public
addManyToOne(string $name, string $targetEntity[, string|null $inversedBy = null ]) : ClassMetadataBuilder
Parameters
- $name : string
- $targetEntity : string
- $inversedBy : string|null = null
Return values
ClassMetadataBuilder —addNamedQuery()
Adds named query.
public
addNamedQuery(string $name, string $dqlQuery) : $this
Parameters
- $name : string
- $dqlQuery : string
Return values
$this —addOneToMany()
Adds simple OneToMany association.
public
addOneToMany(string $name, string $targetEntity, string $mappedBy) : ClassMetadataBuilder
Parameters
- $name : string
- $targetEntity : string
- $mappedBy : string
Return values
ClassMetadataBuilder —addOwningManyToMany()
Adds a simple owning many to many association.
public
addOwningManyToMany(string $name, string $targetEntity[, string|null $inversedBy = null ]) : ClassMetadataBuilder
Parameters
- $name : string
- $targetEntity : string
- $inversedBy : string|null = null
Return values
ClassMetadataBuilder —addOwningOneToOne()
Adds simple owning one-to-one association.
public
addOwningOneToOne(string $name, string $targetEntity[, string|null $inversedBy = null ]) : ClassMetadataBuilder
Parameters
- $name : string
- $targetEntity : string
- $inversedBy : string|null = null
Return values
ClassMetadataBuilder —addUniqueConstraint()
Adds Unique Constraint.
public
addUniqueConstraint(array<string|int, mixed> $columns, string $name) : $this
Parameters
- $columns : array<string|int, mixed>
- $name : string
Tags
Return values
$this —createEmbedded()
Creates an embedded builder.
public
createEmbedded(string $fieldName, string $class) : EmbeddedBuilder
Parameters
- $fieldName : string
- $class : string
Return values
EmbeddedBuilder —createField()
Creates a field builder.
public
createField(string $name, string $type) : FieldBuilder
Parameters
- $name : string
- $type : string
Return values
FieldBuilder —createManyToMany()
Creates a ManyToMany Association Builder.
public
createManyToMany(string $name, string $targetEntity) : ManyToManyAssociationBuilder
Parameters
- $name : string
- $targetEntity : string
Return values
ManyToManyAssociationBuilder —createManyToOne()
Creates a ManyToOne Association Builder.
public
createManyToOne(string $name, string $targetEntity) : AssociationBuilder
Note: This method does not add the association, you have to call build() on the AssociationBuilder.
Parameters
- $name : string
- $targetEntity : string
Return values
AssociationBuilder —createOneToMany()
Creates a one to many association builder.
public
createOneToMany(string $name, string $targetEntity) : OneToManyAssociationBuilder
Parameters
- $name : string
- $targetEntity : string
Return values
OneToManyAssociationBuilder —createOneToOne()
Creates a OneToOne Association Builder.
public
createOneToOne(string $name, string $targetEntity) : AssociationBuilder
Parameters
- $name : string
- $targetEntity : string
Return values
AssociationBuilder —getClassMetadata()
public
getClassMetadata() : ClassMetadataInfo
Return values
ClassMetadataInfo —setChangeTrackingPolicyDeferredExplicit()
Sets deferred explicit change tracking policy.
public
setChangeTrackingPolicyDeferredExplicit() : $this
Return values
$this —setChangeTrackingPolicyNotify()
Sets notify change tracking policy.
public
setChangeTrackingPolicyNotify() : $this
Return values
$this —setCustomRepositoryClass()
Sets custom Repository class name.
public
setCustomRepositoryClass(string $repositoryClassName) : $this
Parameters
- $repositoryClassName : string
Return values
$this —setDiscriminatorColumn()
Sets the discriminator column details.
public
setDiscriminatorColumn(string $name[, string $type = 'string' ][, int $length = 255 ]) : $this
Parameters
- $name : string
- $type : string = 'string'
- $length : int = 255
Return values
$this —setEmbeddable()
Marks the class as embeddable.
public
setEmbeddable() : $this
Return values
$this —setJoinedTableInheritance()
Sets class as root of a joined table inheritance hierarchy.
public
setJoinedTableInheritance() : $this
Return values
$this —setMappedSuperClass()
Marks the class as mapped superclass.
public
setMappedSuperClass() : $this
Return values
$this —setReadOnly()
Marks class read only.
public
setReadOnly() : $this
Return values
$this —setSingleTableInheritance()
Sets class as root of a single table inheritance hierarchy.
public
setSingleTableInheritance() : $this
Return values
$this —setTable()
Sets the table name.
public
setTable(string $name) : $this
Parameters
- $name : string