Zend/Rest/Controller.php

0001 <?php
0002 /**
0003  * Zend Framework
0004  *
0005  * LICENSE
0006  *
0007  * This source file is subject to the new BSD license that is bundled
0008  * with this package in the file LICENSE.txt.
0009  * It is also available through the world-wide-web at this URL:
0010  * http://framework.zend.com/license/new-bsd
0011  * If you did not receive a copy of the license and are unable to
0012  * obtain it through the world-wide-web, please send an email
0013  * to license@zend.com so we can send you a copy immediately.
0014  *
0015  * @category   Zend
0016  * @package    Zend_Rest
0017  * @copyright  Copyright (c) 2005-2015 Zend Technologies USA Inc. (http://www.zend.com)
0018  * @license    http://framework.zend.com/license/new-bsd     New BSD License
0019  * @version    $Id$
0020  */
0021
0022 /** Zend_Controller_Action */
0023 // require_once 'Zend/Controller/Action.php';
0024
0025 /**
0026  * An abstract class to guide implementation of action controllers for use with
0027  * Zend_Rest_Route.
0028  *
0029  * @category   Zend
0030  * @package Zend_Rest
0031  * @see Zend_Rest_Route
0032  * @copyright  Copyright (c) 2005-2015 Zend Technologies USA Inc. (http://www.zend.com)
0033  * @license    http://framework.zend.com/license/new-bsd     New BSD License
0034  */
0035 abstract class Zend_Rest_Controller extends Zend_Controller_Action
0036 {
0037     /**
0038      * The index action handles index/list requests; it should respond with a
0039      * list of the requested resources.
0040      */
0041     abstract public function indexAction();
0042
0043     /**
0044      * The get action handles GET requests and receives an 'id' parameter; it
0045      * should respond with the server resource state of the resource identified
0046      * by the 'id' value.
0047      */
0048     abstract public function getAction();
0049
0050     /**
0051      * The head action handles HEAD requests and receives an 'id' parameter; it
0052      * should respond with the server resource state of the resource identified
0053      * by the 'id' value.
0054      */
0055     abstract public function headAction();
0056
0057     /**
0058      * The post action handles POST requests; it should accept and digest a
0059      * POSTed resource representation and persist the resource state.
0060      */
0061     abstract public function postAction();
0062
0063     /**
0064      * The put action handles PUT requests and receives an 'id' parameter; it
0065      * should update the server resource state of the resource identified by
0066      * the 'id' value.
0067      */
0068     abstract public function putAction();
0069
0070     /**
0071      * The delete action handles DELETE requests and receives an 'id'
0072      * parameter; it should update the server resource state of the resource
0073      * identified by the 'id' value.
0074      */
0075     abstract public function deleteAction();
0076
0077 }