/components/ERestController.php

<?php
class ERestController extends Controller
{
	Const APPLICATION_ID = 'REST';
	Const C404NOTFOUND = 'HTTP/1.1 404 Not Found';
	Const C401UNAUTHORIZED = 'HTTP/1.1 401 Unauthorized';
	Const C406NOTACCEPTABLE = 'HTTP/1.1 406 Not Acceptable';
	Const C201CREATED = 'HTTP/1.1 201 Created';
	Const C200OK = 'HTTP/1.1 200 OK';
	Const C500INTERNALSERVERERROR = 'HTTP/1.1 500 Internal Server Error';
	Const USERNAME = 'admin@restuser';
	Const PASSWORD = 'admin@Access';

	public $HTTPStatus = 'HTTP/1.1 200 OK';

	protected $requestReader;
	protected $model = null;

	public function __construct($id, $module = null) {
		parent::__construct($id, $module);
		$this->requestReader = new ERequestReader('php://input');
	}

	public function filters() {
		$restFilters = array('restAccessRules+ restList restView restCreate restUpdate restDelete');
		if(method_exists($this, '_filters'))
			return CMap::mergeArray($restFilters, $this->_filters());
		else
			return $restFilters;
	} 

	public function accessRules()
	{
	$restAccessRules = array(
		array('allow',	// allow all users to perform 'index' and 'view' actions
				'actions'=>array('restList', 'restView', 'restCreate', 'restUpdate', 'restDelete', 'error'),
				'users'=>array('*'),
		));

	if(method_exists($this, '_accessRules'))
		return CMap::mergeArray($restAccessRules, $this->_accessRules());
	else
		return $restAccessRules;
	}	

	/**
	 * Controls access to restfull requests
	 */ 
	public function filterRestAccessRules( $c )
  {
    Yii::app()->clientScript->reset(); //Remove any scripts registered by Controller Class

    //For requests from JS check that a user is loged in and throw validateUser
    //validateUser can/should be overridden in your controller.
    if(!Yii::app()->user->isGuest && $this->validateAjaxUser($this->action->id)) 
      $c->run(); 
    else 
    {
      Yii::app()->errorHandler->errorAction = '/' . $this->uniqueid . '/error';

      if(!(isset($_SERVER['HTTP_X_'.self::APPLICATION_ID.'_USERNAME']) and isset($_SERVER['HTTP_X_'.self::APPLICATION_ID.'_PASSWORD']))) {
        // Error: Unauthorized
        throw new CHttpException(401, 'You are not authorized to proform this action.');
      }
      $username = $_SERVER['HTTP_X_'.self::APPLICATION_ID.'_USERNAME'];
      $password = $_SERVER['HTTP_X_'.self::APPLICATION_ID.'_PASSWORD'];
      // Find the user
      if($username != self::USERNAME)
      {
        // Error: Unauthorized
        throw new CHttpException(401, 'Error: User Name is invalid');
      } 
      else if($password != self::PASSWORD) 
      {
        // Error: Unauthorized
        throw new CHttpException(401, 'Error: User Password is invalid');
      } 
      // This tells the filter chain $c to keep processing.
      $c->run(); 
    }
  }	


	/**
	 * Custom error handler for restfull Errors
	 */ 
	public function actionError()
	{
    if($error=Yii::app()->errorHandler->error)
    {
      if(!Yii::app()->request->isAjaxRequest)
        $this->HTTPStatus = $this->getHttpStatus($error['code'], 'C500INTERNALSERVERERROR');

      $this->renderJson(array('success' => false, 'message' => $error['message'], 'data' => array('errorCode'=>$error['code'])));
    }
	}

	/**
	 * Get HTTP Status Headers From code
	 */ 
	public function getHttpStatus($statusCode, $default='C200OK')
	{
	switch ($statusCode) {
		case '200':
		return self::C200OK;
		break;
		case '201':
		return self::C201CREATED;
		break;
		case '401':
		return self::C401UNAUTHORIZED;
		break;
		case '404':
		return self::C404NOTFOUND;
		break;
		case '406':
		return self::C406NOTACCEPTABLE;
		break;
		case '500':
		return self::C500INTERNALSERVERERROR;
		break;
		default:
		return self::$default;
	}
	}

