BatchController::batchPage

public BatchController::batchPage(Request $request) Returns a system batch page. Parameters \Symfony\Component\HttpFoundation\Request $request: The current request object. Return value \Symfony\Component\HttpFoundation\Response|array A \Symfony\Component\HttpFoundation\Response object or render array. Throws \Symfony\Component\HttpKernel\Exception\AccessDeniedHttpException File core/modules/system/src/Controller/BatchController.php, line 53 Class BatchController Controller routines for

BatchController::$root

The app root. Type: string File core/modules/system/src/Controller/BatchController.php, line 21 Class BatchController Controller routines for batch routes. Namespace Drupal\system\Controller Code protected $root;

BatchController

Controller routines for batch routes. Hierarchy class \Drupal\system\Controller\BatchController implements ContainerInjectionInterface File core/modules/system/src/Controller/BatchController.php, line 14 Namespace Drupal\system\Controller Members Name Modifiers Type Description BatchController::$root protected property The app root. BatchController::batchPage public function Returns a system batch page. BatchController::batchPageTitle public function The

Batch::getAllItems

public Batch::getAllItems() Retrieves all remaining items in the queue. This is specific to Batch API and is not part of the \Drupal\Core\Queue\QueueInterface. Return value array An array of queue items. File core/lib/Drupal/Core/Queue/Batch.php, line 50 Class Batch Defines a batch queue handler used by the Batch API. Namespace Drupal\Core\Queue Code public function getAllItems() { $result = array(); try { $items = $this->connection->query('SELECT data FROM {queue} q WHE

Batch::claimItem

public Batch::claimItem($lease_time = 0) Overrides \Drupal\Core\Queue\DatabaseQueue::claimItem(). Unlike \Drupal\Core\Queue\DatabaseQueue::claimItem(), this method provides a default lease time of 0 (no expiration) instead of 30. This allows the item to be claimed repeatedly until it is deleted. Overrides DatabaseQueue::claimItem File core/lib/Drupal/Core/Queue/Batch.php, line 27 Class Batch Defines a batch queue handler used by the Batch API. Namespace Drupal\Core\Queue Code public fu

batch.inc

Batch processing API for processes to run in multiple HTTP requests. Note that batches are usually invoked by form submissions, which is why the core interaction functions of the batch processing API live in form.inc. See also form.inc batch_set() batch_process() batch_get() File core/includes/batch.inc Functions Name Description _batch_api_percentage Formats the percent completion for a batch set. _batch_current_set Returns the batch set being currently processed. _batch_do

Batch operations

Creates and processes batch operations. Functions allowing forms processing to be spread out over several page requests, thus ensuring that the processing does not get interrupted because of a PHP timeout, while allowing the user to receive feedback on the progress of the ongoing operations. The API is primarily designed to integrate nicely with the Form API workflow, but can also be used by non-Form API scripts (like update.php) or even simple page callbacks (which should probably be used spar

Batch

Defines a batch queue handler used by the Batch API. This implementation: Ensures FIFO ordering. Allows an item to be repeatedly claimed until it is actually deleted (no notion of lease time or 'expire' date), to allow multipass operations. Stale items from failed batches are cleaned from the {queue} table on cron using the 'created' date. Hierarchy class \Drupal\Core\Queue\DatabaseQueue implements QueueGarbageCollectionInterface, ReliableQueueInterface uses DependencySerializationTraitclass

basic_auth_help

basic_auth_help($route_name, RouteMatchInterface $route_match) Implements hook_help(). File core/modules/basic_auth/basic_auth.module, line 13 Provides an HTTP Basic authentication provider. Code function basic_auth_help($route_name, RouteMatchInterface $route_match) { switch ($route_name) { case 'help.page.basic_auth': $output = ''; $output .= '<h3>' . t('About') . '</h3>'; $output .= '<p>' . t('The HTTP Basic Authentication module supplies an <a

basic_auth.module

Provides an HTTP Basic authentication provider. File core/modules/basic_auth/basic_auth.module Functions Name Description basic_auth_help Implements hook_help().