Class IMP_Ftree

IMP_Ftree (folder tree) provides a tree view of the mailboxes on a backend (a/k/a a folder list; in IMP, folders = collection of mailboxes), along with other display elements (Remote Accounts; Virtual Folders).

IMP_Ftree implements ArrayAccess, Countable, IteratorAggregate, Serializable

Package: IMP
Category: Horde
Copyright: 2000-2014 Horde LLC
License: GPL
Author: Chuck Hagenbuch chuck@horde.org
Author: Anil Madhavapeddy avsm@horde.org
Author: Jon Parise jon@horde.org
Author: Michael Slusarz slusarz@horde.org
Located at Ftree.php

Methods summary
`public`	# `__construct( )` Constructor. Constructor.
`public`	# `__get( mixed $name )`
`public`	# `init( )` Initialize the tree. Initialize the tree.
`public`	# `insert( mixed $id )` Insert an element into the tree. Insert an element into the tree. Parameters `$id` <p>The name of the mailbox (or a list of mailboxes), an IMP_Search_Vfolder object, an IMP_Remote_Account object, or an array containing any mixture of these.</p>
`public`	# `expand( mixed $elts, boolean $expandall = false )` Expand an element. Expand an element. Parameters `$elts` <p>The element (or an array of elements) to expand.</p> `$expandall` Expand all subelements?
`public`	# `expandAll( )` Expand all elements. Expand all elements.
`public`	# `collapse( mixed $elts )` Collapse an element. Collapse an element. Parameters `$elts` The element (or an array of elements) to expand.
`public`	# `collapseAll( )` Collapse all elements. Collapse all elements.
`public`	# `delete( mixed $id )` Delete an element from the tree. Delete an element from the tree. Parameters `$id` $elts The element (or an array of elements) to delete.
`public`	# `rename( string $old, string $new )` Rename a mailbox. Rename a mailbox. Parameters `$old` The old mailbox name. `$new` The new mailbox name.
`public`	# `subscribe( mixed $id )` Subscribe an element to the tree. Subscribe an element to the tree. Parameters `$id` The element name or an array of element names.
`public`	# `unsubscribe( mixed $id )` Unsubscribe an element from the tree. Unsubscribe an element from the tree. Parameters `$id` The element name or an array of element names.
`public`	# `loadUnsubscribed( )` Load unsubscribed mailboxes. Load unsubscribed mailboxes.
`public mixed`	# `getAttribute( string $type, string $name )` Get an attribute value. Get an attribute value. Parameters `$type` The attribute type. `$name` The element name. Returns `mixed` Boolean attribute result, or null if element or attribute doesn't exist
`public`	# `setAttribute( string $type, string $elt, boolean $bool )` Change an attribute value. Change an attribute value. Parameters `$type` The attribute type. `$elt` The element name. `$bool` The boolean value.
`public IMP_Ftree_Account`	# `getAccount( string $id )` Get the account object for a given element ID. Get the account object for a given element ID. Parameters `$id` Element ID. Returns `IMP_Ftree_Account` Account object.
`public array`	# `getChildren( string $id )` Return the list of children for a given element ID. Return the list of children for a given element ID. Parameters `$id` Element ID. Returns `array` Array of tree elements.
`public mixed`	# `getParent( string $id )` Get the parent element for a given element ID. Get the parent element for a given element ID. Parameters `$id` Element ID. Returns `mixed` IMP_Ftree_Element object, or null if no parent.
`public`	# `sortList( array & $mbox, IMP_Ftree_Element $base = false )` Sorts a list of mailboxes. Sorts a list of mailboxes. Parameters `$mbox` $mbox The list of mailboxes to sort. `$base` The base element.
`public`	# `offsetExists( mixed $offset )` Implementation of `ArrayAccess::offsetExists()`
`public IMP_Ftree_Element`	# `offsetGet( mixed $offset )` Returns `IMP_Ftree_Element` Implementation of `ArrayAccess::offsetGet()`
`public`	# `offsetSet( mixed $offset, mixed $value )` Implementation of `ArrayAccess::offsetSet()`
`public`	# `offsetUnset( mixed $offset )` Implementation of `ArrayAccess::offsetUnset()`
`public`	# `count( )` Return the number of mailboxes on the server. Return the number of mailboxes on the server. Implementation of `Countable::count()`
`public`	# `serialize( )` Implementation of `Serializable::serialize()`
`public`	# `unserialize( mixed $data )` Throws Horde_Pack_Exception Implementation of `Serializable::unserialize()`
`public Horde_Tree`	# `createTree( string\|Horde_Tree $name, array $opts = array() )` Creates a Horde_Tree representation of the current tree. Creates a Horde_Tree representation of the current tree. Parameters `$name` <p>Either the tree name, or a Horde_Tree object to add nodes to.</p> `$opts` <p>Additional options: - basename: (boolean) Use raw basename instead of abbreviated label? DEFAULT: false - checkbox: (boolean) Display checkboxes? DEFAULT: false - editvfolder: (boolean) Display vfolder edit links? DEFAULT: false - iterator: (Iterator) Tree iterator to use. DEFAULT: Base iterator. - open: (boolean) Force child mailboxes to this status. DEFAULT: null - parent: (string) The parent object of the current level. DEFAULT: null (add to base level) - poll_info: (boolean) Include poll information in output? DEFAULT: false - render_params: (array) List of params to pass to renderer if auto-creating. DEFAULT: 'alternate', 'lines', and 'lines_base' are passed in with true values. - render_type: (string) The renderer name. DEFAULT: Javascript</p> Returns `Horde_Tree` The tree object.
`public IMP_Ftree_Iterator`	# `getIterator( )` This returns a RecursiveIterator - a RecursiveIteratorIterator is needed to properly iterate through all elements. This returns a RecursiveIterator - a RecursiveIteratorIterator is needed to properly iterate through all elements. Returns `IMP_Ftree_Iterator` Iterator object. Implementation of `IteratorAggregate::getIterator()`