 /**
	****************************************************************************************** 
	******************************************************************************************
	* Actions that are tiggered by RESTFull requests
	* To change their default behavoir 
	* you should overide "doRest..." Methods in the controller 
	* and leave these actions as is
	******************************************************************************************
	******************************************************************************************
	 */

	/**
	 * Renders list of data assosiated with controller as json
	 */
  public function actionRestList() {
	  $this->doRestList();
	}
	
	/**
	 * Renders View of record as json
	 * Or Custom method
	 */ 
	public function actionRestView($id, $var=null, $var2=null)
	{
	//If the value is numeric we can assume we have a record ID
	if($this->isPk($id))
		$this->doRestView($id);
	else
	{
		//if the $id is not numeric 
		//we are assume that the client is attempting to call a custom method
		//There may optionaly be a second param `$var` passed in the url
		if(isset($var) && isset($var2))
		$var = array($var, $var2);
		$id = 'doCustomRestGet' . ucfirst($id);
		if(method_exists($this, $id))
		$this->$id($var);
		else
		throw new CHttpException(500, 'Method does not exist.');
	}
	}

	/**
	 * Updated record
	 */ 
	public function actionRestUpdate($id, $var=false)
	{
		$this->HTTPStatus = $this->getHttpStatus('201');

		if(!$var)
			$this->doRestUpdate($id, $this->data());
		else
		{
			$var = 'doCustomRestPut' . ucfirst($var);
			if(method_exists($this, $var))
				$this->$var($id, $this->data());
			else if($this->isPk($var))
				$this->doRestUpdate($id, $this->data());
			else
				throw new CHttpException(500, 'Method does not exist.');
		}
	}

	/**
	 * Creates new record
	 */ 
	public function actionRestCreate($id=null) {
		$this->HTTPStatus = $this->getHttpStatus('201');

		if(!$id) {
			$this->doRestCreate($this->data());
		}
		else
		{
			//we can assume if $id is set the user is trying to call a custom method
			$id = 'doCustomRestPost' . ucfirst($id);
			if(method_exists($this, $id))
				$this->$id($this->data());
			else if($this->isPk($var))
				$this->doRestCreate($this->data());
			else
				throw new CHttpException(500, 'Method does not exist.');
		}
	}

	/**
	 * Deletes record
	 */ 
	public function actionRestDelete($id)
	{
	$this->doRestDelete($id);
	}

	 /**
	****************************************************************************************** 
	******************************************************************************************
	* Helper functions for processing Rest data 
	******************************************************************************************
	******************************************************************************************
	 */
	
	/**
	 * Takes array and renders Json String
	 */ 
	protected function renderJson($data) {
		$this->layout = 'ext.restfullyii.views.layouts.json';
		$this->render('ext.restfullyii.views.api.output', array('data'=>$data));
	}


	/**
	 * Get data submited by the client
	 */ 
	public function data() {
    $request = $this->requestReader->getContents();
		if ($request) {
      if ($json_post = CJSON::decode($request)){
				return $json_post;
			}else{
				parse_str($request,$variables);
				return $variables;
			}
		}
		return false;
	}

	/**
	 * Returns the model assosiated with this controller.
	 * The assumption is that the model name matches your controller name
	 * If this is not the case you should override this method in your controller
	 */ 
  public function getModel() {
		if ($this->model === null) {
      $modelName = str_replace('Controller', '', get_class($this)); 
      $this->model = new $modelName;
		}
		return $this->model;
	}

	/**
	* Helper for loading a single model
	*/
	protected function loadModel($id) {
		return $this->getModel()->findByPk($id);
	}
	
	/**
	 * Helper for saving single/mutliple models 
	 * Multiple models now working
	 */ 
  private function saveModel($model, $data) {
		if(!isset($data[0])) {
			$model->attributes = $data;
			$models[] = $model;
		}
    else {
			for($i=0; $i<count($data); $i++) {
				$models[$i] = $this->getModel();
				$models[$i]->attributes = $data[$i];
				if(!$models[$i]->validate())
          throw new CHttpException(406, 'Model could not be saved as vildation failed.');
        $this->model = null; //Unsetting model to null to force create new model object.
			}
		}

    for($cnt=0;$cnt<count($models);$cnt++) {
      $temp = $models[$cnt];
			if(!$temp->save())
				throw new CHttpException(406, 'Model could not be saved');
			else
        $ids[] = $temp->id;
      unset($temp);
		}
		return $ids;
	} 


