abstract class EnumPluginBase in GraphQL 8.3

Hierarchy

• class \Drupal\Component\Plugin\PluginBase implements DerivativeInspectionInterface, PluginInspectionInterface
  • class \Drupal\graphql\Plugin\GraphQL\Enums\EnumPluginBase implements TypePluginInterface uses CacheablePluginTrait, DescribablePluginTrait

10 files declare their use of EnumPluginBase

DisplayModeId.php in modules/graphql_core/src/Plugin/GraphQL/Enums/DisplayModes/DisplayModeId.php

EntityQueryBundleMode.php in modules/graphql_core/src/Plugin/GraphQL/Enums/EntityQuery/EntityQueryBundleMode.php

EntityQueryRevisionMode.php in modules/graphql_core/src/Plugin/GraphQL/Enums/EntityQuery/EntityQueryRevisionMode.php

ImageStyleId.php in modules/graphql_core/src/Plugin/GraphQL/Enums/Images/ImageStyleId.php

LanguageId.php in modules/graphql_core/src/Plugin/GraphQL/Enums/Languages/LanguageId.php

... See full list

1 string reference to 'EnumPluginBase'

graphql.services.yml in ./graphql.services.yml

graphql.services.yml

File

src/Plugin/GraphQL/Enums/EnumPluginBase.php, line 13

Namespace

Drupal\graphql\Plugin\GraphQL\Enums

abstract class EnumPluginBase extends PluginBase implements TypePluginInterface {
  use CacheablePluginTrait;
  use DescribablePluginTrait;

  /**
   * {@inheritdoc}
   */
  public static function createInstance(SchemaBuilderInterface $builder, TypePluginManager $manager, $definition, $id) {
    return new EnumType([
      'name' => $definition['name'],
      'description' => $definition['description'],
      'values' => $definition['values'],
      'contexts' => $definition['contexts'],
    ]);
  }

  /**
   * {@inheritdoc}
   */
  public function getDefinition() {
    $definition = $this
      ->getPluginDefinition();
    return [
      'name' => $definition['name'],
      'description' => $this
        ->buildDescription($definition),
      'values' => $this
        ->buildEnumValues($definition),
      'contexts' => $this
        ->buildCacheContexts($definition),
    ];
  }

  /**
   * Builds the enum values.
   *
   * @param array $definition
   *   The plugin definition array/
   *
   * @return array
   *   The enum values.
   */
  protected function buildEnumValues($definition) {
    return array_map(function ($value) use ($definition) {
      return [
        'value' => $this
          ->buildEnumValue($value, $definition),
        'description' => $this
          ->buildEnumDescription($value, $definition),
      ];
    }, $definition['values']);
  }

  /**
   * Builds the value of an enum item.
   *
   * @param mixed $value
   *   The enum's value definition.
   * @param array $definition
   *   The plugin definition array.
   *
   * @return mixed
   *   The value of the enum item.
   */
  protected function buildEnumValue($value, $definition) {
    return is_array($value) ? $value['value'] : $value;
  }

  /**
   * Builds the description of an enum item.
   *
   * @param mixed $value
   *   The enum's value definition.
   * @param array $definition
   *   The plugin definition array.
   *
   * @return string
   *   The description of the enum item.
   */
  protected function buildEnumDescription($value, $definition) {
    return (string) (is_array($value) ? $value['description'] : '');
  }

}

Members

Name	Modifiers	Type	Description	Overrides
CacheablePluginTrait::buildCacheContexts	protected	function
DescribablePluginTrait::buildDescription	protected	function
EnumPluginBase::buildEnumDescription	protected	function	Builds the description of an enum item.
EnumPluginBase::buildEnumValue	protected	function	Builds the value of an enum item.
EnumPluginBase::buildEnumValues	protected	function	Builds the enum values.	3
EnumPluginBase::createInstance	public static	function	Overrides TypePluginInterface::createInstance
EnumPluginBase::getDefinition	public	function	Returns the plugin's type or field definition for the schema. Overrides TypePluginInterface::getDefinition
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.
PluginBase::__construct	public	function	Constructs a \Drupal\Component\Plugin\PluginBase object.	92