contenido\plugins\repository\custom\FrontendNavigation.php

Show: PublicProtectedPrivateinherited
Table of Contents

\FrontendNavigation

Package: Default
file FrontendNavigation.php
Author
Willi Man  
Copyright
four for business AG  
Created
25.03.2005  
Modified
22.11.2005  
Version
1.1.0  

Methods

methodpublicFrontendNavigation( $db,  $cfg,  $cfgClient,  $client,  $lang) : void

Constructor

Parameters
NameTypeDescription
$db
$cfg
$cfgClient
$client
$lang
methodpublicgetCategoryName( $cat_id) : void

Get category name

Parameters
NameTypeDescription
$cat_id
methodpublicgetCategoryOfArticle(int $iArticleId) : int

Get category of article.

If an article is assigned to more than one category take the first category.

Parameters
NameTypeDescription
$iArticleIdint
Returns
TypeDescription
intcategory id
methodpublicgetCategoryPath( $cat_id,  $level = 0,  $reverse = true) : void

Get path of a given category up to a certain level

Parameters
NameTypeDescription
$cat_id
$level
$reverse
methodpublicgetCategoryURLName( $cat_id) : void

Get category urlname

Parameters
NameTypeDescription
$cat_id
methodpublicgetFrontContentUrl(integer $iIdcat, integer $iIdart, boolean $bAbsolute = true) : string

Get URL by given category in front_content.php style

Parameters
NameTypeDescription
$iIdcatinteger
$iIdartinteger
$bAbsoluteboolean

return absolute path or not

Returns
TypeDescription
stringURL
Details
Access
public  
Author
Willi Man  
methodpublicgetLevel( $catid) : void

Get level of a category

Parameters
NameTypeDescription
$catid
methodpublicgetParent( $preid) : void

Get parent id of a category

Parameters
NameTypeDescription
$preid
methodpublicgetRoot( $cat_id) : void

Get root category of a given category

Parameters
NameTypeDescription
$cat_id
methodpublicgetSubCategories( $iParentCategory) : void

Get child categories by given parent category

Parameters
NameTypeDescription
$iParentCategory
methodpublicgetSubTree(int $idcat_start) : array

get subtree by a given id

Parameters
NameTypeDescription
$idcat_startint

Id of category

Returns
TypeDescription
arrayArray with subtree
Details
Copyright
four for business AG  
methodpublicgetSuccessor( $iCategory) : void

Get direct successor of a given category Note: does not work if direct successor (with preid 0) is not visible or not public

Parameters
NameTypeDescription
$iCategory
methodpublicgetURL(integer $iIdcat, integer $iIdart,  $sType = '', boolean $bAbsolute = true,  $iLevel = 0) : string

Get URL by given categoryid and/or articleid

Parameters
NameTypeDescription
$iIdcatinteger

url name to create for

$iIdartinteger
$sType
$bAbsoluteboolean

return absolute path or not

$iLevel
Returns
TypeDescription
stringURL
Details
Access
public  
Author
Willi Man  
methodpublicgetUrlPath(integer $iIdcat, integer $iIdart, boolean $bAbsolute = true,  $iLevel = 0,  $sURL_SUFFIX = 'index.html') : string

Get urlpath by given category and/or idart and level.

The urlpath looks like /Home/Product/Support/ where the directory-like string equals a category path.

Parameters
NameTypeDescription
$iIdcatinteger
$iIdartinteger
$bAbsoluteboolean

return absolute path or not

$iLevel
$sURL_SUFFIX
Returns
TypeDescription
stringpath information or empty string
Details
Access
public  
Author
Marco Jahn (Project www.usa.de)  
Modified
by Willi Man  
Requires
functions.pathresolver.php  
methodpublicgetUrlPathGenParam(integer $iIdcat, integer $iSelectedNumber, boolean $bAbsolute = true,  $iLevel = 0) : string

Get urlpath by given category and/or selected param and level.

Parameters
NameTypeDescription
$iIdcatinteger
$iSelectedNumberinteger
$bAbsoluteboolean

return absolute path or not

$iLevel
Returns
TypeDescription
stringpath information or empty string
Details
Access
public  
Author
Willi Man  
Requires
functions.pathresolver.php  
methodpublichasChildren( $iParentCategory) : void

Check if child categories of a given parent category exist

Parameters
NameTypeDescription
$iParentCategory
methodpublichasParent( $preid) : void

Check if a category has a parent

Parameters
NameTypeDescription
$preid
methodpublichasSuccessor( $iCategory) : void

Check if a given category has a direct successor

Parameters
NameTypeDescription
$iCategory
methodpublicisParent( $parentid,  $catid) : void

Return true if $parentid is parent of $catid

Parameters
NameTypeDescription
$parentid
$catid
methodpublicisPublic( $cat_id) : void

Check if category is public

Parameters
NameTypeDescription
$cat_id
methodpublicisVisible( $cat_id) : void

Check if category is visible

Parameters
NameTypeDescription
$cat_id
Documentation was generated by phpDocumentor 2.0.0a12.