contenido\classes\Contenido_FrontendNavigation\Contenido_FrontendNavigation_Breadcrumb.class.php

Show: PublicProtectedPrivateinherited
Table of Contents
Project: Contenido Content Management System

Description: Area management class

Requirements:

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

Package: Default
Parent(s)
\Contenido_FrontendNavigation_Base

Properties

>VPropertyprivatearray $_aCategories
Details
Type
array
Access
private  
>VPropertyprivateboolean $_bAsArray
Details
Type
boolean
Access
private  
>VPropertyprivateint $_iCurrentLevel
Details
Type
int
Access
private  
Desc
Used for breadcrumb loop over tree  
>VPropertyprotectedarray $aCategories
Details
Type
array
Access
protected  
Inherited_from
\Contenido_FrontendNavigation_Base::$$aCategories  
>VPropertyprotectedarray $aCfg
Details
Type
array
Access
protected  
Inherited_from
\Contenido_FrontendNavigation_Base::$$aCfg  
>VPropertyprotectedarray $aCfgClient
Details
Type
array
Access
protected  
Inherited_from
\Contenido_FrontendNavigation_Base::$$aCfgClient  
>VPropertyprotectedboolean $bDbg
Details
Type
boolean
Access
protected  
Inherited_from
\Contenido_FrontendNavigation_Base::$$bDbg  
>VPropertyprotected$iClient
Details
Type
n/a
Inherited_from
\Contenido_FrontendNavigation_Base::$$iClient  
>VPropertyprotected$iLang
Details
Type
n/a
Inherited_from
\Contenido_FrontendNavigation_Base::$$iLang  
>VPropertyprotected\obj $oCategories
Details
Type
\obj
Access
protected  
Inherited_from
\Contenido_FrontendNavigation_Base::$$oCategories  
>VPropertyprotected\obj $oDb
Details
Type
\obj
Access
protected  
Inherited_from
\Contenido_FrontendNavigation_Base::$$oDb  
>VPropertyprotected\obj $oDbg
Details
Type
\obj
Access
protected  
Inherited_from
\Contenido_FrontendNavigation_Base::$$oDbg  
>VPropertyprotectedstring $sDbgMode
Details
Type
string
Access
protected  
Inherited_from
\Contenido_FrontendNavigation_Base::$$sDbgMode  

Methods

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

Constructor.

Parameters
NameTypeDescription
$oDb\DB_Contenido
$aCfgarray
$iClientint
$iLangint
$aCfgClient
Details
Access
public  
Author
Rudi Bieller  
methodpublicget(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
NameTypeDescription
$iBaseCategoryIdint

idcat of Sub-Category

$iRootLevelint

Level until which the path should be created

$bResetboolean

If true, will reset internal property $this->oCategories to an empty object

Returns
TypeDescription
array
Details
Access
public  
Author
Rudi Bieller  
Todo
Add possibility to return an array  
methodpublicgetAsArray(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
NameTypeDescription
$iBaseCategoryIdint

idcat of Sub-Category

$iRootLevelint

Level until which the path should be created

$bResetboolean

If true, will reset internal property $this->oCategories to an empty object

Returns
TypeDescription
array
Details
Access
public  
Author
Rudi Bieller  
Todo
Add possibility to return an array  
methodprotectedgetBreadcrumb(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
NameTypeDescription
$iBaseCategoryIdint

idcat of Sub-Category

$iRootLevelint

Level until which the path should be created

$bResetboolean

If true, will reset internal property $this->oCategories to an empty object

Returns
TypeDescription
array
Details
Access
protected  
Author
Rudi Bieller  
methodpublicgetUrl(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
NameTypeDescription
$aParamsarray

Parameters needed to build the URL

$sStylestring

Available styles are: front_content, custom, custom_path

$aConfigarray

As default this is Contenido_UrlBuilderConfig::getConfig(), can be overridden by setting this value

$bUseAbsolutePathboolean

If true, will use absolute http://www.xy.com/ as "prefix"

Throws
ExceptionDescription
\InvalidArgumentException
Details
Access
public  
See
Contenido_UrlBuilder for details on needed params  
methodpublicsetDebug(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
NameTypeDescription
$bDebugboolean
$sDebugModestring
Details
Access
public  
Author
Rudi Bieller  
Documentation was generated by phpDocumentor 2.0.0a12.