class FieldController in Display Suite 8.3

Route controller fields.

Hierarchy

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

File

src/Controller/FieldController.php, line 16

Namespace

Drupal\ds\Controller

class FieldController extends ControllerBase implements ContainerInjectionInterface {

  /**
   * The config storage.
   *
   * @var \Drupal\Core\Config\StorageInterface
   */
  protected $storage;

  /**
   * The module handler.
   *
   * @var \Drupal\Core\Extension\ModuleHandlerInterface
   */
  protected $moduleHandler;

  /**
   * Constructs a \Drupal\ds\Controller\FieldController object.
   *
   * @param \Drupal\Core\Config\StorageInterface $storage
   *   The configuration storage.
   * @param \Drupal\Core\Extension\ModuleHandlerInterface $module_handler
   *   The module handler.
   */
  public function __construct(StorageInterface $storage, ModuleHandlerInterface $module_handler) {
    $this->storage = $storage;
    $this->moduleHandler = $module_handler;
  }

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

  /**
   * Builds a list of fields.
   */
  public function fieldList() {
    $custom_fields = $this->storage
      ->listAll('ds.field.');
    if (!empty($custom_fields)) {
      $rows = [];
      foreach ($custom_fields as $config) {
        $field_value = $this
          ->config($config)
          ->get();
        $row = [];
        $row[] = [
          'data' => [
            '#plain_text' => $field_value['label'],
          ],
        ];
        $row[] = isset($field_value['type_label']) ? $field_value['type_label'] : $this
          ->t('Unknown');
        $row[] = $field_value['id'];
        $row[] = ucwords(str_replace('_', ' ', implode(', ', $field_value['entities'])));
        $operations = [];
        $operations['edit'] = [
          'title' => $this
            ->t('Edit'),
          'url' => new Url('ds.manage_field', [
            'field_key' => $field_value['id'],
          ]),
        ];
        $operations['delete'] = [
          'title' => $this
            ->t('Delete'),
          'url' => new Url('ds.delete_field', [
            'field_key' => $field_value['id'],
          ]),
        ];
        $this->moduleHandler
          ->alter('ds_field_operations', $operations, $field_value);
        $row[] = [
          'data' => [
            '#type' => 'operations',
            '#subtype' => 'ds',
            '#links' => $operations,
          ],
        ];
        $rows[] = $row;
      }
      $build = [
        '#theme' => 'table',
        '#header' => [
          'Label',
          'Type',
          'Machine name',
          'Entities',
          'Operations',
        ],
        '#rows' => $rows,
      ];
    }
    else {
      $build = [
        '#markup' => $this
          ->t('No custom fields have been defined.'),
      ];
    }
    return $build;
  }

  /**
   * Redirect to the correct manage callback.
   */
  public function manageRedirect($field_key) {
    $config = $this
      ->config('ds.field.' . $field_key);
    if ($field = $config
      ->get()) {
      $url = new Url('ds.manage_' . $field['type'] . '_field', [
        'field_key' => $field_key,
      ]);
      if ($url
        ->toString()) {
        return new RedirectResponse($url
          ->toString());
      }
    }
    $this
      ->messenger()
      ->addMessage($this
      ->t('Field not found'));
    $url = new Url('ds.fields_list');
    return new RedirectResponse($url
      ->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::$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.
FieldController::$moduleHandler	protected	property	The module handler. Overrides ControllerBase::$moduleHandler
FieldController::$storage	protected	property	The config storage.
FieldController::create	public static	function	Instantiates a new instance of this class. Overrides ControllerBase::create
FieldController::fieldList	public	function	Builds a list of fields.
FieldController::manageRedirect	public	function	Redirect to the correct manage callback.
FieldController::__construct	public	function	Constructs a \Drupal\ds\Controller\FieldController object.
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.