Properties

$classComment

$classComment : string

Class comment

Type

string

$modified

$modified : boolean

Has the object been modified

Type

boolean

$connectionNameMap

$connectionNameMap : array

Connection name

Type

array

$collectionNameMap

$collectionNameMap : array

Collection name

Type

array

$propertyMap

$propertyMap : array

Property map

Type

array — map of properties from Document Comment

Methods

getConnectionName()

getConnectionName() : string

Get connection name

Returns

string

setConnectionName()

setConnectionName(string  $connectionName) : void

Set connection name

Parameters

string $connectionName

Connection name

getCollectionName()

getCollectionName() : string

Get collection name

Returns

string

setCollectionName()

setCollectionName(string  $collectionName) : void

Set collection name

Parameters

string $collectionName

Collection name

resetCollectionName()

resetCollectionName() : void

Set collection name

__call()

__call(string  $name, array  $arguments) : mixed

Call method by name

Parameters

string $name

of method to call

array $arguments

Arguments to method

Returns

mixed

toArray()

toArray() : array

Get the object state as a array

Returns

array

__get()

__get(string  $name) : mixed

Get the property

Parameters

string $name

Name of the property

Throws

\Exception

if not found

Returns

mixed

__toString()

__toString() : string

String representation of the object

Returns

string

listPropertyNames()

listPropertyNames() : array

List properties on object

Returns

array —

with property names

listFieldNames()

listFieldNames() : array

List fields on object

Returns

array —

with field names

propertyAlias()

propertyAlias(string  $name) : string

Get property alias

Parameters

string $name

Property name

Returns

string —

Property alias or property name if no alias was found/specfied

getMetadata()

getMetadata() : array

Get meta data

Throws

\InvalidArgumentException

if an invalid option was found

Returns

array

isValidType()

isValidType(string  $property, mixed  $value) : boolean

Check if value is valid for the given property

Parameters

string $property

Name of property

mixed $value

Value to test

Throws

\Localgod\Tick\RangeException

if the value dos not fit the specified size

\InvalidArgumentException

if the value dos not mathc the property declartion

Returns

boolean

getClassComment()

getClassComment() : string

Get class comment

Returns

string

init()

init() : void

Initialize the properties with empty values

modified()

modified(boolean  $modified = false) : boolean

Is the object modified

If true is given as an argument the object will be marked as modified

Parameters

boolean $modified

Set the object as modified

Returns

boolean

propertyExists()

propertyExists(string  $name) : boolean

Check if a property exists

Parameters

string $name

Name of the property to check

Returns

boolean

defaultValue()

defaultValue(string  $name) : mixed

Get property default value

Parameters

string $name

Property name

Returns

mixed —

Property default value if specified

getProperty()

getProperty(string  $name, string  $key) : string

Get property

Parameters

string $name

Name

string $key

Key

Returns

string

notNull()

notNull(string  $name) : boolean

Disallow the value to be persisted if null

Parameters

string $name

Property name

Returns

boolean —

false if the property can be persisted with a null value

fieldAlias()

fieldAlias(string  $field) : string

Get field alias

Parameters

string $field

Field name

Throws

\RuntimeException

if field could not be matched to a property

Returns

string —

Field alias or field name if no alias was found/specfied

mustBeUnique()

mustBeUnique(string  $name) : boolean

Is property unique

Parameters

string $name

Field name

Throws

\RuntimeException

if property don't exists

Returns

boolean —

Property is unique

isValidLength()

isValidLength(string  $name, mixed  $value) : boolean

Check if the value fits the size of the property if the size is specified

Parameters

string $name

Name of the property

mixed $value

Value to test

Throws

\RangeException

if the value dos not fit the specified size

Returns

boolean

propertyType()

propertyType(string  $name) : string

Get the property type

Parameters

string $name

Property name

Returns

string

callGet()

callGet(string  $name, array  $arguments) : mixed

Call get method

Parameters

string $name

of method to call

array $arguments

Arguments to method

Returns

mixed

callSet()

callSet(string  $name, array  $arguments) : mixed

Call set method

Parameters

string $name

of method to call

array $arguments

Arguments to method

Returns

mixed