class TaskController in Search API 8

Returns responses for task-related routes.

Hierarchy

• class \Drupal\Core\Controller\ControllerBase implements ContainerInjectionInterface uses LoggerChannelTrait, MessengerTrait, LinkGeneratorTrait, RedirectDestinationTrait, UrlGeneratorTrait, StringTranslationTrait
  • class \Drupal\search_api\Controller\TaskController

File

src/Controller/TaskController.php, line 15

Namespace

Drupal\search_api\Controller

class TaskController extends ControllerBase {

  /**
   * The server task manager.
   *
   * @var \Drupal\search_api\Task\TaskManagerInterface|null
   */
  protected $taskManager;

  /**
   * {@inheritdoc}
   */
  public static function create(ContainerInterface $container) {

    /** @var static $controller */
    $controller = parent::create($container);
    $controller
      ->setTaskManager($container
      ->get('search_api.task_manager'));
    return $controller;
  }

  /**
   * Retrieves the task manager.
   *
   * @return \Drupal\search_api\Task\TaskManagerInterface
   *   The task manager.
   */
  public function getTaskManager() {
    return $this->taskManager ?: \Drupal::service('search_api._task_manager');
  }

  /**
   * Sets the task manager.
   *
   * @param \Drupal\search_api\Task\TaskManagerInterface $task_manager
   *   The new task manager.
   *
   * @return $this
   */
  public function setTaskManager(TaskManagerInterface $task_manager) {
    $this->taskManager = $task_manager;
    return $this;
  }

  /**
   * Executes all pending tasks.
   */
  public function executeTasks() {
    $this
      ->getTaskManager()
      ->setTasksBatch();
    return batch_process(Url::fromRoute('search_api.overview'));
  }

  /**
   * Checks access for executing pending tasks.
   *
   * @param \Drupal\Core\Session\AccountInterface $account
   *   Run access checks for this account.
   *
   * @return \Drupal\Core\Access\AccessResultInterface
   *   The access result.
   */
  public function executeTasksAccess(AccountInterface $account) {
    if ($this->taskManager
      ->getTasksCount()) {
      return AccessResult::allowedIfHasPermission($account, 'administer search_api')
        ->addCacheTags([
        'search_api_task_list',
      ]);
    }
    return AccessResult::forbidden()
      ->addCacheTags([
      'search_api_task_list',
    ]);
  }

}

Members

Name	Modifiers	Type	Description	Overrides
ControllerBase::$configFactory	protected	property	The configuration factory.
ControllerBase::$currentUser	protected	property	The current user service.	1
ControllerBase::$entityFormBuilder	protected	property	The entity form builder.
ControllerBase::$entityManager	protected	property	The entity manager.
ControllerBase::$entityTypeManager	protected	property	The entity type manager.
ControllerBase::$formBuilder	protected	property	The form builder.	2
ControllerBase::$keyValue	protected	property	The key-value storage.	1
ControllerBase::$languageManager	protected	property	The language manager.	1
ControllerBase::$moduleHandler	protected	property	The module handler.	2
ControllerBase::$stateService	protected	property	The state service.
ControllerBase::cache	protected	function	Returns the requested cache bin.
ControllerBase::config	protected	function	Retrieves a configuration object.
ControllerBase::container	private	function	Returns the service container.
ControllerBase::currentUser	protected	function	Returns the current user.	1
ControllerBase::entityFormBuilder	protected	function	Retrieves the entity form builder.
ControllerBase::entityManager Deprecated	protected	function	Retrieves the entity manager service.
ControllerBase::entityTypeManager	protected	function	Retrieves the entity type manager.
ControllerBase::formBuilder	protected	function	Returns the form builder service.	2
ControllerBase::keyValue	protected	function	Returns a key/value storage collection.	1
ControllerBase::languageManager	protected	function	Returns the language manager service.	1
ControllerBase::moduleHandler	protected	function	Returns the module handler.	2
ControllerBase::redirect	protected	function	Returns a redirect response object for the specified route. Overrides UrlGeneratorTrait::redirect
ControllerBase::state	protected	function	Returns the state storage service.
LinkGeneratorTrait::$linkGenerator	protected	property	The link generator.	1
LinkGeneratorTrait::getLinkGenerator Deprecated	protected	function	Returns the link generator.
LinkGeneratorTrait::l Deprecated	protected	function	Renders a link to a route given a route name and its parameters.
LinkGeneratorTrait::setLinkGenerator Deprecated	public	function	Sets the link generator service.
LoggerChannelTrait::$loggerFactory	protected	property	The logger channel factory service.
LoggerChannelTrait::getLogger	protected	function	Gets the logger for a specific channel.
LoggerChannelTrait::setLoggerFactory	public	function	Injects the logger channel factory.
MessengerTrait::$messenger	protected	property	The messenger.	29
MessengerTrait::messenger	public	function	Gets the messenger.	29
MessengerTrait::setMessenger	public	function	Sets the messenger.
RedirectDestinationTrait::$redirectDestination	protected	property	The redirect destination service.	1
RedirectDestinationTrait::getDestinationArray	protected	function	Prepares a 'destination' URL query parameter for use with \Drupal\Core\Url.
RedirectDestinationTrait::getRedirectDestination	protected	function	Returns the redirect destination service.
RedirectDestinationTrait::setRedirectDestination	public	function	Sets the redirect destination service.
StringTranslationTrait::$stringTranslation	protected	property	The string translation service.	1
StringTranslationTrait::formatPlural	protected	function	Formats a string containing a count of items.
StringTranslationTrait::getNumberOfPlurals	protected	function	Returns the number of plurals supported by a given language.
StringTranslationTrait::getStringTranslation	protected	function	Gets the string translation service.
StringTranslationTrait::setStringTranslation	public	function	Sets the string translation service to use.	2
StringTranslationTrait::t	protected	function	Translates a string to the current language or to a given language.
TaskController::$taskManager	protected	property	The server task manager.
TaskController::create	public static	function	Instantiates a new instance of this class. Overrides ControllerBase::create
TaskController::executeTasks	public	function	Executes all pending tasks.
TaskController::executeTasksAccess	public	function	Checks access for executing pending tasks.
TaskController::getTaskManager	public	function	Retrieves the task manager.
TaskController::setTaskManager	public	function	Sets the task manager.
UrlGeneratorTrait::$urlGenerator	protected	property	The url generator.
UrlGeneratorTrait::getUrlGenerator Deprecated	protected	function	Returns the URL generator service.
UrlGeneratorTrait::setUrlGenerator Deprecated	public	function	Sets the URL generator service.
UrlGeneratorTrait::url Deprecated	protected	function	Generates a URL or path for a specific route based on the given parameters.