BEdita API doc | 4-cactus
  • Class
  • Tree
  • Deprecated
  • Download

Classes

  • Addon
  • AddressbookController
  • AddressbookShell
  • AdminController
  • Alias
  • Annotation
  • ApiAuthComponent
  • ApiBaseController
  • ApiFormatterComponent
  • ApiUploadComponent
  • ApiValidatorComponent
  • AppController
  • AppError
  • AppHelper
  • Application
  • AppModel
  • Area
  • AreasController
  • Audio
  • AuthenticationsController
  • BannedIp
  • BEAppModel
  • BEAppObjectModel
  • BeAuthComponent
  • BeAuthFacebookComponent
  • BeAuthGoogleComponent
  • BeAuthTwitterComponent
  • BeCallbackManager
  • BeConfigure
  • BeCustomPropertyComponent
  • BeditaAnnotationModel
  • BeditaBaseShell
  • BeditaCollectionModel
  • BeditaContentModel
  • BeditaExportFilter
  • BeditaImportFilter
  • BeditaObjectModel
  • BeditaProductModel
  • BeditaShell
  • BeditaSimpleObjectModel
  • BeditaSimpleStreamModel
  • BeditaStreamModel
  • BeEmbedFlashHelper
  • BeEmbedHtml5Helper
  • BeEmbedMediaHelper
  • BeErrorCode
  • BeExceptionHandler
  • BEFile
  • BeFileHandlerComponent
  • BeFormHelper
  • BeFrontHelper
  • BeHashComponent
  • BeHtmlHelper
  • BeLangTextComponent
  • BeLib
  • BeMailComponent
  • BEObject
  • BeObjectCache
  • BePaginatorToolbarHelper
  • BeSchema
  • BeSecurityComponent
  • BeSystem
  • BeSystemComponent
  • BeThumb
  • BeTimeHelper
  • BeToolbarHelper
  • BeTreeComponent
  • BeTreeHelper
  • BeUploadToObjComponent
  • BeurlHelper
  • BeVimeoComponent
  • BeYoutubeComponent
  • BuildFilterBehavior
  • CacheableBehavior
  • CacheShell
  • CallbackBehavior
  • CaptchaComponent
  • Caption
  • CaptionsBehavior
  • Card
  • CardsImportFilter
  • Category
  • CleanupDataTask
  • CleanupTask
  • Comment
  • CommentsController
  • CompactResultBehavior
  • Content
  • CreateIndexFieldsBehavior
  • DataShell
  • DataTransfer
  • DateItem
  • DbadminShell
  • DeleteDependentObjectBehavior
  • DeleteObjectBehavior
  • DeployShell
  • Document
  • DocumentsController
  • DumpModel
  • EditorialContentsShell
  • EditorNote
  • Event
  • EventLog
  • EventsController
  • FilesController
  • ForeignDependenceSaveBehavior
  • FrontendController
  • FrontendShell
  • GalleriesController
  • Gallery
  • GeoTag
  • GettextShell
  • Git
  • GravatarHelper
  • Group
  • HashJob
  • History
  • HomeController
  • Image
  • ImageInfoHelper
  • JsonExportFilter
  • JsonImportFilter
  • JsonView
  • LangText
  • Link
  • MailGroup
  • MailGroupCard
  • MailJob
  • MailLog
  • MailMessage
  • MailShell
  • MailTemplate
  • Mask
  • MediaShell
  • MigrateDumpModel
  • MigrateShell
  • Migration
  • MigrationBase
  • MigrationDateItemsShell
  • Module
  • ModulesController
  • ModuleShell
  • MultimediaController
  • NewsController
  • NewsletterController
  • NewsletterShell
  • NotifyBehavior
  • ObjectEditor
  • ObjectProperty
  • ObjectRelation
  • ObjectType
  • ObjectUser
  • PagesController
  • Permission
  • PermissionModule
  • PermsHelper
  • Product
  • Property
  • PropertyOption
  • PublicationShell
  • RedisShell
  • RelationCheck
  • RelationRepair
  • RelationShell
  • RelationStats
  • RemoveDummyNameBehavior
  • ResponseHandlerComponent
  • RestClientModel
  • Revision
  • RevisionObjectBehavior
  • SearchText
  • SearchTextSaveBehavior
  • Section
  • SectionDummy
  • SessionFilterComponent
  • SessionFilterHelper
  • ShortNews
  • SmartyView
  • SoapClientModel
  • SplitterSql
  • StatisticsController
  • Stream
  • StreamLog
  • StreamsController
  • Svn
  • TagsController
  • ThemeSmartyView
  • ThumbnailHelper
  • ThumbShell
  • TransactionComponent
  • TransactionFS
  • TranslationsController
  • Tree
  • TrHelper
  • User
  • UserProperty
  • UsersController
  • Utility
  • Version
  • Video
  • VimeoHelper
  • WebmarksController
  • XmlExportFilter
  • XmlImportFilter
  • XmlJsonConverter
  • XmlView
  • YoutubeHelper

