contenido\classes\Contenido_Category\Contenido_Category.class.php

Show:

inherited

Classes

Table of Contents

Project: Contenido Content Management System

Description: Objects for Category handling.

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 modified 2008-02-22 Contenido_Categories now implements Countable modified 2008-08-20 Removed unnecessary/redundant security fixes (typecasting is already done in getter methods) that were made during security fixing phase changed method setDebug() in Contenido_Category_Base to allow all debug modes available modified 2009-01-05 Bugfix in Contenido_Categories::load() Subcategories will be loaded only if set so. modified 2009-01-14 Removed duplicate row in sql select at method load() $Id: Contenido_Category.class.php 1218 2010-10-04 08:49:23Z timo.trautmann $: }}
Package: Contenido Backend classes
Version: 0.8.2

\Contenido_Categories
jump to top

Package: Default

Implementation of a "Collection" of Contenido Categories.

Implements
Parent(s): \Contenido_Category_Base
Author: Rudi Bieller
Copyright: four for business AG {@internal created 2008-02-15 modified 2008-02-25 Implemented ArrayAccess; added methods reverse(), ksort() and krsort(). }}
Version: 0.9.0

Properties

array $aCfg

inherited

Inherited from: \Contenido_Category_Base::$$aCfg

Details

Type: array
Access: protected
Inherited_from: \Contenido_Category_Base::$$aCfg

array $aContenidoCategories

Details

Type: array
Access: protected

boolean $bDbg

inherited

Inherited from: \Contenido_Category_Base::$$bDbg

Details

Type: boolean
Access: protected
Inherited_from: \Contenido_Category_Base::$$bDbg

boolean $bLoadSubCategories

Details

Type: boolean
Access: protected

int $iIdLang

Details

Type: int
Access: protected

int $iSubCategoriesLoadDepth

Details

Type: int
Access: protected

\obj $oDb

inherited

Inherited from: \Contenido_Category_Base::$$oDb

Details

Type: \obj
Access: protected
Inherited_from: \Contenido_Category_Base::$$oDb

\obj $oDbg

inherited

Inherited from: \Contenido_Category_Base::$$oDbg

Details

Type: \obj
Access: protected
Inherited_from: \Contenido_Category_Base::$$oDbg

string $sDbgMode

inherited

Inherited from: \Contenido_Category_Base::$$sDbgMode

Details

Type: string
Access: protected
Inherited_from: \Contenido_Category_Base::$$sDbgMode

Methods

__construct(\DB_Contenido $oDb, array $aCfg) : void

Constructor.

Parameters

Name	Type	Description
$oDb	\DB_Contenido
$aCfg	array

Details

Access: public
Author: Rudi Bieller

add(\Contenido_Category $oContenidoCategory, int $iOffset = null) : void

Add a Contenido_Category object into internal array ("Collection")

Parameters

Name	Type	Description
$oContenidoCategory	\Contenido_Category
$iOffset	int

Details

Access: public
Author: Rudi Bieller

count() : int

Interface method for Countable.

Returns

Type	Description
int

Details

Access: public
Author: Rudi Bieller

getIdLang() : int

Get internal property for Contenido-Idlang

Returns

Type	Description
int

Details

Access: public
Author: Rudi Bieller

getIterator() : \ArrayObject

Interface method for Iterator.

Returns

Type	Description
\ArrayObject

Details

Access: public
Author: Rudi Bieller

krsort() : void

Sort list of Contenido_Category objects by assigned key in reverse order

Details

Access: public
Author: Rudi Bieller

ksort() : void

Sort list of Contenido_Category objects by assigned key

Details

Access: public
Author: Rudi Bieller

load(array $aCategoryIds, boolean $bIncludeLanguage = false, int $iIdlang = -1) : void

Loads a range of Category-IDs.

Parameters

Name	Type	Description
$aCategoryIds	array
$bIncludeLanguage	boolean
$iIdlang	int	If $bIncludeLanguage is set to true, you must set this value, too or use setIdLang() before!

Details

Access: public
Author: Rudi Bieller

offsetExists(int $mOffset) : boolean

Interface method for ArrayAccess.

Parameters

Name	Type	Description
$mOffset	int

Returns

Type	Description
boolean

Details

Access: public
Author: Rudi Bieller

offsetGet(int $mOffset) : \obj

Interface method for ArrayAccess.

Parameters

Name	Type	Description
$mOffset	int

