Documentation

DefaultStringProperty extends StringProperty

A string property.

This can be validated with min/max length and/or a pattern

Table of Contents

$pattern Optional pattern to use when validating the string. string
$min Minimum value float
$max Maximum value float
$NAME_CACHE A list of names that have been checked via preg_match array
$id An optional unique identifier for this property. int
$caption Property caption/label string
$flags Flags IPropertyFlags
$type Property Type IPropertyType
$name Property name string
$defaultValue Default value mixed
$behavior Property behavior/callbacks \buffalokiwi\magicgraph\property\IPropertyBehavior[]
$value The stored property value mixed
$config Random config data mixed
$readOnly Read only flag bool
$tag An optional tag for the attribute string
__construct() Create a new StringProperty instance mixed
__construct() Create a new Property instance. mixed
getPattern() Retrieve a regular expression used to validate the string property value during calls to IProperty::validate(). string
getValueAsString() Retrieve the property value as a string string
validatePropertyValue() Validate some property value. void
preparePropertyValue() Called after the behavior callback setter, and BEFORE validate. mixed
setPropertyValue() Called when setting a property value. mixed
getMin() Retrieve the maximum value of the stored integer. float
getMax() Retrieve the minimum value of the stored integer. float
reset() Initialize and/or reset the property state to default. IProperty
__clone() Make this clonable. mixed
getTag() Retrieve the tag value for this attribute string
getId() Retrieve the optionally set unique identifier for this property. int
getDefaultValue() Retrieve the default value for some property mixed
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[]
getCaption() Retrieve the attribute caption/label string
getConfig() Retrieve random config data mixed
getPrefix() Retrieve the prefix for this property. string
setReadOnly() Sets the property set to read only. void
validate() Test to see if some value is valid void
testEmpty() Tests that the value is empty. bool
setValue() Sets the property value If the IProperty instance contains a valid Setter callback, it is called and the result of that callback is returned from this method. void
getValue() Retrieve the stored property value mixed
__toString() All properties must be able to be cast to a string. string
getPropertyValue() Called when getting a property value. mixed
initValue() Initialize the value property with some value. mixed
getValidateBehaviorCallback() Retrieve the validate callback from the IPropertyBehavior instance. type
decodeJson() mixed

Properties

$pattern

Optional pattern to use when validating the string.

private string $pattern

$NAME_CACHE

A list of names that have been checked via preg_match

private static array $NAME_CACHE = []

$behavior

Property behavior/callbacks

private \buffalokiwi\magicgraph\property\IPropertyBehavior[] $behavior = []

Methods

__construct()

Create a new StringProperty instance

public __construct( $name : string [, $defaultValue : string|null = '' ] [, $behavior : IPropertyBehavior = null ] , ...$flags : mixed ) : mixed
Parameters
$name : string
$defaultValue : string|null = ''
$behavior : IPropertyBehavior = null
$flags : mixed
Return values
mixed

getPattern()

Retrieve a regular expression used to validate the string property value during calls to IProperty::validate().

public getPattern( ) : string
Return values
string —

regex

getValueAsString()

Retrieve the property value as a string

public getValueAsString( ) : string
Return values
string

validatePropertyValue()

Validate some property value.

protected abstract validatePropertyValue( $value : mixed ) : void

Child classes should implement some sort of validation based on the property type.

Parameters
$value : mixed

The property value

Tags
throws
ValidationException

If the supplied value is not valid

preparePropertyValue()

Called after the behavior callback setter, and BEFORE validate.

protected preparePropertyValue( $value : mixed ) : mixed

Override this to prepare data for validation.

DO NOT USE THIS TO COMMIT DATA.

Parameters
$value : mixed

Value being set.

Return values
mixed —

value to validate and set

setPropertyValue()

Called when setting a property value.

protected setPropertyValue( $value : mixed ) : mixed

This is called AFTER validate. Override this in child classes to modify the value prior to committing it. This is the default implementation which simply returns the supplied value.

Parameters
$value : mixed

Value being set

Return values
mixed —

Value to set

getMin()

Retrieve the maximum value of the stored integer.

public getMin( ) : float

Defaults to PHP_FLOAT_MIN

Return values
float —

min

getMax()

Retrieve the minimum value of the stored integer.

public getMax( ) : float

Defaults to PHP_FLOAT_MAX

Return values
float —

max

reset()

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
throws
InvalidArgumentException
throws
ValidationException
Return values
IProperty —

this - Makes object creation and initialization a single statement.

__clone()

Make this clonable.

public __clone( ) : mixed

Clones the default value if it is an object Clones flags Clones the type

Return values
mixed

getTag()

Retrieve the tag value for this attribute

public getTag( ) : string
Return values
string —

tag

getId()

Retrieve the optionally set unique identifier for this property.

public getId( ) : int

This may be zero if unassigned.

Return values
int —

optional id

getDefaultValue()

Retrieve the default value for some property

public getDefaultValue( ) : mixed
Return values
mixed —

Default value

getName()

Retrieve the property name

public getName( ) : string
Return values
string —

name

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[] —

List of IPropertyBehavior instances

getCaption()

Retrieve the attribute caption/label

public getCaption( ) : string

If no caption is listed, this returns name.

Return values
string

getConfig()

Retrieve random config data

public getConfig( ) : mixed
Return values
mixed

getPrefix()

Retrieve the prefix for this property.

public getPrefix( ) : string

This means this property maps to a child model

Return values
string

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.

testEmpty()

Tests that the value is empty.

private testEmpty( ) : bool

If no behavior is found (IS_EMPTY) then this simply does empty( value ) && value != '0000-00-00 00:00:00'. If behavior is used, the above logic is ignored and the is_empty callback determines empty state.

Return values
bool

setValue()

Sets the property value If the IProperty instance contains a valid Setter callback, it is called and the result of that callback is returned from this method.

public final setValue( $value : mixed ) : void

If that callback is null, the passed value is returned.

Parameters
$value : mixed

Value to set

Tags
throws
ValidationException
final

getValue()

Retrieve the stored property value

public final getValue( [ $context : array = [] ] ) : mixed
Parameters
$context : array = []
Tags
final
Return values
mixed —

value

__toString()

All properties must be able to be cast to a string.

public __toString( ) : string

If value is an array, it will be serialized by default. Classes overriding this method may change this behavior.

Values other than array are simply cast to a string. Here be dragons.

Return values
string —

property value

getPropertyValue()

Called when getting a property value.

protected getPropertyValue( $value : mixed ) : mixed

Override this in child classes to modify the value prior to returning it from the getValue() method. This is the default implementation which simply returns the supplied value.

Parameters
$value : mixed

Value being returned

Return values
mixed —

Value to return

initValue()

Initialize the value property with some value.

protected initValue( ) : mixed

This will be immediately overwritten by the initial call to reset(), but is useful for when value is some object type that must not be null.

Returns null by default.

Return values
mixed —

value

getValidateBehaviorCallback()

Retrieve the validate callback from the IPropertyBehavior instance.

private getValidateBehaviorCallback( ) : type

If the callback contained with IPropertyBehavior is null, a function that always returns true (valid property value) is returned.

Return values
type

decodeJson()

private decodeJson( $value : mixed ) : mixed
Parameters
$value : mixed
Return values
mixed

Search results