class ShsController in Simple hierarchical select 2.0.x

Controller for getting taxonomy terms.

Hierarchy

• class \Drupal\Core\Controller\ControllerBase implements ContainerInjectionInterface uses LoggerChannelTrait, MessengerTrait, RedirectDestinationTrait, StringTranslationTrait
  • class \Drupal\shs\Controller\ShsController

File

src/Controller/ShsController.php, line 15

Namespace

Drupal\shs\Controller

class ShsController extends ControllerBase {

  /**
   * The dependency injection container.
   *
   * @var \Symfony\Component\DependencyInjection\ContainerInterface
   */
  protected $container;

  /**
   * Construct a new ShsController object.
   */
  public function __construct(ContainerInterface $container) {
    $this->container = $container;
  }

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

  /**
   * Load term data.
   *
   * @param string $identifier
   *   Name of field to load the data for.
   * @param string $bundle
   *   Bundle (vocabulary) identifier to limit the return list to a specific
   *   bundle.
   * @param int $entity_id
   *   Id of parent term to load all children for. Defaults to 0.
   *
   * @return CacheableJsonResponse
   *   Cacheable Json response.
   */
  public function getTermData($identifier, $bundle, $entity_id = 0) {
    $context = [
      'identifier' => $identifier,
      'bundle' => $bundle,
      'parent' => $entity_id,
    ];
    $response = new ShsCacheableJsonResponse($context);
    $cache_tags = [];
    $result = [];
    $langcode_current = $this
      ->languageManager()
      ->getCurrentLanguage(LanguageInterface::TYPE_CONTENT)
      ->getId();

    /** @var \Drupal\taxonomy\TermStorageInterface $storage */
    $storage = $this
      ->entityTypeManager()
      ->getStorage('taxonomy_term');
    $translation_enabled = FALSE;
    if ($this
      ->moduleHandler()
      ->moduleExists('content_translation')) {

      /** @var \Drupal\content_translation\ContentTranslationManagerInterface $translation_manager */
      $translation_manager = $this->container
        ->get('content_translation.manager');

      // If translation is enabled for the vocabulary, we need to load the full
      // term objects to get the translation for the current language.
      $translation_enabled = $translation_manager
        ->isEnabled('taxonomy_term', $bundle);
    }
    $access_unpublished = $this
      ->currentUser()
      ->hasPermission('administer taxonomy') || $this
      ->currentUser()
      ->hasPermission('view unpublished terms in ' . $bundle);
    $cache_tags[] = 'access_unpublished:' . $access_unpublished;

    /** @var \Drupal\taxonomy\TermInterface[] $terms */
    $terms = $storage
      ->loadTree($bundle, $entity_id, 1, $translation_enabled);
    foreach ($terms as $term) {
      $langcode = $langcode_current;
      if ($translation_enabled && $term instanceof TranslatableInterface && $term
        ->hasTranslation($langcode)) {
        $term = $term
          ->getTranslation($langcode);
      }
      else {
        $langcode = $term->default_langcode;
      }
      $tid = $translation_enabled ? $term
        ->id() : $term->tid;
      $published = $translation_enabled ? $term
        ->isPublished() : $term->status;
      if (!$published && !$access_unpublished) {
        continue;
      }
      $result[] = (object) [
        'tid' => $tid,
        'name' => $translation_enabled ? $term
          ->getName() : $term->name,
        'description__value' => $translation_enabled ? $term
          ->getDescription() : $term->description__value,
        'langcode' => $langcode,
        'hasChildren' => shs_term_has_children($tid),
      ];
      $cache_tags[] = sprintf('taxonomy_term:%d', $tid);
    }
    $response
      ->addCacheableDependency(new ShsTermCacheDependency($cache_tags));
    $response
      ->setData($result, TRUE);
    return $response;
  }

}

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::$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.
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.
ShsController::$container	protected	property	The dependency injection container.
ShsController::create	public static	function	Instantiates a new instance of this class. Overrides ControllerBase::create
ShsController::getTermData	public	function	Load term data.
ShsController::__construct	public	function	Construct a new ShsController object.
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.