class QueuerFormController in Purge 8.3

Controller for queuer configuration forms.

Hierarchy

class \Drupal\Core\Controller\ControllerBase implements ContainerInjectionInterface uses LoggerChannelTrait, MessengerTrait, LinkGeneratorTrait, RedirectDestinationTrait, UrlGeneratorTrait, StringTranslationTrait
- class \Drupal\purge_ui\Controller\QueuerFormController

Expanded class hierarchy of QueuerFormController

File

modules/purge_ui/src/Controller/QueuerFormController.php, line 13

Namespace

Drupal\purge_ui\Controller

View source

class QueuerFormController extends ControllerBase {

  /**
   * The 'purge.queuers' service.
   *
   * @var \Drupal\purge\Plugin\Purge\Queuer\QueuersServiceInterface
   */
  protected $purgeQueuers;

  /**
   * Construct the QueuerFormController.
   *
   * @param \Drupal\purge\Plugin\Purge\Queuer\QueuersServiceInterface $purge_queuers
   *   The purge queuers service.
   */
  public final function __construct(QueuersServiceInterface $purge_queuers) {
    $this->purgeQueuers = $purge_queuers;
  }

  /**
   * {@inheritdoc}
   */
  public static function create(ContainerInterface $container) {
    return new static($container
      ->get('purge.queuers'));
  }

  /**
   * Render the queuer add form.
   *
   * @return array
   *   The render array.
   */
  public function addForm() {
    if (count($this->purgeQueuers
      ->getPluginsAvailable())) {
      return $this
        ->formBuilder()
        ->getForm("Drupal\\purge_ui\\Form\\QueuerAddForm");
    }
    throw new NotFoundHttpException();
  }

  /**
   * Render the queuer configuration form.
   *
   * @param string $id
   *   The plugin id of the queuer to retrieve.
   * @param bool $dialog
   *   Determines if the modal dialog variant of the form should be rendered.
   *
   * @return array
   *   The render array.
   */
  public function configForm($id, $dialog) {
    if ($this->purgeQueuers
      ->isPluginEnabled($id)) {
      $definition = $this->purgeQueuers
        ->getPlugins()[$id];
      if (isset($definition['configform']) && !empty($definition['configform'])) {
        return $this
          ->formBuilder()
          ->getForm($definition['configform'], [
          'id' => $id,
          'dialog' => $dialog,
        ]);
      }
    }
    throw new NotFoundHttpException();
  }

  /**
   * Route title callback.
   *
   * @param string $id
   *   The plugin id of the queuer to retrieve.
   *
   * @return \Drupal\Core\StringTranslation\TranslatableMarkup
   *   The page title.
   */
  public function configFormTitle($id) {
    if ($this->purgeQueuers
      ->isPluginEnabled($id)) {
      $definition = $this->purgeQueuers
        ->getPlugins()[$id];
      if (isset($definition['configform']) && !empty($definition['configform'])) {
        return $this
          ->t('Configure @label', [
          '@label' => $definition['label'],
        ]);
      }
    }
    return $this
      ->t('Configure');
  }

  /**
   * Render the queuer delete form.
   *
   * @param string $id
   *   The plugin id of the queuer to retrieve.
   *
   * @return array
   *   The render array.
   */
  public function deleteForm($id) {
    if ($this->purgeQueuers
      ->isPluginEnabled($id)) {
      return $this
        ->formBuilder()
        ->getForm("\\Drupal\\purge_ui\\Form\\QueuerDeleteForm", $id);
    }
    throw new NotFoundHttpException();
  }

  /**
   * Route title callback.
   *
   * @param string $id
   *   The plugin id of the queuer to retrieve.
   *
   * @return \Drupal\Core\StringTranslation\TranslatableMarkup
   *   The page title.
   */
  public function deleteFormTitle($id) {
    if ($this->purgeQueuers
      ->isPluginEnabled($id)) {
      $label = $this->purgeQueuers
        ->getPlugins()[$id]['label'];
      return $this
        ->t('Delete @label', [
        '@label' => $label,
      ]);
    }
    return $this
      ->t('Delete');
  }

  /**
   * Render the queuer detail form.
   *
   * @param string $id
   *   The plugin id of the queuer to retrieve.
   *
   * @return array
   *   The render array.
   */
  public function detailForm($id) {
    if ($this->purgeQueuers
      ->isPluginEnabled($id)) {
      return $this
        ->formBuilder()
        ->getForm("\\Drupal\\purge_ui\\Form\\PluginDetailsForm", [
        'details' => $this->purgeQueuers
          ->getPlugins()[$id]['description'],
      ]);
    }
    throw new NotFoundHttpException();
  }

  /**
   * Route title callback.
   *
   * @param string $id
   *   The plugin id of the queuer to retrieve.
   *
   * @return \Drupal\Core\StringTranslation\TranslatableMarkup
   *   The page title.
   */
  public function detailFormTitle($id) {
    return $this->purgeQueuers
      ->getPlugins()[$id]['label'];
  }

}

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.
QueuerFormController::$purgeQueuers	protected	property	The 'purge.queuers' service.
QueuerFormController::addForm	public	function	Render the queuer add form.
QueuerFormController::configForm	public	function	Render the queuer configuration form.
QueuerFormController::configFormTitle	public	function	Route title callback.
QueuerFormController::create	public static	function	Instantiates a new instance of this class. Overrides ControllerBase::create
QueuerFormController::deleteForm	public	function	Render the queuer delete form.
QueuerFormController::deleteFormTitle	public	function	Route title callback.
QueuerFormController::detailForm	public	function	Render the queuer detail form.
QueuerFormController::detailFormTitle	public	function	Route title callback.
QueuerFormController::__construct	final public	function	Construct the QueuerFormController.
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.
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.

You are here

class QueuerFormController in Purge 8.3

Hierarchy

File

Namespace

Members

API Navigation