class BibciteEntityController in Bibliography & Citation 2.0.x

Returns responses for Bibcite routes.

Hierarchy

• class \Drupal\Core\Controller\ControllerBase implements ContainerInjectionInterface uses LoggerChannelTrait, MessengerTrait, RedirectDestinationTrait, StringTranslationTrait
  • class \Drupal\bibcite_entity\Controller\BibciteEntityController implements ContainerInjectionInterface

File

modules/bibcite_entity/src/Controller/BibciteEntityController.php, line 12

Namespace

Drupal\bibcite_entity\Controller

class BibciteEntityController extends ControllerBase implements ContainerInjectionInterface {

  /**
   * Provides the reference submission form.
   *
   * @param ReferenceTypeInterface $bibcite_reference_type
   *   The reference type entity for the reference.
   *
   * @return array
   *   A reference submission form.
   *
   * @throws \Drupal\Component\Plugin\Exception\InvalidPluginDefinitionException
   * @throws \Drupal\Component\Plugin\Exception\PluginNotFoundException
   */
  public function add(ReferenceTypeInterface $bibcite_reference_type) {
    $entity = $this
      ->entityTypeManager()
      ->getStorage('bibcite_reference')
      ->create([
      'type' => $bibcite_reference_type
        ->id(),
    ]);
    return $this
      ->entityFormBuilder()
      ->getForm($entity);
  }

  /**
   * {@inheritdoc}
   */
  protected function entityFormBuilder() {
    if (!$this->entityFormBuilder) {

      /* We use our form builder for saving entity in cache
       * on first form build. This is temporary patch for
       * entity form cache problem.
       *
       * @see https://www.drupal.org/project/drupal/issues/2824293
       *   Core issue.
       *
       * @see https://www.drupal.org/project/bibcite/issues/2930990
       *   Issue for this patch.
       *
       * @todo Remove after core fix.
       */
      $this->entityFormBuilder = $this
        ->container()
        ->get('reference_entity.form_builder');
    }
    return $this->entityFormBuilder;
  }

  /**
   * Returns the service container.
   *
   * This method is marked private to prevent sub-classes from retrieving
   * services from the container through it. Instead,
   * \Drupal\Core\DependencyInjection\ContainerInjectionInterface should be used
   * for injecting services.
   *
   * @see ControllerBase
   *   Copy of method from original parent class.
   *
   * @return \Symfony\Component\DependencyInjection\ContainerInterface
   *   The service container.
   */
  private function container() {
    return \Drupal::getContainer();
  }

}

Members

Name	Modifiers	Type	Description	Overrides
BibciteEntityController::add	public	function	Provides the reference submission form.
BibciteEntityController::container	private	function	Returns the service container. Overrides ControllerBase::container
BibciteEntityController::entityFormBuilder	protected	function	Retrieves the entity form builder. Overrides ControllerBase::entityFormBuilder
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::$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::create	public static	function	Instantiates a new instance of this class. Overrides ContainerInjectionInterface::create	46
ControllerBase::currentUser	protected	function	Returns the current user.	1
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.
ControllerBase::state	protected	function	Returns the state storage 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.	27
MessengerTrait::messenger	public	function	Gets the messenger.	27
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.	4
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.