class RelationshipConfigure

Same name in other branches
  1. 8.x-3.x src/Form/RelationshipConfigure.php \Drupal\ctools\Form\RelationshipConfigure

Configure Relationship Form.

Hierarchy

Expanded class hierarchy of RelationshipConfigure

File

src/Form/RelationshipConfigure.php, line 18

Namespace

Drupal\ctools\Form
View source
abstract class RelationshipConfigure extends FormBase {
    
    /**
     * Tempstore Factory.
     *
     * @var \Drupal\Core\TempStore\SharedTempStoreFactory
     */
    protected $tempstore;
    
    /**
     * Typed Data Resolver Service.
     *
     * @var \Drupal\ctools\TypedDataResolver
     */
    protected $resolver;
    
    /**
     * Tempstore ID.
     *
     * @var string
     */
    protected $tempstore_id;
    
    /**
     * Relationship Machine Name.
     *
     * @var string
     */
    protected $machine_name;
    
    /**
     * {@inheritdoc}
     */
    public static function create(ContainerInterface $container) {
        return new static($container->get('tempstore.shared'), $container->get('ctools.typed_data.resolver'));
    }
    
    /**
     * Configure Relationship Form constructor.
     *
     * @param \Drupal\Core\TempStore\SharedTempStoreFactory $tempstore
     *   Tempstore Service.
     * @param \Drupal\ctools\TypedDataResolver $resolver
     *   Typed Data Resolver Service.
     */
    public function __construct(SharedTempStoreFactory $tempstore, TypedDataResolver $resolver) {
        $this->tempstore = $tempstore;
        $this->resolver = $resolver;
    }
    
    /**
     * {@inheritdoc}
     */
    public function getFormId() {
        return 'ctools_relationship_configure';
    }
    
    /**
     * {@inheritdoc}
     */
    public function buildForm(array $form, FormStateInterface $form_state, $context_id = NULL, $tempstore_id = NULL, $machine_name = NULL) {
        $this->tempstore_id = $tempstore_id;
        $this->machine_name = $machine_name;
        $cached_values = $this->tempstore
            ->get($this->tempstore_id)
            ->get($this->machine_name);
        
        /** @var \Drupal\Core\Plugin\Context\ContextInterface[] $contexts */
        $contexts = $this->getContexts($cached_values);
        $context_object = $this->resolver
            ->convertTokenToContext($context_id, $contexts);
        $form['id'] = [
            '#type' => 'value',
            '#value' => $context_id,
        ];
        $form['context_object'] = [
            '#type' => 'value',
            '#value' => $context_object,
        ];
        $form['label'] = [
            '#type' => 'textfield',
            '#title' => $this->t('Context label'),
            '#default_value' => !empty($contexts[$context_id]) ? $contexts[$context_id]->getContextDefinition()
                ->getLabel() : $this->resolver
                ->getLabelByToken($context_id, $contexts),
            '#required' => TRUE,
        ];
        $form['context_data'] = [
            '#type' => 'item',
            '#title' => $this->t('Data type'),
            '#markup' => $context_object->getContextDefinition()
                ->getDataType(),
        ];
        $form['submit'] = [
            '#type' => 'submit',
            '#value' => $this->t('Save'),
            '#ajax' => [
                'callback' => [
                    $this,
                    'ajaxSave',
                ],
            ],
        ];
        return $form;
    }
    
    /**
     * {@inheritdoc}
     */
    public function submitForm(array &$form, FormStateInterface $form_state) {
        $cached_values = $this->tempstore
            ->get($this->tempstore_id)
            ->get($this->machine_name);
        [
            $route_name,
            $route_options,
        ] = $this->getParentRouteInfo($cached_values);
        $form_state->setRedirect($route_name, $route_options);
    }
    
    /**
     * Ajax Save Method.
     *
     * @param array $form
     *   Drupal Form.
     * @param \Drupal\Core\Form\FormStateInterface $form_state
     *   Form State.
     *
     * @return \Drupal\Core\Ajax\AjaxResponse
     *   The ajax data in the response.
     */
    public function ajaxSave(array &$form, FormStateInterface $form_state) {
        $cached_values = $this->tempstore
            ->get($this->tempstore_id)
            ->get($this->machine_name);
        [
            $route_name,
            $route_parameters,
        ] = $this->getParentRouteInfo($cached_values);
        $response = new AjaxResponse();
        $url = Url::fromRoute($route_name, $route_parameters);
        $response->addCommand(new RedirectCommand($url->toString()));
        $response->addCommand(new CloseModalDialogCommand());
        return $response;
    }
    
    /**
     * Document the route name and parameters for redirect after submission.
     *
     * @param array $cached_values
     *   Cached Values get route info from.
     *
     * @return array In the format of
     *   In the format of
     *   return ['route.name',
     *      ['machine_name' => $this->machine_name, 'step' => 'step_name']];
     */
    protected abstract function getParentRouteInfo(array $cached_values);
    
    /**
     * Custom logic for setting the conditions array in cached_values.
     *
     * @param array $cached_values
     *
     * @param mixed $contexts
     *   The conditions to set within the cached values.
     *
     * @return mixed
     *   Return the $cached_values
     */
    protected abstract function setContexts(array $cached_values, mixed $contexts);
    
    /**
     * Custom logic for retrieving the contexts array from cached_values.
     *
     * @param array $cached_values
     *   Cached Values contexts are fetched from.
     *
     * @return \Drupal\Core\Plugin\Context\ContextInterface[]
     */
    protected abstract function getContexts(array $cached_values);

}

Members

Title Sort descending Modifiers Object type Summary Overriden Title Overrides
DependencySerializationTrait::$_entityStorages protected property
DependencySerializationTrait::$_serviceIds protected property
DependencySerializationTrait::__sleep public function 1
DependencySerializationTrait::__wakeup public function 2
FormBase::$configFactory protected property The config factory. 3
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. 3
FormBase::container private function Returns the service container.
FormBase::currentUser protected function Gets the current user. 2
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.
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 57
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. 16
MessengerTrait::messenger public function Gets the messenger. 16
MessengerTrait::setMessenger public function Sets the messenger.
RedirectDestinationTrait::$redirectDestination protected property The redirect destination service. 2
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.
RelationshipConfigure::$machine_name protected property Relationship Machine Name.
RelationshipConfigure::$resolver protected property Typed Data Resolver Service.
RelationshipConfigure::$tempstore protected property Tempstore Factory.
RelationshipConfigure::$tempstore_id protected property Tempstore ID.
RelationshipConfigure::ajaxSave public function Ajax Save Method.
RelationshipConfigure::buildForm public function Form constructor. Overrides FormInterface::buildForm
RelationshipConfigure::create public static function Instantiates a new instance of this class. Overrides FormBase::create
RelationshipConfigure::getContexts abstract protected function Custom logic for retrieving the contexts array from cached_values.
RelationshipConfigure::getFormId public function Returns a unique string identifying the form. Overrides FormInterface::getFormId
RelationshipConfigure::getParentRouteInfo abstract protected function Document the route name and parameters for redirect after submission.
RelationshipConfigure::setContexts abstract protected function Custom logic for setting the conditions array in cached_values.
RelationshipConfigure::submitForm public function Form submission handler. Overrides FormInterface::submitForm
RelationshipConfigure::__construct public function Configure Relationship Form constructor.
StringTranslationTrait::$stringTranslation protected property The string translation service. 3
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.