You are here

Home » API reference » Page Manager 8.4 » SelectionConfigure.php

class SelectionConfigure in Page Manager 8.4

Same name and namespace in other branches
  1. 8 page_manager_ui/src/Form/SelectionConfigure.php \Drupal\page_manager_ui\Form\SelectionConfigure

Hierarchy

Expanded class hierarchy of SelectionConfigure

1 string reference to 'SelectionConfigure'
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/SelectionConfigure.php, line 8

Namespace

Drupal\page_manager_ui\Form
View source 
class SelectionConfigure extends ConditionConfigure {

  /**
   * 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' => 'selection',
        ],
      ];
    }
    else {
      $page_variant = $this
        ->getPageVariant($cached_values);
      return [
        'entity.page.edit_form',
        [
          'machine_name' => $this->machine_name,
          'step' => 'page_variant__' . $page_variant
            ->id() . '__selection',
        ],
      ];
    }
  }

  /**
   * @inheritDoc
   */
  public function buildForm(array $form, FormStateInterface $form_state, $condition = NULL, $tempstore_id = NULL, $machine_name = NULL, $variant_machine_name = NULL) {
    $this->variantMachineName = $variant_machine_name;
    return parent::buildForm($form, $form_state, $condition, $tempstore_id, $machine_name);
  }

  /**
   * {@inheritdoc}
   */
  protected function getConditions($cached_values) {
    $page_variant = $this
      ->getPageVariant($cached_values);
    return $page_variant
      ->get('selection_criteria');
  }

  /**
   * {@inheritdoc}
   */
  protected function setConditions($cached_values, $conditions) {
    $page_variant = $this
      ->getPageVariant($cached_values);
    $page_variant
      ->set('selection_criteria', $conditions);
    return $cached_values;
  }

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

    /** @var $page \Drupal\page_manager\Entity\PageVariant */
    $page_variant = $this
      ->getPageVariant($cached_values);
    return $page_variant
      ->getContexts();
  }

}

Members

Namesort descending Modifiers Type Description Overrides
ConditionConfigure::$machine_name protected property
ConditionConfigure::$manager protected property
ConditionConfigure::$tempstore protected property
ConditionConfigure::$tempstore_id protected property
ConditionConfigure::ajaxSave public function
ConditionConfigure::create public static function Instantiates a new instance of this class. Overrides FormBase::create
ConditionConfigure::getFormId public function Returns a unique string identifying the form. Overrides FormInterface::getFormId
ConditionConfigure::submitForm public function Form submission handler. Overrides FormInterface::submitForm
ConditionConfigure::__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.
FormBase::validateForm public function Form validation handler. Overrides FormInterface::validateForm 62
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.
SelectionConfigure::$variantMachineName protected property The machine-name of the variant.
SelectionConfigure::buildForm public function @inheritDoc Overrides ConditionConfigure::buildForm
SelectionConfigure::getConditions protected function Custom logic for retrieving the conditions array from cached_values. Overrides ConditionConfigure::getConditions
SelectionConfigure::getContexts protected function Custom logic for retrieving the contexts array from cached_values. Overrides ConditionConfigure::getContexts
SelectionConfigure::getPageVariant protected function Get the page variant.
SelectionConfigure::getParentRouteInfo protected function Document the route name and parameters for redirect after submission. Overrides ConditionConfigure::getParentRouteInfo
SelectionConfigure::setConditions protected function Custom logic for setting the conditions array in cached_values. Overrides ConditionConfigure::setConditions
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.