PHP Class JamesMoss\Flywheel\Document

Represents a document in Flywheel. Essentially this is a Plain Old PHP Object (POPO). The only important property on this object is $id. It's used to ensure uniqueness when storing a document. You can set this yourself via the contructor or if omitted it will be autogenerated for you.

Show file Open project: jamesmoss/flywheel Class Usage Examples

Protected Properties

Property	Type	Description
$__flywheelDocId
$__flywheelInitialId

Public Methods

Method	Description
__construct ( array $data = [] )	Constructor
getId ( ) : string	Get the document ID.
getInitialId ( ) : string	Get the initial document ID.
getNestedProperty ( $field, &$found = false )
setId ( string $id )	Set the document ID.

Method Details

__construct() public method

Constructor

public __construct ( array $data = [] )
$data	array	An associative array, each key/value pair will be turned into properties on this object.

getId() public method

Get the document ID.

public getId ( ) : string
return	string

getInitialId() public method

Get the initial document ID.

public getInitialId ( ) : string
return	string

getNestedProperty() public method

public getNestedProperty ( $field, &$found = false )

setId() public method

Set the document ID.

public setId ( string $id )
$id	string

Property Details

$__flywheelDocId protected property

protected $__flywheelDocId

$__flywheelInitialId protected property

protected $__flywheelInitialId