data/controller.php

   1 <?php
   2 // Hoplite
   3 // Copyright (c) 2011 Blue Static
   4 //
   5 // This program is free software: you can redistribute it and/or modify it
   6 // under the terms of the GNU General Public License as published by the Free
   7 // Software Foundation, either version 3 of the License, or any later version.
   8 //
   9 // This program is distributed in the hope that it will be useful, but WITHOUT
  10 // ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
  11 // FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License for
  12 // more details.
  13 //
  14 // You should have received a copy of the GNU General Public License along with
  15 // this program.  If not, see <http://www.gnu.org/licenses/>.
  16
  17 namespace hoplite\data;
  18 use \hoplite\http as http;
  19
  20 require_once HOPLITE_ROOT . '/http/response_code.php';
  21 require_once HOPLITE_ROOT . '/http/rest_action.php';
  22
  23 /*!
  24   A Controller is a RESTful http\Action that is used to bind a data\Model to a
  25   web interface. Subclass this in order to perform business logic such as
  26   validation and authentication.
  27
  28   This class is semi-abstract in that it cannot be used directly. At minimum,
  29   _SelectModel() needs to be overridden to select the Model to use.
  30 */
  31 abstract class Controller extends http\RestAction
  32 {
  33   /*! @var hoplite\data\Model The object that will be operated on. */
  34   protected $model = NULL;
  35
  36   /*! Selects the Model object. */
  37   public function FilterRequest(http\Request $request, http\Response $response)
  38   {
  39     $this->model = $this->_SelectModel();
  40     $this->model->SetFrom(array_merge(
  41         $request->data, $request->data['_POST'], $request->data['_GET']));
  42   }
  43
  44   /*! Returns a new instance of the Model that this object will control. */
  45   abstract protected function _SelectModel();
  46
  47   /*! Gets the data from the model. */
  48   public function DoGet(http\Request $request, http\Response $response)
  49   {
  50     try {
  51       $response->data = $this->model->Fetch();
  52     } catch (ModelException $e) {
  53       $response->body = $e->GetMessage();
  54       $response->response_code = http\ResponseCode::NOT_FOUND;
  55     } catch (\PDOException $e) {
  56       $response->body = $e->GetMessage();
  57       $response->response_code = http\ResponseCode::INTERNAL_SERVER_ERROR;
  58     }
  59   }
  60
  61   /*! Updates an object in the store. */
  62   public function DoPost(http\Request $request, http\Response $response)
  63   {
  64     try {
  65       $this->model->Update();
  66       $response->data = $this->model->Fetch();
  67     } catch (ModelException $e) {
  68       $response->body = $e->GetMessage();
  69       $response->response_code = http\ResponseCode::NOT_FOUND;
  70     } catch (\PDOException $e) {
  71       $response->body = $e->GetMessage();
  72       $response->response_code = http\ResponseCode::INTERNAL_SERVER_ERROR;
  73     }
  74   }
  75
  76   /*! Deletes the object from the store. */
  77   public function DoDelete(http\Request $request, http\Response $response)
  78   {
  79     try {
  80       $this->model->Delete();
  81     } catch (ModelException $e) {
  82       $response->body = $e->GetMessage();
  83       $response->response_code = http\ResponseCode::BAD_REQUEST;
  84     } catch (\PDOException $e) {
  85       $response->body = $e->GetMessage();
  86       $response->response_code = http\ResponseCode::INTERNAL_SERVER_ERROR;
  87     }
  88   }
  89
  90   /*! Updates an object in the store. */
  91   public function DoPut(http\Request $request, http\Response $response)
  92   {
  93     try {
  94       $this->model->Insert();
  95       $response->data = $this->model->Fetch();
  96     } catch (ModelException $e) {
  97       $response->body = $e->GetMessage();
  98       $response->response_code = http\ResponseCode::BAD_REQUEST;
  99     } catch (\PDOException $e) {
 100       $response->body = $e->GetMessage();
 101       $response->response_code = http\ResponseCode::INTERNAL_SERVER_ERROR;
 102     }
 103   }
 104 }
 105
 106 class ControllerException extends \Exception {}