You are here

Home » API reference » Embed 8 » Aircraft.php

class Aircraft in Embed 8

An embed type plugin for testing the plugin form. Using aircraft.

Plugin annotation


@EmbedType(
  id = "embed_test_aircraft",
  label = @Translation("Aircraft"),
)

Hierarchy

Expanded class hierarchy of Aircraft

File

tests/embed_test/src/Plugin/EmbedType/Aircraft.php, line 16

Namespace

Drupal\embed_test\Plugin\EmbedType
View source 
class Aircraft extends EmbedTypeBase {

  /**
   * {@inheritdoc}
   */
  public function defaultConfiguration() {
    return [
      'aircraft_type' => 'fixed-wing',
    ];
  }

  /**
   * {@inheritdoc}
   */
  public function buildConfigurationForm(array $form, FormStateInterface $form_state) {
    $form['aircraft_type'] = [
      '#type' => 'select',
      '#title' => $this
        ->t('Aircraft type'),
      '#options' => [
        'aerostats' => $this
          ->t('Lighter than air (aerostats)'),
        'fixed-wing' => $this
          ->t('Fixed-wing'),
        'rotorcraft' => $this
          ->t('Rotorcraft'),
        'helicopters' => $this
          ->t('Helicopers'),
        'invalid' => $this
          ->t('Invalid type'),
      ],
      '#default_value' => $this
        ->getConfigurationValue('aircraft_type'),
      '#required' => TRUE,
    ];
    return $form;
  }

  /**
   * {@inheritdoc}
   */
  public function validateConfigurationForm(array &$form, FormStateInterface $form_state) {
    if ($form_state
      ->getValue('aircraft_type') === 'invalid') {
      $form_state
        ->setError($form['aircraft_type'], $this
        ->t('Cannot select invalid aircraft type.'));
    }
  }

  /**
   * {@inheritdoc}
   */
  public function submitConfigurationForm(array &$form, FormStateInterface $form_state) {
    if ($form_state
      ->getValue('aircraft_type') === 'helicopters') {
      $this
        ->messenger()
        ->addWarning($this
        ->t('Helicopters are just rotorcraft.'));
      $form_state
        ->setValue('aircraft_type', 'rotorcraft');
    }
    parent::submitConfigurationForm($form, $form_state);
  }

  /**
   * {@inheritdoc}
   */
  public function getDefaultIconUrl() {
    return '';
  }

}

Members

Namesort descending Modifiers Type Description Overrides
Aircraft::buildConfigurationForm public function Form constructor. Overrides EmbedTypeBase::buildConfigurationForm
Aircraft::defaultConfiguration public function Gets default configuration for this plugin. Overrides EmbedTypeBase::defaultConfiguration
Aircraft::getDefaultIconUrl public function Gets the default icon URL for the embed type. Overrides EmbedTypeInterface::getDefaultIconUrl
Aircraft::submitConfigurationForm public function Form submission handler. Overrides EmbedTypeBase::submitConfigurationForm
Aircraft::validateConfigurationForm public function Form validation handler. Overrides EmbedTypeBase::validateConfigurationForm
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
EmbedTypeBase::calculateDependencies public function Calculates dependencies for the configured plugin. Overrides DependentPluginInterface::calculateDependencies
EmbedTypeBase::getConfiguration public function Gets this plugin's configuration. Overrides ConfigurableInterface::getConfiguration
EmbedTypeBase::getConfigurationValue public function Gets a configuration value. Overrides EmbedTypeInterface::getConfigurationValue
EmbedTypeBase::setConfiguration public function Sets the configuration for this plugin instance. Overrides ConfigurableInterface::setConfiguration
EmbedTypeBase::setConfigurationValue public function Sets a configuration value. Overrides EmbedTypeInterface::setConfigurationValue
EmbedTypeBase::__construct public function Constructs a \Drupal\Component\Plugin\PluginBase object. Overrides PluginBase::__construct
MessengerTrait::$messenger protected property The messenger. 29
MessengerTrait::messenger public function Gets the messenger. 29
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 3
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. 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.