Class Folder

Summary

Fully Qualified Name: Zend\Mail\Storage\Folder
Implements: RecursiveIterator

Description

Methods

Name Description Defined By
__construct() create a new mail folder instance Folder
__get() get subfolder named $name Folder
__set() add or replace subfolder named $name Folder
__toString() magic method for easy output of global name Folder
__unset() remove subfolder named $name Folder
current() implements Iterator::current() Folder
getChildren() implements RecursiveIterator::getChildren() Folder
getGlobalName() get global name Folder
getLocalName() get local name Folder
hasChildren() implements RecursiveIterator::hasChildren() Folder
isLeaf() check if folder has no subfolder Folder
isSelectable() is this folder selectable? Folder
key() implements Iterator::key() Folder
next() implements Iterator::next() Folder
rewind() implements Iterator::rewind() Folder
valid() implements Iterator::valid() Folder

Method Details

__construct()

create a new mail folder instance

Parameter Name Type Description
$localName string name
$globalName string absolute
$selectable bool if
$folders array init

Returns:

__get()

get subfolder named $name

Parameter Name Type Description
$name string wanted

Returns: \Zend\Mail\Storage\Folder folder named $folder

__set()

add or replace subfolder named $name

Parameter Name Type Description
$name string local
$folder \Zend\Mail\Storage\Folder instance

Returns:

__toString()

magic method for easy output of global name

Returns: string global name of folder

__unset()

remove subfolder named $name

Parameter Name Type Description
$name string local

Returns:

current()

implements Iterator::current()

Returns: \Zend\Mail\Storage\Folder current folder

getChildren()

implements RecursiveIterator::getChildren()

Returns: \Zend\Mail\Storage\Folder same as self::current()

getGlobalName()

get global name

Returns: string global name

getLocalName()

get local name

Returns: string local name

hasChildren()

implements RecursiveIterator::hasChildren()

Returns: bool current element has children

isLeaf()

check if folder has no subfolder

Returns: bool true if no subfolders

isSelectable()

is this folder selectable?

Returns: bool selectable

key()

implements Iterator::key()

Returns: string key/local name of current element

next()

implements Iterator::next()

Returns:

rewind()

implements Iterator::rewind()

Returns:

valid()

implements Iterator::valid()

Returns: bool check if there's a current element

Top