interface Fz152PluginInterface in FZ152 8

Provides an interface for fz152 settings plugins.

@todo Use \Drupal\Core\Plugin\PluginWithFormsInterface

Hierarchy

• interface \Drupal\Component\Plugin\PluginInspectionInterface
  • interface \Drupal\fz152\Fz152PluginInterface

File

src/Fz152PluginInterface.php, line 12

Namespace

Drupal\fz152

interface Fz152PluginInterface extends PluginInspectionInterface {

  /**
   * {@inheritdoc}
   */
  public function getId();

  /**
   * If you want to add settings as tab to main settings you can define it here.
   *
   * Otherwise define the page by yourself.
   *
   * @return array
   *   Possible values:
   *   - "path": The tab path additional: /admin/config/fz152/[PATH].
   *   - "title": String with title for tab and page with settings.
   *   - "form": As in routing.yml file must contains form Class.
   *   - "weight": Weight for tab on page.
   */
  public function getSettingsPage();

  /**
   * Returns a list of form to and confirmation for sending private data.
   *
   * @return array
   *   Array with form names to add checkbox:
   *   - "form_id": The form id. Can contains wildcards "*".
   *   - "weight": (optional) The weight for checkbox in the form.
   */
  public function getForms();

}

Members

Name	Modifiers	Type	Description	Overrides
Fz152PluginInterface::getForms	public	function	Returns a list of form to and confirmation for sending private data.	1
Fz152PluginInterface::getId	public	function		1
Fz152PluginInterface::getSettingsPage	public	function	If you want to add settings as tab to main settings you can define it here.	1
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