class crumbs_PluginSystem_PluginMethodIteratorPosition in Crumbs, the Breadcrumbs suite 7.2

Hierarchy

• class \crumbs_PluginSystem_PluginMethodIteratorPosition

File

lib/PluginSystem/PluginMethodIteratorPosition.php, line 4

class crumbs_PluginSystem_PluginMethodIteratorPosition {

  /**
   * The plugin key at the current iterator position.
   *
   * @var string|false
   */
  private $pluginKey;

  /**
   * The plugin method at the current iterator position.
   *
   * @var string
   */
  private $pluginMethod;

  /**
   * The plugin at the current iterator position.
   *
   * @var crumbs_PluginInterface
   */
  private $plugin;

  /**
   * @param string $pluginKey
   * @param string $pluginMethod
   *   Either 'findParent' or 'findTitle'.
   * @param crumbs_PluginInterface $plugin
   */
  function __construct($pluginKey, $pluginMethod, $plugin) {
    $this->pluginKey = $pluginKey;
    $this->pluginMethod = $pluginMethod;
    $this->plugin = $plugin;
  }

  /**
   * @return bool
   *   TRUE, if the current plugin is a multi plugin.
   */
  function isMultiPlugin() {
    return $this->plugin instanceof crumbs_MultiPlugin;
  }

  /**
   * @return bool
   *   TRUE, if the current plugin is a mono plugin.
   */
  function isMonoPlugin() {
    return $this->plugin instanceof crumbs_MonoPlugin;
  }

  /**
   * @param mixed[] $args
   *   E.g. array($path, $item, $breadcrumb) for findTitle().
   *
   * @return mixed
   */
  function invokeFinderMethod(array $args) {
    return call_user_func_array(array(
      $this->plugin,
      $this->pluginMethod,
    ), $args);
  }

}

Members

Name	Modifiers	Type	Description	Overrides
crumbs_PluginSystem_PluginMethodIteratorPosition::$plugin	private	property	The plugin at the current iterator position.
crumbs_PluginSystem_PluginMethodIteratorPosition::$pluginKey	private	property	The plugin key at the current iterator position.
crumbs_PluginSystem_PluginMethodIteratorPosition::$pluginMethod	private	property	The plugin method at the current iterator position.
crumbs_PluginSystem_PluginMethodIteratorPosition::invokeFinderMethod		function
crumbs_PluginSystem_PluginMethodIteratorPosition::isMonoPlugin		function
crumbs_PluginSystem_PluginMethodIteratorPosition::isMultiPlugin		function
crumbs_PluginSystem_PluginMethodIteratorPosition::__construct		function