Public Member Functions | Protected Attributes

Zend_Mail_Storage_Folder Class Reference

Public Member Functions

 __construct ($localName, $globalName= '', $selectable=true, array $folders=array())
 hasChildren ()
 getChildren ()
 valid ()
 next ()
 key ()
 current ()
 rewind ()
 __get ($name)
 __set ($name, Zend_Mail_Storage_Folder $folder)
 __unset ($name)
 __toString ()
 getLocalName ()
 getGlobalName ()
 isSelectable ()
 isLeaf ()

Protected Attributes

 $_folders
 $_localName
 $_globalName
 $_selectable = true

Detailed Description

Definition at line 31 of file Folder.php.


Constructor & Destructor Documentation

__construct ( localName,
globalName = '',
selectable = true,
array $  folders = array() 
)

create a new mail folder instance

Parameters:
string$localNamename of folder in current subdirectory
string$globalNameabsolute name of folder
bool$selectableif true folder holds messages, if false it's just a parent for subfolders
array$foldersinit with given instances of Zend_Mail_Storage_Folder as subfolders

Definition at line 65 of file Folder.php.


Member Function Documentation

__get ( name )

get subfolder named $name

Parameters:
string$namewanted subfolder
Returns:
Zend_Mail_Storage_Folder folder named $folder
Exceptions:
Zend_Mail_Storage_Exception

See also:
Zend_Mail_Storage_Exception

Definition at line 151 of file Folder.php.

__set ( name,
Zend_Mail_Storage_Folder folder 
)

add or replace subfolder named $name

Parameters:
string$namelocal name of subfolder
Zend_Mail_Storage_Folder$folderinstance for new subfolder
Returns:
null

Definition at line 171 of file Folder.php.

__toString (  )

magic method for easy output of global name

Returns:
string global name of folder

Definition at line 192 of file Folder.php.

__unset ( name )

remove subfolder named $name

Parameters:
string$namelocal name of subfolder
Returns:
null

Definition at line 182 of file Folder.php.

current (  )

implements Iterator::current()

Returns:
Zend_Mail_Storage_Folder current folder

Definition at line 129 of file Folder.php.

getChildren (  )

implements RecursiveIterator::getChildren()

Returns:
Zend_Mail_Storage_Folder same as self::current()

Definition at line 89 of file Folder.php.

getGlobalName (  )

get global name

Returns:
string global name

Definition at line 212 of file Folder.php.

getLocalName (  )

get local name

Returns:
string local name

Definition at line 202 of file Folder.php.

hasChildren (  )

implements RecursiveIterator::hasChildren()

Returns:
bool current element has children

Definition at line 78 of file Folder.php.

isLeaf (  )

check if folder has no subfolder

Returns:
bool true if no subfolders

Definition at line 232 of file Folder.php.

isSelectable (  )

is this folder selectable?

Returns:
bool selectable

Definition at line 222 of file Folder.php.

key (  )

implements Iterator::key()

Returns:
string key/local name of current element

Definition at line 119 of file Folder.php.

next (  )

implements Iterator::next()

Returns:
null

Definition at line 109 of file Folder.php.

rewind (  )

implements Iterator::rewind()

Returns:
null

Definition at line 139 of file Folder.php.

valid (  )

implements Iterator::valid()

Returns:
bool check if there's a current element

Definition at line 99 of file Folder.php.


The documentation for this class was generated from the following file: