class Animal in Embed 8

Animal test embed type.

Plugin annotation

@EmbedType(
  id = "embed_test_animal",
  label = @Translation("Animals"),
)

Hierarchy

• class \Drupal\Component\Plugin\PluginBase implements DerivativeInspectionInterface, PluginInspectionInterface
  • class \Drupal\Core\Plugin\PluginBase uses DependencySerializationTrait, MessengerTrait, StringTranslationTrait
    • class \Drupal\embed\EmbedType\EmbedTypeBase implements EmbedTypeInterface
      • class \Drupal\embed_test\Plugin\EmbedType\Animal

File

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

Namespace

Drupal\embed_test\Plugin\EmbedType

class Animal extends EmbedTypeBase {

  /**
   * {@inheritdoc}
   */
  public function buildConfigurationForm(array $form, FormStateInterface $form_state) {
    $form_object = $form_state
      ->getFormObject();
    $form['animal_type'] = [
      '#type' => 'select',
      '#title' => $this
        ->t('Animal type'),
      '#options' => [
        'vertebrates' => $this
          ->t('Vertebrates (with backbone)'),
        'invertebrates' => $this
          ->t('Invertebrates (without backbone)'),
      ],
      '#default_value' => $this
        ->getConfigurationValue('animal_type'),
      '#required' => TRUE,
      '#ajax' => [
        'callback' => [
          $form_object,
          'updateTypeSettings',
        ],
        'effect' => 'fade',
      ],
    ];
    if ($this
      ->getConfigurationValue('animal_type') === 'vertebrates') {
      $form['allowed_vertebrates'] = [
        '#type' => 'checkboxes',
        '#title' => $this
          ->t('Limit allowed vertebrates'),
        '#options' => [
          'amphibians' => $this
            ->t('Amphibians'),
          'birds' => $this
            ->t('Birds'),
          'fish' => $this
            ->t('Fish'),
          'mammals' => $this
            ->t('Mammals'),
          'reptiles' => $this
            ->t('Reptiles'),
        ],
        '#default_value' => $this
          ->getConfigurationValue('allowed_vertebrates', []),
      ];
    }
    return $form;
  }

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

}

Members

Name	Modifiers	Type	Description	Overrides
Animal::buildConfigurationForm	public	function	Form constructor. Overrides EmbedTypeBase::buildConfigurationForm
Animal::getDefaultIconUrl	public	function	Gets the default icon URL for the embed type. Overrides EmbedTypeInterface::getDefaultIconUrl
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::defaultConfiguration	public	function	Gets default configuration for this plugin. Overrides ConfigurableInterface::defaultConfiguration	1
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::submitConfigurationForm	public	function	Form submission handler. Overrides PluginFormInterface::submitConfigurationForm	1
EmbedTypeBase::validateConfigurationForm	public	function	Form validation handler. Overrides PluginFormInterface::validateConfigurationForm	1
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.