[Summary view] [Print] [Text view]

   1  <?php
   2  /**
   3   * Zend Framework
   4   *
   5   * LICENSE
   6   *
   7   * This source file is subject to the new BSD license that is bundled
   8   * with this package in the file LICENSE.txt.
   9   * It is also available through the world-wide-web at this URL:
  10   * http://framework.zend.com/license/new-bsd
  11   * If you did not receive a copy of the license and are unable to
  12   * obtain it through the world-wide-web, please send an email
  13   * to [email protected] so we can send you a copy immediately.
  14   *
  15   * @category   Zend
  16   * @package    Zend_Rest
  17   * @copyright  Copyright (c) 2005-2010 Zend Technologies USA Inc. (http://www.zend.com)
  18   * @license    http://framework.zend.com/license/new-bsd     New BSD License
  19   * @version    $Id$
  20   */
  21  
  22  /** Zend_Controller_Action */
  23  require_once 'Zend/Controller/Action.php';
  24  
  25  /**
  26   * An abstract class to guide implementation of action controllers for use with
  27   * Zend_Rest_Route.
  28   *
  29   * @category   Zend
  30   * @package Zend_Rest
  31   * @see Zend_Rest_Route
  32   * @copyright  Copyright (c) 2005-2010 Zend Technologies USA Inc. (http://www.zend.com)
  33   * @license    http://framework.zend.com/license/new-bsd     New BSD License
  34   */
  35  abstract class Zend_Rest_Controller extends Zend_Controller_Action
  36  {
  37      /**
  38       * The index action handles index/list requests; it should respond with a
  39       * list of the requested resources.
  40       */
  41      abstract public function indexAction();
  42  
  43      /**
  44       * The get action handles GET requests and receives an 'id' parameter; it
  45       * should respond with the server resource state of the resource identified
  46       * by the 'id' value.
  47       */
  48      abstract public function getAction();
  49  
  50      /**
  51       * The post action handles POST requests; it should accept and digest a
  52       * POSTed resource representation and persist the resource state.
  53       */
  54      abstract public function postAction();
  55  
  56      /**
  57       * The put action handles PUT requests and receives an 'id' parameter; it
  58       * should update the server resource state of the resource identified by
  59       * the 'id' value.
  60       */
  61      abstract public function putAction();
  62  
  63      /**
  64       * The delete action handles DELETE requests and receives an 'id'
  65       * parameter; it should update the server resource state of the resource
  66       * identified by the 'id' value.
  67       */
  68      abstract public function deleteAction();
  69  
  70  }