[ Index ]
 

Code source de IMP H3 (4.1.5)

Accédez au Source d'autres logiciels libres

Classes | Fonctions | Variables | Constantes | Tables

title

Body

[fermer]

/lib/IMAP/ -> Tree.php (sommaire)

(pas de description)

Poids: 614 lignes (18 kb)
Inclus ou requis: 13 fois
Référencé: 0 fois
Nécessite: 2 fichiers
 lib/Folder.php
 lib/version.php

Définit 1 class

IMP_Tree:: (24 méthodes):
  singleton()
  IMP_Tree()
  init()
  insertVFolders()
  _init()
  _addAliases()
  _getStream()
  _initExpandedList()
  _addExpandedList()
  _removeExpandedList()
  getPollList()
  addPollList()
  removePollList()
  _getInitExpandedMode()
  _createVFolderContainer()
  _createVFolderElt()
  isVFolder()
  _getNonIMAPElt()
  delete()
  rename()
  hasChildren()
  _initSubscribed()
  folderList()
  isOpenSidebar()


Classe: IMP_Tree  - X-Ref

The IMP_tree class provides a tree view of the folders in an IMAP/POP3
repository.  It provides access functions to iterate through this tree and
query information about individual mailboxes.

$Horde: imp/lib/IMAP/Tree.php,v 1.25.2.45 2007/04/18 13:20:53 slusarz Exp $

Copyright 2000-2007 Chuck Hagenbuch <chuck@horde.org>
Copyright 2000-2007 Jon Parise <jon@horde.org>
Copyright 2000-2007 Anil Madhavapeddy <avsm@horde.org>
Copyright 2003-2007 Michael Slusarz <slusarz@horde.org>

See the enclosed file COPYING for license information (GPL). If you did not
receive this file, see http://www.fsf.org/copyleft/gpl.html.

singleton()   X-Ref
Singleton method.
By default, the tree will contain only currently viewable items and
will be stored in the session under 'imp'.  However, if you would
rather pass different parameters to IMAP_Tree, you may declare a
global variable named $imp_tree_singleton with the array of parameters
you want to pass to IMAP_Tree::singleton().


IMP_Tree($init = IMAPTREE_INIT_SUB, $cachename = null)   X-Ref
Constructor.


init($init = null)   X-Ref
Initalizes the list at the top level of the hierarchy.


insertVFolders($id_list)   X-Ref
Inserts virtual folders into the tree.

param: array $id_list  An array with the folder IDs to add as the key

_init()   X-Ref
Subclass specific initialization tasks.


_addAliases($elt)   X-Ref
Adds aliases to a tree element and returns the resulting array.

param: array $elt  A tree element.
return: array  A tree element with the aliases added.

_getStream()   X-Ref
Returns a reference to a currently open IMAP stream.


_initExpandedList()   X-Ref
Initializes the expanded folder list.


_addExpandedList($id)   X-Ref
Adds an element to the expanded list.


_removeExpandedList($id)   X-Ref
Removes an element from the expanded list.


getPollList()   X-Ref
Initializes and returns the list of mailboxes to poll.


addPollList($id)   X-Ref
Adds element(s) to the poll list.


removePollList($id)   X-Ref
Removes element(s) from the poll list.


_getInitExpandedMode()   X-Ref
Returns the currently selected initialization expanded mode.


_createVFolderContainer()   X-Ref
Creates the virtual folder container.

return: array  A mailbox element.

_createVFolderElt($vfolder)   X-Ref
Creates a virtual folder element.

param: string $vfolder  Virtual folder ID.
return: array  A mailbox element.

isVFolder($elt)   X-Ref
Returns whether this element is a virtual folder.

param: array $elt  A tree element.
return: integer  True if the element is a virtual folder.

_getNonIMAPElt($id)   X-Ref
Returns a non-IMAP mailbox element given an element identifier.

param: string $id  The element identifier.
return: array  A mailbox element.

delete($id)   X-Ref
Deletes an element from the tree.


rename($old, $new)   X-Ref
Rename a current folder.

param: array $old  The old folder names.
param: array $new  The new folder names.

hasChildren($elt, $viewable = false)   X-Ref
Does the element have any children?


_initSubscribed()   X-Ref
Initializes the list of subscribed mailboxes.


folderList()   X-Ref
Returns a list of all IMAP folders in the tree (i.e. not containers or
non-imap elements).

return: array  An array of IMAP mailbox names.

isOpenSidebar($mbox)   X-Ref
Is the mailbox open in the sidebar?

param: array $mbox  A mailbox name.
return: integer  True if the mailbox is open in the sidebar.



Généré le : Thu Nov 29 12:30:07 2007 par Balluche grâce à PHPXref 0.7
  Clicky Web Analytics