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

Namespaces

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

Classes

  • frankmayer\ArangoDbPhpCore\Api\Rest\Api
  • frankmayer\ArangoDbPhpCore\Api\Rest\Async
  • frankmayer\ArangoDbPhpCore\Api\Rest\Batch
  • frankmayer\ArangoDbPhpCore\Api\Rest\Collection
  • frankmayer\ArangoDbPhpCore\Api\Rest\Database
  • frankmayer\ArangoDbPhpCore\Api\Rest\Document
  • frankmayer\ArangoDbPhpCore\Api\Rest\DocumentBase
  • frankmayer\ArangoDbPhpCore\Api\Rest\Edge
  • frankmayer\ArangoDbPhpCore\Autoloader
  • frankmayer\ArangoDbPhpCore\Client
  • frankmayer\ArangoDbPhpCore\ClientOptions
  • frankmayer\ArangoDbPhpCore\Config\ConnectionOptions
  • frankmayer\ArangoDbPhpCore\Config\DefaultValues
  • frankmayer\ArangoDbPhpCore\Config\Endpoint
  • frankmayer\ArangoDbPhpCore\Config\UpdatePolicy
  • frankmayer\ArangoDbPhpCore\Connectors\AbstractHttpConnector
  • frankmayer\ArangoDbPhpCore\Plugins\Plugin
  • frankmayer\ArangoDbPhpCore\Plugins\PluginManager
  • frankmayer\ArangoDbPhpCore\Plugins\TestPlugin
  • frankmayer\ArangoDbPhpCore\Plugins\TracerPlugin
  • frankmayer\ArangoDbPhpCore\Protocols\Http\AbstractHttpRequest
  • frankmayer\ArangoDbPhpCore\Protocols\Http\HttpRequest
  • frankmayer\ArangoDbPhpCore\Protocols\Http\HttpResponse

Interfaces

  • frankmayer\ArangoDbPhpCore\Api\ApiInterface
  • frankmayer\ArangoDbPhpCore\Api\RestApiInterface
  • frankmayer\ArangoDbPhpCore\ClientInterface
  • frankmayer\ArangoDbPhpCore\ConnectorInterface
  • frankmayer\ArangoDbPhpCore\Plugins\PluginInterface
  • frankmayer\ArangoDbPhpCore\Protocols\Http\HttpConnectorInterface
  • frankmayer\ArangoDbPhpCore\Protocols\Http\HttpRequestInterface
  • frankmayer\ArangoDbPhpCore\Protocols\Http\HttpResponseInterface
  • frankmayer\ArangoDbPhpCore\Protocols\RequestInterface
  • frankmayer\ArangoDbPhpCore\Protocols\ResponseInterface

Traits

  • frankmayer\ArangoDbPhpCore\Api\Rest\DocumentTrait
  • frankmayer\ArangoDbPhpCore\Api\Rest\EdgeTrait
  • frankmayer\ArangoDbPhpCore\TraitRepository\ClientLogger

Exceptions

  • frankmayer\ArangoDbPhpCore\ClientException
  • frankmayer\ArangoDbPhpCore\ConnectionException
  • frankmayer\ArangoDbPhpCore\Exception
  • frankmayer\ArangoDbPhpCore\ServerException
  1 <?php
  2 /**
  3  * ArangoDB PHP Core Client: client
  4  *
  5  * @author    Frank Mayer
  6  * @copyright Copyright 2013-2015, FRANKMAYER.NET, Athens, Greece
  7  */
  8 
  9 namespace frankmayer\ArangoDbPhpCore\Api\Rest;
 10 
 11 use frankmayer\ArangoDbPhpCore\Api\RestApiInterface;
 12 use frankmayer\ArangoDbPhpCore\Protocols\Http\AbstractHttpRequest;
 13 
 14 
 15 /**
 16  * Class Async
 17  *
 18  * @package frankmayer\ArangoDbPhpCore\Api\Rest
 19  */
 20 class Async extends
 21     Api implements
 22     RestApiInterface
 23 {
 24     /**
 25      *
 26      */
 27     const API_PATH = '/_api/job';
 28 
 29     /**
 30      * @param string $handle The job handle of the job we want to get. Example: 1
 31      * @param array  $options
 32      *
 33      * @return \frankmayer\ArangoDbPhpCore\Protocols\Http\HttpResponse
 34      */
 35     public function fetchJobResult(
 36         $handle,
 37         $options = []
 38     ) {
 39         /** @var AbstractHttpRequest $request */
 40         $request          = $this->getRequest();
 41         $request->options = $options;
 42         $request->path    = $this->client->fullDatabasePath . static::API_PATH . '/' . $handle;
 43         $request->method  = static::METHOD_PUT;
 44 
 45         return $this->getReturnObject($request);
 46     }
 47 
 48 
 49     /**
 50      * @param string  $type The type of jobs to return. Might be `done` or `pending`. Example: 'pending'
 51      * @param integer $count
 52      * @param array   $options
 53      *
 54      * @return \frankmayer\ArangoDbPhpCore\Protocols\Http\HttpResponse
 55      */
 56     public function listJobResults(
 57         $type,
 58         $count = null,
 59         $options = []
 60     ) {
 61         $urlQuery = null;
 62 
 63         /** @var AbstractHttpRequest $request */
 64         $request          = $this->getRequest();
 65         $request->options = $options;
 66         $request->path    = $this->client->fullDatabasePath . static::API_PATH . '/' . $type;
 67 
 68         if ($count) {
 69             $urlQuery = ['count' => $count];
 70             $urlQuery = $request->buildUrlQuery($urlQuery);
 71         }
 72 
 73         $request->path .= $urlQuery;
 74 
 75         $request->method = static::METHOD_GET;
 76 
 77         return $this->getReturnObject($request);
 78     }
 79 
 80 
 81     /**
 82      * @param mixed   $type The type or specific job id of jobs to delete. Example: 1 or `all` or `expired`
 83      * @param integer $stamp
 84      * @param array   $options
 85      *
 86      * @return \frankmayer\ArangoDbPhpCore\Protocols\Http\HttpResponse
 87      */
 88     public function deleteJobResult(
 89         $type,
 90         $stamp = null,
 91         $options = []
 92     ) {
 93         $urlQuery = null;
 94 
 95         /** @var AbstractHttpRequest $request */
 96         $request          = $this->getRequest();
 97         $request->options = $options;
 98         $request->path    = $this->client->fullDatabasePath . static::API_PATH . '/' . $type;
 99 
100         if ($stamp) {
101             $urlQuery = ['stamp' => $stamp];
102             $urlQuery = $request->buildUrlQuery($urlQuery);
103         }
104         $request->path .= $urlQuery;
105 
106         $request->method = static::METHOD_DELETE;
107 
108         return $this->getReturnObject($request);
109     }
110 }
111 
ArangoDB-PHP-Core API Documentation API documentation generated by ApiGen