Class Zend_Mail_Storage_Folder

Description

Implements interfaces:

  • RecursiveIterator (internal interface)

Located in /Zend/Mail/Storage/Folder.php (line 31)


	
			
Variable Summary
 array $_folders
 string $_globalName
 string $_localName
Method Summary
 Zend_Mail_Storage_Folder __construct (string $localName, [string $globalName = ''], [bool $selectable = true], [ $folders = array()])
 string getGlobalName ()
 string getLocalName ()
 bool hasChildren ()
 bool isLeaf ()
 bool isSelectable ()
 string key ()
 null next ()
 null rewind ()
 bool valid ()
 null __set (string $name, Zend_Mail_Storage_Folder $folder)
 string __toString ()
Variables
array $_folders (line 37)

subfolders of folder array(localName => Zend_Mail_Storage_Folder folder)

  • access: protected
string $_globalName (line 49)

global name (absolute name of folder)

  • access: protected
string $_localName (line 43)

local name (name of folder in parent folder)

  • access: protected
bool $_selectable = true (line 55)

folder is selectable if folder is able to hold messages, else it's just a parent folder

  • access: protected
Methods
Constructor __construct (line 65)

create a new mail folder instance

  • access: public
Zend_Mail_Storage_Folder __construct (string $localName, [string $globalName = ''], [bool $selectable = true], [ $folders = array()])
  • string $localName: name of folder in current subdirectory
  • string $globalName: absolute name of folder
  • bool $selectable: if true folder holds messages, if false it's just a parent for subfolders
  • array $folders: init with given instances of Zend_Mail_Storage_Folder as subfolders
current (line 129)

implements Iterator::current()

  • return: current folder
  • access: public

Implementation of:
RecursiveIterator::current
getChildren (line 89)

implements RecursiveIterator::getChildren()

  • return: same as self::current()
  • access: public
Zend_Mail_Storage_Folder getChildren ()

Implementation of:
RecursiveIterator::getChildren
getGlobalName (line 197)

get global name

  • return: global name
  • access: public
string getGlobalName ()
getLocalName (line 187)

get local name

  • return: local name
  • access: public
string getLocalName ()
hasChildren (line 78)

implements RecursiveIterator::hasChildren()

  • return: current element has children
  • access: public
bool hasChildren ()

Implementation of:
RecursiveIterator::hasChildren
isLeaf (line 217)

check if folder has no subfolder

  • return: true if no subfolders
  • access: public
bool isLeaf ()
isSelectable (line 207)

is this folder selectable?

  • return: selectable
  • access: public
bool isSelectable ()
key (line 119)

implements Iterator::key()

  • return: key/local name of current element
  • access: public
string key ()

Implementation of:
RecursiveIterator::key
next (line 109)

implements Iterator::next()

  • access: public
null next ()

Implementation of:
RecursiveIterator::next
rewind (line 139)

implements Iterator::rewind()

  • access: public
null rewind ()

Implementation of:
RecursiveIterator::rewind
valid (line 99)

implements Iterator::valid()

  • return: check if there's a current element
  • access: public
bool valid ()

Implementation of:
RecursiveIterator::valid
__get (line 151)

get subfolder named $name

  • return: folder named $folder
  • access: public
  • throws: Zend_Mail_Storage_Exception
Zend_Mail_Storage_Folder __get (string $name)
  • string $name: wanted subfolder
__set (line 167)

add or replace subfolder named $name

  • access: public
null __set (string $name, Zend_Mail_Storage_Folder $folder)
__toString (line 177)

magic method for easy output of global name

  • return: global name of folder
  • access: public
string __toString ()

Documentation generated on Wed, 21 Feb 2007 11:48:31 -0800 by phpDocumentor 1.3.1