StringPropertyBuilder extends BoundedPropertyBuilder implements IStringPropertyBuilder
Adds min/max properties to the builder min defaults to zero and max defaults to PHP_MAX_INT.
Table of Contents
| $pattern | Value validation pattern | string |
|---|---|---|
| $min | min length/value | float |
| $max | Max length / value | float |
| $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 BoundedPropertyBuilder instance | mixed |
| setPattern() | Sets the validation pattern to use. | PropertyBuilder |
| getPattern() | Retrieve the pattern used to validate the value against. | string |
| __construct() | Create a new PropertyBuilder instance | mixed |
| setMin() | Sets the minimum value/length | PropertyBuilder |
| getMin() | Retrieve the minimum value or length | float |
| setMax() | Sets the maximum value/length | PropertyBuilder |
| getMax() | Retrieve the maximum value or length | float |
| 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
$pattern
Value validation pattern
private
string
$pattern
= ''
$min
min length/value
private
float
$min
= PHP_INT_MIN
$max
Max length / value
private
float
$max
= PHP_INT_MAX
$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 BoundedPropertyBuilder instance
public
__construct(
$type :
IPropertyType
[, $flags :
IPropertyFlags
= null ]
[, $name :
string
= '' ]
[, $defaultValue :
mixed
= null ]
[, $behavior :
IPropertyBehavior
= null ]
)
: mixed
Parameters
- $type : IPropertyType
- $flags : IPropertyFlags = null
- $name : string = ''
- $defaultValue : mixed = null
- $behavior : IPropertyBehavior = null
Return values
mixedsetPattern()
Sets the validation pattern to use.
public
setPattern(
$pattern :
string
)
: PropertyBuilder
Parameters
- $pattern : string
Regex
Return values
PropertyBuilder —this
getPattern()
Retrieve the pattern used to validate the value against.
public
getPattern(
)
: string
Return values
string —pattern
__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
mixedsetMin()
Sets the minimum value/length
public
setMin(
$min :
float
)
: PropertyBuilder
Parameters
- $min : float
minimum
Return values
PropertyBuilder —$this
getMin()
Retrieve the minimum value or length
public
getMin(
)
: float
Return values
float —minimum
setMax()
Sets the maximum value/length
public
setMax(
$max :
float
)
: PropertyBuilder
Parameters
- $max : float
maximum
Return values
PropertyBuilder —$this
getMax()
Retrieve the maximum value or length
public
getMax(
)
: float
Return values
float —maximum
getId()
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