Class Document
Value object representing a single collection-based document
Direct known subclasses
triagens\ArangoDb\Edge
,
triagens\ArangoDb\Graph
,
triagens\ArangoDb\User
,
triagens\ArangoDb\Vertex
Methods summary
public
|
|
public static
|
#
createFromArray( array $values, array $options = [] )
Factory method to construct a new document using the values passed to populate it |
public
|
|
public
string
|
|
public
string
|
|
public
string
|
|
public
array
|
#
filterHiddenAttributes( array $attributes, array $_hiddenAttributes = [] )
Returns the attributes with the hidden ones removed |
public
|
|
public
|
|
public
mixed
|
|
public
mixed
|
|
public
boolean
|
|
public
|
|
public
array
|
|
public
mixed
|
|
public
mixed
|
#
getAllAsObject( array $options = [] )
Get all document attributes, and return an empty object if the documentapped into a DocumentWrapper class |
public
|
|
public
array
|
|
public
boolean
|
|
public
|
|
public
boolean
|
|
public
boolean
|
|
public
|
|
public
boolean
|
|
public
|
|
public
|
|
public
string
|
|
public
string
|
|
public
string
|
|
public
mixed
|
|
public
mixed
|
|
public
mixed
|
|
public
|
|
public
mixed
|
Constants summary
string |
ENTRY_ID
Document id index |
#
'_id'
|
string |
ENTRY_KEY
Document key index |
#
'_key'
|
string |
ENTRY_REV
Revision id index |
#
'_rev'
|
string |
ENTRY_ISNEW
isNew id index |
#
'_isNew'
|
string |
ENTRY_HIDDENATTRIBUTES
hidden attribute index |
#
'_hiddenAttributes'
|
string |
ENTRY_IGNOREHIDDENATTRIBUTES
hidden attribute index |
#
'_ignoreHiddenAttributes'
|
string |
OPTION_WAIT_FOR_SYNC
waitForSync option index |
#
'waitForSync'
|
string |
OPTION_POLICY
policy option index |
#
'policy'
|
string |
OPTION_KEEPNULL
keepNull option index |
#
'keepNull'
|
Properties summary
protected
string
|
$_id
The document id (might be NULL for new documents) |
|
protected
string
|
$_key
The document key (might be NULL for new documents) |
|
protected
mixed
|
$_rev
The document revision (might be NULL for new documents) |
|
protected
array
|
$_values
The document attributes (names/values) |
#
[]
|
protected
boolean
|
$_changed
Flag to indicate whether document was changed locally |
#
false
|
protected
boolean
|
$_isNew
Flag to indicate whether document is a new document (never been saved to the server) |
#
true
|
protected
boolean
|
$_doValidate
Flag to indicate whether validation of document values should be performed This can be turned on, but has a performance penalty |
#
false
|
protected
boolean
|
$_ignoreHiddenAttributes
Flag to indicate whether document was changed locally |
#
false
|