Abstract.php

Go to the documentation of this file.

<?php
abstract class Zend_Mail_Storage_Abstract implements Countable, ArrayAccess, SeekableIterator
{
    protected $_has = array('uniqueid'  => true,
                            'delete'    => false,
                            'create'    => false,
                            'top'       => false,
                            'fetchPart' => true,
                            'flags'     => false);

    protected $_iterationPos = 0;

    protected $_iterationMax = null;

    protected $_messageClass = 'Zend_Mail_Message';

    public function __get($var)
    {
        if (strpos($var, 'has') === 0) {
            $var = strtolower(substr($var, 3));
            return isset($this->_has[$var]) ? $this->_has[$var] : null;
        }

        #require_once 'Zend/Mail/Storage/Exception.php';
        throw new Zend_Mail_Storage_Exception($var . ' not found');
    }


    public function getCapabilities()
    {
        return $this->_has;
    }


    abstract public function countMessages();


    abstract public function getSize($id = 0);


    abstract public function getMessage($id);


    abstract public function getRawHeader($id, $part = null, $topLines = 0);

    abstract public function getRawContent($id, $part = null);

    abstract public function __construct($params);


    public function __destruct()
    {
        $this->close();
    }


    abstract public function close();


    abstract public function noop();

    abstract public function removeMessage($id);

    abstract public function getUniqueId($id = null);

    abstract public function getNumberByUniqueId($id);

    // interface implementations follows

     public function count()
     {
        return $this->countMessages();
     }


     public function offsetExists($id)
     {
        try {
            if ($this->getMessage($id)) {
                return true;
            }
        } catch(Zend_Mail_Storage_Exception $e) {}

        return false;
     }


     public function offsetGet($id)
     {
        return $this->getMessage($id);
     }


     public function offsetSet($id, $value)
     {
        #require_once 'Zend/Mail/Storage/Exception.php';
        throw new Zend_Mail_Storage_Exception('cannot write mail messages via array access');
     }


     public function offsetUnset($id)
     {
        return $this->removeMessage($id);
     }


     public function rewind()
     {
        $this->_iterationMax = $this->countMessages();
        $this->_iterationPos = 1;
     }


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


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


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


     public function valid()
     {
        if ($this->_iterationMax === null) {
          $this->_iterationMax = $this->countMessages();
        }
        return $this->_iterationPos && $this->_iterationPos <= $this->_iterationMax;
     }


     public function seek($pos)
     {
        if ($this->_iterationMax === null) {
          $this->_iterationMax = $this->countMessages();
        }

        if ($pos > $this->_iterationMax) {
            throw new OutOfBoundsException('this position does not exist');
        }
        $this->_iterationPos = $pos;
     }

}