PHP Class Neos\Flow\Reflection\ClassSchema

ファイルを表示 Open project: neos/flow-development-collection Class Usage Examples

Protected Properties

Property Type Description
$className string Name of the class this schema is referring to
$identityProperties array The properties forming the identity of an object
$lazyLoadable boolean Whether instances of the class can be lazy-loadable
$modelType integer Model type of the class this schema is referring to
$properties array Properties of the class which need to be persisted
$repositoryClassName string

Public Methods

Method Description
__construct ( string $className ) Constructs this class schema
addProperty ( string $name, string $type, boolean $lazy = false, boolean $transient = false ) : void Adds (defines) a specific property and its type.
getClassName ( ) : string Returns the class name this schema is referring to
getIdentityProperties ( ) : array Gets the properties (names and types) forming the identity of an object.
getModelType ( ) : integer Returns the model type of the class this schema is referring to.
getProperties ( ) : array Returns all properties defined in this schema
getProperty ( string $propertyName ) : array Returns the given property defined in this schema. Check with hasProperty($propertyName) before!
getRepositoryClassName ( ) : string
hasProperty ( string $propertyName ) : boolean If the class schema has a certain property.
isAggregateRoot ( ) : boolean Whether the class is accessible through a repository and therefore an aggregate root.
isLazyLoadableObject ( ) : boolean Marks the class as being lazy-loadable.
isMultiValuedProperty ( string $propertyName ) : boolean Checks if the given property defined in this schema is multi-valued (i.e.
isPropertyLazy ( string $propertyName ) : boolean If a certain class schema property is to be lazy loaded
isPropertyTransient ( string $propertyName ) : boolean If a certain class schema property is to disregarded for persistence
markAsIdentityProperty ( string $propertyName ) : void Marks the given property as one of properties forming the identity of an object. The property must already be registered in the class schema.
setLazyLoadableObject ( boolean $lazyLoadable ) : void Marks the class as being lazy-loadable.
setModelType ( integer $modelType ) : void Sets the model type of the class this schema is referring to.
setRepositoryClassName ( string $repositoryClassName ) : void Set the class name of the repository managing an entity.

Method Details

__construct() public method

Constructs this class schema
public __construct ( string $className )
$className string Name of the class this schema is referring to

addProperty() public method

Adds (defines) a specific property and its type.
public addProperty ( string $name, string $type, boolean $lazy = false, boolean $transient = false ) : void
$name string Name of the property
$type string Type of the property
$lazy boolean Whether the property should be lazy-loaded when reconstituting
$transient boolean Whether the property should not be considered for persistence
return void

getClassName() public method

Returns the class name this schema is referring to
public getClassName ( ) : string
return string The class name

getIdentityProperties() public method

Gets the properties (names and types) forming the identity of an object.
See also: markAsIdentityProperty()
public getIdentityProperties ( ) : array
return array

getModelType() public method

Returns the model type of the class this schema is referring to.
public getModelType ( ) : integer
return integer The model type, one of the MODELTYPE_* constants.

getProperties() public method

Returns all properties defined in this schema
public getProperties ( ) : array
return array

getProperty() public method

Returns the given property defined in this schema. Check with hasProperty($propertyName) before!
public getProperty ( string $propertyName ) : array
$propertyName string
return array

getRepositoryClassName() public method

public getRepositoryClassName ( ) : string
return string

hasProperty() public method

If the class schema has a certain property.
public hasProperty ( string $propertyName ) : boolean
$propertyName string Name of the property
return boolean

isAggregateRoot() public method

Whether the class is accessible through a repository and therefore an aggregate root.
public isAggregateRoot ( ) : boolean
return boolean TRUE

isLazyLoadableObject() public method

Marks the class as being lazy-loadable.
public isLazyLoadableObject ( ) : boolean
return boolean

isMultiValuedProperty() public method

array or SplObjectStorage).
public isMultiValuedProperty ( string $propertyName ) : boolean
$propertyName string
return boolean

isPropertyLazy() public method

If a certain class schema property is to be lazy loaded
public isPropertyLazy ( string $propertyName ) : boolean
$propertyName string Name of the property
return boolean

isPropertyTransient() public method

If a certain class schema property is to disregarded for persistence
public isPropertyTransient ( string $propertyName ) : boolean
$propertyName string Name of the property
return boolean

markAsIdentityProperty() public method

Marks the given property as one of properties forming the identity of an object. The property must already be registered in the class schema.
public markAsIdentityProperty ( string $propertyName ) : void
$propertyName string
return void

setLazyLoadableObject() public method

Marks the class as being lazy-loadable.
public setLazyLoadableObject ( boolean $lazyLoadable ) : void
$lazyLoadable boolean
return void

setModelType() public method

Sets the model type of the class this schema is referring to.
public setModelType ( integer $modelType ) : void
$modelType integer The model type, one of the MODELTYPE_* constants.
return void

setRepositoryClassName() public method

Set the class name of the repository managing an entity.
public setRepositoryClassName ( string $repositoryClassName ) : void
$repositoryClassName string
return void

Property Details

$className protected_oe property

Name of the class this schema is referring to
protected string $className
return string

$identityProperties protected_oe property

The properties forming the identity of an object
protected array $identityProperties
return array

$lazyLoadable protected_oe property

Whether instances of the class can be lazy-loadable
protected bool $lazyLoadable
return boolean

$modelType protected_oe property

Model type of the class this schema is referring to
protected int $modelType
return integer

$properties protected_oe property

Properties of the class which need to be persisted
protected array $properties
return array

$repositoryClassName protected_oe property

protected string $repositoryClassName
return string