	/**
	****************************************************************************************** 
	******************************************************************************************
	* OVERIDE THE METHODS BELOW IN YOUR CONTROLLER TO REMOVE/ALTER DEFAULT FUNCTIONALITY
	******************************************************************************************
	******************************************************************************************
	 */
	
	/**
	 * Override this function if your model uses a non Numeric PK.
	 */
	public function isPk($pk) {
		return filter_var($pk, FILTER_VALIDATE_INT) !== false;
  } 

  /**
   * You should override this method to provide stronger access control 
   * to specifc restfull actions via AJAX
   */ 
  public function validateAjaxUser($action)
  {
    return false;
  }

	/**
	 * This is broken out as a sperate method from actionRestList 
	 * To allow for easy overriding in the controller
	 * and to allow for easy unit testing
	 */ 
	public function doRestList()
	{
	$this->renderJson(array('success'=>true, 'message'=>'Records Retrieved Successfully', 'data'=>$this->getModel()->findAll()));
	}

	 /**
	 * This is broken out as a sperate method from actionRestView
	 * To allow for easy overriding in the controller
	 * adn to allow for easy unit testing
	 */ 
	public function doRestView($id)
	{
	$this->renderJson(array('success'=>true, 'message'=>'Record Retrieved Successfully', 'data'=>$this->loadModel($id)));
	}

	/**
	 * This is broken out as a sperate method from actionResUpdate 
	 * To allow for easy overriding in the controller
	 * and to allow for easy unit testing
	 */ 
	public function doRestUpdate($id, $data) {		
		$model = $this->saveModel($this->loadModel($id), $data);
		$this->renderJson(array('success'=>true, 'message'=>'Record Updated', 'data'=>array('id'=>$id)));
	}
	
	/**
	 * This is broken out as a sperate method from actionRestCreate 
	 * To allow for easy overriding in the controller
	 * and to alow for easy unit testing
	 */ 
	public function doRestCreate($data) {
		$model = $this->getModel();
		$ids = $this->saveModel($model, $data);
		$this->renderJson(array('success'=>true, 'message'=>'Record(s) Created', 'data'=>array('id'=>$ids)));
	}
	
	/**
	 * This is broken out as a sperate method from actionRestDelete 
	 * To allow for easy overridding in the controller
	 * and to alow for easy unit testing
	 */ 
	public function doRestDelete($id)
	{
	$model = $this->loadModel($id);
	if($model->delete())
		$data = array('success'=>true, 'message'=>'Record Deleted', 'data'=>array('id'=>$id));
	else
		throw new CHttpException(406, 'Could not delete model with ID: ' . $id);

	$this->renderJson($data);
	}


  /**
   * Provides the ability to Limit and offset results
   * http://example.local/api/sample/limit/1/2
   * The above example would limit results to 1
   * and offest them by 2
   */ 
	public function doCustomRestGetLimit($var) {
		$criteria = new CDbCriteria();
		
		if(is_array($var)){
	  	  $criteria->limit = $var[0];
	  	  $criteria->offset = $var[1];
		}
		else {
	  	  $criteria->limit = $var;
		}

		$this->renderJson(array('success'=>true, 'message'=>'Records Retrieved Successfully', 'data'=>$this->getModel()->findAll($criteria)));
	}

	/**
	 * Returns the current record count
	 * http://example.local/api/sample/count
	 */ 
	public function doCustomRestGetCount($var=null, $remote=true) {
    	$this->renderJson(array('success'=>true, 'message'=>'Record Count Retrieved Successfully', 'data'=>array('count'=> $this->getModel()->count() )));
	}

	/**
	 * Search by attribute
	 * Simply post a list of attributes and values you wish to search by
	 * http://example.local/api/sample/search
	 * POST = {'id':'6', 'name':'evan'}
	 */ 
	public function doCustomRestPostSearch($data)
	{
	$this->renderJson(array('success'=>true, 'message'=>'Records Retrieved Successfully', 'data'=>$this->getModel()->findAllByAttributes($data)));		
	}

	public function setRequestReader($requestReader) {
		$this->requestReader = $requestReader;
	}

	public function setModel($model) {
		$this->model = $model;
	}
}