Folder.php

Go to the documentation of this file.

<?php
class Zend_Mail_Storage_Folder implements RecursiveIterator
{
    protected $_folders;

    protected $_localName;

    protected $_globalName;

    protected $_selectable = true;

    public function __construct($localName, $globalName = '', $selectable = true, array $folders = array())
    {
        $this->_localName  = $localName;
        $this->_globalName = $globalName ? $globalName : $localName;
        $this->_selectable = $selectable;
        $this->_folders    = $folders;
    }

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

    public function getChildren()
    {
        return $this->current();
    }

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

    public function next()
    {
        next($this->_folders);
    }

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

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

    public function rewind()
    {
        reset($this->_folders);
    }

    public function __get($name)
    {
        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];
    }

    public function __set($name, Zend_Mail_Storage_Folder $folder)
    {
        $this->_folders[$name] = $folder;
    }

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

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

    public function getLocalName()
    {
        return $this->_localName;
    }

    public function getGlobalName()
    {
        return $this->_globalName;
    }

    public function isSelectable()
    {
        return $this->_selectable;
    }

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