You are here

Home » API reference » Synonyms 8 » SynonymConfigController.php

class SynonymConfigController in Synonyms 8

Same name and namespace in other branches
  1. 2.0.x src/Controller/SynonymConfigController.php \Drupal\synonyms\Controller\SynonymConfigController

Controller for admin UI of the module.

Hierarchy

Expanded class hierarchy of SynonymConfigController

File

src/Controller/SynonymConfigController.php, line 18

Namespace

Drupal\synonyms\Controller
View source 
class SynonymConfigController extends ControllerBase {

  /**
   * The entity type bundle info.
   *
   * @var \Drupal\Core\Entity\EntityTypeBundleInfoInterface
   */
  protected $entityTypeBundleInfo;

  /**
   * The synonyms behavior service.
   *
   * @var \Drupal\synonyms\SynonymsService\BehaviorService
   */
  protected $behaviorService;

  /**
   * SynonymConfigController constructor.
   */
  public function __construct(EntityTypeBundleInfoInterface $entity_type_bundle_info, BehaviorService $behavior_service) {
    $this->entityTypeBundleInfo = $entity_type_bundle_info;
    $this->behaviorService = $behavior_service;
  }

  /**
   * {@inheritdoc}
   */
  public static function create(ContainerInterface $container) {
    return new static($container
      ->get('entity_type.bundle.info'), $container
      ->get('synonyms.behaviors'));
  }

  /**
   * Routing callback: show overview table of synonyms configuration.
   */
  public function overview() {
    $render = [
      '#type' => 'table',
      '#header' => [
        $this
          ->t('Entity type'),
        $this
          ->t('Bundle'),
        $this
          ->t('Manage'),
      ],
    ];
    foreach ($this
      ->entityTypeManager()
      ->getDefinitions() as $entity_type) {
      if ($entity_type instanceof ContentEntityTypeInterface) {
        foreach ($this->entityTypeBundleInfo
          ->getBundleInfo($entity_type
          ->id()) as $bundle => $bundle_info) {
          $links = [];
          foreach ($this->behaviorService
            ->getBehaviorServices() as $service_id => $service) {
            $count = count($this->behaviorService
              ->getSynonymConfigEntities($service_id, $entity_type
              ->id(), $bundle));
            if ($count > 0) {
              $title = $this
                ->t('@behavior (@count)', [
                '@behavior' => $service['service']
                  ->getTitle(),
                '@count' => $count,
              ]);
            }
            else {
              $title = $service['service']
                ->getTitle();
            }
            $links[$service_id] = [
              'title' => $title,
              'url' => Url::fromRoute('entity.synonym.overview.entity_type.bundle.behavior', [
                'synonyms_entity_type' => $entity_type
                  ->id(),
                'bundle' => $bundle,
                'synonyms_behavior_service' => $service_id,
              ]),
            ];
          }
          $render[] = [
            [
              '#markup' => Html::escape($entity_type
                ->getLabel()),
            ],
            [
              '#markup' => $bundle == $entity_type
                ->id() ? '' : Html::escape($bundle_info['label']),
            ],
            [
              '#type' => 'operations',
              '#links' => $links,
            ],
          ];
        }
      }
    }
    return $render;
  }

  /**
   * Routing callback to overview a particular entity type and behavior service.
   */
  public function overviewEntityTypeBundle(EntityTypeInterface $synonyms_entity_type, $bundle, SynonymsBehaviorInterface $synonyms_behavior_service) {
    $table = [
      '#type' => 'table',
      '#header' => [
        $this
          ->t('Provider'),
        $this
          ->t('Operations'),
      ],
    ];
    foreach ($this
      ->entityTypeManager()
      ->getStorage('synonym')
      ->loadMultiple() as $synonym_config) {
      $provider_instance = $synonym_config
        ->getProviderPluginInstance();
      $provider_definition = $provider_instance
        ->getPluginDefinition();
      if ($provider_definition['controlled_entity_type'] == $synonyms_entity_type
        ->id() && $provider_definition['controlled_bundle'] == $bundle && $this->behaviorService
        ->getBehaviorService($provider_definition['synonyms_behavior_service'])['service'] == $synonyms_behavior_service) {
        $table[] = [
          [
            '#markup' => Html::escape($synonym_config
              ->label()),
          ],
          [
            '#type' => 'operations',
            '#links' => $this
              ->entityTypeManager()
              ->getListBuilder($synonym_config
              ->getEntityTypeId())
              ->getOperations($synonym_config),
          ],
        ];
      }
    }
    return $table;
  }

  /**
   * Title callback for 'entity.synonym.overview.entity_type.bundle.behavior'.
   */
  public function overviewEntityTypeBundleTitle(EntityTypeInterface $synonyms_entity_type, $bundle, SynonymsBehaviorInterface $synonyms_behavior_service) {
    if ($synonyms_entity_type
      ->id() == $bundle) {
      return $this
        ->t('Manage @behavior of @entity_type', [
        '@behavior' => $synonyms_behavior_service
          ->getTitle(),
        '@entity_type' => $synonyms_entity_type
          ->getLabel(),
      ]);
    }
    $bundle_info = $this->entityTypeBundleInfo
      ->getBundleInfo($synonyms_entity_type
      ->id());
    return $this
      ->t('Manage @behavior of @entity_type @bundle', [
      '@behavior' => $synonyms_behavior_service
        ->getTitle(),
      '@entity_type' => $synonyms_entity_type
        ->getLabel(),
      '@bundle' => $bundle_info[$bundle]['label'],
    ]);
  }

}

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.
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.
SynonymConfigController::$behaviorService protected property The synonyms behavior service.
SynonymConfigController::$entityTypeBundleInfo protected property The entity type bundle info.
SynonymConfigController::create public static function Instantiates a new instance of this class. Overrides ControllerBase::create
SynonymConfigController::overview public function Routing callback: show overview table of synonyms configuration.
SynonymConfigController::overviewEntityTypeBundle public function Routing callback to overview a particular entity type and behavior service.
SynonymConfigController::overviewEntityTypeBundleTitle public function Title callback for 'entity.synonym.overview.entity_type.bundle.behavior'.
SynonymConfigController::__construct public function SynonymConfigController constructor.
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.