IEnumProperty extends IProperty
A property backed by an IEnum instance.
This accepts any valid values for the store IEnum and will throw an exception when attempting to set invalid values.
IProperty::getValue() and IProperty::setValue() will both work with string values for the enum.
Table of Contents
| getValueAsEnum() | Retrieve a clone of the stored enum value. | IEnum |
|---|---|---|
| setReadOnly() | Sets the property set to read only. | void |
| getPrefix() | Retrieve the prefix used to identify properties of a child model. | string |
| getConfig() | Retrieve random config data | mixed |
| getId() | Retrieve the optionally set unique identifier for this property. | int |
| getCaption() | Retrieve the attribute caption/label. | string |
| reset() | Initialize and/or reset the property state to default. | IProperty |
| getName() | Retrieve the property name | string |
| getType() | Retrieve the property type | IPropertyType |
| getFlags() | Retrieve the set of flags for this property | IPropertyFlags |
| getPropertyBehavior() | Retrieve the object containing callbacks that can modify some behavior of the property. | \buffalokiwi\magicgraph\property\IPropertyBehavior[] |
| validate() | Test to see if some value is valid | void |
| getDefaultValue() | Retrieve the default value for some property | mixed |
| setValue() | Sets the property value | void |
| getValue() | Retrieve the stored property value | mixed |
| __toString() | All properties must be able to be cast to a string | string |
| getTag() | Retrieve the tag value for this attribute | string |
Methods
getValueAsEnum()
Retrieve a clone of the stored enum value.
public
getValueAsEnum(
)
: IEnum
Return values
IEnum —stored enum
setReadOnly()
Sets the property set to read only.
public
setReadOnly(
)
: void
This is a method because the model still needs to be written to when creating instances populated from persistent storage. The idea is for the mapping object factory to call this method after filling the model, but before returning it.
getPrefix()
Retrieve the prefix used to identify properties of a child model.
public
getPrefix(
)
: string
ie: parent model has property foo_bar child model has property bar
Prefix = foo_
parent->foo_bar = 'baz';
sets bar equal to 'baz' in the child model.
Return values
stringgetConfig()
Retrieve random config data
public
getConfig(
)
: mixed
Return values
mixedgetId()
Retrieve the optionally set unique identifier for this property.
public
getId(
)
: int
This may be zero if unassigned.
Return values
int —optional id
getCaption()
Retrieve the attribute caption/label.
public
getCaption(
)
: string
If no caption is listed, this returns name.
Return values
stringreset()
Initialize and/or reset the property state to default.
public
reset(
)
: IProperty
First checks for an init callback attached to IPropertyBehavior. If it exists, then the result of that callback is used as the default value, otherwise the default value specified during object construction is used.
Second, calls setValue() with the derived default value.
This allows the default value to go through validation.
I really don't like this, but it makes object construction more clear.
Tags
Return values
IProperty —this - Makes object initialization a single statement.
getName()
Retrieve the property name
public
getName(
)
: string
Return values
string —name
getType()
Retrieve the property type
public
getType(
)
: IPropertyType
Return values
IPropertyType —type
getFlags()
Retrieve the set of flags for this property
public
getFlags(
)
: IPropertyFlags
Return values
IPropertyFlags —flags
getPropertyBehavior()
Retrieve the object containing callbacks that can modify some behavior of the property.
public
getPropertyBehavior(
)
: \buffalokiwi\magicgraph\property\IPropertyBehavior[]
Return values
\buffalokiwi\magicgraph\property\IPropertyBehavior[]validate()
Test to see if some value is valid
public
validate(
$value :
type
)
: void
Parameters
- $value : type
Tags
getDefaultValue()
Retrieve the default value for some property
public
getDefaultValue(
)
: mixed
Return values
mixed —Default value
setValue()
Sets the property value
public
setValue(
$value :
mixed
)
: void
Parameters
- $value : mixed
Value to set
Tags
getValue()
Retrieve the stored property value
public
getValue(
[ $context :
array
= [] ]
)
: mixed
Parameters
- $context : array = []
Return values
mixed —value
__toString()
All properties must be able to be cast to a string
public
__toString(
)
: string
Return values
string —property value
getTag()
Retrieve the tag value for this attribute
public
getTag(
)
: string
Return values
string —tag