FLAG_ABSTRACT
FLAG_ABSTRACT
A class to describe an entity
getAllEntityDescriptors() : array<mixed,\Orpheus\EntityDescriptor\EntityDescriptor>
Get all available entity descriptor
load(string $name, string $class = null) : \Orpheus\EntityDescriptor\EntityDescriptor
Load an entity descriptor from configuraiton file
| string | $name | |
| string | $class |
setAbstract( $abstract) : \Orpheus\EntityDescriptor\EntityDescriptor
Set the abstract property of this entity
| $abstract |
the descriptor
getField( $name) : \Orpheus\EntityDescriptor\FieldDescriptor
Get one field by name
| $name | The field name |
getFields() : array<mixed,\Orpheus\EntityDescriptor\FieldDescriptor>
Get all fields
validateFieldValue(string $fieldName, mixed $value, $input = array(), \Orpheus\EntityDescriptor\PermanentEntity $ref = null)
Validate a value for a specified field, an exception is thrown if the value is invalid
| string | $fieldName | The field to use |
| mixed | $value | input|output value to validate for this field |
| $input | string[] |
|
| \Orpheus\EntityDescriptor\PermanentEntity | $ref |
validate(array $input, array $fields = null, \Orpheus\EntityDescriptor\PermanentEntity $ref = null, integer $errCount) : array
Validate input
| array | $input | |
| array | $fields | |
| \Orpheus\EntityDescriptor\PermanentEntity | $ref | |
| integer | $errCount |
registerType(\Orpheus\EntityDescriptor\TypeDescriptor $type)
Register a TypeDescriptor
| \Orpheus\EntityDescriptor\TypeDescriptor | $type |
getType(string $name, string $type = null) : \Orpheus\EntityDescriptor\TypeDescriptor
Get a type by name
| string | $name | Name of the type to get |
| string | $type | Output parameter for type |