You are here

Home » API reference » Field collection 8.3 » FieldCollectionItemController.php

class FieldCollectionItemController in Field collection 8.3

Same name and namespace in other branches
  1. 8 src/Controller/FieldCollectionItemController.php \Drupal\field_collection\Controller\FieldCollectionItemController

Returns responses for Field collection item routes.

Hierarchy

Expanded class hierarchy of FieldCollectionItemController

File

src/Controller/FieldCollectionItemController.php, line 13

Namespace

Drupal\field_collection\Controller
View source 
class FieldCollectionItemController extends ControllerBase {

  /**
   * Provides the field collection item submission form.
   *
   * @param \Drupal\field_collection\Entity\FieldCollection $field_collection
   *   The field_collection entity for the field collection item.
   *
   * @param $host_type
   *   The type of the entity hosting the field collection item.
   *
   * @param $host_id
   *   The id of the entity hosting the field collection item.
   *
   * @return array
   *   A field collection item submission form.
   *
   * TODO: additional fields
   */
  public function add(FieldCollection $field_collection, $host_type, $host_id) {
    $host = $this
      ->entityTypeManager()
      ->getStorage($host_type)
      ->load($host_id);
    if (_field_collection_field_item_list_full($host->{$field_collection
      ->id()})) {
      drupal_set_message(t('This field is already full.'), 'error');
      return [
        '#markup' => 'Can not add to an already full field.',
      ];
    }
    else {
      $field_collection_item = $this
        ->entityTypeManager()
        ->getStorage('field_collection_item')
        ->create([
        'field_name' => $field_collection
          ->id(),
        'host_type' => $host_type,
        'revision_id' => 0,
      ]);
      $form = $this
        ->entityFormBuilder()
        ->getForm($field_collection_item);
      return $form;
    }
  }

  /**
   * Displays a field collection item.
   *
   * @param \Drupal\field_collection\Entity\FieldCollectionItem $field_collection_item
   *   The field collection item we are displaying.
   *
   * @return array
   *   An array suitable for drupal_render().
   */
  public function page(FieldCollectionItem $field_collection_item) {
    $build = $this
      ->buildPage($field_collection_item);
    return $build;
  }

  /**
   * Builds a field collection item page render array.
   *
   * @param \Drupal\field_collection\Entity\FieldCollectionItem $field_collection_item
   *   The field collection item we are displaying.
   *
   * @return array
   *   An array suitable for drupal_render().
   */
  protected function buildPage(FieldCollectionItem $field_collection_item) {
    $ret = [
      'field_collection_items' => $this
        ->entityTypeManager()
        ->getViewBuilder('field_collection_item')
        ->view($field_collection_item),
    ];
    return $ret;
  }

  /**
   * The _title_callback for the field_collection_item.view route.
   *
   * @param FieldCollectionItem $field_collection_item
   *   The current field_collection_item.
   *
   * @return string
   *   The page title.
   */
  public function pageTitle(FieldCollectionItem $field_collection_item) {
    return \Drupal::service('entity.repository')
      ->getTranslationFromContext($field_collection_item)
      ->label();
  }

  /**
   * The _title_callback for the field_collection_item.add route.
   *
   * @param \Drupal\field_collection\Entity\FieldCollection $field_collection
   *   The current field collection.
   *
   * @return string
   *   The page title.
   */
  public function addPageTitle(FieldCollection $field_collection) {
    return $this
      ->t('Create @label', [
      '@label' => $field_collection
        ->label(),
    ]);
  }

  /**
   * Displays a field collection item revision.
   *
   * @param int $field_collection_item_revision
   *   The field collection item revision ID.
   *
   * @return array
   *   An array suitable for drupal_render().
   */
  public function revisionShow($field_collection_item_revision) {
    $field_collection_item = $this
      ->entityTypeManager()
      ->getStorage('field_collection_item')
      ->loadRevision($field_collection_item_revision);
    $field_collection_item_view_controller = new EntityViewController($this
      ->entityManager(), \Drupal::service('renderer'));
    $page = $field_collection_item_view_controller
      ->view($field_collection_item);
    unset($page['field_collection_item'][$field_collection_item
      ->id()]['#cache']);
    return $page;
  }

  /**
   * Page title callback for a field collection item revision.
   *
   * @param int $field_collection_item_revision
   *   The field collection item revision ID.
   *
   * @return string
   *   The page title.
   */
  public function revisionPageTitle($field_collection_item_revision) {
    $field_collection_item = $this
      ->entityTypeManager()
      ->getStorage('field_collection_item')
      ->loadRevision($field_collection_item_revision);
    return $this
      ->t('Revision %revision of %title', [
      '%revision' => $field_collection_item_revision,
      '%title' => $field_collection_item
        ->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::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.
FieldCollectionItemController::add public function Provides the field collection item submission form.
FieldCollectionItemController::addPageTitle public function The _title_callback for the field_collection_item.add route.
FieldCollectionItemController::buildPage protected function Builds a field collection item page render array.
FieldCollectionItemController::page public function Displays a field collection item.
FieldCollectionItemController::pageTitle public function The _title_callback for the field_collection_item.view route.
FieldCollectionItemController::revisionPageTitle public function Page title callback for a field collection item revision.
FieldCollectionItemController::revisionShow public function Displays a field collection item revision.
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.