library/Zend/Rest/Controller.php

   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 license@zend.com so we can send you a copy immediately.
  14  *
  15  * @package    Zend_Rest
  16  * @copyright  Copyright (c) 2005-2009 Zend Technologies USA Inc. (http://www.zend.com)
  17  * @license    http://framework.zend.com/license/new-bsd     New BSD License
  18  * @version    $Id: Controller.php 16595 2009-07-09 20:26:25Z matthew $
  19  */
  20
  21 /** Zend_Controller_Action */
  22 require_once 'Zend/Controller/Action.php';
  23
  24 /**
  25  * An abstract class to guide implementation of action controllers for use with
  26  * Zend_Rest_Route.
  27  *
  28  * @package Zend_Rest
  29  * @see Zend_Rest_Route
  30  * @copyright  Copyright (c) 2005-2008 Zend Technologies USA Inc. (http://www.zend.com)
  31  * @license    http://framework.zend.com/license/new-bsd     New BSD License
  32  */
  33 abstract class Zend_Rest_Controller extends Zend_Controller_Action
  34 {
  35     /**
  36      * The index action handles index/list requests; it should respond with a
  37      * list of the requested resources.
  38      */
  39     abstract public function indexAction();
  40
  41     /**
  42      * The get action handles GET requests and receives an 'id' parameter; it
  43      * should respond with the server resource state of the resource identified
  44      * by the 'id' value.
  45      */
  46     abstract public function getAction();
  47
  48     /**
  49      * The post action handles POST requests; it should accept and digest a
  50      * POSTed resource representation and persist the resource state.
  51      */
  52     abstract public function postAction();
  53
  54     /**
  55      * The put action handles PUT requests and receives an 'id' parameter; it
  56      * should update the server resource state of the resource identified by
  57      * the 'id' value.
  58      */
  59     abstract public function putAction();
  60
  61     /**
  62      * The delete action handles DELETE requests and receives an 'id'
  63      * parameter; it should update the server resource state of the resource
  64      * identified by the 'id' value.
  65      */
  66     abstract public function deleteAction();
  67
  68 }