A handler that manages views.
| package | ArangoDBClient |
|---|---|
| since | 3.4 |
| inherited_from | \ArangoDBClient\Handler |
__construct(\ArangoDBClient\Connection $connection)
\ArangoDBClient\Connectioncreate(\ArangoDBClient\View $view) : array
This will create a view using the given view object and return an array of the created view object's attributes.
| since | 3.4 |
|---|
\ArangoDBClient\View\ArangoDBClient\Exception |
|---|
arraydrop(mixed $view) : boolean
| since | 3.4 |
|---|
mixed\ArangoDBClient\Exception |
|---|
boolean- always true, will throw if there is an errorget(String $view) : \ArangoDBClient\View | false
This will get a view.
| since | 3.4 |
|---|
String\ArangoDBClient\ClientException |
|---|
\ArangoDBClient\Viewfalse
properties(mixed $view) : array
| since | 3.4 |
|---|
mixed\ArangoDBClient\Exception |
|---|
array- Returns an array of attributes. Will throw if there is an errorrename(mixed $view, string $name) : boolean
mixedstring\ArangoDBClient\Exception |
|---|
boolean- always true, will throw if there is an errorsetDocumentClass(string $class) : \ArangoDBClient\DocumentClassable
stringDocument class to use
\ArangoDBClient\DocumentClassablesetEdgeClass(string $class) : \ArangoDBClient\DocumentClassable
stringEdge class to use
\ArangoDBClient\DocumentClassablesetProperties(mixed $view, array $properties) : array
| since | 3.4 |
|---|
mixedarray\ArangoDBClient\Exception |
|---|
array- Returns an array of attributes. Will throw if there is an erroraddTransactionHeader(array $headers, mixed $collection)
arraymixedgetConnection() : \ArangoDBClient\Connection
\ArangoDBClient\Connection- the connection objectgetConnectionOption($optionName) : mixed
\ArangoDBClient\ClientException |
|---|
mixed- the option's valueincludeOptionsInBody(array $options, array $body, array $includeArray = array()) : array
Only options that are set in $includeArray will be included. This is only for options that are to be sent to the ArangoDB server in a json body(like 'limit', 'skip', etc...) .
arrayarrayarrayarray$params - array of parameters for use in a urljson_encode_wrapper(array $body) : string
This is a convenience function that calls json_encode_wrapper on the connection
array\ArangoDBClient\ClientException |
|---|
string- json string of the body that was passedmakeCollection(mixed $value) : string
mixed\ArangoDBClient\ClientException |
|---|
string- collection name$_documentClass : string
'\ArangoDBClient\Document'$_edgeClass : string
'\ArangoDBClient\Edge'$_connection
| param |
|---|
OPTION_RENAME = 'rename'