You are here

class TagcloudsListVocs in TagCloud 2.0.x

Same name and namespace in other branches
  1. 8 src/Controller/TagcloudsListVocs.php \Drupal\tagclouds\Controller\TagcloudsListVocs
  2. 1.0.x src/Controller/TagcloudsListVocs.php \Drupal\tagclouds\Controller\TagcloudsListVocs

Controller routines for user routes.

Hierarchy

Expanded class hierarchy of TagcloudsListVocs

File

src/Controller/TagcloudsListVocs.php, line 15

Namespace

Drupal\tagclouds\Controller
View source
class TagcloudsListVocs extends ControllerBase {
  use CsvToArrayTrait;

  /**
   * The tag service.
   *
   * @var \Drupal\tagclouds\TagService
   */
  protected $tagService;

  /**
   * The cloud builder service.
   *
   * @var \Drupal\tagclouds\CloudBuilder
   */
  protected $cloudBuilder;

  /**
   * Constructs a new TagcloudsTermsBlock instance.
   *
   * @param \Drupal\tagclouds\TagService $tagService
   *   The tag service.
   * @param \Drupal\tagclouds\CloudBuilder $cloudBuilder
   *   The cloud builder service.
   */
  public function __construct(TagService $tagService, CloudBuilder $cloudBuilder) {
    $this->tagService = $tagService;
    $this->cloudBuilder = $cloudBuilder;
  }

  /**
   * {@inheritdoc}
   */
  public static function create(ContainerInterface $container) {
    return new static($container
      ->get('tagclouds.tag'), $container
      ->get('tagclouds.cloud_builder'));
  }

  /**
   * Renders a list of vocabularies.
   *
   * Vocabularys are wrapped in a series of boxes, labeled by name
   * description.
   *
   * @param string $tagclouds_vocs_str
   *   A comma separated list of vocabulary ids.
   *
   * @return array
   *   A render array.
   *
   * @throws NotFoundHttpException
   *   Thrown when any vocabulary in the list cannot be found.
   */
  public function listVocs($tagclouds_vocs_str = NULL) {
    $vocs = $this
      ->csvToArray($tagclouds_vocs_str);
    if (empty($vocs)) {
      throw new NotFoundHttpException();
    }
    $boxes = [];
    foreach ($vocs as $vid) {
      $vocabulary = Vocabulary::load($vid);
      if ($vocabulary == FALSE) {
        throw new NotFoundHttpException();
      }
      $config = $this
        ->config('tagclouds.settings');
      $tags = $this->tagService
        ->getTags([
        $vid,
      ], $config
        ->get('levels'), $config
        ->get('page_amount'));
      $sorted_tags = $this->tagService
        ->sortTags($tags);
      $cloud = $this->cloudBuilder
        ->build($sorted_tags);
      if (!$cloud) {
        throw new NotFoundHttpException();
      }
      $boxes[] = [
        '#theme' => 'tagclouds_list_box',
        '#vocabulary' => $vocabulary,
        '#children' => $cloud,
      ];
    }

    // Wrap boxes in a div.
    $output = [
      '#attached' => [
        'library' => 'tagclouds/clouds',
      ],
      '#type' => 'container',
      '#children' => $boxes,
      '#attributes' => [
        'class' => 'wrapper tagclouds',
      ],
    ];
    return $output;
  }

}

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::$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::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.
ControllerBase::state protected function Returns the state storage service.
CsvToArrayTrait::csvToArray protected function Returns and array of ids when given a comma separated string of ids.
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. 27
MessengerTrait::messenger public function Gets the messenger. 27
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. 4
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.
TagcloudsListVocs::$cloudBuilder protected property The cloud builder service.
TagcloudsListVocs::$tagService protected property The tag service.
TagcloudsListVocs::create public static function Instantiates a new instance of this class. Overrides ControllerBase::create
TagcloudsListVocs::listVocs public function Renders a list of vocabularies.
TagcloudsListVocs::__construct public function Constructs a new TagcloudsTermsBlock instance.