Mail/Storage/Folder.php
inherited
Classes
LICENSE
This source file is subject to the new BSD license that is bundled with this package in the file LICENSE.txt. It is also available through the world-wide-web at this URL: http://framework.zend.com/license/new-bsd If you did not receive a copy of the license and are unable to obtain it through the world-wide-web, please send an email to license@zend.com so we can send you a copy immediately.
- Category
- Zend
- Copyright
- Copyright (c) 2005-2012 Zend Technologies USA Inc. (http://www.zend.com)
- License
- New BSD License
- Package
- Zend_Mail
- Subpackage
- Storage
- Version
- $Id: Folder.php 24593 2012-01-05 20:35:02Z matthew $
\Zend_Mail_Storage_Folder
- Implements
- Category
- Zend
- Copyright
- Copyright (c) 2005-2012 Zend Technologies USA Inc. (http://www.zend.com)
- License
- New BSD License
Properties
array $_folders- Type
- array
string $_globalName- Type
- string
string $_localName- Type
- string
bool $_selectable = truetrueDetails- Type
- bool
Methods
__construct(string $localName, string $globalName = '', bool $selectable = true, array $folders = array()) : voidcreate a new mail folder instance
| Name | Type | Description |
|---|---|---|
| $localName | string | name of folder in current subdirectory |
| $globalName | string | absolute name of folder |
| $selectable | bool | if true folder holds messages, if false it's just a parent for subfolders |
| $folders | array | init with given instances of Zend_Mail_Storage_Folder as subfolders |
__get(string $name) : \Zend_Mail_Storage_Folderget subfolder named $name
| Name | Type | Description |
|---|---|---|
| $name | string | wanted subfolder |
| Type | Description |
|---|---|
| \Zend_Mail_Storage_Folder | folder named $folder |
| Exception | Description |
|---|---|
| \Zend_Mail_Storage_Exception |
__set(string $name, \Zend_Mail_Storage_Folder $folder) : nulladd or replace subfolder named $name
| Name | Type | Description |
|---|---|---|
| $name | string | local name of subfolder |
| $folder | \Zend_Mail_Storage_Folder | instance for new subfolder |
| Type | Description |
|---|---|
| null |
__toString() : stringmagic method for easy output of global name
| Type | Description |
|---|---|
| string | global name of folder |
__unset(string $name) : nullremove subfolder named $name
| Name | Type | Description |
|---|---|---|
| $name | string | local name of subfolder |
| Type | Description |
|---|---|
| null |
current() : \Zend_Mail_Storage_Folderimplements Iterator::current()
| Type | Description |
|---|---|
| \Zend_Mail_Storage_Folder | current folder |
getChildren() : \Zend_Mail_Storage_Folderimplements RecursiveIterator::getChildren()
| Type | Description |
|---|---|
| \Zend_Mail_Storage_Folder | same as self::current() |
getGlobalName() : stringget global name
| Type | Description |
|---|---|
| string | global name |
getLocalName() : stringget local name
| Type | Description |
|---|---|
| string | local name |
hasChildren() : boolimplements RecursiveIterator::hasChildren()
| Type | Description |
|---|---|
| bool | current element has children |
isLeaf() : boolcheck if folder has no subfolder
| Type | Description |
|---|---|
| bool | true if no subfolders |
isSelectable() : boolis this folder selectable?
| Type | Description |
|---|---|
| bool | selectable |
key() : stringimplements Iterator::key()
| Type | Description |
|---|---|
| string | key/local name of current element |
next() : nullimplements Iterator::next()
| Type | Description |
|---|---|
| null |
rewind() : nullimplements Iterator::rewind()
| Type | Description |
|---|---|
| null |
valid() : boolimplements Iterator::valid()
| Type | Description |
|---|---|
| bool | check if there's a current element |