├── application
    ├── modules
    │   ├── api
    │   │   ├── views
    │   │   │   └── scripts
    │   │   │   │   └── index
    │   │   │   │       └── index.phtml
    │   │   ├── controllers
    │   │   │   ├── IndexController.php
    │   │   │   ├── ErrorController.php
    │   │   │   └── FooController.php
    │   │   └── Bootstrap.php
    │   └── default
    │   │   ├── Bootstrap.php
    │   │   ├── controllers
    │   │       ├── IndexController.php
    │   │       └── ErrorController.php
    │   │   └── views
    │   │       └── scripts
    │   │           ├── error
    │   │               └── error.phtml
    │   │           └── index
    │   │               └── index.phtml
    ├── Bootstrap.php
    └── configs
    │   └── application.ini
├── public
    ├── .htaccess
    └── index.php
├── .gitmodules
├── README.md
└── LICENSE


/application/modules/api/views/scripts/index/index.phtml:
--------------------------------------------------------------------------------
1 | <h1>Api Module landing page</h1>
2 | 


--------------------------------------------------------------------------------
/application/modules/default/Bootstrap.php:
--------------------------------------------------------------------------------
1 | <?php
2 | /**
3 |  * Description of Bootstrap
4 |  */
5 | class Default_Bootstrap extends Zend_Application_Module_Bootstrap 
6 | {
7 | }
8 | 


--------------------------------------------------------------------------------
/public/.htaccess:
--------------------------------------------------------------------------------
1 | 
2 | RewriteEngine On
3 | RewriteCond %{REQUEST_FILENAME} -s [OR]
4 | RewriteCond %{REQUEST_FILENAME} -l [OR]
5 | RewriteCond %{REQUEST_FILENAME} -d
6 | RewriteRule ^.*$ - [NC,L]
7 | RewriteRule ^.*$ index.php [NC,L]
8 | 


--------------------------------------------------------------------------------
/.gitmodules:
--------------------------------------------------------------------------------
1 | [submodule "library/REST"]
2 | 	path = library/REST
3 | 	url = git://github.com/codeinchaos/restful-zend-framework.git
4 | [submodule "library/Zend"]
5 | 	path = library/Zend
6 | 	url = git://github.com/codeinchaos/zend-framework.git
7 | 


--------------------------------------------------------------------------------
/application/modules/api/controllers/IndexController.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | /**
 3 |  * Regular controller
 4 |  **/
 5 | class Api_IndexController extends Zend_Controller_Action
 6 | {
 7 |     public function indexAction()
 8 |     {
 9 |     }
10 | }
11 | 


--------------------------------------------------------------------------------
/application/modules/default/controllers/IndexController.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | class Default_IndexController extends Zend_Controller_Action
 4 | {
 5 | 
 6 |     public function init()
 7 |     {
 8 |         /* Initialize action controller here */
 9 |     }
10 | 
11 |     public function indexAction()
12 |     {
13 |         // action body
14 |     }
15 | 
16 | 
17 | }
18 | 
19 | 