Returns

Type	Description
\obj

Details

Access: public
Author: Rudi Bieller

offsetSet(int $mOffset, mixed $mValue) : void

Interface method for ArrayAccess.

Parameters

Name	Type	Description
$mOffset	int
$mValue	mixed

Details

Access: public
Author: Rudi Bieller

offsetUnset(int $mOffset) : void

Interface method for ArrayAccess.

Parameters

Name	Type	Description
$mOffset	int

Details

Access: public
Author: Rudi Bieller

reverse() : void

Sort list of Contenido_Category objects in reverse order

Details

Access: public
Author: Rudi Bieller

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

inherited

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

Inherited from: \Contenido_Category_Base::setDebug()

Parameters

Name	Type	Description
$bDebug	boolean
$sDebugMode	string

Details

Access: public
Author: Rudi Bieller

setIdLang(int $iIdlang) : void

Set internal property for Contenido-Idlang

Parameters

Name	Type	Description
$iIdlang	int

Details

Access: public
Author: Rudi Bieller

setloadSubCategories(boolean $bLoad = false, int $iLoadDepth = 0) : void

If you need to load SubCategories, set to true and set how deep SubCategories should be loaded

Parameters

Name	Type	Description
$bLoad	boolean
$iLoadDepth	int

Details

Access: public
Author: Rudi Bieller

\Contenido_Category
jump to top

Package: Default

Implementation of a Contenido Category.

Parent(s): \Contenido_Category_Base
Author: Rudi Bieller
Copyright: four for business AG {@internal created 2008-02-15 }}
Version: 0.9.0

Properties

\obj $_oDb

DB_Contenido

Details

Type: \obj
Access: private

array $aCfg

inherited

Inherited from: \Contenido_Category_Base::$$aCfg

Details

Type: array
Access: protected
Inherited_from: \Contenido_Category_Base::$$aCfg

boolean $bDbg

inherited

Inherited from: \Contenido_Category_Base::$$bDbg

Details

Type: boolean
Access: protected
Inherited_from: \Contenido_Category_Base::$$bDbg

boolean $bHasSubCategories

Details

Type: boolean
Access: protected

boolean $bLoadSubCategories

Details

Type: boolean
Access: protected

int $iCurrentSubCategoriesLoadDepth

Details

Type: int
Access: protected

$iIdCat

Details

Type: n/a

$iIdClient

Details

Type: n/a

int $iIdLang

Details

Type: int
Access: protected

$iIdParent

Details

Type: n/a

$iIdPost

Details

Type: n/a

$iIdPre

Details

Type: n/a

$iStatus

Details

Type: n/a

int $iSubCategoriesLoadDepth

Details

Type: int
Access: protected

\obj $oCategoryLanguage

Details

Type: \obj
Access: protected

\obj $oDb

inherited

Inherited from: \Contenido_Category_Base::$$oDb

Details

Type: \obj
Access: protected
Inherited_from: \Contenido_Category_Base::$$oDb

\obj $oDbg

inherited

Inherited from: \Contenido_Category_Base::$$oDbg

Details

Type: \obj
Access: protected
Inherited_from: \Contenido_Category_Base::$$oDbg

\obj $oSubCategories

Details

Type: \obj
Access: protected

$sAuthor

Details

Type: n/a

$sCreated

Details

Type: n/a

string $sDbgMode

inherited

Inherited from: \Contenido_Category_Base::$$sDbgMode

Details

Type: string
Access: protected
Inherited_from: \Contenido_Category_Base::$$sDbgMode

$sModified

Details

Type: n/a

Methods

__construct(\DB_Contenido $oDb, array $aCfg) : void

Constructor.

Parameters

Name	Type	Description
$oDb	\DB_Contenido
$aCfg	array

Details

Access: public
Author: Rudi Bieller

_getSubCategories(int $iIdcat, boolean $bIncludeLanguage = false, int $iIdlang = -1) : \Contenido_Categories

Loads SubCategories depending on values for $this->bLoadSubCategories and $this->iSubCategoriesLoadDepth

Parameters

Name	Type	Description
$iIdcat	int
$bIncludeLanguage	boolean	If set to true, also creates Contenido_Category_Language object
$iIdlang	int	If $bIncludeLanguage is set to true, you must set this value, too or use setIdLang() before!

Returns

Type	Description
\Contenido_Categories

Details

Access: private
Author: Rudi Bieller

