contenido\classes\Contenido_FrontendNavigation\Contenido_FrontendNavigation_Breadcrumb.class.php

Show: inherited

• Classes
  • \Contenido_FrontendNavigation_Breadcrumb

Table of Contents

Author

Rudi Bieller  

Con_php_req

5.0  

Copyright

four for business AG  

License

http://www.contenido.org/license/LIZENZ.txt  

Link

http://www.4fb.de  

Link

{@internal created 2008-02-15 @todo Add possibility to load subcategories $Id: Contenido_FrontendNavigation_Breadcrumb.class.php 742 2008-08-27 11:06:12Z timo.trautmann $: }}  

Package

Contenido Backend classes  

Version

0.2.0  

\Contenido_FrontendNavigation_Breadcrumb

jump to top

Package: Default

Parent(s)

\Contenido_FrontendNavigation_Base

Properties

array $_aCategories

Details

Type

array

Access

private  

boolean $_bAsArray

Details

Type

boolean

Access

private  

int $_iCurrentLevel

Details

Type

int

Access

private  

Desc

Used for breadcrumb loop over tree  

array $aCategories

inherited

Inherited from: \Contenido_FrontendNavigation_Base::$$aCategories

Details

Type

array

Access

protected  

Inherited_from

\Contenido_FrontendNavigation_Base::$$aCategories  

array $aCfg

inherited

Inherited from: \Contenido_FrontendNavigation_Base::$$aCfg

Details

Type

array

Access

protected  

Inherited_from

\Contenido_FrontendNavigation_Base::$$aCfg  

array $aCfgClient

inherited

Inherited from: \Contenido_FrontendNavigation_Base::$$aCfgClient

Details

Type

array

Access

protected  

Inherited_from

\Contenido_FrontendNavigation_Base::$$aCfgClient  

boolean $bDbg

inherited

Inherited from: \Contenido_FrontendNavigation_Base::$$bDbg

Details

Type

boolean

Access

protected  

Inherited_from

\Contenido_FrontendNavigation_Base::$$bDbg  

$iClient

inheritedInherited from: \Contenido_FrontendNavigation_Base::$$iClient

Details

Type

n/a

Inherited_from

\Contenido_FrontendNavigation_Base::$$iClient  

$iLang

inheritedInherited from: \Contenido_FrontendNavigation_Base::$$iLang

Details

Type

n/a

Inherited_from

\Contenido_FrontendNavigation_Base::$$iLang  

\obj $oCategories

inherited

Inherited from: \Contenido_FrontendNavigation_Base::$$oCategories

Details

Type

\obj

Access

protected  

Inherited_from

\Contenido_FrontendNavigation_Base::$$oCategories  

\obj $oDb

inherited

Inherited from: \Contenido_FrontendNavigation_Base::$$oDb

Details

Type

\obj

Access

protected  

Inherited_from

\Contenido_FrontendNavigation_Base::$$oDb  

\obj $oDbg

inherited

Inherited from: \Contenido_FrontendNavigation_Base::$$oDbg

Details

Type

\obj

Access

protected  

Inherited_from

\Contenido_FrontendNavigation_Base::$$oDbg  

string $sDbgMode

inherited

Inherited from: \Contenido_FrontendNavigation_Base::$$sDbgMode

Details

Type

string

Access

protected  

Inherited_from

\Contenido_FrontendNavigation_Base::$$sDbgMode  

Methods

__construct(\DB_Contenido $oDb, array $aCfg, int $iClient, int $iLang,  $aCfgClient) : void

Constructor.

Parameters

Name	Type	Description
$oDb	\DB_Contenido
$aCfg	array
$iClient	int
$iLang	int
$aCfgClient

Details

Access

public  

Author

Rudi Bieller  

get(int $iBaseCategoryId, int $iRootLevel = 0, boolean $bReset = false) : array

Assuming we are in a Sub-Category and need to get the path to it starting at its root.

Here, the path starts at root node.

Parameters

Name	Type	Description
$iBaseCategoryId	int	idcat of Sub-Category
$iRootLevel	int	Level until which the path should be created
$bReset	boolean	If true, will reset internal property $this->oCategories to an empty object

Returns

Type	Description
array

Details

Access

public  

Author

Rudi Bieller  

Todo

Add possibility to return an array  

getAsArray(int $iBaseCategoryId, int $iRootLevel = 0, boolean $bReset = false) : array

Assuming we are in a Sub-Category and need to get the path to it starting at its root.

Here, the path starts at root node.

Parameters

Name	Type	Description
$iBaseCategoryId	int	idcat of Sub-Category
$iRootLevel	int	Level until which the path should be created
$bReset	boolean	If true, will reset internal property $this->oCategories to an empty object

Returns

Type	Description
array

Details

Access

public  

Author

Rudi Bieller  

Todo

Add possibility to return an array  

getBreadcrumb(int $iBaseCategoryId, int $iRootLevel = 0, boolean $bReset = false) : array

Assuming we are in a Sub-Category and need to get the path to it starting at its root.

This method goes recursively until the desired top level is reached and adds a Contenido_Category with each loop.

Parameters

Name	Type	Description
$iBaseCategoryId	int	idcat of Sub-Category
$iRootLevel	int	Level until which the path should be created
$bReset	boolean	If true, will reset internal property $this->oCategories to an empty object

Returns

Type	Description
array

Details

Access

protected  

Author

Rudi Bieller  

getUrl(array $aParams, string $sStyle = 'custom_path', array $aConfig = array(), boolean $bUseAbsolutePath = false) : void

inherited

Get a URL to a Navigation point.

Inherited from: \Contenido_FrontendNavigation_Base::getUrl()

Depending on style of URL needed, values of $aParams differ.

Parameters

Name	Type	Description
$aParams	array	Parameters needed to build the URL
$sStyle	string	Available styles are: front_content, custom, custom_path
$aConfig	array	As default this is Contenido_UrlBuilderConfig::getConfig(), can be overridden by setting this value
$bUseAbsolutePath	boolean	If true, will use absolute http://www.xy.com/ as "prefix"

Throws

Exception	Description
\InvalidArgumentException

Details

Access

public  

See

Contenido_UrlBuilder for details on needed params  

setDebug(boolean $bDebug = true, string $sDebugMode = 'visible') : void

inherited

Set internal property for debugging on/off and choose appropriate debug object

Inherited from: \Contenido_FrontendNavigation_Base::setDebug()

Parameters

Name	Type	Description
$bDebug	boolean
$sDebugMode	string

Details

Access

public  

Author

Rudi Bieller