WidgetBreadcrumb Class Reference
[View]

Print a breadcrumb. More...

Inheritance diagram for WidgetBreadcrumb:

List of all members.

Public Member Functions
	__construct ($source)
	render ($policy=self::NONE)
	Renders what should be rendered.
Static Public Member Functions
static	output ($source, $policy=self::NONE)
Public Attributes
	$action = 'view'
	$action_params = null
	$glue = ' > '
	$prefix = '> '
	$source
	$url_home
const	BLOCK = 512
const	LINK_LAST = 128
	Link Last Element.
const	UNLINK_LAST = 1024
const	USE_PREFIX = 256
Protected Member Functions
	instance2string ($instance, $action)
	Turn a data obejct into a (link) string.
	to_array ($item, $key=false)
	Transform given source into an array.

---

Detailed Description

Print a breadcrumb.

The breadcrumb is passed an array that may contain different types of content, namely:

• a string, which is printed as is (that is: it is not escaped, so you can pass HTML)
• a data object which is translated to the path to the VIEW action. The object must implement the ISelfDescribing interface. If it implements the IHierarchic interface, too, its parent will be added to the crumb, also (and its parent's parent, and so on)
• the name of an action as key and a data object as value. This is treated like the object above except the VIEW action is replaced by the given one

As usual, you may substitute the array by a single element.

Author:

Gerd Riesselmann

Definition at line 20 of file breadcrumb.widget.php.

---

Constructor & Destructor Documentation

WidgetBreadcrumb::__construct

(

$

source

)

Definition at line 42 of file breadcrumb.widget.php.

                                             {
                $this->url_home = Config::get_value(Config::URL_BASEDIR);
                $this->source = $source;
        }

---

Member Function Documentation

WidgetBreadcrumb::instance2string	(	$	instance,
		$	action
	)			[protected]

Turn a data obejct into a (link) string.

Definition at line 96 of file breadcrumb.widget.php.

                                                               {
                if (empty($action) || is_numeric($action)) {
                        $action = $this->action;
                }
                return WidgetActionLink::output($instance, $action, $instance);
        }

static WidgetBreadcrumb::output	(	$	source,
		$	policy = self::NONE
	)			[static]

Definition at line 37 of file breadcrumb.widget.php.

                                                                   {
                $w = new WidgetBreadcrumb($source);
                return $w->render($policy);
        }

WidgetBreadcrumb::render

(

$

policy = self::NONE

)

Renders what should be rendered.

Parameters:

int

$policy Defines how to render, meaning depends on implementation

Returns:

string The rendered content

Implements IRenderer.

Definition at line 47 of file breadcrumb.widget.php.

                                                   {
                $src = $this->to_array($this->source);
                $crumb = array();
                $unlink_this = !Common::flag_is_set($policy, self::LINK_LAST);
                foreach($src as $item) {
                        $link = ($unlink_this) ? preg_replace('|<a.*?>(.*?)</a>|', '$1', $item) : $item;
                        array_unshift($crumb, $link);
                        $unlink_this = false;
                }
                $home = html::a(Config::get_value(Config::TITLE), $this->url_home, tr('Go to home page', 'app'));
                array_unshift($crumb, $home);
        
                $view = ViewFactory::create_view(IViewFactory::MESSAGE, 'core::widgets/breadcrumb');
                $view->assign('breadcrumb_prefix', Common::flag_is_set($policy, self::USE_PREFIX) ? $this->prefix : '');
                $view->assign('breadcrumb_glue', $this->glue);
                $view->assign('breadcrumb_items', $crumb);
                
                return $view->render();
        }

WidgetBreadcrumb::to_array	(	$	item,
		$	key = false
	)			[protected]

Transform given source into an array.

The array has the last item in breadcrumb as first element

Parameters:

mixed

$source

Returns:

array

Definition at line 73 of file breadcrumb.widget.php.

                                                         {
                $arr_ret = array();
                if ($item instanceof IHierarchic) {
                        $arr_ret[] = $this->instance2string($item, $key);
                        $arr_ret = array_merge($arr_ret, $this->to_array($item->get_parent(), $key));
                }
                else if ($item instanceof ISelfDescribing) {
                        $arr_ret[] = $this->instance2string($item, $key);
                }
                else if (is_array($item)) {
                        foreach($item as $subkey => $subitem) {
                                $arr_ret = array_merge($this->to_array($subitem, $subkey), $arr_ret);                   
                        }
                }
                else if (!empty($item)) {
                        $arr_ret[] = @strval($item);
                }
                return $arr_ret;        
        }

---

Member Data Documentation

WidgetBreadcrumb::$action = 'view'

Definition at line 31 of file breadcrumb.widget.php.

WidgetBreadcrumb::$action_params = null

Definition at line 32 of file breadcrumb.widget.php.

WidgetBreadcrumb::$glue = ' > '

Definition at line 34 of file breadcrumb.widget.php.

WidgetBreadcrumb::$prefix = '> '

Definition at line 33 of file breadcrumb.widget.php.

WidgetBreadcrumb::$source

Definition at line 30 of file breadcrumb.widget.php.

WidgetBreadcrumb::$url_home

Definition at line 35 of file breadcrumb.widget.php.

const WidgetBreadcrumb::BLOCK = 512

Definition at line 26 of file breadcrumb.widget.php.

const WidgetBreadcrumb::LINK_LAST = 128

Link Last Element.

If not set (default), the last element will be unlinked

Definition at line 24 of file breadcrumb.widget.php.

const WidgetBreadcrumb::UNLINK_LAST = 1024

Deprecated:

Definition at line 28 of file breadcrumb.widget.php.

const WidgetBreadcrumb::USE_PREFIX = 256

Definition at line 25 of file breadcrumb.widget.php.

---

The documentation for this class was generated from the following file:

• gyro/core/view/widgets/breadcrumb.widget.php