Constants summary
`integer`	`ELT_NOSELECT`	# `1`
`integer`	`ELT_NAMESPACE_OTHER`	# `2`
`integer`	`ELT_NAMESPACE_SHARED`	# `4`
`integer`	`ELT_IS_OPEN`	# `8`
`integer`	`ELT_IS_SUBSCRIBED`	# `16`
`integer`	`ELT_NOINFERIORS`	# `32`
`integer`	`ELT_IS_POLLED`	# `64`
`integer`	`ELT_NOT_POLLED`	# `128`
`integer`	`ELT_VFOLDER`	# `256`
`integer`	`ELT_NONIMAP`	# `512`
`integer`	`ELT_INVISIBLE`	# `1024`
`integer`	`ELT_NEED_SORT`	# `2048`
`integer`	`ELT_REMOTE`	# `4096`
`integer`	`ELT_REMOTE_AUTH`	# `8192`
`integer`	`ELT_REMOTE_MBOX`	# `16384`
`string`	`BASE_ELT`	# `"base\0"`

Magic properties summary
`public boolean`	`$changed` Has the tree changed?
`public IMP_Ftree_Eltdiff`	`$eltdiff` Element diff tracker.
`public IMP_FTree_Prefs_Expanded`	`$expanded` The expanded folders list.
`public IMP_Ftree_Prefs_Poll`	`$poll` The poll list.
`public boolean`	`$subscriptions` Whether IMAP subscriptions are enabled.
`public boolean`	`$unsubscribed_loaded` True if unsubscribed mailboxes have been loaded.

Packages

Classes

Interfaces

Class IMP_Ftree

Parameters

Parameters

Parameters

Parameters

Parameters

Parameters

Parameters

Parameters

Returns

Parameters

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Implementation of

Returns

Implementation of

Implementation of

Implementation of

Implementation of

Implementation of

Throws

Implementation of

Parameters

Returns

Returns

Implementation of