Overview

Packages

  • Core
    • Authentication
    • Backend
    • Cache
    • CEC
    • Chain
    • ContentType
    • Database
    • Datatype
    • Debug
    • Exception
    • Frontend
      • Search
      • URI
      • Util
    • GenericDB
      • Model
    • GUI
      • HTML
    • I18N
    • LayoutHandler
    • Log
    • Security
    • Session
    • Util
    • Validation
    • Versioning
    • XML
  • Module
    • ContentSitemapHtml
    • ContentSitemapXml
    • ContentUserForum
    • NavigationTop
  • mpAutoloaderClassMap
  • None
  • Plugin
    • ContentAllocation
    • CronjobOverview
    • FormAssistant
    • FrontendLogic
    • FrontendUsers
    • Linkchecker
    • ModRewrite
    • Newsletter
    • Repository
      • FrontendNavigation
      • KeywordDensity
    • SearchSolr
    • SmartyWrapper
    • UrlShortener
    • UserForum
    • Workflow
  • PluginManager
  • Setup
    • Form
    • GUI
    • Helper
      • Environment
      • Filesystem
      • MySQL
      • PHP
    • UpgradeJob

Classes

  • FrontendNavigation
  • Overview
  • Package
  • Class
  • Tree
  • Deprecated
  • Todo

Class FrontendNavigation

file FrontendNavigation.php

Package: Plugin\Repository\FrontendNavigation
Copyright: four for business AG <www.4fb.de>
License: http://www.contenido.org/license/LIZENZ.txt
Author: Willi Man
Located at plugins/repository/custom/FrontendNavigation.php
Methods summary
public
# FrontendNavigation( mixed $db, mixed $cfg, mixed $cfgClient, mixed $client, mixed $lang )

Constructor

Constructor

public
# getSubCategories( mixed $iParentCategory )

Get child categories by given parent category

Get child categories by given parent category

public
# hasChildren( mixed $iParentCategory )

Check if child categories of a given parent category exist

Check if child categories of a given parent category exist

public
# getSuccessor( mixed $iCategory )

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

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

public
# hasSuccessor( mixed $iCategory )

Check if a given category has a direct successor

Check if a given category has a direct successor

public
# getCategoryName( mixed $cat_id )

Get category name

Get category name

public
# getCategoryURLName( mixed $cat_id )

Get category urlname

Get category urlname

public
# isVisible( mixed $cat_id )

Check if category is visible

Check if category is visible

public
# isPublic( mixed $cat_id )

Check if category is public

Check if category is public

public
# isParent( mixed $parentid, mixed $catid )

Return true if $parentid is parent of $catid

Return true if $parentid is parent of $catid

public
# getParent( mixed $preid )

Get parent id of a category

Get parent id of a category

public
# hasParent( mixed $preid )

Check if a category has a parent

Check if a category has a parent

public
# getLevel( mixed $catid )

Get level of a category

Get level of a category

public string
# getFrontContentUrl( integer $iIdcat, integer $iIdart, boolean $bAbsolute = true )

Get URL by given category in front_content.php style

Get URL by given category in front_content.php style

Parameters

$iIdcat
integer
$iIdcat
$iIdart
integer
$iIdart
$bAbsolute
boolean
$bAbsolute return absolute path or not

Returns

string
URL

Author

Willi Man
public string
# getUrlPath( integer $iIdcat, integer $iIdart, boolean $bAbsolute = true, mixed $iLevel = 0, mixed $sURL_SUFFIX = 'index.html' )

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.

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

$iIdcat
integer
$iIdcat
$iIdart
integer
$iIdart
$bAbsolute
boolean
$bAbsolute return absolute path or not
$iLevel
$sURL_SUFFIX

Returns

string
path information or empty string

Author

Marco Jahn (Project www.usa.de)

Modified

by Willi Man

Requires

functions.pathresolver.php
public string
# getUrlPathGenParam( integer $iIdcat, integer $iSelectedNumber, boolean $bAbsolute = true, mixed $iLevel = 0 )

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

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

Parameters

$iIdcat
integer
$iIdcat
$iSelectedNumber
integer
$iSelectedNumber
$bAbsolute
boolean
$bAbsolute return absolute path or not
$iLevel

Returns

string
path information or empty string

Author

Willi Man

Requires

functions.pathresolver.php
public string
# getURL( integer $iIdcat, integer $iIdart, boolean $sType = '', mixed $bAbsolute = true, mixed $iLevel = 0 )

Get URL by given categoryid and/or articleid

Get URL by given categoryid and/or articleid

Parameters

$iIdcat
integer
$iIdcat url name to create for
$iIdart
integer
$iIdart
$sType
boolean
$bAbsolute return absolute path or not
$bAbsolute
$iLevel

Returns

string
URL

Author

Willi Man
public integer
# getCategoryOfArticle( integer $iArticleId )

Get category of article.

Get category of article.

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

Parameters

$iArticleId
integer
$iArticleId

Returns

integer
category id
public
# getCategoryPath( mixed $cat_id, mixed $level = 0, mixed $reverse = true )

Get path of a given category up to a certain level

Get path of a given category up to a certain level

public
# getRoot( mixed $cat_id )

Get root category of a given category

Get root category of a given category

public array
# getSubTree( integer $idcat_start )

get subtree by a given id

get subtree by a given id

Parameters

$idcat_start
integer
$idcat_start Id of category

Returns

array
Array with subtree

Copyright

four for business AG <www.4fb.de>
CMS CONTENIDO 4.9.1 API documentation generated by ApiGen 2.8.0