PHP Класс 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.

Показать файл Открыть проект Примеры использования класса

Защищенные свойства (Protected)

Свойство	Тип	Описание
$__flywheelDocId
$__flywheelInitialId

Открытые методы

Метод	Описание
__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.

Описание методов

__construct() публичный Метод

Constructor

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

getId() публичный Метод

Get the document ID.

public getId ( ) : string
Результат	string

getInitialId() публичный Метод

Get the initial document ID.

public getInitialId ( ) : string
Результат	string

getNestedProperty() публичный Метод

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

setId() публичный Метод

Set the document ID.

public setId ( string $id )
$id	string

Описание свойств

$__flywheelDocId защищенное свойство

protected $__flywheelDocId

$__flywheelInitialId защищенное свойство

protected $__flywheelInitialId