ArangoDB-PHP-Core API Documentation
  • Namespace
  • Class
  • Deprecated

Namespaces

  • frankmayer
    • ArangoDbPhpCore
      • Api
        • Rest
      • Config
      • Connectors
      • Plugins
      • Protocols
        • Http
      • TraitRepository

Classes

  • Api
  • Async
  • Batch
  • Collection
  • Database
  • Document
  • DocumentBase
  • Edge

Traits

  • DocumentTrait
  • EdgeTrait

Class Async

Class Async

frankmayer\ArangoDbPhpCore\Api\Rest\Api
Extended by frankmayer\ArangoDbPhpCore\Api\Rest\Async implements frankmayer\ArangoDbPhpCore\Api\RestApiInterface
Namespace: frankmayer\ArangoDbPhpCore\Api\Rest
Package: frankmayer\ArangoDbPhpCore\Api\Rest
Located at Api/Rest/Async.php

Methods summary

public frankmayer\ArangoDbPhpCore\Protocols\Http\HttpResponse
# fetchJobResult( string $handle, array $options = [] )

Parameters

$handle
The job handle of the job we want to get. Example: 1
$options

Returns

frankmayer\ArangoDbPhpCore\Protocols\Http\HttpResponse
public frankmayer\ArangoDbPhpCore\Protocols\Http\HttpResponse
# listJobResults( string $type, integer $count = null, array $options = [] )

Parameters

$type
The type of jobs to return. Might be done or pending. Example: 'pending'
$count
$options

Returns

frankmayer\ArangoDbPhpCore\Protocols\Http\HttpResponse
public frankmayer\ArangoDbPhpCore\Protocols\Http\HttpResponse
# deleteJobResult( mixed $type, integer $stamp = null, array $options = [] )

Parameters

$type
The type or specific job id of jobs to delete. Example: 1 or all or expired
$stamp
$options

Returns

frankmayer\ArangoDbPhpCore\Protocols\Http\HttpResponse

Methods inherited from frankmayer\ArangoDbPhpCore\Api\Rest\Api

__construct(), array_merge_recursive_distinct(), getRequest(), getResponse(), getReturnObject()

Constants summary

string API_PATH
# '/_api/job'

Constants inherited from frankmayer\ArangoDbPhpCore\Api\Rest\Api

METHOD_DELETE, METHOD_GET, METHOD_HEAD, METHOD_OPTIONS, METHOD_PATCH, METHOD_POST, METHOD_PUT

Properties summary

Properties inherited from frankmayer\ArangoDbPhpCore\Api\Rest\Api

$client

ArangoDB-PHP-Core API Documentation API documentation generated by ApiGen