$_connection
$_connection :
Connection object
A handler that manages users
. A user-document handler that fetches vertices from the server and persists them on the server. It does so by issuing the appropriate HTTP requests to the server.
__construct(\triagens\ArangoDb\Connection $connection) : \triagens\ArangoDb\Handler
Construct a new handler
\triagens\ArangoDb\Connection | $connection |
|
addUser(mixed $username, mixed $passwd, mixed $active, array $extra, array $options) : boolean
save an user to the user-collection
This will save the user to the user-collection
This will throw if the user cannot be saved
mixed | $username |
|
mixed | $passwd |
|
mixed | $active |
|
array | $extra |
|
array | $options |
|
replaceUser(mixed $username, mixed $passwd, mixed $active, array $extra, array $options) : boolean
Replace an existing User, identified by its username
This will replace the user-document on the server
This will throw if the document cannot be Replaced
mixed | $username |
|
mixed | $passwd |
|
mixed | $active |
|
array | $extra |
|
array | $options |
|
updateUser(mixed $username, mixed $passwd, mixed $active, array $extra, array $options) : boolean
Update an existing user, identified by the username
This will update the user-document on the server
This will throw if the document cannot be updated
mixed | $username |
|
mixed | $passwd |
|
mixed | $active |
|
array | $extra |
|
array | $options |
|
get(mixed $username) : \triagens\ArangoDb\User
Get a single user-document, identified by the username
This will throw if the document cannot be fetched from the server
mixed | $username |
|
getConnection() : \triagens\ArangoDb\Connection
Return the connection object
json_encode_wrapper(array $body) : string
Return a json encoded string for the array passed.
This is a convenience function that calls json_encode_wrapper on the connection
array | $body |
|
validateAndIncludeOldSingleParameterInParams(array $options, array $params, mixed $parameter) : array
Helper function that validates and includes an old single method parameter setting into the parameters array given.
This is only for keeping backwards-compatibility where methods had for example a parameter which was called 'policy' and which was later changed to being an array of options, so more than one options can be passed easily. This is only for options that are to be sent to the ArangoDB server.
array | $options |
|
array | $params |
|
mixed | $parameter |
|
$params - array of parameters for use in a url
includeOptionsInParams(array $options, array $params, array $includeArray) : array
Helper function that runs through the options given and includes them into the parameters array given.
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 form of url parameters (like 'waitForSync', 'keepNull', etc...) .
array | $options |
|
array | $params |
|
array | $includeArray |
|
$params - array of parameters for use in a url
includeOptionsInBody(array $options, array $body, array $includeArray) : array
Helper function that runs through the options given and includes them into the parameters array given.
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...) .
array | $options |
|
array | $body |
|
array | $includeArray |
|
$params - array of parameters for use in a url