PropertyBuilder implements IPropertyBuilder
Builder used for creating Property instances.
Tags
Table of Contents
| $caption | Property caption/label | string |
|---|---|---|
| $defaultValue | Default property value | mixed |
| $flags | Flags | SPropertyFlags |
| $type | Property Type | EPropertyType |
| $name | Property name | string |
| $behavior | Property behavior | \buffalokiwi\magicgraph\property\IPropertyBehavior[] |
| $config | Some config array if needed. | array |
| $id | Optional unique id | int |
| $prefix | A prefix that can be used to map something to an IModel instance | string |
| $tag | An optional tag | string |
| __construct() | Create a new PropertyBuilder instance | mixed |
| getId() | Retrieve the optionally set unique identifier for this property. | int |
| setId() | Sets the optional unique identifier for this property | void |
| getTag() | string | |
| setTag() | void | |
| getCaption() | Get the property caption/label | string |
| setCaption() | Sets the property caption/label | void |
| getType() | Retrieve the property type | IPropertyType |
| getFlags() | Retrieve the set of flags for this property | IPropertyFlags |
| setFlags() | void | |
| getName() | Retrieve the property name | string |
| setName() | void | |
| setDefaultValue() | Sets the default property value | PropertyBuilder |
| getDefaultValue() | Retrieve the default value for some property | mixed |
| addBehavior() | Sets callbacks to modify the property behavior | void |
| getBehavior() | Retrieve callbacks for modifying property behavior | \buffalokiwi\magicgraph\property\IPropertyBehavior[] |
| setConfig() | Sets some config array if needed. | PropertyBuilder |
| getConfig() | Retrieve some arbitrary config array | array |
| getPrefix() | string | |
| setPrefix() | void |
Properties
$caption
Property caption/label
private
string
$caption
= ''
$defaultValue
Default property value
private
mixed
$defaultValue
$flags
Flags
private
SPropertyFlags
$flags
$type
Property Type
private
EPropertyType
$type
$name
Property name
private
string
$name
$behavior
Property behavior
private
\buffalokiwi\magicgraph\property\IPropertyBehavior[]
$behavior
= []
$config
Some config array if needed.
private
array
$config
= []
$id
Optional unique id
private
int
$id
= ""
$prefix
A prefix that can be used to map something to an IModel instance
private
string
$prefix
= ''
$tag
An optional tag
private
string
$tag
= ''
Methods
__construct()
Create a new PropertyBuilder instance
public
__construct(
$type :
IPropertyType
[, $flags :
IPropertyFlags|null
= null ]
[, $name :
string
= '' ]
[, $defaultValue :
mixed
= null ]
[, $behavior :
IPropertyBehavior|null
= null ]
)
: mixed
Parameters
- $type : IPropertyType
- $flags : IPropertyFlags|null = null
- $name : string = ''
- $defaultValue : mixed = null
- $behavior : IPropertyBehavior|null = null
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
setId()
Sets the optional unique identifier for this property
public
setId(
$id :
int
)
: void
Parameters
- $id : int
id
getTag()
public
getTag(
)
: string
Return values
stringsetTag()
public
setTag(
$tag :
string
)
: void
Parameters
- $tag : string
getCaption()
Get the property caption/label
public
getCaption(
)
: string
Return values
string —caption
setCaption()
Sets the property caption/label
public
setCaption(
$caption :
string
)
: void
Parameters
- $caption : string
caption
getType()
Retrieve the property type
public
getType(
)
: IPropertyType
Return values
IPropertyType —type
getFlags()
Retrieve the set of flags for this property
public
getFlags(
)
: IPropertyFlags
Tags
Return values
IPropertyFlags —flags
setFlags()
public
setFlags(
$flags :
IPropertyFlags
)
: void
Parameters
- $flags : IPropertyFlags
getName()
Retrieve the property name
public
getName(
)
: string
Return values
string —name
setName()
public
setName(
$name :
string
)
: void
Parameters
- $name : string
setDefaultValue()
Sets the default property value
public
setDefaultValue(
$value :
mixed
)
: PropertyBuilder
Parameters
- $value : mixed
Value
Return values
PropertyBuilder —This
getDefaultValue()
Retrieve the default value for some property
public
getDefaultValue(
)
: mixed
Return values
mixed —Default value
addBehavior()
Sets callbacks to modify the property behavior
public
addBehavior(
$behavior :
IPropertyBehavior
)
: void
Parameters
- $behavior : IPropertyBehavior
callbacks
getBehavior()
Retrieve callbacks for modifying property behavior
public
getBehavior(
)
: \buffalokiwi\magicgraph\property\IPropertyBehavior[]
Return values
\buffalokiwi\magicgraph\property\IPropertyBehavior[] —callbacks
setConfig()
Sets some config array if needed.
public
setConfig(
$config :
array
)
: PropertyBuilder
Parameters
- $config : array
Arbitrary config data
Return values
PropertyBuilder —this
getConfig()
Retrieve some arbitrary config array
public
getConfig(
)
: array
Return values
array —config
getPrefix()
public
getPrefix(
)
: string
Return values
stringsetPrefix()
public
setPrefix(
$value :
string
)
: void
Parameters
- $value : string