_getSubCategoriesAsArray(int $iIdcat) : array

Return array with idcats of subcategories of given idcat

Parameters

Name	Type	Description
$iIdcat	int

Returns

Type	Description
array

Details

Access: private
Author: Rudi Bieller

getAuthor() : void

getCategoryLanguage() : void

getDateCreated() : void

getDateModified() : void

getIdCat() : void

getIdClient() : void

getIdLang() : void

getIdParent() : void

getIdPost() : void

getIdPre() : void

getStatus() : void

getSubCategories() : void

load(int $iIdCat, boolean $bIncludeLanguage = false, int $iIdlang = -1) : boolean

Loads properties for a given idcat.

Optionally, also properties from catlang will be loaded into object.

Parameters

Name	Type	Description
$iIdCat	int
$bIncludeLanguage	boolean	If set to true, also creates Contenido_Category_Language object
$iIdlang	int	If $bIncludeLanguage is set to true, you must set this value, too or use setIdLang() before!

Returns

Type	Description
boolean

Throws

Exception	Description
\InvalidArgumentException
\Exception	TODO

Details

Access: public
Author: Rudi Bieller

setAuthor( $sAuthor) : void

Parameters

Name	Type	Description
$sAuthor

setCategoryLanguage( $oCatLang) : void

Parameters

Name	Type	Description
$oCatLang

setDateCreated( $sDateCreated) : void

Parameters

Name	Type	Description
$sDateCreated

setDateModified( $sDateModified) : void

Parameters

Name	Type	Description
$sDateModified

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

inherited

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

Inherited from: \Contenido_Category_Base::setDebug()

Parameters

Name	Type	Description
$bDebug	boolean
$sDebugMode	string

Details

Access: public
Author: Rudi Bieller

setIdCat( $iIdcat) : void

Parameters

Name	Type	Description
$iIdcat

setIdClient( $iIdcient) : void

Parameters

Name	Type	Description
$iIdcient

setIdLang( $iIdlang) : void

Parameters

Name	Type	Description
$iIdlang

setIdParent( $iIdcatParent) : void

Parameters

Name	Type	Description
$iIdcatParent

setIdPost( $iIdcatPost) : void

Parameters

Name	Type	Description
$iIdcatPost

setIdPre( $iIdcatPre) : void

Parameters

Name	Type	Description
$iIdcatPre

setStatus( $iStatus) : void

Parameters

Name	Type	Description
$iStatus

setSubCategories(\Contenido_Categories $oCategories) : void

Set internal property with SubCategories of current Category

Parameters

Name	Type	Description
$oCategories	\Contenido_Categories

Details

Access: public
Author: Rudi Bieller

setloadSubCategories(boolean $bLoad = false, int $iLoadDepth = 0) : void

If you need to load SubCategories, set to true and set how deep SubCategories should be loaded

Parameters

Name	Type	Description
$bLoad	boolean
$iLoadDepth	int

Details

Access: public
Author: Rudi Bieller

\Contenido_Category_Base
jump to top

Package: Default

Base class for Contenido_Category, Contenido_Categories, Contenido_Category_Language.

Children: \Contenido_Category; \Contenido_Categories; \Contenido_Category_Language; \Contenido_Category_Articles
Author: Rudi Bieller
Copyright: four for business AG {@internal created 2008-02-15 }}
Version: 0.9.0

Properties

array $aCfg

Details

Type: array
Access: protected

boolean $bDbg

Details

Type: boolean
Access: protected

\obj $oDb

Details

Type: \obj
Access: protected

\obj $oDbg

Details

Type: \obj
Access: protected

string $sDbgMode

Details

Type: string
Access: protected

Methods

__construct(\DB_Contenido $oDb, array $aCfg) : void

Constructor.

Parameters

Name	Type	Description
$oDb	\DB_Contenido
$aCfg	array

Details

Access: public
Author: Rudi Bieller

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

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

Parameters

Name	Type	Description
$bDebug	boolean
$sDebugMode	string

Details

Access: public
Author: Rudi Bieller

\Contenido_Category_Language
jump to top

Package: Default

Implementation of a Contenido Category for a given Contenido Language.

Parent(s): \Contenido_Category_Base
Author: Rudi Bieller
Copyright: four for business AG {@internal created 2008-02-15 }}
Version: 0.9.0

Properties

array $aCfg

inherited

Inherited from: \Contenido_Category_Base::$$aCfg

