Dropped response class
Seems pointless to have class that had a single method that basically contained all of the shit that the resource already had and knew. Moved respond() method to the response class and moved all of the response validation logic and errors from the router to the response class.
This commit is contained in:
Josh Sherman
parent
a749c80d93
commit
141ac693cb
3 changed files with 166 additions and 193 deletions
|
|
@ -36,15 +36,6 @@ class Resource extends Object
|
|||
*/
|
||||
public $secure = false;
|
||||
|
||||
/**
|
||||
* Required
|
||||
*
|
||||
* Variables that are required.
|
||||
*
|
||||
* @var array
|
||||
*/
|
||||
public $required = [];
|
||||
|
||||
/**
|
||||
* Filter
|
||||
*
|
||||
|
|
@ -63,16 +54,16 @@ class Resource extends Object
|
|||
*/
|
||||
public $validate = [];
|
||||
|
||||
// @todo
|
||||
public $status = 200;
|
||||
public $message = 'OK';
|
||||
public $echo = false;
|
||||
public $limit = false;
|
||||
public $offset = false;
|
||||
public $errors = [];
|
||||
public $uids = [];
|
||||
|
||||
// @todo if $status != 200 && $message == 'OK' ...
|
||||
// @todo Document this
|
||||
public $status = 200;
|
||||
public $message = 'OK';
|
||||
public $echo = false;
|
||||
public $limit = false;
|
||||
public $offset = false;
|
||||
public $errors = [];
|
||||
public $uids = [];
|
||||
public $response = false;
|
||||
public $profiler = false;
|
||||
|
||||
/**
|
||||
* Constructor
|
||||
|
|
@ -86,90 +77,173 @@ class Resource extends Object
|
|||
{
|
||||
$this->uids = $uids;
|
||||
|
||||
parent::__construct(['cache', 'db']);
|
||||
|
||||
$method = $_SERVER['REQUEST_METHOD'];
|
||||
$filter = isset($this->filter[$method]);
|
||||
$validate = isset($this->validate[$method]);
|
||||
|
||||
if ($filter || $validate)
|
||||
try
|
||||
{
|
||||
// Hack together some new globals
|
||||
if (in_array($method, ['PUT', 'DELETE']))
|
||||
// Determines if we need to serve over HTTP or HTTPS
|
||||
if ($this->secure
|
||||
&& (!isset($_SERVER['HTTPS']) || $_SERVER['HTTPS'] == false))
|
||||
{
|
||||
$GLOBALS['_' . $method] = [];
|
||||
|
||||
// @todo Populate it
|
||||
throw new Exception('400 - SSL is required.');
|
||||
}
|
||||
|
||||
$global =& $GLOBALS['_' . $method];
|
||||
$method = $_SERVER['REQUEST_METHOD'];
|
||||
$filter = isset($this->filter[$method]);
|
||||
$validate = isset($this->validate[$method]);
|
||||
|
||||
// Checks that the required parameters are present
|
||||
// @todo Add in support for uid:* variables
|
||||
if ($validate)
|
||||
if ($filter || $validate)
|
||||
{
|
||||
$variables = [];
|
||||
|
||||
foreach ($this->validate[$method] as $variable => $rules)
|
||||
// Hack together some new globals
|
||||
if (in_array($method, ['PUT', 'DELETE']))
|
||||
{
|
||||
if (!is_array($rules))
|
||||
{
|
||||
$variable = $rules;
|
||||
}
|
||||
$GLOBALS['_' . $method] = [];
|
||||
|
||||
$variables[] = $variable;
|
||||
// @todo Populate it
|
||||
}
|
||||
|
||||
$missing_variables = array_diff($variables, array_keys($global));
|
||||
$global =& $GLOBALS['_' . $method];
|
||||
|
||||
if ($missing_variables !== array())
|
||||
// Checks that the required parameters are present
|
||||
// @todo Add in support for uid:* variables
|
||||
if ($validate)
|
||||
{
|
||||
foreach ($missing_variables as $variable)
|
||||
$variables = [];
|
||||
|
||||
foreach ($this->validate[$method] as $variable => $rules)
|
||||
{
|
||||
$this->errors[$variable] = 'The ' . $variable . ' parameter is required.';
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
foreach ($global as $variable => $value)
|
||||
{
|
||||
// Applies any filters
|
||||
if ($filter && isset($this->filter[$method][$variable]))
|
||||
{
|
||||
// @todo Definitely could see the need to expand this out
|
||||
// to allow for more robust filters to be applied
|
||||
// similar to how the validation logic work.
|
||||
$global[$variable] = $this->filter[$method][$variable]($value);
|
||||
}
|
||||
|
||||
if ($validate && isset($this->validate[$method][$variable]))
|
||||
{
|
||||
$rules = $this->validate[$method][$variable];
|
||||
|
||||
if (is_array($rules))
|
||||
{
|
||||
if (isset($global[$variable]) && !String::isEmpty($global[$variable]))
|
||||
if (!is_array($rules))
|
||||
{
|
||||
if (is_array($rules))
|
||||
{
|
||||
$rule_errors = Validate::isValid($global[$variable], $rules);
|
||||
$variable = $rules;
|
||||
}
|
||||
|
||||
if (is_array($rule_errors))
|
||||
$variables[] = $variable;
|
||||
}
|
||||
|
||||
$missing_variables = array_diff($variables, array_keys($global));
|
||||
|
||||
if ($missing_variables !== array())
|
||||
{
|
||||
foreach ($missing_variables as $variable)
|
||||
{
|
||||
$this->errors[$variable] = 'The ' . $variable . ' parameter is required.';
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
foreach ($global as $variable => $value)
|
||||
{
|
||||
// Applies any filters
|
||||
if ($filter && isset($this->filter[$method][$variable]))
|
||||
{
|
||||
// @todo Definitely could see the need to expand this out
|
||||
// to allow for more robust filters to be applied
|
||||
// similar to how the validation logic work.
|
||||
$global[$variable] = $this->filter[$method][$variable]($value);
|
||||
}
|
||||
|
||||
if ($validate && isset($this->validate[$method][$variable]))
|
||||
{
|
||||
$rules = $this->validate[$method][$variable];
|
||||
|
||||
if (is_array($rules))
|
||||
{
|
||||
if (isset($global[$variable]) && !String::isEmpty($global[$variable]))
|
||||
{
|
||||
if (is_array($rules))
|
||||
{
|
||||
$this->errors[$variable] = $rule_errors[0];
|
||||
$rule_errors = Validate::isValid($global[$variable], $rules);
|
||||
|
||||
if (is_array($rule_errors))
|
||||
{
|
||||
$this->errors[$variable] = $rule_errors[0];
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
// if PUT or DELETE, need to update the super globals directly as
|
||||
// they do not stay in sync. Probably need to make them global in
|
||||
// this class method
|
||||
//
|
||||
// $_PUT = $GLOBALS['_PUT'];
|
||||
}
|
||||
|
||||
// if PUT or DELETE, need to update the super globals directly as
|
||||
// they do not stay in sync. Probably need to make them global in
|
||||
// this class method
|
||||
//
|
||||
// $_PUT = $GLOBALS['_PUT'];
|
||||
if ($this->errors)
|
||||
{
|
||||
throw new Exception('400 - Missing or invalid parameters.');
|
||||
}
|
||||
|
||||
parent::__construct(['cache', 'db']);
|
||||
|
||||
// Checks if the request method has been implemented
|
||||
//if (get_class($this) != 'Resource')
|
||||
{
|
||||
if (!method_exists($this, $method))
|
||||
{
|
||||
throw new Exception('405 - Method not allowed.');
|
||||
}
|
||||
else
|
||||
{
|
||||
// Gets the profiler status
|
||||
// @todo Refactor out that stripos
|
||||
$profiler = $this->config->pickles['profiler'];
|
||||
$profiler = $profiler === true
|
||||
|| stripos($profiler, 'timers') !== false;
|
||||
|
||||
// Starts a timer before the resource is executed
|
||||
if ($profiler)
|
||||
{
|
||||
Profiler::timer('resource ' . $method);
|
||||
}
|
||||
|
||||
$this->response = $this->$method();
|
||||
|
||||
// Stops the resource timer
|
||||
if ($profiler)
|
||||
{
|
||||
Profiler::timer('resource ' . $method);
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
catch (Exception $e)
|
||||
{
|
||||
$this->status = 400;
|
||||
$this->message = $e->getMessage();
|
||||
}
|
||||
}
|
||||
|
||||
public function respond()
|
||||
{
|
||||
header('Content-type: application/json');
|
||||
|
||||
$meta = [
|
||||
'status' => $this->status,
|
||||
'message' => $this->message,
|
||||
];
|
||||
|
||||
foreach (['echo', 'limit', 'offset', 'errors'] as $variable)
|
||||
{
|
||||
if ($this->$variable)
|
||||
{
|
||||
$meta[$variable] = $this->$variable;
|
||||
}
|
||||
}
|
||||
|
||||
$response = ['meta' => $meta];
|
||||
|
||||
foreach (['response', 'profiler'] as $variable)
|
||||
{
|
||||
if ($this->$variable)
|
||||
{
|
||||
$response[$variable] = $this->$variable;
|
||||
}
|
||||
}
|
||||
|
||||
$pretty = isset($_REQUEST['pretty']) ? JSON_PRETTY_PRINT : false;
|
||||
|
||||
echo json_encode($response, $pretty);
|
||||
}
|
||||
}
|
||||
|
||||
|
|
|
|||
|
|
@ -1,46 +0,0 @@
|
|||
<?php
|
||||
|
||||
class Response extends Object
|
||||
{
|
||||
public $status = 200;
|
||||
public $message = 'OK';
|
||||
public $echo = false;
|
||||
public $limit = false;
|
||||
public $offset = false;
|
||||
public $errors = false;
|
||||
public $response = false;
|
||||
public $profiler = false;
|
||||
|
||||
public function respond()
|
||||
{
|
||||
header('Content-type: application/json');
|
||||
|
||||
$meta = [
|
||||
'status' => $this->status,
|
||||
'message' => $this->message,
|
||||
];
|
||||
|
||||
foreach (['echo', 'limit', 'offset', 'errors'] as $variable)
|
||||
{
|
||||
if ($this->$variable)
|
||||
{
|
||||
$meta[$variable] = $this->$variable;
|
||||
}
|
||||
}
|
||||
|
||||
$response = ['meta' => $meta];
|
||||
|
||||
foreach (['response', 'profiler'] as $variable)
|
||||
{
|
||||
if ($this->$variable)
|
||||
{
|
||||
$response[$variable] = $this->$variable;
|
||||
}
|
||||
}
|
||||
|
||||
$pretty = isset($_REQUEST['pretty']) ? JSON_PRETTY_PRINT : false;
|
||||
|
||||
exit(json_encode($response, $pretty));
|
||||
}
|
||||
}
|
||||
|
||||
|
|
@ -38,8 +38,6 @@ class Router extends Object
|
|||
{
|
||||
parent::__construct();
|
||||
|
||||
$response = new Response();
|
||||
|
||||
try
|
||||
{
|
||||
// Grabs the requested page
|
||||
|
|
@ -70,81 +68,28 @@ class Router extends Object
|
|||
array_unshift($nouns, SITE_RESOURCE_PATH);
|
||||
$filename = implode('/', $nouns) . '.php';
|
||||
|
||||
if (!file_exists($filename))
|
||||
// Checks that the file is present and contains our class
|
||||
if (!file_exists($filename) || !class_exists($class))
|
||||
{
|
||||
// @todo Should be a 404, will need to change it up after I add
|
||||
// namespaces and a Pickles\Exception
|
||||
throw new Exception('Cannot find the file ' . $filename);
|
||||
}
|
||||
|
||||
if (!class_exists($class))
|
||||
{
|
||||
throw new Exception('Cannot find the class ' . $class);
|
||||
throw new Exception('404 - Not Found.');
|
||||
}
|
||||
|
||||
// Instantiates our resource with the UIDs
|
||||
$resource = new $class($uids);
|
||||
|
||||
// Determines if we need to serve over HTTP or HTTPS
|
||||
if ($resource->secure == false && isset($_SERVER['HTTPS']) && $_SERVER['HTTPS'])
|
||||
{
|
||||
throw new Exception('This resource expects HTTPS communication.');
|
||||
}
|
||||
elseif ($resource->secure == true && (!isset($_SERVER['HTTPS']) || $_SERVER['HTTPS'] == false))
|
||||
{
|
||||
throw new Exception('This resource expects HTTP communication.');
|
||||
}
|
||||
|
||||
// Gets the profiler status
|
||||
$profiler = $this->config->pickles['profiler'];
|
||||
$profiler = $profiler === true || stripos($profiler, 'timers') !== false;
|
||||
|
||||
$method = strtolower($_SERVER['REQUEST_METHOD']);
|
||||
|
||||
if (!method_exists($resource, $method))
|
||||
{
|
||||
throw new Exception('Cannot find the method ' . $class . '::' . $method);
|
||||
}
|
||||
|
||||
// Starts a timer before the resource is executed
|
||||
if ($profiler)
|
||||
{
|
||||
Profiler::timer('resource ' . $method);
|
||||
}
|
||||
|
||||
if ($resource->validate)
|
||||
{
|
||||
$validation_errors = $resource->__validate();
|
||||
|
||||
if ($validation_errors)
|
||||
{
|
||||
$response->status = 400;
|
||||
$response->message = implode(' ', $validation_errors);
|
||||
}
|
||||
}
|
||||
|
||||
if ($response->status == 200)
|
||||
{
|
||||
$resource_return = $resource->$method();
|
||||
|
||||
if ($resource_return)
|
||||
{
|
||||
$response->response = $resource_return;
|
||||
}
|
||||
}
|
||||
|
||||
// Stops the resource timer
|
||||
if ($profiler)
|
||||
{
|
||||
Profiler::timer('resource ' . $method);
|
||||
}
|
||||
}
|
||||
catch (Exception $e)
|
||||
{
|
||||
$response->status = 500;
|
||||
$response->message = $e->getMessage();
|
||||
// Creates a resource object if we don't have one
|
||||
if (!isset($resource))
|
||||
{
|
||||
$resource = new Resource();
|
||||
}
|
||||
|
||||
$resource->status = 400;
|
||||
$resource->message = $e->getMessage();
|
||||
}
|
||||
|
||||
$response->respond();
|
||||
$resource->respond();
|
||||
}
|
||||
}
|
||||
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue