class StaticContextConfigure in Page Manager 8.4

Same name and namespace in other branches

8 page_manager_ui/src/Form/StaticContextConfigure.php \Drupal\page_manager_ui\Form\StaticContextConfigure

Hierarchy

class \Drupal\Core\Form\FormBase implements ContainerInjectionInterface, FormInterface uses DependencySerializationTrait, LoggerChannelTrait, MessengerTrait, LinkGeneratorTrait, RedirectDestinationTrait, UrlGeneratorTrait, StringTranslationTrait
- class \Drupal\ctools\Form\ContextConfigure
  - class \Drupal\page_manager_ui\Form\StaticContextConfigure

Expanded class hierarchy of StaticContextConfigure

1 string reference to 'StaticContextConfigure'

page_manager_ui.routing.yml in page_manager_ui/page_manager_ui.routing.yml: page_manager_ui/page_manager_ui.routing.yml

File

page_manager_ui/src/Form/StaticContextConfigure.php, line 9

Namespace

Drupal\page_manager_ui\Form

View source

class StaticContextConfigure extends ContextConfigure {

  /**
   * The machine-name of the variant.
   *
   * @var string
   */
  protected $variantMachineName;

  /**
   * Get the page variant.
   *
   * @param array $cached_values
   *   The cached values from the wizard.
   *
   * @return \Drupal\page_manager\PageVariantInterface
   */
  protected function getPageVariant($cached_values) {
    if (isset($cached_values['page_variant'])) {
      return $cached_values['page_variant'];
    }

    /** @var $page \Drupal\page_manager\PageInterface */
    $page = $cached_values['page'];
    return $page
      ->getVariant($this->variantMachineName);
  }

  /**
   * {@inheritdoc}
   */
  protected function getParentRouteInfo($cached_values) {

    /** @var $page \Drupal\page_manager\PageInterface */
    $page = $cached_values['page'];
    if ($page
      ->isNew()) {
      return [
        'entity.page.add_step_form',
        [
          'machine_name' => $this->machine_name,
          'step' => 'contexts',
        ],
      ];
    }
    else {
      $page_variant = $this
        ->getPageVariant($cached_values);
      return [
        'entity.page.edit_form',
        [
          'machine_name' => $this->machine_name,
          'step' => 'page_variant__' . $page_variant
            ->id() . '__contexts',
        ],
      ];
    }
  }

  /**
   * {@inheritdoc}
   *
   * Overridden to set the variantMachineName.
   */
  public function buildForm(array $form, FormStateInterface $form_state, $context_id = NULL, $tempstore_id = NULL, $machine_name = NULL, $variant_machine_name = NULL) {
    $this->variantMachineName = $variant_machine_name;
    return parent::buildForm($form, $form_state, $context_id, $tempstore_id, $machine_name);
  }

  /**
   * {@inheritdoc}
   */
  protected function getContexts($cached_values) {

    /** @var $page_variant \Drupal\page_manager\PageVariantInterface */
    $page_variant = !empty($cached_values['page_variant']) ? $cached_values['page_variant'] : NULL;
    if (is_null($page_variant)) {
      $page_variant = $this
        ->getPageVariant($cached_values);
    }
    return $page_variant
      ->getContexts();
  }

  /**
   * {@inheritdoc}
   */
  protected function addContext($cached_values, $context_id, ContextInterface $context) {

    /** @var $page_variant \Drupal\page_manager\PageVariantInterface */
    $page_variant = $this
      ->getPageVariant($cached_values);
    $context_config = [
      'label' => $context
        ->getContextDefinition()
        ->getLabel(),
      'type' => $context
        ->getContextDefinition()
        ->getDataType(),
      'description' => $context
        ->getContextDefinition()
        ->getDescription(),
      'value' => strpos($context
        ->getContextDefinition()
        ->getDataType(), 'entity:') === 0 ? $context
        ->getContextValue()
        ->uuid() : $context
        ->getContextValue(),
    ];
    $page_variant
      ->setStaticContext($context_id, $context_config);
    $cached_values['page_variant'] = $page_variant;
    return $cached_values;
  }

  /**
   * {@inheritdoc}
   */
  public function contextExists($value, $element, $form_state) {
    return FALSE;
  }

  /**
   * {@inheritdoc}
   */
  protected function disableMachineName($cached_values, $machine_name) {
    if ($machine_name) {
      return !empty($this
        ->getContexts($cached_values)[$machine_name]);
    }
    return FALSE;
  }

}

Members

Name	Modifiers	Type	Description	Overrides
ContextConfigure::$entityTypeManager	protected	property	Object EntityTypeManager.
ContextConfigure::$machine_name	protected	property
ContextConfigure::$tempstore	protected	property
ContextConfigure::$tempstore_id	protected	property
ContextConfigure::ajaxSave	public	function
ContextConfigure::create	public static	function	Instantiates a new instance of this class. Overrides FormBase::create
ContextConfigure::getFormId	public	function	Returns a unique string identifying the form. Overrides FormInterface::getFormId
ContextConfigure::submitForm	public	function	Form submission handler. Overrides FormInterface::submitForm
ContextConfigure::validateForm	public	function	Form validation handler. Overrides FormBase::validateForm
ContextConfigure::__construct	public	function
DependencySerializationTrait::$_entityStorages	protected	property	An array of entity type IDs keyed by the property name of their storages.
DependencySerializationTrait::$_serviceIds	protected	property	An array of service IDs keyed by property name used for serialization.
DependencySerializationTrait::__sleep	public	function		1
DependencySerializationTrait::__wakeup	public	function		2
FormBase::$configFactory	protected	property	The config factory.	1
FormBase::$requestStack	protected	property	The request stack.	1
FormBase::$routeMatch	protected	property	The route match.
FormBase::config	protected	function	Retrieves a configuration object.
FormBase::configFactory	protected	function	Gets the config factory for this form.	1
FormBase::container	private	function	Returns the service container.
FormBase::currentUser	protected	function	Gets the current user.
FormBase::getRequest	protected	function	Gets the request object.
FormBase::getRouteMatch	protected	function	Gets the route match.
FormBase::logger	protected	function	Gets the logger for a specific channel.
FormBase::redirect	protected	function	Returns a redirect response object for the specified route. Overrides UrlGeneratorTrait::redirect
FormBase::resetConfigFactory	public	function	Resets the configuration factory.
FormBase::setConfigFactory	public	function	Sets the config factory for this form.
FormBase::setRequestStack	public	function	Sets the request stack object to use.
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.
StaticContextConfigure::$variantMachineName	protected	property	The machine-name of the variant.
StaticContextConfigure::addContext	protected	function	Custom logic for adding a context to the cached_values contexts array. Overrides ContextConfigure::addContext
StaticContextConfigure::buildForm	public	function	Overridden to set the variantMachineName. Overrides ContextConfigure::buildForm
StaticContextConfigure::contextExists	public	function	Custom "exists" logic for the context to be created. Overrides ContextConfigure::contextExists
StaticContextConfigure::disableMachineName	protected	function	Determines if the machine_name should be disabled. Overrides ContextConfigure::disableMachineName
StaticContextConfigure::getContexts	protected	function	Custom logic for retrieving the contexts array from cached_values. Overrides ContextConfigure::getContexts
StaticContextConfigure::getPageVariant	protected	function	Get the page variant.
StaticContextConfigure::getParentRouteInfo	protected	function	Document the route name and parameters for redirect after submission. Overrides ContextConfigure::getParentRouteInfo
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 StaticContextConfigure in Page Manager 8.4

Hierarchy

File

Namespace

Members

API Navigation