<?php

/**

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

 *

 * @category   Zend

 * @package    Zend_Queue

 * @subpackage Adapter

 * @license    http://framework.zend.com/license/new-bsd     New BSD License

 */

/**

 * @see Zend_Queue_Adapter_AdapterAbstract

 */

require_once 'Zend/Queue/Adapter/AdapterAbstract.php';

/**

 * Class testing.  No supported functions.  Also used to disable a Zend_Queue.

 *

 * @category   Zend

 * @package    Zend_Queue

 * @subpackage Adapter

 * @license    http://framework.zend.com/license/new-bsd     New BSD License

 */

class Zend_Queue_Adapter_Null extends Zend_Queue_Adapter_AdapterAbstract

{

    /**

     * Constructor

     *

     * @param  array|Zend_Config $options

     * @param  null|Zend_Queue $queue

     * @return void

     */

    public function __construct($options, Zend_Queue $queue = null)

    {

        parent::__construct($options, $queue);

    }

    /********************************************************************

     * Queue management functions

     *********************************************************************/

    /**

     * Does a queue already exist?

     *

     * @throws Zend_Queue_Exception - not supported.

     */

    public function isExists($name)

    {

        require_once 'Zend/Queue/Exception.php';

        throw new Zend_Queue_Exception(__FUNCTION__ . '() is not supported by ' . get_class($this));

    }

    /**

     * Create a new queue

     *

     * @throws Zend_Queue_Exception - not supported.

     */

    public function create($name, $timeout=null)

    {

        require_once 'Zend/Queue/Exception.php';

        throw new Zend_Queue_Exception(__FUNCTION__ . '() is not supported by ' . get_class($this));

    }

    /**

     * Delete a queue and all of it's messages

     *

     * @throws Zend_Queue_Exception - not supported.

     */

    public function delete($name)

    {

        require_once 'Zend/Queue/Exception.php';

        throw new Zend_Queue_Exception(__FUNCTION__ . '() is not supported by ' . get_class($this));

    }

    /**

     * Get an array of all available queues

     *

     * @throws Zend_Queue_Exception - not supported.

     */

    public function getQueues()

    {

        require_once 'Zend/Queue/Exception.php';

        throw new Zend_Queue_Exception(__FUNCTION__ . '() is not supported by ' . get_class($this));

    }

    /**

     * Return the approximate number of messages in the queue

     *

     * @throws Zend_Queue_Exception - not supported.

     */

    public function count(Zend_Queue $queue=null)

    {

        require_once 'Zend/Queue/Exception.php';

        throw new Zend_Queue_Exception(__FUNCTION__ . '() is not supported by ' . get_class($this));

    }

    /********************************************************************

     * Messsage management functions

     *********************************************************************/

    /**

     * Send a message to the queue

     *

     * @throws Zend_Queue_Exception - not supported.

     */

    public function send($message, Zend_Queue $queue=null)

    {

        require_once 'Zend/Queue/Exception.php';

        throw new Zend_Queue_Exception(__FUNCTION__ . '() is not supported by ' . get_class($this));

    }

    /**

     * Get messages in the queue

     *

     * @throws Zend_Queue_Exception - not supported.

     */

    public function receive($maxMessages=null, $timeout=null, Zend_Queue $queue=null)

    {

        require_once 'Zend/Queue/Exception.php';

        throw new Zend_Queue_Exception(__FUNCTION__ . '() is not supported by ' . get_class($this));

    }

    /**

     * Delete a message from the queue

     *

     * @throws Zend_Queue_Exception - not supported.

     */

    public function deleteMessage(Zend_Queue_Message $message)

    {

        require_once 'Zend/Queue/Exception.php';

        throw new Zend_Queue_Exception(__FUNCTION__ . '() is not supported by ' . get_class($this));

    }

    /********************************************************************

     * Supporting functions

     *********************************************************************/

    /**

     * Return a list of queue capabilities functions

     *

     * $array['function name'] = true or false

     * true is supported, false is not supported.

     *

     * @param  string $name

     * @return array

     */

    public function getCapabilities()

    {

        return array(

            'create'        => false,

            'delete'        => false,

            'send'          => false,

            'receive'       => false,

            'deleteMessage' => false,

            'getQueues'     => false,

            'count'         => false,

            'isExists'      => false,

        );

    }

}