class crumbs_PluginSystem_PluginBag in Crumbs, the Breadcrumbs suite 7.2

Hierarchy

• class \crumbs_PluginSystem_PluginBag

File

lib/PluginSystem/PluginBag.php, line 4

class crumbs_PluginSystem_PluginBag {

  /**
   * @var crumbs_PluginInterface[]
   */
  protected $plugins;

  /**
   * @var true[][]
   *   Format: $['findParent'][$plugin_key] = true
   */
  protected $routelessPluginMethods = array();

  /**
   * @var true[][][]
   *   Format: $['findParent'][$route][$plugin_key] = true
   */
  protected $routePluginMethods = array();

  /**
   * @param crumbs_PluginInterface[] $plugins
   * @param true[][] $routelessPluginMethods
   * @param true[][][] $routePluginMethods
   */
  function __construct($plugins, $routelessPluginMethods, $routePluginMethods) {
    $this->plugins = $plugins;
    $this->routelessPluginMethods = $routelessPluginMethods;
    $this->routePluginMethods = $routePluginMethods;
  }

  /**
   * @return crumbs_MonoPlugin
   */
  function getDecorateBreadcrumbPlugins() {
    $plugin_methods = isset($this->routelessPluginMethods['decorateBreadcrumb']) ? $this->routelessPluginMethods['decorateBreadcrumb'] : array();
    $plugins = array();
    foreach ($plugin_methods as $pluginKey => $method) {
      if (!isset($this->plugins[$pluginKey])) {
        continue;
      }
      $plugins[$pluginKey] = $this->plugins[$pluginKey];
    }
    return $plugins;
  }

  /**
   * @param $base_method_name
   * @param $route
   *
   * @return crumbs_PluginSystem_PluginMethodIterator
   */
  function getRoutePluginMethodIterator($base_method_name, $route) {
    $methods = $this
      ->getRoutePluginMethods($base_method_name, $route);
    return new crumbs_PluginSystem_PluginMethodIterator($methods, $this->plugins, $base_method_name);
  }

  /**
   * @param string $base_method_name
   *   Either 'findParent' or 'findTitle' or 'decorateBreadcrumb'.
   * @param string $route
   *   A route, e.g. 'node/%'.
   *
   * @return true[]
   *   Format: $[$plugin_key] = true.
   */
  private function getRoutePluginMethods($base_method_name, $route) {
    if (isset($this->routePluginMethods[$base_method_name][$route])) {
      return $this->routePluginMethods[$base_method_name][$route];
    }
    if (isset($this->routelessPluginMethods[$base_method_name])) {
      return $this->routelessPluginMethods[$base_method_name];
    }
    return array();
  }

}

Members

Name	Modifiers	Type	Description	Overrides
crumbs_PluginSystem_PluginBag::$plugins	protected	property
crumbs_PluginSystem_PluginBag::$routelessPluginMethods	protected	property	Format: $['findParent'][$plugin_key] = true
crumbs_PluginSystem_PluginBag::$routePluginMethods	protected	property	Format: $['findParent'][$route][$plugin_key] = true
crumbs_PluginSystem_PluginBag::getDecorateBreadcrumbPlugins		function
crumbs_PluginSystem_PluginBag::getRoutePluginMethodIterator		function
crumbs_PluginSystem_PluginBag::getRoutePluginMethods	private	function
crumbs_PluginSystem_PluginBag::__construct		function