class crumbs_MonoPlugin_TitleCallback in Crumbs, the Breadcrumbs suite 7.2

Hierarchy

• class \crumbs_MonoPlugin_TitleCallback implements crumbs_MonoPlugin_FindTitleInterface

File

lib/MonoPlugin/TitleCallback.php, line 3

class crumbs_MonoPlugin_TitleCallback implements crumbs_MonoPlugin_FindTitleInterface {

  /**
   * @var callback
   */
  protected $callback;

  /**
   * @var string
   */
  protected $module;

  /**
   * @var string
   */
  protected $key;

  /**
   * @param callback $callback
   * @param string $module
   * @param string $key
   */
  function __construct($callback, $module, $key) {
    $this->callback = $callback;
    $this->module = $module;
    $this->key = $key;
  }

  /**
   * @return string[]
   *   Names of properties that should be remembered on serialize().
   *   It should be noted that "callback" is not one of them, because this could
   *   be an anonymous function.
   */
  function __sleep() {
    return array(
      'module',
      'key',
    );
  }

  /**
   * {@inheritdoc}
   */
  function describe($api) {
    $api
      ->titleWithLabel(t('Callback result.'), t('Title'));
  }

  /**
   * {@inheritdoc}
   */
  function findTitle($path, $item) {
    if (!isset($this->callback)) {

      // Restore the callback after serialization.
      $this->callback = crumbs()->callbackRestoration
        ->restoreCallback($this->module, $this->key, 'routeTitle');
    }
    if (!empty($this->callback)) {
      return call_user_func($this->callback, $path, $item);
    }
    return NULL;
  }

}

Members

Name	Modifiers	Type	Description	Overrides
crumbs_MonoPlugin_TitleCallback::$callback	protected	property
crumbs_MonoPlugin_TitleCallback::$key	protected	property
crumbs_MonoPlugin_TitleCallback::$module	protected	property
crumbs_MonoPlugin_TitleCallback::describe		function	Overrides crumbs_MonoPlugin::describe
crumbs_MonoPlugin_TitleCallback::findTitle		function	Find candidates for the parent path. Overrides crumbs_MonoPlugin_FindTitleInterface::findTitle
crumbs_MonoPlugin_TitleCallback::__construct		function
crumbs_MonoPlugin_TitleCallback::__sleep		function