class FlexiformController in Flexiform 8

Controller for flexiform pages.

Hierarchy

class \Drupal\Core\Controller\ControllerBase implements ContainerInjectionInterface uses LoggerChannelTrait, MessengerTrait, LinkGeneratorTrait, RedirectDestinationTrait, UrlGeneratorTrait, StringTranslationTrait
- class \Drupal\flexiform\Controller\FlexiformController

Expanded class hierarchy of FlexiformController

File

src/Controller/FlexiformController.php, line 19

Namespace

Drupal\flexiform\Controller

View source

class FlexiformController extends ControllerBase {

  /**
   * The token service.
   *
   * @var \Drupal\flexiform\Utility\Token
   */
  protected $token;

  /**
   * The entity form builder.
   *
   * @var \Drupal\Core\Form\FormBuilderInterface
   */
  protected $formBuilder;

  /**
   * The flexiform manager.
   *
   * @var \Drupal\flexiform\FlexiformManager
   */
  protected $flexiformManager;

  /**
   * Construct a new flexiform controller.
   *
   * @param \Drupal\flexiform\Utility\Token $token
   *   The token service.
   * @param \Drupal\Core\Form\FormBuilderInterface $form_builder
   *   The entity form builder.
   * @param \Drupal\flexiform\FlexiformManager $flexiform_manager
   *   The flexiform manager.
   */
  public function __construct(Token $token, FormBuilderInterface $form_builder, FlexiformManager $flexiform_manager) {
    $this->token = $token;
    $this->formBuilder = $form_builder;
    $this->flexiformManager = $flexiform_manager;
  }

  /**
   * {@inheritdoc}
   */
  public static function create(ContainerInterface $container) {
    return new static($container
      ->get('flexiform.token'), $container
      ->get('form_builder'), $container
      ->get('flexiform.manager'));
  }

  /**
   * Flexiform form mode page.
   */
  public function formModePage(EntityFormMode $form_mode, Request $request) {
    $provided = $this
      ->getProvidedEntities($form_mode, $request);
    $entity = $provided['base_entity'];
    unset($provided['base_entity']);
    $settings = $form_mode
      ->getThirdPartySetting('flexiform', 'exposure');
    list($entity_type_id, $display_mode_name) = explode('.', $form_mode
      ->id(), 2);
    $entity_form_display = EntityFormDisplay::collectRenderDisplay($entity, $display_mode_name);
    $form_object = $this->flexiformManager
      ->getFormObject($entity_form_display, [
      $entity_form_display
        ->getBaseEntityNamespace() => $entity,
    ]);
    $form_state = new FormState();
    $form_state
      ->set('form_entity_provided', $provided);
    return $this->formBuilder
      ->buildForm($form_object, $form_state);
  }

  /**
   * Flexiform form mode title callback.
   */
  public function formModePageTitle(EntityFormMode $form_mode, Request $request) {
    $settings = $form_mode
      ->getThirdPartySetting('flexiform', 'exposure');
    $entities = $this
      ->getProvidedEntities($form_mode, $request);

    // @todo: Move this process somewhere better.
    $token_data = $token_options = [];
    $token_info = $this->token
      ->getInfo();
    foreach ($entities as $namespace => $entity) {
      $token_type = $entity
        ->getEntityType()
        ->get('token_type') ?: (!empty($token_info['types'][$entity
        ->getEntityTypeId()]) ? $entity
        ->getEntityTypeId() : FALSE);
      if ($token_type) {
        $token_data[$namespace] = $entity;
        $token_options['alias'][$namespace] = $token_type;
      }
    }
    return $this->token
      ->replace($settings['title'], $token_data, $token_options);
  }

  /**
   * Get the provided entities.
   *
   * @return \Drupal\Core\Entity\EntityInterface[]
   *   An array of provided entities keyed by machine name.
   */
  protected function getProvidedEntities(EntityFormMode $form_mode, Request $request) {
    $route_match = RouteMatch::createFromRequest($request);
    $settings = $form_mode
      ->getThirdPartySetting('flexiform', 'exposure');
    $provided = [];
    $provided['base_entity'] = $route_match
      ->getParameter('base_entity');
    foreach ($settings['parameters'] as $namespace => $info) {
      if ($provided_entity = $route_match
        ->getParameter($namespace)) {
        $provided[$namespace] = $provided_entity;
      }
    }
    return $provided;
  }

}

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::$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.
FlexiformController::$flexiformManager	protected	property	The flexiform manager.
FlexiformController::$formBuilder	protected	property	The entity form builder. Overrides ControllerBase::$formBuilder
FlexiformController::$token	protected	property	The token service.
FlexiformController::create	public static	function	Instantiates a new instance of this class. Overrides ControllerBase::create
FlexiformController::formModePage	public	function	Flexiform form mode page.
FlexiformController::formModePageTitle	public	function	Flexiform form mode title callback.
FlexiformController::getProvidedEntities	protected	function	Get the provided entities.
FlexiformController::__construct	public	function	Construct a new flexiform controller.
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.

You are here

class FlexiformController in Flexiform 8

Hierarchy

File

Namespace

Members

API Navigation