interface AckMenuHandlerInterface in Access Control Kit 7

Interface for a menu link access handler.

Hierarchy

• interface \AccessControlKitHandlerInterface
  • interface \AckMenuHandlerInterface

File

ack_menu/ack_menu_handler.inc, line 11

Contains the ACK menu handler interface.

interface AckMenuHandlerInterface extends AccessControlKitHandlerInterface {

  /**
   * Finds all links in a menu for the given realm.
   *
   * @param int $realm
   *   A realm value.
   * @param string $menu_name
   *   The machine-readable name of the menu.
   *
   * @return array
   *   The realm's menu links, sorted by depth. Each value is an array defining
   *   a link, similar to what would be returned by menu_link_load().
   *
   * @see menu_overview_form()
   */
  public function realmLinks($realm, $menu_name);

  /**
   * Finds the default menu to which new links for a realm can be added.
   *
   * @param int $realm
   *   A realm value.
   *
   * @return string|false
   *   The menu name, or FALSE if no usable menu found.
   */
  public function realmMenu($realm);

  /**
   * Returns the list of menus managed by this handler.
   *
   * @return array
   *   An array with the machine-readable names as the keys, and human-readable
   *   titles as the values.
   */
  public function managedMenus();

}

Members

Name	Modifiers	Type	Description	Overrides
AccessControlKitHandlerInterface::description	public	function	Returns a description of the handler.	1
AccessControlKitHandlerInterface::getSettings	public	function	Returns the current handler settings.	1
AccessControlKitHandlerInterface::objectFormAlter	public	function	Alters the add/edit form for an object to reflect ACK permissions.	1
AccessControlKitHandlerInterface::objectFormSubmit	public	function	Performs handler-specific actions when an object's form is submitted.	1
AccessControlKitHandlerInterface::objectFormValidate	public	function	Performs additional validation on an access-controlled object's form.	1
AccessControlKitHandlerInterface::objectRealms	public	function	Returns the list of realms to which a given object belongs in the scheme.	1
AccessControlKitHandlerInterface::settingsForm	public	function	Returns the form elements needed to configure the handler.	1
AccessControlKitHandlerInterface::viewsDataAlter	public	function	Relates realm field values to access-controlled objects for Views.	1
AccessControlKitHandlerInterface::__construct	public	function	Constructor: generates an object access handler for an access scheme.	1
AckMenuHandlerInterface::managedMenus	public	function	Returns the list of menus managed by this handler.	1
AckMenuHandlerInterface::realmLinks	public	function	Finds all links in a menu for the given realm.	1
AckMenuHandlerInterface::realmMenu	public	function	Finds the default menu to which new links for a realm can be added.	1