Class pApiTree

Tree class for content allocation

Direct known subclasses

pApiContentAllocationArticle, pApiContentAllocationComplexList, pApiContentAllocationSelectBox, pApiContentAllocationTreeView

Package: Plugin\ContentAllocation
Copyright: four for business AG <www.4fb.de>
License: http://www.contenido.org/license/LIZENZ.txt
Author: Marco Jahn
Located at plugins/content_allocation/classes/class.content_allocation_tree.php

Methods summary
`public`	# `__construct( string $uuid )` pApiTree constructor pApiTree constructor Parameters `$uuid` `string` $uuid Throws `cDbException` `cException`
`public pApiTree`	# `pApiTree( string $uuid )` Old constructor Old constructor Deprecated [2016-02-11] This method is deprecated and is not needed any longer. Please use __construct() as constructor function. Parameters `$uuid` `string` $uuid Returns `pApiTree` Throws `cDbException` `cException`
`public array\|boolean`	# `fetchTree( mixed $parentId = false, integer $level = 0, boolean $useTreeStatus = true )` Fetch tree Fetch tree Parameters `$parentId` `mixed` $parentId `$level` `integer` $level `$useTreeStatus` `boolean` $useTreeStatus (if true use expand/collapsed status of the tree, otherwise not) Returns `array\|boolean` Throws `cDbException`
`public boolean\|array`	# `fetchTreeIds( mixed $parentId = false, integer $level = 0, boolean $showOffline = false )` Fetch ContentAllocation tree Consider offline/online status Fetch ContentAllocation tree Consider offline/online status Parameters `$parentId` `mixed` $parentId `$level` `integer` $level `$showOffline` `boolean` $showOffline Returns `boolean\|array` with ContentAllocation id's Throws `cDbException` Created 21.11.2005 Willi Man
`public`	# `setTreeStatus( integer $idpica_alloc )` Set tree status Set tree status Parameters `$idpica_alloc` `integer` $idpica_alloc Throws `cDbException` `cException` `cInvalidArgumentException`
`public`	# `loadTreeStatus( )` Load tree status Load tree status Throws `cDbException` `cException`
`public array\|boolean`	# `fetchParent( integer $idpica_alloc )` Fetch parent via idpica_alloc variable Fetch parent via idpica_alloc variable Parameters `$idpica_alloc` `integer` $idpica_alloc Returns `array\|boolean` Throws `cDbException`
`public`	# `fetchParents( )` Old unused function Old unused function
`protected array`	# `fetchLevel( boolean $parentId = false, boolean $showOffline = false )` Fetch level Fetch level Parameters `$parentId` `boolean` $parentId `$showOffline` `boolean` $showOffline Returns `array` Throws `cDbException`
`public mixed`	# `storeItem( mixed $treeItem )` Store item into database Store item into database Parameters `$treeItem` `mixed` $treeItem Returns `mixed` Throws `cDbException`
`public`	# `setOnline( integer $idpica_alloc )` Set status to online Set status to online Parameters `$idpica_alloc` `integer` $idpica_alloc Throws `cDbException`
`public`	# `setOffline( integer $idpica_alloc )` Set status to offline Set status to offline Parameters `$idpica_alloc` `integer` $idpica_alloc Throws `cDbException`
`protected`	# `_switchOnOffline( integer $idpica_alloc, integer $status )` Set status to online or offline Set status to online or offline Parameters `$idpica_alloc` `integer` $idpica_alloc `$status` `integer` $status Throws `cDbException`
`public`	# `itemMoveUp( integer $idpica_alloc )` Move item up Move item up Parameters `$idpica_alloc` `integer` $idpica_alloc Throws `cDbException`
`public`	# `itemMoveDown( )` Old unused function Old unused function
`public boolean`	# `deleteItem( integer $idpica_alloc )` Delete content allocation item Delete content allocation item Parameters `$idpica_alloc` `integer` $idpica_alloc Returns `boolean` Throws `cDbException`
`public array\|boolean`	# `fetchItem( integer $idpica_alloc )` Get parentid and sortorder Get parentid and sortorder Parameters `$idpica_alloc` `integer` $idpica_alloc Returns `array\|boolean` Throws `cDbException`
`public array\|boolean`	# `fetchItemNameLang( integer $idpica_alloc )` Get name, id of language and online/offline status Get name, id of language and online/offline status Parameters `$idpica_alloc` `integer` $idpica_alloc Returns `array\|boolean` Throws `cDbException`
`protected integer`	# `_fetchMaxOrder( boolean\|integer $parentId = false )` Get maximal sortorder Get maximal sortorder Parameters `$parentId` `boolean\|integer` $parentId Returns `integer` Throws `cDbException`
`protected`	# `_decreaseOrder( boolean $parentId, integer $fromOrder )` Decrease order (value at database - 1) Decrease order (value at database - 1) Parameters `$parentId` `boolean` $parentId `$fromOrder` `integer` $fromOrder Throws `cDbException`
`protected`	# `_increaseOrder( boolean $parentId, integer $fromOrder )` Increase order (value at database + 1) Increase order (value at database + 1) Parameters `$parentId` `boolean` $parentId `$fromOrder` `integer` $fromOrder Throws `cDbException`
`public`	# `setFilters( array $arrInFilters = array(), array $arrOutFilters = array() )` Set method for filters Set method for filters Parameters `$arrInFilters` `array` $arrInFilters `$arrOutFilters` `array` $arrOutFilters
`protected mixed`	# `_inFilter( mixed $data )` Get data from filters Get data from filters Parameters `$data` `mixed` $data Returns `mixed`
`protected mixed`	# `_outFilter( mixed $data )` Get data from filters Get data from filters Parameters `$data` `mixed` $data Returns `mixed`

Properties summary
`protected object`	`$_db`	`null`	# cDb cDb CONTENIDO Database
`protected boolean`	`$_debug`	`false`	#
`protected array`	`$_table`	`array()`	#
`protected integer`	`$_lang`	`1`	#
`protected integer`	`$_client`	`1`	#
`protected integer`	`$_defaultLang`	`1`	#
`protected boolean`	`$_logger`	`null`	#
`protected string`	`$_user`	`''`	#
`protected array`	`$_treeStatus`	`array()`	#
`protected string`	`$_uuid`	`''`	#
`protected array`	`$_arrInFilters`	`array('htmlspecialchars', 'addslashes')`	#
`protected array`	`$_arrOutFilters`	`array('stripslashes', 'htmldecode')`	#

Packages

Classes

Functions

Class pApiTree

Direct known subclasses

Parameters

Throws

Deprecated

Parameters

Returns

Throws

Parameters

Returns

Throws

Parameters

Returns

Throws

Created

Parameters

Throws

Throws

Parameters

Returns

Throws

Parameters

Returns

Throws

Parameters

Returns

Throws

Parameters

Throws

Parameters

Throws

Parameters

Throws

Parameters

Throws

Parameters

Returns

Throws

Parameters

Returns

Throws

Parameters

Returns

Throws

Parameters

Returns

Throws

Parameters

Throws

Parameters

Throws

Parameters

Parameters

Returns

Parameters

Returns