You are here

class ActionAjaxTest in Drupal 9

Same name and namespace in other branches
  1. 8 core/modules/action/tests/action_form_ajax_test/src/Plugin/Action/ActionAjaxTest.php \Drupal\action_form_ajax_test\Plugin\Action\ActionAjaxTest

Plugin used for testing AJAX in action config entity forms.

Plugin annotation


@Action(
  id = "action_form_ajax_test",
  label = @Translation("action_form_ajax_test"),
  type = "system"
)

Hierarchy

Expanded class hierarchy of ActionAjaxTest

File

core/modules/action/tests/action_form_ajax_test/src/Plugin/Action/ActionAjaxTest.php, line 19

Namespace

Drupal\action_form_ajax_test\Plugin\Action
View source
class ActionAjaxTest extends ConfigurableActionBase {

  /**
   * {@inheritdoc}
   */
  public function defaultConfiguration() {
    return [
      'party_time' => '',
    ];
  }

  /**
   * {@inheritdoc}
   */
  public function access($object, AccountInterface $account = NULL, $return_as_object = FALSE) {
    $result = AccessResult::allowed();
    return $return_as_object ? $result : $result
      ->isAllowed();
  }

  /**
   * {@inheritdoc}
   */
  public function execute() {
  }

  /**
   * {@inheritdoc}
   */
  public function buildConfigurationForm(array $form, FormStateInterface $form_state) {
    $having_a_party = $form_state
      ->getValue('having_a_party', !empty($this->configuration['party_time']));
    $form['having_a_party'] = [
      '#type' => 'checkbox',
      '#title' => $this
        ->t('Are we having a party?'),
      '#ajax' => [
        'wrapper' => 'party-container',
        'callback' => [
          $this,
          'partyCallback',
        ],
      ],
      '#default_value' => $having_a_party,
    ];
    $form['container'] = [
      '#type' => 'container',
      '#prefix' => '<div id="party-container">',
      '#suffix' => '</div>',
    ];
    if ($having_a_party) {
      $form['container']['party_time'] = [
        '#type' => 'textfield',
        '#title' => $this
          ->t('Party time'),
        '#default_value' => $this->configuration['party_time'],
      ];
    }
    return $form;
  }

  /**
   * Callback for party checkbox.
   */
  public function partyCallback(array $form, FormStateInterface $form_state) {
    return $form['container'];
  }

  /**
   * {@inheritdoc}
   */
  public function submitConfigurationForm(array &$form, FormStateInterface $form_state) {
    $this->configuration['party_time'] = $form_state
      ->getValue('party_time');
  }

}

Members

Namesort descending Modifiers Type Description Overrides
ActionAjaxTest::access public function Checks object access. Overrides ActionInterface::access
ActionAjaxTest::buildConfigurationForm public function Form constructor. Overrides PluginFormInterface::buildConfigurationForm
ActionAjaxTest::defaultConfiguration public function Gets default configuration for this plugin. Overrides ConfigurableActionBase::defaultConfiguration
ActionAjaxTest::execute public function Executes the plugin. Overrides ExecutableInterface::execute
ActionAjaxTest::partyCallback public function Callback for party checkbox.
ActionAjaxTest::submitConfigurationForm public function Form submission handler. Overrides PluginFormInterface::submitConfigurationForm
ActionBase::executeMultiple public function Executes the plugin for an array of objects. Overrides ActionInterface::executeMultiple 3
ConfigurableActionBase::calculateDependencies public function Calculates dependencies for the configured plugin. Overrides DependentPluginInterface::calculateDependencies 1
ConfigurableActionBase::getConfiguration public function Gets this plugin's configuration. Overrides ConfigurableInterface::getConfiguration
ConfigurableActionBase::setConfiguration public function Sets the configuration for this plugin instance. Overrides ConfigurableInterface::setConfiguration
ConfigurableActionBase::validateConfigurationForm public function Form validation handler. Overrides PluginFormInterface::validateConfigurationForm 2
ConfigurableActionBase::__construct public function Constructs a \Drupal\Component\Plugin\PluginBase object. Overrides PluginBase::__construct 6
DependencySerializationTrait::$_entityStorages protected property
DependencySerializationTrait::$_serviceIds protected property
DependencySerializationTrait::__sleep public function 2
DependencySerializationTrait::__wakeup public function 2
MessengerTrait::$messenger protected property The messenger. 27
MessengerTrait::messenger public function Gets the messenger. 27
MessengerTrait::setMessenger public function Sets the messenger.
PluginBase::$configuration protected property Configuration information passed into the plugin. 1
PluginBase::$pluginDefinition protected property The plugin implementation definition. 1
PluginBase::$pluginId protected property The plugin_id.
PluginBase::DERIVATIVE_SEPARATOR constant A string which is used to separate base plugin IDs from the derivative ID.
PluginBase::getBaseId public function Gets the base_plugin_id of the plugin instance. Overrides DerivativeInspectionInterface::getBaseId
PluginBase::getDerivativeId public function Gets the derivative_id of the plugin instance. Overrides DerivativeInspectionInterface::getDerivativeId
PluginBase::getPluginDefinition public function Gets the definition of the plugin implementation. Overrides PluginInspectionInterface::getPluginDefinition 2
PluginBase::getPluginId public function Gets the plugin_id of the plugin instance. Overrides PluginInspectionInterface::getPluginId
PluginBase::isConfigurable public function Determines if the plugin is configurable.
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.