mirrors/easyappointments
1
0
Fork 1
mirror of https://github.com/alextselegidis/easyappointments.git synced 2024-11-25 17:33:19 +03:00
Code Issues Projects Releases Packages Wiki Activity

Implemented secretaries API resource controller and parser.

Browse source
This commit is contained in:
Alex Tselegidis 2016-07-10 16:01:49 +02:00
parent 655c400750
commit 623eb32d67
2 changed files with 215 additions and 11 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

92
src/application/controllers/api/v1/Secretaries.php
View file

@ -13,6 +13,10 @@
require_once __DIR__ . '/API_V1_Controller.php';
use \EA\Engine\Api\V1\Response;
use \EA\Engine\Api\V1\Request;
use \EA\Engine\Types\NonEmptyString;
/**
* Secretaries Controller
*
@ -20,53 +24,125 @@ require_once __DIR__ . '/API_V1_Controller.php';
* @subpackage API
*/
class Secretaries extends API_V1_Controller {
/**
* Secretaries Resource Parser
*
* @var \EA\Engine\Api\V1\Parsers\Secretaries
*/
protected $parser;
/**
* Class Constructor
*/
public function __construct() {
parent::__construct();
$this->load->model('secretaries_model');
$this->parser = new \EA\Engine\Api\V1\Parsers\Secretaries;
}
/**
* GET API Method
*
* @param int $id Optional (null), the record ID to be returned.
*
* @return \EA\Engine\Api\V1\Response Returns data response.
*/
public function get($id = null) {
try {
$condition = $id !== null ? 'id = ' . $id : null;
$secretaries = $this->secretaries_model->get_batch($condition);
if ($id !== null && count($secretaries) === 0) {
$this->_throwRecordNotFound();
}
$response = new Response($secretaries);
$response->encode($this->parser)
->search()
->sort()
->paginate()
->minimize()
->singleEntry($id)
->output();
} catch (\Exception $exception) {
$this->_handleException($exception);
}
}
/**
* POST API Method
*
* @return @return \EA\Engine\Api\V1\Response Returns data response.
*/
public function post() {
try {
// Insert the secretary to the database.
$request = new Request();
$secretary = $request->getBody();
$this->parser->decode($secretary);
if (isset($secretary['id'])) {
unset($secretary['id']);
}
$id = $this->secretaries_model->add($secretary);
// Fetch the new object from the database and return it to the client.
$batch = $this->secretaries_model->get_batch('id = ' . $id);
$response = new Response($batch);
$status = new NonEmptyString('201 Created');
$response->encode($this->parser)->singleEntry(true)->output($status);
} catch (\Exception $exception) {
$this->_handleException($exception);
}
}
/**
* PUT API Method
*
* @param int $id The record ID to be updated.
*
* @return @return \EA\Engine\Api\V1\Response Returns data response.
*/
public function put($id) {
try {
// Update the secretary record.
$batch = $this->secretaries_model->get_batch('id = ' . $id);
if ($id !== null && count($batch) === 0) {
$this->_throwRecordNotFound();
}
$request = new Request();
$updatedSecretary = $request->getBody();
$baseSecretary = $batch[0];
$this->parser->decode($updatedSecretary, $baseSecretary);
$updatedSecretary['id'] = $id;
$id = $this->secretaries_model->add($updatedSecretary);
// Fetch the updated object from the database and return it to the client.
$batch = $this->secretaries_model->get_batch('id = ' . $id);
$response = new Response($batch);
$response->encode($this->parser)->singleEntry($id)->output();
} catch (\Exception $exception) {
$this->_handleException($exception);
}
}
/**
* DELETE API Method
*
* @param int $id The record ID to be deleted.
*
* @return @return \EA\Engine\Api\V1\Response Returns data response.
*/
public function delete($id) {
try {
$result = $this->secretaries_model->delete($id);
$response = new Response([
'code' => 200,
'message' => 'Record was deleted successfully!'
]);
$response->output();
} catch (\Exception $exception) {
$this->_handleException($exception);
}
}
}

128
src/engine/Api/V1/Parsers/Secretaries.php Normal file
View file

@ -0,0 +1,128 @@
<?php
/* ----------------------------------------------------------------------------
* Easy!Appointments - Open Source Web Scheduler
*
* @package EasyAppointments
* @author A.Tselegidis <alextselegidis@gmail.com>
* @copyright Copyright (c) 2013 - 2016, Alex Tselegidis
* @license http://opensource.org/licenses/GPL-3.0 - GPLv3
* @link http://easyappointments.org
* @since v1.2.0
* ---------------------------------------------------------------------------- */
namespace EA\Engine\Api\V1\Parsers;
/**
* Secretaries Parser
*
* This class will handle the encoding and decoding from the API requests.
*/
class Secretaries implements ParsersInterface {
/**
* Encode Response Array
*
* @param array &$response The response to be encoded.
*/
public function encode(array &$response) {
$encodedResponse = [
'id' => $response['id'] !== null ? (int)$response['id'] : null,
'firstname' => $response['first_name'],
'lastname' => $response['last_name'],
'email' => $response['email'],
'mobile' => $response['mobile_number'],
'phone' => $response['phone_number'],
'address' => $response['address'],
'city' => $response['city'],
'state' => $response['state'],
'zip' => $response['zip_code'],
'notes' => $response['notes'],
'providers' => $response['providers'],
'settings' => [
'username' => $response['settings']['username'],
'notifications' => filter_var($response['settings']['notifications'], FILTER_VALIDATE_BOOLEAN)
]
];
$response = $encodedResponse;
}
/**
* Decode Request
*
* @param array &$request The request to be decoded.
* @param array $base Optional (null), if provided it will be used as a base array.
*/
public function decode(array &$request, array $base = null) {
$decodedRequest = $base ?: [];
if (!empty($request['id'])) {
$decodedRequest['id'] = $request['id'];
}
if (!empty($request['firstname'])) {
$decodedRequest['first_name'] = $request['firstname'];
}
if (!empty($request['lastname'])) {
$decodedRequest['last_name'] = $request['lastname'];
}
if (!empty($request['email'])) {
$decodedRequest['email'] = $request['email'];
}
if (!empty($request['mobile'])) {
$decodedRequest['mobile_number'] = $request['mobile'];
}
if (!empty($request['phone'])) {
$decodedRequest['phone_number'] = $request['phone'];
}
if (!empty($request['address'])) {
$decodedRequest['address'] = $request['address'];
}
if (!empty($request['city'])) {
$decodedRequest['city'] = $request['city'];
}
if (!empty($request['state'])) {
$decodedRequest['state'] = $request['state'];
}
if (!empty($request['zip'])) {
$decodedRequest['zip_code'] = $request['zip'];
}
if (!empty($request['notes'])) {
$decodedRequest['notes'] = $request['notes'];
}
if (!empty($request['providers'])) {
$decodedRequest['providers'] = $request['providers'];
}
if (!empty($request['settings'])) {
if (empty($decodedRequest['settings'])) {
$decodedRequest['settings'] = [];
}
if (!empty($request['settings']['username'])) {
$decodedRequest['settings']['username'] = $request['settings']['username'];
}
if (!empty($request['settings']['password'])) {
$decodedRequest['settings']['password'] = $request['settings']['password'];
}
if ($request['settings']['notifications'] !== null) {
$decodedRequest['settings']['notifications'] = filter_var($request['settings']['notifications'],
FILTER_VALIDATE_BOOLEAN);
}
}
$request = $decodedRequest;
}
}