You are here

Home » API reference » Custom Formatters 8.3 » CustomFormattersController.php

class CustomFormattersController in Custom Formatters 8.3

Class CustomFormattersController.

@package Drupal\custom_formatters\Controller

Hierarchy

Expanded class hierarchy of CustomFormattersController

File

src/Controller/CustomFormattersController.php, line 16

Namespace

Drupal\custom_formatters\Controller
View source 
class CustomFormattersController extends ControllerBase implements ContainerInjectionInterface {

  /**
   * The Formatter type plugin manager.
   *
   * @var FormatterTypeManager
   */
  protected $formatterTypeManager = NULL;

  /**
   * Constructs a CustomFormattersController object.
   */
  public function __construct(FormatterTypeManager $formatter_type_manager) {
    $this->formatterTypeManager = $formatter_type_manager;
  }

  /**
   * {@inheritdoc}
   */
  public static function create(ContainerInterface $container) {
    return new static($container
      ->get('plugin.manager.custom_formatters.formatter_type'));
  }

  /**
   * Provides the formatter creation form.
   *
   * @return array
   *   A node submission form.
   */
  public function add($formatter_type) {
    $formatter = $this
      ->entityTypeManager()
      ->getStorage('formatter')
      ->create([
      'type' => $formatter_type,
    ]);
    $form = $this
      ->entityFormBuilder()
      ->getForm($formatter);
    return $form;
  }

  /**
   * Displays add content links for available formatter types.
   *
   * @return array|\Symfony\Component\HttpFoundation\RedirectResponse
   *   A render array for a list of the formatter types that can be added;
   *   however, if there is only one formatter type available for the user, the
   *   function will return a RedirectResponse to the formatter add page for
   *   that one formatter type.
   */
  public function addList() {
    $build = [
      '#theme' => 'formatter_add_list',
    ];
    $content = [];

    // Only use formatter types the user has access to.
    // @TODO - Add granular permissions system.
    foreach ($this->formatterTypeManager
      ->getDefinitions() as $formatter_type) {
      $content[$formatter_type['id']] = $formatter_type;
    }
    $build['#content'] = $content;
    return $build;
  }

  /**
   * Page title callback for a formatter edit form.
   *
   * @return string
   *   The formatter edit page title.
   */
  public function editTitle(FormatterInterface $formatter) {
    return $this
      ->t('<em>Edit formatter</em> :title', [
      ':title' => $formatter
        ->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.
CustomFormattersController::$formatterTypeManager protected property The Formatter type plugin manager.
CustomFormattersController::add public function Provides the formatter creation form.
CustomFormattersController::addList public function Displays add content links for available formatter types.
CustomFormattersController::create public static function Instantiates a new instance of this class. Overrides ControllerBase::create
CustomFormattersController::editTitle public function Page title callback for a formatter edit form.
CustomFormattersController::__construct public function Constructs a CustomFormattersController 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.