You are here

Home » API reference » Scheduled Updates 8 » ScheduledUpdateAddController.php

class ScheduledUpdateAddController in Scheduled Updates 8

Class ScheduledUpdateAddController.

@package Drupal\scheduled_updates\Controller

Hierarchy

Expanded class hierarchy of ScheduledUpdateAddController

File

src/Controller/ScheduledUpdateAddController.php, line 28
Contains Drupal\scheduled_updates\Controller\ScheduledUpdateAddController.

Namespace

Drupal\scheduled_updates\Controller
View source 
class ScheduledUpdateAddController extends ControllerBase {

  /** @var \Drupal\Core\Entity\EntityStorageInterface  */
  protected $typeStorage;

  /**
   * @var \Drupal\Core\Entity\EntityStorageInterface
   */
  protected $storage;

  /**
   * @var \Drupal\scheduled_updates\UpdateRunnerUtils
   */
  protected $runnerUtils;
  public function __construct(EntityTypeManagerInterface $entityTypeManager, UpdateRunnerUtils $runnerUtils) {
    $this->storage = $entityTypeManager
      ->getStorage('scheduled_update');
    $this->typeStorage = $entityTypeManager
      ->getStorage('scheduled_update_type');
    $this->runnerUtils = $runnerUtils;
  }

  /**
   * {@inheritdoc}
   */
  public static function create(ContainerInterface $container) {
    return new static($container
      ->get('entity_type.manager'), $container
      ->get('scheduled_updates.update_runner'));
  }

  /**
   * Displays add links for available bundles/types for entity
   * scheduled_update .
   *
   * @param \Symfony\Component\HttpFoundation\Request $request
   *   The current request object.
   *
   * @return array
   *   A render array for a list of the scheduled_update bundles/types that
   *   can be added or if there is only one type/bunlde defined for the site,
   *   the function returns the add page for that bundle/type.
   */
  public function add(Request $request) {
    $types = $this
      ->getIndependentTypes();
    if ($types && count($types) == 1) {
      $type = reset($types);
      return $this
        ->addForm($type, $request);
    }
    if (count($types) === 0) {
      return array(
        '#markup' => $this
          ->t('You have not created any %bundle types yet. @link to add a new type.', [
          '%bundle' => 'Scheduled update',
          '@link' => Link::fromTextAndUrl($this
            ->t('Go to the type creation page'), Url::fromRoute('entity.scheduled_update_type.add_form')),
        ]),
      );
    }
    return array(
      '#theme' => 'scheduled_update_content_add_list',
      '#content' => $types,
    );
  }

  /**
   * Presents the creation form for scheduled_update entities of given
   * bundle/type.
   *
   * @param EntityInterface $scheduled_update_type
   *   The custom bundle to add.
   * @param \Symfony\Component\HttpFoundation\Request $request
   *   The current request object.
   *
   * @return array
   *   A form array as expected by drupal_render().
   */
  public function addForm(EntityInterface $scheduled_update_type, Request $request) {
    $entity = $this->storage
      ->create(array(
      'type' => $scheduled_update_type
        ->id(),
    ));
    return $this
      ->entityFormBuilder()
      ->getForm($entity);
  }

  /**
   * Provides the page title for this controller.
   *
   * @param EntityInterface $scheduled_update_type
   *   The custom bundle/type being added.
   *
   * @return string
   *   The page title.
   */
  public function getAddFormTitle(EntityInterface $scheduled_update_type) {
    return t('Create <em>@label</em> Scheduled Update', array(
      '@label' => $scheduled_update_type
        ->label(),
    ));
  }
  protected function getIndependentTypes() {
    $types = [];

    /** @var ScheduledUpdateTypeInterface $type */
    foreach ($this->typeStorage
      ->loadMultiple() as $type) {
      if ($this->runnerUtils
        ->isIndependentUpdater($type)) {
        $types[] = $type;
      }
    }
    return $types;
  }

  /**
   * Determine access to update add page.
   *
   * If user has permission to add any types they should have access to this page.
   *
   * @param \Drupal\Core\Session\AccountInterface $account
   *
   * @return \Drupal\Core\Access\AccessResult
   */
  public function addPageAccess(AccountInterface $account) {
    $types = $this->typeStorage
      ->loadMultiple();
    $perms = [];
    foreach ($types as $type_id => $type) {
      $perms[] = "create {$type_id} scheduled updates";
    }
    return AccessResult::allowedIfHasPermissions($account, $perms, 'OR');
  }
  public function addFormAccess(AccountInterface $account, ScheduledUpdateTypeInterface $scheduled_update_type) {
    if ($scheduled_update_type
      ->isEmbeddedType()) {
      return AccessResult::forbidden();
    }
    $type_id = $scheduled_update_type
      ->id();
    return AccessResult::allowedIfHasPermission($account, "create {$type_id} scheduled updates");
  }

}

Members

Namesort descending 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.
ScheduledUpdateAddController::$runnerUtils protected property
ScheduledUpdateAddController::$storage protected property
ScheduledUpdateAddController::$typeStorage protected property @var \Drupal\Core\Entity\EntityStorageInterface
ScheduledUpdateAddController::add public function Displays add links for available bundles/types for entity scheduled_update .
ScheduledUpdateAddController::addForm public function Presents the creation form for scheduled_update entities of given bundle/type.
ScheduledUpdateAddController::addFormAccess public function
ScheduledUpdateAddController::addPageAccess public function Determine access to update add page.
ScheduledUpdateAddController::create public static function Instantiates a new instance of this class. Overrides ControllerBase::create
ScheduledUpdateAddController::getAddFormTitle public function Provides the page title for this controller.
ScheduledUpdateAddController::getIndependentTypes protected function
ScheduledUpdateAddController::__construct public function
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.