Tracking

A trait for entities which can track changes.

trait Tracking

Copyright: 2015-2016 Appertly

Since: 0.5.1

License: Apache-2.0

Instance Properties

Protected
Name	Type	Summary
`$changes`	`Map`<`string`,`Map`<`string`,`mixed`>>	Changes to persist.

Instance Methods

Public
Returns	Signature and Description
`ConstMap`<`string`,`Map`<`string`,`mixed`>>	`getChanges`() Gets the pending changes.
`bool`	`isDirty`() Whether the object has any changes.

Protected
Returns	Signature and Description
`this`	`aggregateChanges`(`Modifiable $child`, `string $field`) Takes all the changes from a `Modifiable` and copies them under a field name.
`this`	`fieldIncrement`(`string $field`, `int $value = 1`) Sets a field for increment.
`this`	`fieldNow`(`string $field`) Sets a field to the current date.
`this`	`fieldPull`(`string $field`, `mixed $value`) Pulls a value from a array field.
`this`	`fieldPush`(`string $field`, `mixed $value`) Pushes a value onto a field.
`this`	`fieldPushAll`(`string $field`, `ConstVector<mixed> $value`) Pushes a value onto an array field.
`this`	`fieldSet`(`string $field`, `mixed $value`) Sets a field for update.
`this`	`fieldUnset`(`string $field`) Sets a field for removal.

Property Details

$changes

protected Map<string,Map<string,mixed>> $changes

Changes to persist.

Method Details

aggregateChanges

protected function aggregateChanges(Modifiable $child, string $field)

Takes all the changes from a Modifiable and copies them under a field name.

Parameters
Name	Type	Description
`$child`	`Modifiable`	The object containing updates
`$field`	`string`	The field name

Returns
Type	Description
`this`	provides a fluent interface

fieldIncrement

protected function fieldIncrement(string $field, int $value = 1)

Sets a field for increment.

Parameters
Name	Type	Description
`$field`	`string`	The field name
`$value`	`int`	Optional. The increment value. Default is `1`.

Returns
Type	Description
`this`	provides a fluent interface

fieldNow

protected function fieldNow(string $field)

Sets a field to the current date.

Parameters
Name	Type	Description
`$field`	`string`	The field name

Returns
Type	Description
`this`	provides a fluent interface

fieldPull

protected function fieldPull(string $field, mixed $value)

Pulls a value from a array field.

In addition to a single value, you can also specify a query document.

$this->fieldPull('vegetables', 'carrot');
$this->fieldPull('listOfDocs', ['foo' => 'bar']);

Parameters
Name	Type	Description
`$field`	`string`	The field name
`$value`	`mixed`	The value to pull

Returns
Type	Description
`this`	provides a fluent interface

fieldPush

protected function fieldPush(string $field, mixed $value)

Pushes a value onto a field.

Parameters
Name	Type	Description
`$field`	`string`	The field name
`$value`	`mixed`	The value to push

Returns
Type	Description
`this`	provides a fluent interface

fieldPushAll

protected function fieldPushAll(string $field, ConstVector<mixed> $value)

Pushes a value onto an array field.

Parameters
Name	Type	Description
`$field`	`string`	The field name
`$value`	`ConstVector`<`mixed`>	The values to push

Returns
Type	Description
`this`	provides a fluent interface

fieldSet

protected function fieldSet(string $field, mixed $value)

Sets a field for update.

Parameters
Name	Type	Description
`$field`	`string`	The field name
`$value`	`mixed`	The field value

Returns
Type	Description
`this`	provides a fluent interface

fieldUnset

protected function fieldUnset(string $field)

Sets a field for removal.

Parameters
Name	Type	Description
`$field`	`string`	The field name

Returns
Type	Description
`this`	provides a fluent interface

getChanges

public function getChanges()

Gets the pending changes.

Returns
Type	Description
`ConstMap`<`string`,`Map`<`string`,`mixed`>>	The pending changes

isDirty

public function isDirty()

Whether the object has any changes.

Returns
Type	Description
`bool`	Whether the object has any changes