Interfaces

  • ApiAuthInterface
  • MediaProviderInterface
  • UploadableInterface

Exceptions

  • BeditaAjaxException
  • BEditaAllowURLException
  • BeditaBadRequestException
  • BeditaConflictException
  • BEditaDeleteStreamObjException
  • BeditaException
  • BEditaFileExistException
  • BeditaForbiddenException
  • BeditaFrontAccessException
  • BeditaHashException
  • BEditaInfoException
  • BeditaInternalErrorException
  • BEditaIOException
  • BeditaLengthRequiredException
  • BeditaMailException
  • BEditaMediaProviderException
  • BeditaMethodNotAllowedException
  • BEditaMIMEException
  • BeditaNotFoundException
  • BeditaNotImplementedException
  • BeditaPublicationException
  • BeditaRuntimeException
  • BEditaSaveStreamObjException
  • BeditaServiceUnavailableException
  • BeditaUnauthorizedException
  • BEditaUploadPHPException
  • BEditaURLException

Class BeTreeComponent

Management of the tree of the contents.

Permits with bits representation (bedita.ini.php): BEDITA_PERMS_READ 0x1 BEDITA_PERMS_MODIFY 0x2

Object
Extended by BeTreeComponent
Version: $Revision$
Modifiedby: $LastChangedBy$
Lastmodified:

$LastChangedDate$

$Id$


Located at controllers/components/be_tree.php

Methods summary

public
# __construct( )
public
# initialize( Controller $controller )

Initialize BeTree component

Initialize BeTree component

Parameters

$controller
public
# cleanFilter( )

clean filter

clean filter

public array
# getSectionsTree( )

Tree of publications and sections for user connected

Tree of publications and sections for user connected

Returns

array
public array
# getPublicationTree( $id )

Tree of a publication and sections for user connected

Tree of a publication and sections for user connected

Returns

array
public array
# getAreaForSection( integer $section_id )

get publication (area) data for the section $section_id

get publication (area) data for the section $section_id

Parameters

$section_id

Returns

array
public array
# expandOneBranch( integer $id = null )

Get tree with one branch expanded (the branch where object $id is)

Get tree with one branch expanded (the branch where object $id is)

Parameters

$id

Returns

array
public array
# getChildren( integer $id = null, mixed $status = null, mixed $filter = false, mixed $order = null, boolean $dir = true, integer $page = 1, integer $dim = null, array $excludeIds = array() )

Get children for node $id

Get children for node $id

Parameters

$id
node ID
$status
$filter
$order
$dir
$page
$dim
$excludeIds

Returns

array
public array
# getDescendants( integer $id = null, mixed $status = null, mixed $filter = false, mixed $order = null, boolean $dir = true, integer $page = 1, integer $dim = null, array $excludeIds = array() )

Return descendants of a tree node

Return descendants of a tree node

Parameters

$id
node ID
$status
$filter
$order
$dir
$page
$dim
$excludeIds

Returns

array
public array
# getParents( integer $id = null, $area_id = null, $status = array() )

TODO: remove this method Array of parent objects of $id...

TODO: remove this method Array of parent objects of $id...

Parameters

$id
$area_id
$status

Returns

array
parents ids
public
# updateTree( integer $id, array $destination )

TODO: remove this method. Used only in some addons shell scripts update tree position of object $id with new $destination array

TODO: remove this method. Used only in some addons shell scripts update tree position of object $id with new $destination array

Parameters

$id
$destination
public
# setupForSave( integer $objectId, array & $destination = array() )

setup array of tree destinations (parent ids) if some parents is forbidden to user (backend_private permission) then add it to $destination because user can't edit that destination

setup array of tree destinations (parent ids) if some parents is forbidden to user (backend_private permission) then add it to $destination because user can't edit that destination

Parameters

$objectId
$destination
array of parent ids
private boolean
# _searchRootDeleteOther( array & $tree, integer $id )

Delete branches that don't contain object $id

Delete branches that don't contain object $id

Parameters

$tree
tree where to perform search
$id
object to search

Returns

boolean

Properties summary

public $controller
# null
public array $filter
# array()
protected $Tree
# null
protected $BEObject
# null
protected $Section
# null
BEdita API doc | 4-cactus API documentation generated by ApiGen