Open Data Catalog v2.0.0
Drupal\dkan_harvest\Controller\Api Class Reference
Inheritance diagram for Drupal\dkan_harvest\Controller\Api:

Public Member Functions

 __construct (ContainerInterface $container)
 
 index ()
 
 getPlan ($identifier)
 
 register ()
 
 deregister ($identifier)
 
 run ()
 
 info ()
 
 infoRun ($identifier)
 
 revert ()
 

Static Public Member Functions

static create (ContainerInterface $container)
 

Detailed Description

Definition at line 16 of file Api.php.

Constructor & Destructor Documentation

◆ __construct()

Drupal\dkan_harvest\Controller\Api::__construct ( ContainerInterface  $container)

Api constructor.

Definition at line 44 of file Api.php.

Member Function Documentation

◆ create()

static Drupal\dkan_harvest\Controller\Api::create ( ContainerInterface  $container)
static

Inherited.

Definition at line 37 of file Api.php.

◆ deregister()

Drupal\dkan_harvest\Controller\Api::deregister (   $identifier)

Deregister a harvest.

Definition at line 123 of file Api.php.

◆ getPlan()

Drupal\dkan_harvest\Controller\Api::getPlan (   $identifier)

Get a single harvest plan.

Parameters
string$identifierA harvest plan id.
Returns
\Symfony\Component\HttpFoundation\JsonResponse Json response.

Definition at line 79 of file Api.php.

◆ index()

Drupal\dkan_harvest\Controller\Api::index ( )

List harvest ids.

Definition at line 52 of file Api.php.

◆ info()

Drupal\dkan_harvest\Controller\Api::info ( )

Gives list of previous runs for a harvest id.

Definition at line 179 of file Api.php.

◆ infoRun()

Drupal\dkan_harvest\Controller\Api::infoRun (   $identifier)

Gives information about a single previous harvest run.

Parameters
string$identifierThe run's id.

Definition at line 211 of file Api.php.

◆ register()

Drupal\dkan_harvest\Controller\Api::register ( )

Register a new harvest.

Definition at line 98 of file Api.php.

◆ revert()

Drupal\dkan_harvest\Controller\Api::revert ( )

Reverts harvest.

Definition at line 240 of file Api.php.

◆ run()

Drupal\dkan_harvest\Controller\Api::run ( )

Runs harvest.

Definition at line 146 of file Api.php.