Zend Framework API Service Design

Zend Framework
“at your service”
Michelangelo van Dam
Dutch PHP Conference 2011 Amsterdam (NL)

Why a service ?
•- opening up existing API
internal applications
- external applications
- additional functionality
• support to more devices
• portability and ﬂexibility

Important components
• - Zend_Soap
Zend_Soap_Server
- Zend_Soap_Client
- Zend_Soap_Wsdl
• Zend_Rest
- Zend_Rest_Server
- Zend_Rest_Client
• Zend_XmlRpc
- Zend_XmlRpc_Server
- Zend_XmlRpc_Client
- Zend_XmlRpc_Request
- Zend_XmlRpc_Response

Example service
•- Time registration
list time sheets
- add a new task
- edit an existing task
- delete an existing task

MVC approach
•- time module
controllers (for displaying listing and forms)
- actions (for listing, adding, editing and deleting)
- models (for access to database)
- forms (for ﬁltering, validation and rendering forms)

Common behavior
• all “logic” is put in the controller
• actions = API interface
•- downside
not ﬂexible towards other clients
- difﬁcult to provide maintenance
- not reusable design

Time Module
Time_IndexController
indexAction editAction
- lists registered tasks - displays a form
- links to the form - for adding task
- for adding task - for editing task
- for editing task
- for deleting task

registerAction deleteAction
- processes form data - deletes task
- validating data
- storing data in db

API Design
•- moving logic
out the controller
- in an API class
• structures the application
• is better testable
• is better maintainable

Time API
My_Api_Timesheet
listTasks registerNewTask
- lists registered tasks - for adding task

editExistingTask deleteExistingTask
- for modifying task - deletes task

API output channels
Web Internal SOAP

XML API XMLRPC

JSON … REST

DocBlocks are important!
•- DocBlocks are very important !
provide quality API documentation
- can be used as reference for the server !!!

My_Api_Timesheet
<?php
class My_Api_Timesheet
{
}

listTasks
/**
* List all tasks for a given user
*
* @param int $user
* @return array
*/
public function listTasks($user)
{
$array = array ();
$timesheet = new Time_Model_Timesheet();
if (null !== ($result = $timesheet->fetchAll(array (
'user_id = ?' => $user,
), array ('date DESC', 'start_time ASC')))) {
foreach ($result as $entry) {
$array[] = $entry->toArray();
}
}
return $array;
}

registerNewTask
/**
* Register a new task
*
* @param int $user The ID of the user
* @param int $customer The ID of the customer
* @param int $task The ID of the task
* @param string $date A date formatted as YYYY-mm-dd
* @param string $start The starting time as HH:mm:ss
* @param string $end The ending time as HH:mm:ss
* @param string $description A short description
* @return bool TRUE if registration succeeded
* @throws My_Api_Timesheet_Exception
*/

registerNewTask
public function registerNewTask(
$user, $customer, $task, $date, $start, $end, $description)
{
$timesheet->setUserId($user)
->setCustomerId($customer)
->setTaskId($task)
->setDate($date)
->setStartTime($start)
->setEndTime($end)
->setDescription($description);
$validator = $this->_validate($timesheet);

if (false === $validator) {
require_once 'My/Api/Timesheet/Exception.php';
throw new My_Api_Timesheet_Exception('Invalid data provided');
}
$timesheet->save();

return true;
}

editExistingTask
/**
* Modify an existing task
*
* @param int $id The ID of an existing Task
* @param int $customer The ID of the customer
* @param int $task The ID of the task
* @param string $date A date formatted as YYYY-mm-dd
* @param string $start The starting time as HH:mm:ss
* @param string $end The ending time as HH:mm:ss
* @param string $description A short description
*/

editExistingTask
public function editExistingTask(
$id, $user, $customer, $task, $date, $start, $end, $description)
{
$timesheet->setId($id)
->setUserId($user)
->setCustomerId($customer)
->setTaskId($task)
->setDate($date)
->setStartTime($start)
->setEndTime($end)
->setDescription($description);

}
$timesheet->save();

return true;
}

