Class Client

The Client class. This is the base operating class through which everything cooperates. The class provides its own IOC Container for easy injection and instantiation of needed classes.

Namespace: frankmayer\ArangoDbPhpCore
Package: frankmayer\ArangoDbPhpCore
Located at Client.php

Methods summary

`public`	# `__construct( frankmayer\ArangoDbPhpCore\ConnectorInterface $connector, array $clientOptions = null )` Parameters `$connector` `$clientOptions`
`public boolean`	# `setPluginsFromPluginArray( null $plugins = null )` Parameters `$plugins` Returns boolean
`public`	# `notifyPlugins( $eventName, array $eventData = [] )` Parameters `$eventName` `$eventData`
`public mixed`	# `doRequest( $request )` Parameters `$request` Returns mixed
`public`	# `bind( $type, Closure $closure )` Binding method for the IOC Container Binding method for the IOC Container Parameters `$type` `$closure`
`public mixed`	# `make( $type )` Make method for the IOC Container Make method for the IOC Container Parameters `$type` Returns mixed Throws `frankmayer\ArangoDbPhpCore\ClientException`
`public`	# `setArangoDBApiVersion( string $version )` Parameters `$version` Returns $this
`public string`	# `getArangoDBApiVersion( )` Returns string
`public`	# `setClientOptions( array $clientOptions )` Set complete Client Options Set complete Client Options Parameters `$clientOptions` Returns $this
`public array`	# `getClientOptions( )` Returns array
`public`	# `setConnector( frankmayer\ArangoDbPhpCore\ConnectorInterface $connector )` Parameters `$connector` Returns $this
`public frankmayer\ArangoDbPhpCore\ConnectorInterface`	# `getConnector( )` Returns `frankmayer\ArangoDbPhpCore\ConnectorInterface`
`public`	# `setDatabase( string $database )` Parameters `$database` Returns $this
`public string`	# `getDatabase( )` Returns string
`public`	# `setEndpoint( string $endpoint )` Parameters `$endpoint` Returns $this
`public string`	# `getEndpoint( )` Returns string
`public`	# `setPluginManager( frankmayer\ArangoDbPhpCore\Plugins\PluginManager $pluginManager )` Parameters `$pluginManager` Returns $this
`public frankmayer\ArangoDbPhpCore\Plugins\PluginManager`	# `getPluginManager( )` Returns `frankmayer\ArangoDbPhpCore\Plugins\PluginManager`
`public`	# `setRequestClass( frankmayer\ArangoDbPhpCore\Protocols\RequestInterface\|frankmayer\ArangoDbPhpCore\Protocols\Http\HttpRequestInterface $requestClass )` Parameters `$requestClass` Returns $this
`public frankmayer\ArangoDbPhpCore\Protocols\RequestInterface`	# `getRequestClass( )` Returns `frankmayer\ArangoDbPhpCore\Protocols\RequestInterface`
`public frankmayer\ArangoDbPhpCore\Protocols\RequestInterface`	# `getRequest( )` Returns `frankmayer\ArangoDbPhpCore\Protocols\RequestInterface`
`public frankmayer\ArangoDbPhpCore\Protocols\ResponseInterface`	# `getResponse( )` Returns `frankmayer\ArangoDbPhpCore\Protocols\ResponseInterface`
`public`	# `setResponseClass( frankmayer\ArangoDbPhpCore\Protocols\ResponseInterface $responseClass )` Parameters `$responseClass` Returns $this
`public frankmayer\ArangoDbPhpCore\Protocols\ResponseInterface`	# `getResponseClass( )` Returns `frankmayer\ArangoDbPhpCore\Protocols\ResponseInterface`

Properties summary

`protected`	`$iocContainerArray`	#
`public frankmayer\ArangoDbPhpCore\Plugins\PluginManager`	`$pluginManager` The plugin-manager for this client. The plugin-manager for this client.	#
`public frankmayer\ArangoDbPhpCore\ConnectorInterface`	`$connector` $connector The connector instance to use, in order to connect to the server $connector The connector instance to use, in order to connect to the server	#
`public array`	`$clientOptions` The client options. An array of client options. The client options. An array of client options.	#
`public string`	`$databasePathPrefix` The database path prefix to use. For example: '/_db/'. (defaults to '/_db/') The database path prefix to use. For example: '/_db/'. (defaults to '/_db/')	#
`public string`	`$database` The database to use. For example: 'my_database' The database to use. For example: 'my_database'	#
`public string`	`$fullDatabasePath` The the full database path. This is a concatenation of $databasePathPrefix & $database that happens on instantiation. The the full database path. This is a concatenation of $databasePathPrefix & $database that happens on instantiation.	#
`public string`	`$endpoint` The endpoint to connect to. For example: 'http://localhost:8529' The endpoint to connect to. For example: 'http://localhost:8529'	#
`public string`	`$requestClass` The class name (including path) for example 'frankmayer\ArangoDbPhpCore\Connectors\Http\HttpRequest' The class name (including path) for example 'frankmayer\ArangoDbPhpCore\Connectors\Http\HttpRequest'	#
`public string`	`$responseClass` The class name (including path) for example 'frankmayer\ArangoDbPhpCore\Connectors\Http\HttpResponse' The class name (including path) for example 'frankmayer\ArangoDbPhpCore\Connectors\Http\HttpResponse'	#
`public string`	`$arangoDBApiVersion` The ArangoDB api version to signal The ArangoDB api version to signal	#

Namespaces

Classes

Interfaces

Exceptions

Class Client

Methods summary

Parameters

Parameters

Returns

Parameters

Parameters

Returns

Parameters

Parameters

Returns

Throws

Parameters

Returns

Returns

Parameters

Returns

Returns

Parameters

Returns

Returns

Parameters

Returns

Returns

Parameters

Returns

Returns

Parameters

Returns

Returns

Parameters

Returns

Returns

Returns

Returns

Parameters

Returns

Returns

Properties summary