Zend_Mail_Storage_Folder Class Reference

Inheritance diagram for Zend_Mail_Storage_Folder:

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()

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

create a new mail folder instance

Parameters

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

Definition at line 65 of file Folder.php.

    {
        $this->_localName  = $localName;
        $this->_globalName = $globalName ? $globalName : $localName;
        $this->_selectable = $selectable;
        $this->_folders    = $folders;
    }

Member Function Documentation

__get()

__get

(

$name

)

get subfolder named $name

Parameters

string

$name

wanted 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.

    {
        if (!isset($this->_folders[$name])) {
            #require_once 'Zend/Mail/Storage/Exception.php';
            throw new Zend_Mail_Storage_Exception("no subfolder named $name");
        }

        return $this->_folders[$name];
    }

__set()

__set	(		$name,
		Zend_Mail_Storage_Folder	$folder
	)

add or replace subfolder named $name

Parameters

string	$name	local name of subfolder
Zend_Mail_Storage_Folder	$folder	instance for new subfolder

Returns

null

Definition at line 171 of file Folder.php.

    {
        $this->_folders[$name] = $folder;
    }

__toString()

__toString

(

)

magic method for easy output of global name

Returns

string global name of folder

Definition at line 192 of file Folder.php.

    {
        return (string)$this->getGlobalName();
    }

__unset()

__unset

(

$name

)

remove subfolder named $name

Parameters

string

$name

local name of subfolder

Returns

null

Definition at line 182 of file Folder.php.

    {
        unset($this->_folders[$name]);
    }

current()

current

(

)

implements Iterator::current()

Returns

Zend_Mail_Storage_Folder current folder

Definition at line 129 of file Folder.php.

    {
        return current($this->_folders);
    }

getChildren()

getChildren

(

)

implements RecursiveIterator::getChildren()

Returns

Zend_Mail_Storage_Folder same as self::current()

Definition at line 89 of file Folder.php.

    {
        return $this->current();
    }

getGlobalName()

getGlobalName

(

)

get global name

Returns

string global name

Definition at line 212 of file Folder.php.

    {
        return $this->_globalName;
    }

getLocalName()

getLocalName

(

)

get local name

Returns

string local name

Definition at line 202 of file Folder.php.

    {
        return $this->_localName;
    }

hasChildren()

hasChildren

(

)

implements RecursiveIterator::hasChildren()

Returns

bool current element has children

Definition at line 78 of file Folder.php.

    {
        $current = $this->current();
        return $current && $current instanceof Zend_Mail_Storage_Folder && !$current->isLeaf();
    }

isLeaf()

isLeaf

(

)

check if folder has no subfolder

Returns

bool true if no subfolders

Definition at line 232 of file Folder.php.

    {
        return empty($this->_folders);
    }

isSelectable()

isSelectable

(

)

is this folder selectable?

Returns

bool selectable

Definition at line 222 of file Folder.php.

    {
        return $this->_selectable;
    }

key()

key

(

)

implements Iterator::key()

Returns

string key/local name of current element

Definition at line 119 of file Folder.php.

    {
        return key($this->_folders);
    }

next()

next

(

)

implements Iterator::next()

Returns

null

Definition at line 109 of file Folder.php.

    {
        next($this->_folders);
    }

rewind()

rewind

(

)

implements Iterator::rewind()

Returns

null

Definition at line 139 of file Folder.php.

    {
        reset($this->_folders);
    }

valid()

valid

(

)

implements Iterator::valid()

Returns

bool check if there's a current element

Definition at line 99 of file Folder.php.

    {
        return key($this->_folders) !== null;
    }

Field Documentation

$_folders

$_folders

protected

Definition at line 37 of file Folder.php.

$_globalName

$_globalName

protected

Definition at line 49 of file Folder.php.

$_localName

$_localName

protected

Definition at line 43 of file Folder.php.

$_selectable

$_selectable = true

protected

Definition at line 55 of file Folder.php.

---

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

• vendor/magento/zendframework1/library/Zend/Mail/Storage/Folder.php