Details

Type: array
Access: protected
Inherited_from: \Contenido_Category_Base::$$aCfg

boolean $bDbg

inherited

Inherited from: \Contenido_Category_Base::$$bDbg

Details

Type: boolean
Access: protected
Inherited_from: \Contenido_Category_Base::$$bDbg

$iIdCat

Details

Type: n/a

$iIdCatlang

Details

Type: n/a

$iIdLang

Details

Type: n/a

$iIdTplcfg

Details

Type: n/a

$iPublic

Details

Type: n/a

int $iStartIdartlang

Details

Type: int
Access: protected

$iStatus

Details

Type: n/a

$iVisible

Details

Type: n/a

\obj $oDb

inherited

Inherited from: \Contenido_Category_Base::$$oDb

Details

Type: \obj
Access: protected
Inherited_from: \Contenido_Category_Base::$$oDb

\obj $oDbg

inherited

Inherited from: \Contenido_Category_Base::$$oDbg

Details

Type: \obj
Access: protected
Inherited_from: \Contenido_Category_Base::$$oDbg

$sAlias

Details

Type: n/a

$sAuthor

Details

Type: n/a

$sDateCreated

Details

Type: n/a

$sDateModified

Details

Type: n/a

string $sDbgMode

inherited

Inherited from: \Contenido_Category_Base::$$sDbgMode

Details

Type: string
Access: protected
Inherited_from: \Contenido_Category_Base::$$sDbgMode

string $sName

Details

Type: string
Access: protected

string $sUrlname

Details

Type: string
Access: protected

Methods

__construct(\DB_Contenido $oDb, array $aCfg) : void

Constructor.

Parameters

Name	Type	Description
$oDb	\DB_Contenido
$aCfg	array

Details

Access: public
Author: Rudi Bieller

getAlias() : void

getAuthor() : void

getDateCreated() : void

getDateLastModified() : void

getIdCat() : void

getIdCatLang() : void

getIdLang() : void

getIdTemplateConfig() : void

getName() : void

getPublic() : void

getStartIdLang() : void

getStatus() : void

getUrlName() : void

getVisible() : void

load(int $iIdCatLang = null) : boolean

Load cat_lang for a given idcat.

Parameters

Name	Type	Description
$iIdCatLang	int

Returns

Type	Description
boolean

Details

Access: public
Author: Rudi Bieller

setAlias( $sAlias) : void

Parameters

Name	Type	Description
$sAlias

setAuthor( $sAuthor) : void

Parameters

Name	Type	Description
$sAuthor

setDateCreated( $sDateCreated) : void

Parameters

Name	Type	Description
$sDateCreated

setDateLastModified( $sDateLastModified) : void

Parameters

Name	Type	Description
$sDateLastModified

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

inherited

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

Inherited from: \Contenido_Category_Base::setDebug()

Parameters

Name	Type	Description
$bDebug	boolean
$sDebugMode	string

Details

Access: public
Author: Rudi Bieller

setIdCat( $iIdcat) : void

Parameters

Name	Type	Description
$iIdcat

setIdCatLang( $iIdcatlang) : void

Parameters

Name	Type	Description
$iIdcatlang

setIdLang( $iIdlang) : void

Parameters

Name	Type	Description
$iIdlang

setIdTemplateConfig( $iIdTplcfg) : void

Parameters

Name	Type	Description
$iIdTplcfg

setName( $sName) : void

Parameters

Name	Type	Description
$sName

setPublic( $iPublic) : void

Parameters

Name	Type	Description
$iPublic

setStartIdLang( $iStartIdlang) : void

Parameters

Name	Type	Description
$iStartIdlang

setStatus( $iStatus) : void

Parameters

Name	Type	Description
$iStatus

setUrlName( $sUrlName) : void

Parameters

Name	Type	Description
$sUrlName

setVisible( $iVisible) : void

Parameters

Name	Type	Description
$iVisible

contenido\classes\Contenido_Category\Contenido_Category.class.php

\Contenido_Categoriesjump to top

Properties

Methods

\Contenido_Categoryjump to top

Properties

Methods

\Contenido_Category_Basejump to top

Properties

Methods

\Contenido_Category_Languagejump to top

Properties

Methods

\Contenido_Categories
jump to top

\Contenido_Category
jump to top

\Contenido_Category_Base
jump to top

\Contenido_Category_Language
jump to top