interface IModuleHelper

Interfaces that need to keep a record of the machine name and human readable display name of the module they serve may choose to extend this.

Also manages an IFactory.

UML: IModuleHelper

@todo Consider providing with with an IModule delegate.

@author darrenkelly

Hierarchy

Expanded class hierarchy of IModuleHelper

All classes that implement IModuleHelper

4 files declare their use of IModuleHelper
IMenuItem.php in lib/Drupal/ooe/Menu/IMenuItem.php
IMenuItem
IMenuTabs.php in lib/Drupal/ooe/Menu/IMenuTabs.php
IMenuTabs
IPageController.php in lib/Drupal/ooe/Page/IPageController.php
IPageController
IProject.php in lib/Drupal/ooe/Project/IProject.php
IProject

File

lib/Drupal/ooe/Module/IModuleHelper.php, line 23
IModuleHelper

Namespace

Drupal\ooe\Module
View source
interface IModuleHelper {

  /**
   * The Drupal machine name of the module as a string (all lower case).
   *
   * @todo Consider rename to getModuleName.
   *
   * @return string
   *   The Drupal machine name of the module as a string (all lower case).
   */
  public function getModule();

  /**
   * A human readable and displayable name of the module.
   *
   * @return string
   *   The module display name (if set)
   *   or the module machine name as upper case.
   */
  public function getModuleDisplayName();

  /**
   * Sets a human readable and displayable name of the module.
   *
   * @param string $displayName
   *   A human readable and displayable name of the module.
   *
   * @return IModuleHelper
   *   This.
   */
  public function setModuleDisplayName($displayName);

  /**
   * Either the current factory or a default factory provided on-the-fly.
   *
   * Never NULL !
   *
   * @return \Drupal\ooe\Factory\IFactory
   *   The currently set factory, otherwise some kind
   *   of default concrete factory should be supplied.
   */
  public function getFactory();
}

Members

Contains filters are case sensitive
Namesort descending Modifiers Type Description
IModuleHelper::getFactory public function Either the current factory or a default factory provided on-the-fly.
IModuleHelper::getModule public function The Drupal machine name of the module as a string (all lower case).
IModuleHelper::getModuleDisplayName public function A human readable and displayable name of the module.
IModuleHelper::setModuleDisplayName public function Sets a human readable and displayable name of the module.