interface SettingGroupInterface in Fasttoggle 8.2

An interface for groups of settings on an object.

Hierarchy

• interface \Drupal\fasttoggle\Plugin\SettingObject\SettingObjectInterface
  • interface \Drupal\fasttoggle\Plugin\SettingGroup\SettingGroupInterface

2 files declare their use of SettingGroupInterface

AbstractSettingGroup.php in src/Plugin/SettingGroup/AbstractSettingGroup.php

Fasttoggle Object List of Values Setting

SettingInterface.php in src/Plugin/Setting/SettingInterface.php

Provides Drupal\fasttoggle\SettingInterface.

File

src/Plugin/SettingGroup/SettingGroupInterface.php, line 14

Provides Drupal\fasttoggle\SettingGroupInterface.

Namespace

Drupal\fasttoggle\Plugin\SettingGroup

interface SettingGroupInterface extends SettingObjectInterface {

  /**
   * Get an array of sitewide setting form elements for this object type.
   *
   * @param $config
   *   The configuration storage.
   *
   * @return array
   *   Render array for the sitewide settings.
   */
  public static function getSitewideSettingFormElements($config);

  /**
   * Write access control check for the group of settings.
   *
   * @return bool
   *   Whether the user is permitted to modify settings on this group of settings.
   */
  public function mayEditGroup();

  /**
   * Return whether this setting group includes the provided field definition.
   *
   * @param $definition
   *   The field definition for which a match should be sought.
   *
   * @return string
   *   The name of the group plugin to use for this field definition.
   */
  public static function groupMatches($definition);

}

Members

Name	Modifiers	Type	Description	Overrides
SettingGroupInterface::getSitewideSettingFormElements	public static	function	Get an array of sitewide setting form elements for this object type. Overrides SettingObjectInterface::getSitewideSettingFormElements
SettingGroupInterface::groupMatches	public static	function	Return whether this setting group includes the provided field definition.	4
SettingGroupInterface::mayEditGroup	public	function	Write access control check for the group of settings.	5
SettingObjectInterface::get_id	public	function	Object ID.	1
SettingObjectInterface::get_object	public	function	Get the node / user / ...	1
SettingObjectInterface::get_title	public	function	Object title.	1
SettingObjectInterface::get_type	public	function	Object subtype machine name.	1
SettingObjectInterface::mayEditEntity	public	function	Write access control check for the object as a whole.	1
SettingObjectInterface::objectMatches	public	function	Matches an object?	3
SettingObjectInterface::save	public	function	Save function. Update the entity in the database.	1
SettingObjectInterface::setObject	public	function	Set an instance of the object.	1