class DsController in Display Suite 8.3

Same name and namespace in other branches

8.4 src/Controller/DsController.php \Drupal\ds\Controller\DsController
8.2 src/Controller/DsController.php \Drupal\ds\Controller\DsController

Returns responses for Display Suite UI routes.

Hierarchy

class \Drupal\Core\Controller\ControllerBase implements ContainerInjectionInterface uses LoggerChannelTrait, MessengerTrait, LinkGeneratorTrait, RedirectDestinationTrait, UrlGeneratorTrait, StringTranslationTrait
- class \Drupal\ds\Controller\DsController

Expanded class hierarchy of DsController

File

src/Controller/DsController.php, line 16

Namespace

Drupal\ds\Controller

View source

class DsController extends ControllerBase {

  /**
   * Lists all bundles per entity type.
   *
   * @return array
   *   The Views fields report page.
   */
  public function listDisplays() {
    $build = [];

    // All entities.
    $entity_info = $this
      ->entityTypeManager()
      ->getDefinitions();

    // Move node to the top.
    if (isset($entity_info['node'])) {
      $node_entity = $entity_info['node'];
      unset($entity_info['node']);
      $entity_info = array_merge([
        'node' => $node_entity,
      ], $entity_info);
    }
    $field_ui_enabled = $this
      ->moduleHandler()
      ->moduleExists('field_ui');
    if (!$field_ui_enabled) {
      $build['no_field_ui'] = [
        '#markup' => '<p>' . $this
          ->t('You need to enable Field UI to manage the displays of entities.') . '</p>',
        '#weight' => -10,
      ];
    }
    if (isset($entity_info['comment'])) {
      $comment_entity = $entity_info['comment'];
      unset($entity_info['comment']);
      $entity_info['comment'] = $comment_entity;
    }
    foreach ($entity_info as $entity_type => $info) {
      $base_table = $info
        ->getBaseTable();
      if ($info
        ->get('field_ui_base_route') && !empty($base_table)) {
        $rows = [];
        $bundles = \Drupal::service('entity_type.bundle.info')
          ->getBundleInfo($entity_type);
        foreach ($bundles as $bundle_type => $bundle) {
          $row = [];
          $operations = '';
          $row[] = [
            'data' => [
              '#plain_text' => $bundle['label'],
            ],
          ];
          if ($field_ui_enabled) {

            // Get the manage display URI.
            $route = FieldUI::getOverviewRouteInfo($entity_type, $bundle_type);
            if ($route) {
              try {
                $operations = Link::fromTextAndUrl($this
                  ->t('Manage display'), Url::fromRoute("entity.entity_view_display.{$entity_type}.default", $route
                  ->getRouteParameters()))
                  ->toString();
              } catch (\Exception $ignored) {
              }
            }
          }

          // Add operation links.
          if (!empty($operations)) {

            // Simulate a drop button. Not using operations because we are
            // catching exceptions from the route generation, sometimes they
            // simply fatal.
            // @see https://www.drupal.org/project/ds/issues/3036765
            $row[] = [
              'data' => [
                '#type' => 'markup',
                '#markup' => '<div class="dropbutton-wrapper dropbutton-single"><div class="dropbutton-widget"><ul class="dropbutton"><li class="manage-display dropbutton-action">' . $operations . '</li></ul></div></div>',
              ],
            ];
          }
          else {
            $row[] = [
              'data' => '',
            ];
          }
          $rows[] = $row;
        }
        if (!empty($rows)) {
          $header = [
            [
              'data' => $info
                ->getLabel(),
            ],
            [
              'data' => $field_ui_enabled ? $this
                ->t('operations') : '',
              'class' => 'ds-display-list-options',
            ],
          ];
          $build['list_' . $entity_type] = [
            '#theme' => 'table',
            '#header' => $header,
            '#rows' => $rows,
          ];
        }
      }
    }
    $build['#attached']['library'][] = 'ds/admin';
    return $build;
  }

  /**
   * Adds a contextual tab to entities.
   *
   * @param \Drupal\Core\Routing\RouteMatchInterface $route_match
   *   The route information.
   *
   * @return \Symfony\Component\HttpFoundation\RedirectResponse
   *   A redirect response pointing to the corresponding display.
   */
  public function contextualTab(RouteMatchInterface $route_match) {
    $parameter_name = $route_match
      ->getRouteObject()
      ->getOption('_ds_entity_type_id');
    $entity = $route_match
      ->getParameter($parameter_name);
    $entity_type_id = $entity
      ->getEntityTypeId();
    $destination = $entity
      ->toUrl();
    if (!empty($entity->ds_switch->value)) {
      $view_mode = $entity->ds_switch->value;
    }
    else {
      $view_mode = 'full';
    }

    // Get the manage display URI.
    $route = FieldUI::getOverviewRouteInfo($entity_type_id, $entity
      ->bundle());
    $entity_display = EntityViewDisplay::load($entity_type_id . '.' . $entity
      ->bundle() . '.' . $view_mode);
    $route_parameters = $route
      ->getRouteParameters();
    if ($entity_display && $entity_display
      ->status() && $entity_display
      ->getThirdPartySetting('ds', 'layout')) {
      $route_parameters['view_mode_name'] = $view_mode;
      $admin_route_name = "entity.entity_view_display.{$entity_type_id}.view_mode";
    }
    else {
      $admin_route_name = "entity.entity_view_display.{$entity_type_id}.default";
    }
    $route
      ->setOption('query', [
      'destination' => $destination
        ->toString(),
    ]);
    $url = new Url($admin_route_name, $route_parameters, $route
      ->getOptions());
    return new RedirectResponse($url
      ->setAbsolute(TRUE)
      ->toString());
  }

}

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::$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::create	public static	function	Instantiates a new instance of this class. Overrides ContainerInjectionInterface::create	40
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.
DsController::contextualTab	public	function	Adds a contextual tab to entities.
DsController::listDisplays	public	function	Lists all bundles per entity type.
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.
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.

You are here

class DsController in Display Suite 8.3

Hierarchy

File

Namespace

Members

API Navigation