You are here

Home » API reference » Entity Construction Kit (ECK) 8 » EckContentController.php

class EckContentController in Entity Construction Kit (ECK) 8

Provides a content controller for entities.

Hierarchy

Expanded class hierarchy of EckContentController

File

src/Controller/EckContentController.php, line 18

Namespace

Drupal\eck\Controller
View source 
class EckContentController extends ControllerBase implements ContainerInjectionInterface {

  /**
   * The render service.
   *
   * @var \Drupal\Core\Render\RendererInterface
   */
  protected $renderer;

  /**
   * Constructs an EckContentController object.
   *
   * @param \Drupal\Core\Render\RendererInterface $renderer
   *   The renderer service.
   */
  public function __construct(RendererInterface $renderer) {
    $this->renderer = $renderer;
  }

  /**
   * {@inheritdoc}
   */
  public static function create(ContainerInterface $container) {
    return new static($container
      ->get('renderer'));
  }

  /**
   * Displays add content link for available entity types.
   *
   * @param \Drupal\eck\EckEntityTypeInterface $eck_entity_type
   *   The request parameters.
   *
   * @return array
   *   The output as a renderable array.
   */
  public function addPage(EckEntityTypeInterface $eck_entity_type) {
    $content = [];
    $bundleStorage = $this
      ->getBundleStorage($eck_entity_type);

    /** @var \Drupal\eck\Entity\EckEntityBundle $bundle */
    foreach ($bundleStorage
      ->loadMultiple() as $bundle) {
      if ($this
        ->entityTypeManager()
        ->getAccessControlHandler($eck_entity_type
        ->id())
        ->createAccess($bundle->type)) {
        $content[$bundle->type] = $bundle;
      }
    }
    return [
      '#theme' => 'eck_content_add_list',
      '#content' => $content,
      '#entity_type' => [
        'id' => $eck_entity_type
          ->id(),
        'label' => $eck_entity_type
          ->label(),
      ],
    ];
  }

  /**
   * Provides the entity submission form.
   *
   * @param \Drupal\eck\EckEntityTypeInterface $eck_entity_type
   *   The entity type.
   * @param string $eck_entity_bundle
   *   The entity type bundle.
   *
   * @return array
   *   The entity submission form.
   */
  public function add(EckEntityTypeInterface $eck_entity_type, $eck_entity_bundle) {
    $bundleStorage = $this
      ->getBundleStorage($eck_entity_type);
    if (!$bundleStorage
      ->load($eck_entity_bundle)) {
      throw new NotFoundHttpException($this
        ->t('Bundle %bundle does not exist', [
        '%bundle' => $eck_entity_bundle,
      ]));
    }
    $entityStorage = $this
      ->entityTypeManager()
      ->getStorage($eck_entity_type
      ->id());
    $entity = $entityStorage
      ->create([
      'type' => $eck_entity_bundle,
    ]);
    return $this
      ->entityFormBuilder()
      ->getForm($entity);
  }

  /**
   * Title callback for add page.
   *
   * @param \Drupal\eck\EckEntityTypeInterface $eck_entity_type
   *   The entity type.
   *
   * @return string
   *   The title.
   */
  public function addPageTitle(EckEntityTypeInterface $eck_entity_type) {
    return $this
      ->t('Add %label content', [
      '%label' => $eck_entity_type
        ->label(),
    ]);
  }

  /**
   * Title callback for add page.
   *
   * @param string $eck_entity_bundle
   *   The bundle id.
   *
   * @return string
   *   The title.
   */
  public function addContentPageTitle($eck_entity_bundle) {
    $eck_entity_bundle = EckEntityBundle::load($eck_entity_bundle);
    return $this
      ->t('Add %label content', [
      '%label' => $eck_entity_bundle
        ->get('name'),
    ]);
  }

  /**
   * Retrieves the bundle storage for the given entity type.
   *
   * @param \Drupal\eck\EckEntityTypeInterface $eck_entity_type
   *   The entity type.
   *
   * @return \Drupal\Core\Entity\EntityStorageInterface
   *   The bundle storage.
   */
  private function getBundleStorage(EckEntityTypeInterface $eck_entity_type) {
    $entityTypeBundle = "{$eck_entity_type->id()}_type";
    $bundleStorage = $this
      ->entityTypeManager()
      ->getStorage($entityTypeBundle);
    return $bundleStorage;
  }

}

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.
EckContentController::$renderer protected property The render service.
EckContentController::add public function Provides the entity submission form.
EckContentController::addContentPageTitle public function Title callback for add page.
EckContentController::addPage public function Displays add content link for available entity types.
EckContentController::addPageTitle public function Title callback for add page.
EckContentController::create public static function Instantiates a new instance of this class. Overrides ControllerBase::create
EckContentController::getBundleStorage private function Retrieves the bundle storage for the given entity type.
EckContentController::__construct public function Constructs an EckContentController 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.