interface PropertyInterface in ThemeKey 8

Defines an interface for ThemeKey property plugins.

Hierarchy

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

File

src/PropertyInterface.php, line 20

Provides Drupal\themekey\PropertyInterface

Namespace

Drupal\themekey

interface PropertyInterface extends SingletonPluginInspectionInterface {

  /**
   * Return the name of the ThemeKey property.
   *
   * @return string
   */
  public function getName();

  /**
   * Return the Description of the ThemeKey property.
   *
   * @return string
   */
  public function getDescription();

  /**
   * Return the the current values of the ThemeKey property.
   *
   * @return array
   *   array of system:query_param values
   */
  public function getValues();

}

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
PropertyInterface::getDescription	public	function	Return the Description of the ThemeKey property.	1
PropertyInterface::getName	public	function	Return the name of the ThemeKey property.	1
PropertyInterface::getValues	public	function	Return the the current values of the ThemeKey property.	3