Class

BreadCrumb

Package: PHPBoost\Environment Copyright: © 2005-2019 PHPBoost License: GNU/GPL-3.0 Author: Benoit SAUTEL ben.popeye@phpboost.com Version: PHPBoost 5.2 - last update: 2018 11 28 Since: PHPBoost 1.6 - 2007 02 16 Contributor: Julien BRISWALTER j1.seth@phpboost.com Contributor: Arnaud GENET elenwii@phpboost.com Located at: phpboost/environment/BreadCrumb.class.php

This class is used to represent the bread crumb displayed on each page of the website. It enables the user to locate himself in the whole site. A bread crumb can look like this: Home >> My module >> First level category >> Second level category >> Third level category >> .. >> My page >> Edition

Methods summary
public
# add( string $text, string $target = '' )

Adds a link in the bread crumb. This link will be put at the end of the list.

public
# reverse( )

Reverses the whole list of the links. It's very useful when it's easier for you to make the list in the reverse way, at the end, you only need to reverse the list and it will be ok.

public
# remove_last( )

Removes the last link of the list

public
# display( Template $tpl )

Displays the bread crumb.

public
# clean( )

Removes all the existing links.

public
# set_graphical_environment( SiteDisplayGraphicalEnvironment $env )

Sets the reference to the parent graphical environment