Mail/Storage/Folder.php

category: Zend
copyright: Copyright (c) 2005-2010 Zend Technologies USA Inc. (http://www.zend.com)
license: http://framework.zend.com/license/new-bsd New BSD License
package: Zend_Mail
subpackage: Storage
version: $Id: Folder.php 20096 2010-01-06 02:05:09Z bkarwin $
Classes: Zend_Mail_Storage_Folder

Description

Zend Framework

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.

Zend_Mail_Storage_Folder
jump to top

Implements
category: Zend
copyright: Copyright (c) 2005-2010 Zend Technologies USA Inc. (http://www.zend.com)
license: http://framework.zend.com/license/new-bsd New BSD License
package: Zend_Mail
subpackage: Storage
Properties: $_folders; $_localName; $_globalName; $_selectable
Methods: __construct; hasChildren; getChildren; valid; next; key; current; rewind; __get; __set; __unset; __toString; getLocalName; getGlobalName; isSelectable; isLeaf

Description

Properties

$_folders
jump to class

array $_folders = ''

subfolders of folder array(localName => Zend_Mail_Storage_Folder folder)

Details

$_folders: array
visibility: protected
default
final: false
static: false

$_globalName
jump to class

string $_globalName = ''

global name (absolute name of folder)

Details

$_globalName: string
visibility: protected
default
final: false
static: false

$_localName
jump to class

string $_localName = ''

local name (name of folder in parent folder)

Details

$_localName: string
visibility: protected
default
final: false
static: false

$_selectable
jump to class

bool $_selectable = 'true'

folder is selectable if folder is able to hold messages, else it's just a parent folder

Details

$_selectable: bool
visibility: protected
default: true
final: false
static: false

Methods

__construct
jump to class

__construct(
          string $localName, string $globalName, bool $selectable
              =
              true, array $folders
              =
              array
          )
        
        :

create a new mail folder instance

Arguments

$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

Details

visibility: public
final: false
static: false

__get
jump to class

__get(
          string $name
          )
        
        :
        Zend_Mail_Storage_Folder

get subfolder named $name

Arguments

$name: string
wanted subfolder

Output

Zend_Mail_Storage_Folder: folder named $folder

Details

visibility: public
final: false
static: false
throws

__set
jump to class

__set(
          string $name, Zend_Mail_Storage_Folder $folder
          )
        
        :
        null

add or replace subfolder named $name

Arguments

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

Output

null

Details

visibility: public
final: false
static: false

__toString
jump to class

__toString(
          
          )
        
        :
        string

magic method for easy output of global name

Output

string: global name of folder

Details

visibility: public
final: false
static: false

__unset
jump to class

__unset(
          string $name
          )
        
        :
        null

remove subfolder named $name

Arguments

$name: string
local name of subfolder

Output

null

Details

visibility: public
final: false
static: false

current
jump to class

current(
          
          )
        
        :
        Zend_Mail_Storage_Folder

implements Iterator::current()

Output

Zend_Mail_Storage_Folder: current folder

Details

visibility: public
final: false
static: false

getChildren
jump to class

getChildren(
          
          )
        
        :
        Zend_Mail_Storage_Folder

implements RecursiveIterator::getChildren()

Output

Zend_Mail_Storage_Folder: same as self::current()

Details

visibility: public
final: false
static: false

getGlobalName
jump to class

getGlobalName(
          
          )
        
        :
        string

get global name

Output

string: global name

Details

visibility: public
final: false
static: false

getLocalName
jump to class

getLocalName(
          
          )
        
        :
        string

get local name

Output

string: local name

Details

visibility: public
final: false
static: false

hasChildren
jump to class

hasChildren(
          
          )
        
        :
        bool

implements RecursiveIterator::hasChildren()

Output

bool: current element has children

Details

visibility: public
final: false
static: false

isLeaf
jump to class

isLeaf(
          
          )
        
        :
        bool

check if folder has no subfolder

Output

bool: true if no subfolders

Details

visibility: public
final: false
static: false

isSelectable
jump to class

isSelectable(
          
          )
        
        :
        bool

is this folder selectable?

Output

bool: selectable

Details

visibility: public
final: false
static: false

key
jump to class

implements Iterator::key()

Output

string: key/local name of current element

Details

visibility: public
final: false
static: false

next
jump to class

implements Iterator::next()

Output

null

Details

visibility: public
final: false
static: false

rewind
jump to class

rewind(
          
          )
        
        :
        null

implements Iterator::rewind()

Output

null

Details

visibility: public
final: false
static: false

valid
jump to class

implements Iterator::valid()

Output

bool: check if there's a current element

Details

visibility: public
final: false
static: false

API Documentation

Mail/Storage/Folder.php

Description

Zend_Mail_Storage_Folderjump to top

Description

Properties

$_foldersjump to class

Details

$_globalNamejump to class

Details

$_localNamejump to class

Details

$_selectablejump to class

Details

Methods

__constructjump to class

Arguments

Details

__getjump to class

Arguments

Output

Details

__setjump to class

Arguments

Output

Details

__toStringjump to class

Output

Details

__unsetjump to class

Arguments

Output

Details

currentjump to class

Output

Details

getChildrenjump to class

Output

Details

getGlobalNamejump to class

Output

Details

getLocalNamejump to class

Output

Details

hasChildrenjump to class

Output

Details

isLeafjump to class

Output

Details

isSelectablejump to class

Output

Details

keyjump to class

Output

Details

nextjump to class

Output

Details

rewindjump to class

Output

Details

validjump to class

Output

Details

Zend_Mail_Storage_Folder
jump to top

$_folders
jump to class

$_globalName
jump to class

$_localName
jump to class

$_selectable
jump to class

__construct
jump to class

__get
jump to class

__set
jump to class

__toString
jump to class

__unset
jump to class

current
jump to class

getChildren
jump to class

getGlobalName
jump to class

getLocalName
jump to class

hasChildren
jump to class

isLeaf
jump to class

isSelectable
jump to class

key
jump to class

next
jump to class

rewind
jump to class

valid
jump to class