--------------------------------------------------------------------------------
/README.md:
--------------------------------------------------------------------------------
1 | # RESTful Applications with Zend Framework [Example]
2 | 
3 | This is an **example** to demonstrate the usage of [RESTful Zend Framework Extension](https://github.com/ahmadnassri/restful-zend-framework) which allows to create RESTful Controllers with ease.
4 | 
5 | for implementation details please refer to [github.com/ahmadnassri/restful-zend-framework](https://github.com/ahmadnassri/restful-zend-framework).
6 | 


--------------------------------------------------------------------------------
/application/Bootstrap.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | class Bootstrap extends Zend_Application_Bootstrap_Bootstrap
 3 | {
 4 |     public function _initREST()
 5 |     {
 6 |         $frontController = Zend_Controller_Front::getInstance();
 7 | 
 8 |         // set custom request object
 9 |         $frontController->setRequest(new REST_Request);
10 |         $frontController->setResponse(new REST_Response);
11 | 
12 |         // add the REST route for the API module only
13 |         $restRoute = new Zend_Rest_Route($frontController, array(), array('api'));
14 |         $frontController->getRouter()->addRoute('rest', $restRoute);
15 |     }
16 | }
17 | 
18 | 


--------------------------------------------------------------------------------
/application/modules/api/Bootstrap.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | class Api_Bootstrap extends Zend_Application_Module_Bootstrap
 3 | {
 4 |     public function _initREST()
 5 |     {
 6 |         $frontController = Zend_Controller_Front::getInstance();
 7 | 
 8 |         // register the RestHandler plugin
 9 |         $frontController->registerPlugin(new REST_Controller_Plugin_RestHandler($frontController));
10 | 
11 |         // add REST contextSwitch helper
12 |         $contextSwitch = new REST_Controller_Action_Helper_ContextSwitch();
13 |         Zend_Controller_Action_HelperBroker::addHelper($contextSwitch);
14 | 
15 |         // add restContexts helper
16 |         $restContexts = new REST_Controller_Action_Helper_RestContexts();
17 |         Zend_Controller_Action_HelperBroker::addHelper($restContexts);
18 |     }
19 | }
20 | 


--------------------------------------------------------------------------------
/public/index.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | // Define path to application directory
 4 | defined('APPLICATION_PATH')
 5 |     || define('APPLICATION_PATH', realpath(dirname(__FILE__) . '/../application'));
 6 | 
 7 | // Define application environment
 8 | defined('APPLICATION_ENV')
 9 |     || define('APPLICATION_ENV', (getenv('APPLICATION_ENV') ? getenv('APPLICATION_ENV') : 'production'));
10 | 
11 | // Ensure library/ is on include_path
12 | set_include_path(implode(PATH_SEPARATOR, array(
13 |     realpath(APPLICATION_PATH . '/../library'),
14 |     get_include_path(),
15 | )));
16 | 
17 | /** Zend_Application */
18 | require_once 'Zend/Application.php';
19 | 
20 | // Create application, bootstrap, and run
21 | $application = new Zend_Application(
22 |     APPLICATION_ENV,
23 |     APPLICATION_PATH . '/configs/application.ini'
24 | );
25 | $application->bootstrap()
26 |             ->run();
27 | 


--------------------------------------------------------------------------------
/application/modules/default/views/scripts/error/error.phtml:
--------------------------------------------------------------------------------
 1 | <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
 2 | <html xmlns="http://www.w3.org/1999/xhtml">
 3 | <head>
 4 |   <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
 5 |   <title>Zend Framework Default Application</title>
 6 | </head>
 7 | <body>
 8 |   <h1>An error occurred</h1>
 9 |   <h2><?php echo $this->message ?></h2>
10 | 
11 |   <?php if (isset($this->exception)): ?>
12 |   
13 |   <h3>Exception information:</h3>
14 |   <p>
15 |       <b>Message:</b> <?php echo $this->exception->getMessage() ?>
16 |   </p>
17 | 
18 |   <h3>Stack trace:</h3>
19 |   <pre><?php echo $this->exception->getTraceAsString() ?>
20 |   </pre>
21 | 
22 |   <h3>Request Parameters:</h3>
23 |   <pre><?php echo $this->escape(var_export($this->request->getParams(), true)) ?>
24 |   </pre>
25 | 
26 |   <?php endif ?>
27 | 
28 | </body>
29 | </html>
30 | 


--------------------------------------------------------------------------------
/application/configs/application.ini:
--------------------------------------------------------------------------------
 1 | [production]
 2 | phpSettings.display_startup_errors = 0
 3 | phpSettings.display_errors = 0
 4 | 
 5 | includePaths.library = APPLICATION_PATH "/../library"
 6 | 
 7 | bootstrap.path = APPLICATION_PATH "/Bootstrap.php"
 8 | bootstrap.class = "Bootstrap"
 9 | 
10 | appnamespace = "Application"
11 | autoloaderNamespaces[] = "REST_"
12 | 
13 | resources.frontController.params.displayExceptions = 0
14 | resources.frontController.moduleDirectory = APPLICATION_PATH "/modules"
15 | resources.frontController.params.prefixDefaultModule = true
16 | 
17 | resources.modules[] = ""
18 | 
19 | rest.default = "json"
20 | rest.formats[] = "xml"
21 | rest.formats[] = "json"
22 | 
23 | [staging : production]
24 | 
25 | [testing : production]
26 | phpSettings.display_startup_errors = 1
27 | phpSettings.display_errors = 1
28 | 
29 | [development : production]
30 | phpSettings.display_startup_errors = 1
31 | phpSettings.display_errors = 1
32 | resources.frontController.params.displayExceptions = 1
33 | 


--------------------------------------------------------------------------------
/LICENSE:
--------------------------------------------------------------------------------
 1 | Copyright (c) 2011 Code in Chaos Inc. http://www.codeinchaos.com
 2 | 
 3 | Permission is hereby granted, free of charge, to any person obtaining
 4 | a copy of this software and associated documentation files (the
 5 | "Software"), to deal in the Software without restriction, including
 6 | without limitation the rights to use, copy, modify, merge, publish,
 7 | distribute, sublicense, and/or sell copies of the Software, and to
 8 | permit persons to whom the Software is furnished to do so, subject to
 9 | the following conditions:
10 | 
11 | The above copyright notice and this permission notice shall be
12 | included in all copies or substantial portions of the Software.
13 | 
14 | THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
15 | EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
16 | MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
17 | NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
18 | LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
19 | OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
20 | WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
21 | 


--------------------------------------------------------------------------------
/application/modules/default/views/scripts/index/index.phtml:
--------------------------------------------------------------------------------
 1 | <style>
 2 |     a:link,
 3 |     a:visited
 4 |     {
 5 |         color: #0398CA;
 6 |     }
 7 | 
 8 |     span#zf-name
 9 |     {
10 |         color: #91BE3F;
11 |     }
12 | 
13 |     div#welcome
14 |     {
15 |         color: #FFFFFF;
16 |         background-image: url(http://framework.zend.com/images/bkg_header.jpg);
17 |         width:  600px;
18 |         height: 400px;
19 |         border: 2px solid #444444;
20 |         overflow: hidden;
21 |         text-align: center;
22 |     }
23 | 
24 |     div#more-information
25 |     {
26 |         background-image: url(http://framework.zend.com/images/bkg_body-bottom.gif);
27 |         height: 100%;
28 |     }
29 | </style>
30 | <div id="welcome">
31 |     <h1>Welcome to the <span id="zf-name">Zend Framework!</span></h1>
32 | 
33 |     <h3>This is your project's main page</h3>
34 | 
35 |     <div id="more-information">
36 |         <p><img src="http://framework.zend.com/images/PoweredBy_ZF_4LightBG.png" /></p>
37 |         <p>
38 |             Helpful Links: <br />
39 |             <a href="http://framework.zend.com/">Zend Framework Website</a> |
40 |             <a href="http://framework.zend.com/manual/en/">Zend Framework Manual</a>
41 |         </p>
42 |     </div>
43 | </div>


--------------------------------------------------------------------------------
/application/modules/default/controllers/ErrorController.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | class Default_ErrorController extends Zend_Controller_Action
 4 | {
 5 | 
 6 |     public function errorAction()
 7 |     {
 8 |         $errors = $this->_getParam('error_handler');
 9 | 
10 |         if (!$errors || !$errors instanceof ArrayObject) {
11 |             $this->view->message = 'You have reached the error page';
12 |             return;
13 |         }
14 | 
15 |         switch ($errors->type) {
16 |             case Zend_Controller_Plugin_ErrorHandler::EXCEPTION_NO_ROUTE:
17 |             case Zend_Controller_Plugin_ErrorHandler::EXCEPTION_NO_CONTROLLER:
18 |             case Zend_Controller_Plugin_ErrorHandler::EXCEPTION_NO_ACTION:
19 |                 // 404 error -- controller or action not found
20 |                 $this->getResponse()->setHttpResponseCode(404);
21 |                 $priority = Zend_Log::NOTICE;
22 |                 $this->view->message = 'Page not found';
23 |                 break;
24 |             default:
25 |                 // application error
26 |                 $this->getResponse()->setHttpResponseCode(500);
27 |                 $priority = Zend_Log::CRIT;
28 |                 $this->view->message = 'Application error';
29 |                 break;
30 |         }
31 | 
32 |         // Log exception, if logger available
33 |         if ($log = $this->getLog()) {
34 |             $log->log($this->view->message, $priority, $errors->exception);
35 |             $log->log('Request Parameters', $priority, $errors->request->getParams());
36 |         }
37 | 
38 |         // conditionally display exceptions
39 |         if ($this->getInvokeArg('displayExceptions') == true) {
40 |             $this->view->exception = $errors->exception;
41 |         }
42 | 
43 |         $this->view->request   = $errors->request;
44 |     }
45 | 
46 |     public function getLog()
47 |     {
48 |         $bootstrap = $this->getInvokeArg('bootstrap');
49 |         if (!$bootstrap->hasResource('Log')) {
50 |             return false;
51 |         }
52 |         $log = $bootstrap->getResource('Log');
53 |         return $log;
54 |     }
55 | 
56 | 
57 | }
58 | 
59 | 


--------------------------------------------------------------------------------
/application/modules/api/controllers/ErrorController.php:
--------------------------------------------------------------------------------
  1 | <?php
  2 | /**
  3 |  * RESTful ErrorController
  4 |  *
  5 |  **/
  6 | class Api_ErrorController extends REST_Controller
  7 | {
  8 |     public function errorAction()
  9 |     {
 10 |         if ($this->_request->hasError()) {
 11 |             $error = $this->_request->getError();
 12 |             $this->view->message = $error->message;
 13 |             $this->getResponse()->setHttpResponseCode($error->code);
 14 |             return;
 15 |         }
 16 | 
 17 |         $errors = $this->_getParam('error_handler');
 18 | 
 19 |         if (!$errors || !$errors instanceof ArrayObject) {
 20 |             $this->view->message = 'You have reached the error page';
 21 |             return;
 22 |         }
 23 | 
 24 |         switch ($errors->type) {
 25 |             case Zend_Controller_Plugin_ErrorHandler::EXCEPTION_NO_ROUTE:
 26 |             case Zend_Controller_Plugin_ErrorHandler::EXCEPTION_NO_CONTROLLER:
 27 |             case Zend_Controller_Plugin_ErrorHandler::EXCEPTION_NO_ACTION:
 28 |                 // 404 error -- controller or action not found
 29 |                 $this->view->message = 'Page not found';
 30 |                 $this->getResponse()->setHttpResponseCode(404);
 31 |                 break;
 32 | 
 33 |             default:
 34 |                 // application error
 35 |                 $this->view->message = 'Application error';
 36 |                 $this->getResponse()->setHttpResponseCode(500);
 37 |                 break;
 38 |         }
 39 | 
 40 |         // conditionally display exceptions
 41 |         if ($this->getInvokeArg('displayExceptions') == true) {
 42 |             $this->view->exception = $errors->exception->getMessage();
 43 |         }
 44 |     }
 45 | 
 46 |     /**
 47 |      * Catch-All
 48 |      * useful for custom HTTP Methods
 49 |      *
 50 |      **/
 51 |     public function __callAction()
 52 |     {
 53 |     }
 54 | 
 55 |     /**
 56 |      * Index Action
 57 |      *
 58 |      * @return void
 59 |      */
 60 |     public function indexAction()
 61 |     {
 62 |     }
 63 | 
 64 |     /**
 65 |      * GET Action
 66 |      *
 67 |      * @return void
 68 |      */
 69 |     public function getAction()
 70 |     {
 71 |     }
 72 | 
 73 |     /**
 74 |      * POST Action
 75 |      *
 76 |      * @return void
 77 |      */
 78 |     public function postAction()
 79 |     {
 80 |     }
 81 | 
 82 |     /**
 83 |      * PUT Action
 84 |      *
 85 |      * @return void
 86 |      */
 87 |     public function putAction()
 88 |     {
 89 |     }
 90 | 
 91 |     /**
 92 |      * DELETE Action
 93 |      *
 94 |      * @return void
 95 |      */
 96 |     public function deleteAction()
 97 |     {
 98 |     }
 99 | }
100 | 
101 | 


--------------------------------------------------------------------------------
/application/modules/api/controllers/FooController.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | /**
 3 |  *  Sample Foo Resource
 4 |  */
 5 | class Api_FooController extends REST_Controller
 6 | {
 7 |     /**
 8 |      * The index action handles index/list requests; it should respond with a
 9 |      * list of the requested resources.
10 |      */
11 |     public function indexAction()
12 |     {
13 |         $this->view->message = 'indexAction has been called.';
14 |         $this->_response->ok();
15 |     }
16 | 
17 |     /**
18 |      * The head action handles HEAD requests; it should respond with an
19 |      * identical response to the one that would correspond to a GET request,
20 |      * but without the response body.
21 |      */
22 |     public function headAction()
23 |     {
24 |         $this->view->message = 'headAction has been called';
25 |         $this->_response->ok();
26 |     }
27 | 
28 |     /**
29 |      * The get action handles GET requests and receives an 'id' parameter; it
30 |      * should respond with the server resource state of the resource identified
31 |      * by the 'id' value.
32 |      */
33 |     public function getAction()
34 |     {
35 |         $id = $this->_getParam('id', 0);
36 | 
37 |         $this->view->id = $id;
38 |         $this->view->message = sprintf('Resource #%s', $id);
39 |         $this->_response->ok();
40 |     }
41 | 
42 |     /**
43 |      * The post action handles POST requests; it should accept and digest a
44 |      * POSTed resource representation and persist the resource state.
45 |      */
46 |     public function postAction()
47 |     {
48 |         $this->view->params = $this->_request->getParams();
49 |         $this->view->message = 'Resource Created';
50 |         $this->_response->created();
51 |     }
52 | 
53 |     /**
54 |      * The put action handles PUT requests and receives an 'id' parameter; it
55 |      * should update the server resource state of the resource identified by
56 |      * the 'id' value.
57 |      */
58 |     public function putAction()
59 |     {
60 |         $id = $this->_getParam('id', 0);
61 | 
62 |         $this->view->id = $id;
63 |         $this->view->params = $this->_request->getParams();
64 |         $this->view->message = sprintf('Resource #%s Updated', $id);
65 |         $this->_response->ok();
66 |     }
67 | 
68 |     /**
69 |      * The delete action handles DELETE requests and receives an 'id'
70 |      * parameter; it should update the server resource state of the resource
71 |      * identified by the 'id' value.
72 |      */
73 |     public function deleteAction()
74 |     {
75 |         $id = $this->_getParam('id', 0);
76 | 
77 |         $this->view->id = $id;
78 |         $this->view->message = sprintf('Resource #%s Deleted', $id);
79 |         $this->_response->ok();
80 |     }
81 | }
82 | 


--------------------------------------------------------------------------------