You are here

Home » API reference » Allow a content type only once (Only One) 8 » OnlyOneController.php

class OnlyOneController in Allow a content type only once (Only One) 8

Returns responses for Node routes managed by Only One.

Hierarchy

Expanded class hierarchy of OnlyOneController

File

src/Controller/OnlyOneController.php, line 13

Namespace

Drupal\onlyone\Controller
View source 
class OnlyOneController extends ControllerBase {

  /**
   * The renderer service.
   *
   * @var \Drupal\Core\Render\RendererInterface
   */
  protected $renderer;

  /**
   * Constructs a NodeController object.
   *
   * @param \Drupal\Core\Render\RendererInterface $renderer
   *   The renderer service.
   */
  public function __construct(RendererInterface $renderer) {
    $this->renderer = $renderer;
  }

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

  /**
   * Displays add content links for Only One available content types.
   *
   * @return array|\Symfony\Component\HttpFoundation\RedirectResponse
   *   A render array for a list of the node types that can be added or redirect
   *   to the creation node page if there is only one content type.
   *
   * @throws \Drupal\Component\Plugin\Exception\InvalidPluginDefinitionException
   * @throws \Drupal\Component\Plugin\Exception\PluginNotFoundException
   */
  public function addPage() {

    // Getting the configured content types.
    $onlyone_content_types = $this
      ->config('onlyone.settings')
      ->get('onlyone_node_types');

    // Leaving this code here until this issue will be resolved:
    // https://www.drupal.org/project/drupal/issues/2965718
    // @see https://www.drupal.org/project/onlyone/issues/3029598
    // Returning a message if the page is empty.
    if (empty($onlyone_content_types)) {
      return [
        '#markup' => '<p>' . $this
          ->t('You have not configured any content type yet, go to the <a href=":config-content-types">Only One page</a> to configure the content types.', [
          ':config-content-types' => Url::fromRoute('onlyone.config_content_types')
            ->toString(),
        ]) . '</p>',
      ];
    }
    $build = [
      '#theme' => 'node_add_list',
      '#cache' => [
        'tags' => [
          'config:onlyone.settings',
        ],
      ],
    ];
    $content = [];

    // Getting configured content types entities.
    $onlyone_content_types_node_types = $this
      ->entityTypeManager()
      ->getStorage('node_type')
      ->loadMultiple($onlyone_content_types);

    // Sorting by content type name (label).
    usort($onlyone_content_types_node_types, function ($a, $b) {
      return $a
        ->label() <=> $b
        ->label();
    });

    // Only use node types the user has access to.
    foreach ($onlyone_content_types_node_types as $type) {

      // Verifying access.
      $access = $this
        ->entityTypeManager()
        ->getAccessControlHandler('node')
        ->createAccess($type
        ->id(), NULL, [], TRUE);

      // If the user have access add the content type to the page.
      if ($access
        ->isAllowed()) {
        $content[$type
          ->id()] = $type;
      }
      $this->renderer
        ->addCacheableDependency($build, $access);
    }

    // Bypass the node/add listing if only one content type is available.
    if (count($content) == 1) {
      $type = array_shift($content);
      return $this
        ->redirect('node.add', [
        'node_type' => $type
          ->id(),
      ]);
    }
    $build['#content'] = $content;
    return $build;
  }

}

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.
OnlyOneController::$renderer protected property The renderer service.
OnlyOneController::addPage public function Displays add content links for Only One available content types.
OnlyOneController::create public static function Instantiates a new instance of this class. Overrides ControllerBase::create
OnlyOneController::__construct public function Constructs a NodeController object.
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.