FootermapInterface.php in footermap: a footer site map 8

Namespace

Drupal\footermap\Plugin\Block

File

src/Plugin/Block/FootermapInterface.php

<?php

namespace Drupal\footermap\Plugin\Block;


/**
 * Interface for Footermap clasess.
 */
interface FootermapInterface {

  /**
   * Build content for footer site map.
   *
   * The default implementation should call buildMenu() recursively.
   *
   * This deprecates footermap_render().
   *
   * @return array
   *   An associative array ready for render system.
   *
   * @todo The return value may change by the time Drupal 8 is released.
   *
   * @see Drupal\footermap\Plugin\Block\Footermap::buildMenu()
   */
  public function buildMap();

  /**
   * Recursively build footer site map.
   *
   * This method should modify the object variable $mapref.
   *
   * This deprecates footermap_get_menu().
   *
   * @param array &$tree
   *   A reference to the menu site tree for a particular menu.
   * @param array &$mapref
   *   A reference to the current menu item's children or the root of the map.
   */
  public function buildMenu(array &$tree, array &$mapref);

}

Interfaces

Name	Description
FootermapInterface	Interface for Footermap clasess.