Class cApiCategoryCollection

Category collection

cGenericDb

cApiCategoryCollection

Package: Core\GenericDB\Model
Copyright: four for business AG <www.4fb.de>
License: http://www.contenido.org/license/LIZENZ.txt
Author: Timo Hummel
Located at classes/contenido/class.category.php

Methods summary
`public`	# `__construct( string $select = false )` Create a new collection of items. Create a new collection of items. Parameters `$select` `string` $select where clause to use for selection (see ItemCollection::select()) Throws `cInvalidArgumentException` If table name or primary key is not set Overrides `ItemCollection::__construct()`
`public cApiCategory`	# `create( integer $idclient, integer $parentid = 0, integer $preid = 0, integer $postid = 0, integer $status = 0, string $author = '', string $created = '', string $lastmodified = '' )` Creates a category entry. Creates a category entry. Parameters `$idclient` `integer` $idclient `$parentid` `integer` $parentid `$preid` `integer` $preid `$postid` `integer` $postid `$status` `integer` $status `$author` `string` $author `$created` `string` $created `$lastmodified` `string` $lastmodified Returns `cApiCategory`
`public cApiCategory`	# `fetchLastCategoryTree( integer $idclient )` Returns the last category tree entry from the category table for a specific client. Last entry has no parentid and no postid. Returns the last category tree entry from the category table for a specific client. Last entry has no parentid and no postid. Parameters `$idclient` `integer` $idclient Returns `cApiCategory` NULL
`public array`	# `getCategoryIdsByClient( integer $idclient )` Returns list of categories (category ids) by passed client. Returns list of categories (category ids) by passed client. Parameters `$idclient` `integer` $idclient Returns `array`
`public integer`	# `getNextPostCategoryId( integer $idcat )` Returns the id of category which is located after passed category id. Returns the id of category which is located after passed category id. Example: ... parent_category this_category post_category () ... () Returned category id Parameters `$idcat` `integer` $idcat Returns `integer`
`public integer`	# `getParentsNextPostCategoryId( integer $idcat )` Returns the id of category which is located after passed category ids parent category. Returns the id of category which is located after passed category ids parent category. Example: ... root_category parent_category previous_cateory this_category post_category parents_post_category () ... () Returned category id Parameters `$idcat` `integer` $idcat Category id Returns `integer`
`public integer`	# `getFirstChildCategoryId( integer $idcat, integer\|null $idlang = NULL )` Returns id of first child category, where parent id is the same as passed id and the previous id is 0. Returns id of first child category, where parent id is the same as passed id and the previous id is 0. Example: ... this_category child_category () child_category2 child_category3 ... () Returned category id Parameters `$idcat` `integer` $idcat `$idlang` `integer\|null` $idlang If defined, it checks also if there is a next deeper category in this language. Returns `integer`
`public array`	# `getAllChildCategoryIds( integer $idcat, integer\|null $idlang = NULL )` Returns list of all child category ids, only them on next deeper level (not recursive!) The returned array contains already the order of the categories. Example: ... this_category child_category () child_category2 () child_of_child_category2 child_category3 () ... () Returned category ids Returns list of all child category ids, only them on next deeper level (not recursive!) The returned array contains already the order of the categories. Example: ... this_category child_category () child_category2 () child_of_child_category2 child_category3 () ... () Returned category ids Parameters `$idcat` `integer` $idcat `$idlang` `integer\|null` $idlang Returns `array`
`public array`	# `getAllCategoryIdsRecursive( integer $idcat, integer $idclient )` Returns list of all child category ids and their child category ids of passed category id. The list also contains the id of passed category. Returns list of all child category ids and their child category ids of passed category id. The list also contains the id of passed category. The return value of this function could be used to perform bulk actions on a specific category an all of its childcategories. NOTE: The returned array is not sorted! Return value is similar to getAllCategoryIdsRecursive2, only the sorting differs Example: ... this_category () child_category () child_category2 () child_of_child_category2 () child_category3 () child_of_child_category3 () ... (*) Returned category ids Parameters `$idcat` `integer` $idcat `$idclient` `integer` $idclient Returns `array`
`public array`	# `getAllCategoryIdsRecursive2( integer $idcat, integer $idclient )` Returns list of all child category ids and their child category ids of passed category id. The list also contains the id of passed category. Returns list of all child category ids and their child category ids of passed category id. The list also contains the id of passed category. The return value of this function could be used to perform bulk actions on a specific category an all of its childcategories. NOTE: Return value is similar to getAllCategoryIdsRecursive, only the sorting differs Example: ... this_category () child_category () child_category2 () child_of_child_category2 () child_category3 () child_of_child_category3 () ... (*) Returned category ids Parameters `$idcat` `integer` $idcat `$idclient` `integer` $client Returns `array` Sorted by category id

Methods inherited from ItemCollection
_buildGroupWhereStatements(), _buildWhereStatements(), _delete(), _deleteMultiple(), _fetchJoinTables(), _findReverseJoinPartner(), _initializeDriver(), _recursiveStructuredFetch(), _resolveLinks(), _setItemClass(), _setJoinPartner(), addResultField(), copyItem(), count(), createNewItem(), delete(), deleteBy(), deleteByWhereClause(), deleteWhere(), deleteWhereGroup(), exists(), fetchArray(), fetchById(), fetchObject(), fetchTable(), flexSelect(), getAllIds(), getFieldsByWhereClause(), getIdsByWhereClause(), link(), loadItem(), next(), query(), queryAndFetchStructured(), removeResultField(), resetQuery(), select(), setEncoding(), setGroupCondition(), setInnerGroupCondition(), setLimit(), setOrder(), setWhere(), setWhereGroup()

Methods inherited from cItemBaseAbstract
`_getPropertiesCollectionInstance(), _getSecondDBInstance(), escape()`

Methods inherited from cGenericDb
`_executeCallbacks(), register(), unregister()`

Constants inherited from cGenericDb
`CREATE_BEFORE, CREATE_FAILURE, CREATE_SUCCESS, DELETE_BEFORE, DELETE_FAILURE, DELETE_SUCCESS, STORE_BEFORE, STORE_FAILURE, STORE_SUCCESS`

Properties inherited from ItemCollection
`$_JoinPartners, $_aOperators, $_bAllMode, $_collectionCache, $_driver, $_encoding, $_forwardJoinPartners, $_groupConditions, $_innerGroupConditions, $_itemClass, $_itemClassInstance, $_iteratorItem, $_lastSQL, $_limitCount, $_limitStart, $_links, $_order, $_resultFields, $_where, $_whereRestriction, $objects`

Properties inherited from cItemBaseAbstract
`$_className, $_oCache, $_settings, $db, $lasterror, $primaryKey, $properties, $secondDb, $table, $virgin`

Packages

Classes

Class cApiCategoryCollection

Parameters

Throws

Overrides

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns