interface PropertyAdminInterface in ThemeKey 8

Defines an interface for ThemeKey property plugins.

Hierarchy

• interface \Drupal\Component\Plugin\PluginInspectionInterface
  • interface \Drupal\themekey\Plugin\SingletonPluginInspectionInterface
    • interface \Drupal\themekey\PropertyAdminInterface

1 file declares its use of PropertyAdminInterface

OperatorBase.php in src/OperatorBase.php

Provides Drupal\themekey\OperatorBase.

File

src/PropertyAdminInterface.php, line 20

Provides Drupal\themekey\PropertyInterface

Namespace

Drupal\themekey

interface PropertyAdminInterface extends SingletonPluginInspectionInterface {

  /**
   * Return the list of possible values of a ThemeKey property.
   *
   * @return array
   *  empty if no list possible values
   */
  public function getPossibleValues();

  /**
   * Validates if a value's format matches a ThemeKey property.
   *
   * @return bool
   */
  public function validateFormat($value);

  /**
   * Return the the current values of the ThemeKey property.
   *
   * @return array
   *   special form element or empty.
   */
  public function getFormElement();

}

Members

Name	Modifiers	Type	Description	Overrides
PluginInspectionInterface::getPluginDefinition	public	function	Gets the definition of the plugin implementation.	4
PluginInspectionInterface::getPluginId	public	function	Gets the plugin_id of the plugin instance.	2
PropertyAdminInterface::getFormElement	public	function	Return the the current values of the ThemeKey property.	1
PropertyAdminInterface::getPossibleValues	public	function	Return the list of possible values of a ThemeKey property.	1
PropertyAdminInterface::validateFormat	public	function	Validates if a value's format matches a ThemeKey property.	1