deleteExistingTask
/**
* Modify an existing task
*
* @param int $id The ID of an existing Task
*/
public function deleteExistingTask($id, $user)
{
$timesheet->setId($id)
->setUserId($user);
}
$timesheet->delete(array (
'id = ?' => $timesheet->getId(),
'user_id = ?' => $timesheet->getUserId(),
));

return true;
}

_validate
/**
* Private validation method
*
* @param Time_Model_Timesheet $timesheet
* @return bool TRUE if validated, FALSE if invalid
*/
private function _validate(Time_Model_Timesheet $timesheet)
{
$result = true;
$validator = new Time_Form_Register();

$customer = new Time_Model_Customer();
$task = new Time_Model_Task();
$validator->getElement('customer_id')->setMultiOptions($customer->toSelect());
$validator->getElement('task_id')->setMultiOptions($task->toSelect());

if (!$validator->isValid($timesheet->toArray())) {
$result = false;
}
return $result;
}

XmlRpc Server
<?php
class Time_XmlRpcController extends Zend_Controller_Action
{
public function indexAction()
{
$this->_helper->layout()->disableLayout();
$this->_helper->viewRenderer->setNoRender(true);

require_once 'My/Api/Timesheet.php';
$server = new Zend_XmlRpc_Server();
$server->setClass('My_Api_Timesheet');
echo $server->handle();
}
}

SOAP Server
<?php
class Time_SoapController extends Zend_Controller_Action
{
{

$options = array ();
$server = new Zend_Soap_AutoDiscover();
$server->handle();
}
}

SOAP Client
<?php
class Time_SoapClientController extends Zend_Controller_Action
{
protected $_client;

public function init()
{
$this->_client = new Zend_Soap_Client(
'http://www.demo.local/Time/soap?wsdl', array ());
}
{
Zend_Debug::dump($this->_client->listTasks(2));
}
public function addAction()
{
Zend_Debug::dump($this->_client->registerNewTask(
2, 2, 3, '2010-03-30', '18:00:00', '23:30:00','Setting up SOAP'));
}
public function editAction()
{
Zend_Debug::dump($this->_client->editExistingTask(
7, 2, 2, 3, '2010-03-30', '18:00:00', '23:30:00','Testing SOAP'));
}
public function deleteAction()
{
Zend_Debug::dump($this->_client->deleteExistingTask(7, 2));
}
}

REST Server
<?php
class Time_RestController extends Zend_Controller_Action
{
{

$server = new Zend_Rest_Server();
$server->handle();
}
}

REST Client
<?php

class Time_RestClientController extends Zend_Controller_Action
{
protected $_client;

public function init()
{
$this->_client = new Zend_Rest_Client('http://www.demo.local/Time/rest');
}

{
$this->_client->listTasks(2);
Zend_Debug::dump($this->_client->get());
}
}

Conclusion

moving functionality out the controller
into a library API
=
saves time

1 api = XmlRpc + SOAP + REST + …

You can help !
•- ﬁnd a bug ?
test it
- report it
- send a patch/ﬁx
• need a non-existing component
- submit proposal
• like Zend Framework
- blog about it
- talk about it

ZF Bug hunt days
Zend Framework Bughuntdays
every 3rd Thursday and Friday of the month
http://framework.zend.com/issues
IRC (irc.freenode.net) #zftalk.dev

prizes:
Free subscription for 1 year on php|Architect magazine
Zend Framework t-shirt
recognition and appreciation of the community

daycamp4developers.com
Project Management
Late August - Early September

Thank you !

Slides on Slideshare

Give feedback on Joind.in
http://joind.in/3473

Zend Framework API Service Design

Empfohlen

Empfohlen

Weitere ähnliche Inhalte

Was ist angesagt?

Was ist angesagt? (20)

Andere mochten auch

Andere mochten auch (8)

Ähnlich wie Zend Framework API Service Design

Ähnlich wie Zend Framework API Service Design (20)

Mehr von Michelangelo van Dam

Mehr von Michelangelo van Dam (20)

Kürzlich hochgeladen

Kürzlich hochgeladen (20)

Zend Framework API Service Design

Hinweis der Redaktion