Documentation

DefaultPropertySet extends BigSet implements IPropertySet

A Basic property set implementation used for storing a list of properties that represent a row from some data source.

This property set only allows a single property to be flagged as primary.

When using multiple property config objects, if any property name is ambiguous, the last encountered instance is used.

Table of Contents

$properties List of properties \buffalokiwi\magicgraph\property\IProperty[]
$primaryKey Primary key name string
$config Property config. \buffalokiwi\magicgraph\property\IPropertyConfig[]
$propFactory Property factory IPropertyFactory
$modelValidation Extra validation closures for the model validate \Closure[]
$readOnly Read only flag bool
$addedMembers A list of property names that have been added via addPropertyConfig(). string[]
$onAddMember Callbacks for when new members are added. \Closure[]
$hash
__construct() Create a new DefaultPropertySet instance mixed
generateHash() string
setOnAddMember() void
setReadOnly() Sets the property set to read only. void
getPropertyConfigArray() Retrieve the product property configuration array array
getModelValidationArray() An array of closures for model validation f( IModel array
addPropertyConfig() Used to add properties to this property set mixed
getNewMembers() Retrieve a list of property names that have been added via addPropertyConfig(). array
getPropertyConfig() Retrieve the property configuration. IPropertyConfig
containsConfig() Determine if this property set was built using a specific interface. bool
getConfigObjects() Retrieve a list of all of the currently enabled property config instances attached to this property set. array
__clone() Clone the internal property list mixed
getProperty() Retrieve a property by name IProperty
getPrimaryKey() Retrieve the property that represents the primary key. IProperty
getPrimaryKeys() Retrieve an array of keys flagged as primary. array
getPrimaryKeyNames() Retrieve the primary key property names. string[]
getProperties() Retrieve a list of all the properties \buffalokiwi\magicgraph\property\IProperty[]
findProperty() Retrieve a list of properties by flag. \buffalokiwi\magicgraph\property\IProperty[]
getPropertiesByType() Retrieve a list of properties by data type. \buffalokiwi\magicgraph\property\IProperty[]
getPropertiesByFlag() Retrieve a list of properties by flag. array

Properties

$properties

List of properties

private \buffalokiwi\magicgraph\property\IProperty[] $properties = []

$config

Property config.

private \buffalokiwi\magicgraph\property\IPropertyConfig[] $config = []
Cast this to some type to use it.

$modelValidation

Extra validation closures for the model validate

private \Closure[] $modelValidation = []

$addedMembers

A list of property names that have been added via addPropertyConfig().

private string[] $addedMembers = []

$onAddMember

Callbacks for when new members are added.

private \Closure[] $onAddMember = []
f( array $memberNames ) : void

Methods

setOnAddMember()

public setOnAddMember( $callback : Closure ) : void
Parameters
$callback : Closure

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.

getPropertyConfigArray()

Retrieve the product property configuration array

public getPropertyConfigArray( ) : array
Return values
array

getModelValidationArray()

An array of closures for model validation f( IModel

public final getModelValidationArray( ) : array
Return values
array —

Closures

addPropertyConfig()

Used to add properties to this property set

public final addPropertyConfig( ...$config : IPropertyConfig ) : mixed

This MUST be marked as final in the implementing class if it is called by the constructor.

Parameters
$config : IPropertyConfig

config to add

Tags
throws
InvalidArgumentException
final
Return values
mixed

getNewMembers()

Retrieve a list of property names that have been added via addPropertyConfig().

public final getNewMembers( ) : array
Return values
array —

names

getPropertyConfig()

Retrieve the property configuration.

public getPropertyConfig( $interface : string ) : IPropertyConfig

The supplied IPropertyConfig instance must have the name interface or class name as the value of $interface. Otherwise an exception is thrown. This is used to retrieve methods attached to the property config instance.

Parameters
$interface : string

The interface name of the desired property config. If the internal instance does not implement $interface, then an exception is thrown.

Tags
throws
Exception

if config does not implement $interface

Return values
IPropertyConfig

containsConfig()

Determine if this property set was built using a specific interface.

public containsConfig( $interface : string ) : bool
Parameters
$interface : string

Interface to test.

Return values
bool —

Implements

getConfigObjects()

Retrieve a list of all of the currently enabled property config instances attached to this property set.

public getConfigObjects( ) : array
Return values
array —

IPropertyConfig[] config instances

getPrimaryKey()

Retrieve the property that represents the primary key.

public getPrimaryKey( ) : IProperty

If multiple primary keys are used, this returns the first one in the list. Use getPrimaryKeys() if using compound primary keys.

Tags
throws
Exception

if there is no primary key defined

Return values
IProperty —

property

getPrimaryKeys()

Retrieve an array of keys flagged as primary.

public getPrimaryKeys( ) : array

If there are no primary keys defined, this returns an empty array

Return values
array —

IProperty[] primary keys

getPrimaryKeyNames()

Retrieve the primary key property names.

public getPrimaryKeyNames( ) : string[]
Return values
string[] —

names

getProperties()

Retrieve a list of all the properties

public getProperties( ) : \buffalokiwi\magicgraph\property\IProperty[]
Return values
\buffalokiwi\magicgraph\property\IProperty[] —

properties

findProperty()

Retrieve a list of properties by flag.

public findProperty( $flags : IPropertyFlags ) : \buffalokiwi\magicgraph\property\IProperty[]
Parameters
$flags : IPropertyFlags

Flags to test

Return values
\buffalokiwi\magicgraph\property\IProperty[] —

properties

getPropertiesByType()

Retrieve a list of properties by data type.

public getPropertiesByType( $type : IPropertyType ) : \buffalokiwi\magicgraph\property\IProperty[]
Parameters
$type : IPropertyType

Type

Return values
\buffalokiwi\magicgraph\property\IProperty[] —

properties

getPropertiesByFlag()

Retrieve a list of properties by flag.

public getPropertiesByFlag( ...$flags : string ) : array
Parameters
$flags : string

flags

Return values
array —

properties

Search results