interface IProject

A project within a module is a useful starting point for creating "one of each" of the type of things a project typically requires, such as a menu item, and a block view that is bound to a block view.

Remember, there is no obligation to use an IProject at all, it is merely a useful starting point that covers many cases.

@UML: IProject

@author darrenkelly

Hierarchy

Expanded class hierarchy of IProject

All classes that implement IProject

1 file declares its use of IProject
ICurrentPosts.php in lib/Drupal/ooe/Demo/Adapted/ICurrentPosts.php
ICurrentPosts

File

lib/Drupal/ooe/Project/IProject.php, line 25
IProject

Namespace

Drupal\ooe\Project
View source
interface IProject extends IModuleHelper {

  /**
   * A primary menu item for the project.
   *
   * @return \Drupal\ooe\Menu\IMenuItem
   *   A primary menu item for the project.
   */
  public function getMenuItem();

  /**
   * A set of menu items handled by this.
   *
   * By convention, the primary menu item should act as the
   * top-level menu item within the project's menu items.
   *
   * @return \Drupal\ooe\Menu\IMenuItem[]
   *   An array of menu items handled by this.
   */
  public function getMenuItems();

  /**
   * A primary block for the project.
   *
   * There is no obligation to use it (enable it, make it visible).
   *
   * @return \Drupal\ooe\Block\IBlock
   *   A primary block for the project.
   */
  public function getBlock();

  /**
   * A primary block view for the primary block of the project.
   *
   * @return \Drupal\ooe\Block\IBlockView
   *   A primary block view for the primary block of the project.
   */
  public function getBlockView();

}

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.
IProject::getBlock public function A primary block for the project.
IProject::getBlockView public function A primary block view for the primary block of the project.
IProject::getMenuItem public function A primary menu item for the project.
IProject::getMenuItems public function A set of menu items handled by this.