interface MenuLinkFormInterface in Drupal 8

Defines an interface for edit forms of menu links.

All menu link plugins use the same interface for their configuration or editing form, but the implementations may differ.

Hierarchy

• interface \Drupal\Core\Plugin\PluginFormInterface
  • interface \Drupal\Core\Menu\Form\MenuLinkFormInterface

See also

\Drupal\Core\Menu\MenuLinkInterface::getFormClass()

File

core/lib/Drupal/Core/Menu/Form/MenuLinkFormInterface.php, line 17

Namespace

Drupal\Core\Menu\Form

interface MenuLinkFormInterface extends PluginFormInterface {

  /**
   * Injects the menu link plugin instance.
   *
   * @param \Drupal\Core\Menu\MenuLinkInterface $menu_link
   *   A menu link plugin instance.
   */
  public function setMenuLinkInstance(MenuLinkInterface $menu_link);

  /**
   * Extracts a plugin definition from form values.
   *
   * @param array $form
   *   An associative array containing the structure of the form.
   * @param \Drupal\Core\Form\FormStateInterface $form_state
   *   The current state of the form.
   *
   * @return array
   *   The new plugin definition values taken from the form values. The plugin
   *   ID must be returned as part of the definition.
   */
  public function extractFormValues(array &$form, FormStateInterface $form_state);

}

Members

Name	Modifiers	Type	Description	Overrides
MenuLinkFormInterface::extractFormValues	public	function	Extracts a plugin definition from form values.	1
MenuLinkFormInterface::setMenuLinkInstance	public	function	Injects the menu link plugin instance.	1
PluginFormInterface::buildConfigurationForm	public	function	Form constructor.	36
PluginFormInterface::submitConfigurationForm	public	function	Form submission handler.	32
PluginFormInterface::validateConfigurationForm	public	function	Form validation handler.	18