Programmer's Reference Guide

Zend_Rest_Client

Zend_Rest
Guide de référence du programmeur

Zend_Rest_Server

Introduction

Zend_Rest_Server est prévu comme un serveur supportant l'ensemble des fonctionnalités d'un serveur REST.

Utilisation d'un serveur REST

Exemple #1 Utilisation basique Zend_Rest_Server - Avec des classes

$server = new Zend_Rest_Server();
$server->setClass('Mon_Service_Classe');
$server->handle();

Exemple #2 Utilisation basique Zend_Rest_Server - Avec des fonctions

/**
 * Dit Bonjour
 *
 * @param string $qui
 * @param string $quand
 * @return string
 */
function ditBonjour($qui, $quand)
{
    return "Bonjour $qui, bonne $quand";
}
 
$server = new Zend_Rest_Server();
$server->addFunction('ditBonjour');
$server->handle();

Appelé un service Zend_Rest_Server

Pour appeler un service Zend_Rest_Server, vous devez fournir un argument de method GET/POST avec une valeur qui est la méthode que vous souhaitez appeler. Vous pouvez alors ajouter tout nombre d'arguments en utilisant le nom de l'argument (c.-à-d. "qui ") ou en utilisant 'arg' suivi de la position numérique de l'argument (c.-à-d. "arg1").

Note: Index numérique
Les arguments numériques utilisent 1 comme point de départ.

Pour appeler le ditBonjour de l'exemple ci-dessus, vous pouvez employer soit :

?method=ditBonjour&qui=Davey&quand=journée

or:

?method=ditBonjour&arg1=Davey&arg2=journée

Envoyer un statut personnalisé

En envoyant des valeurs, pour ajouter un statut personnalisé, vous pouvez envoyer un tableau avec une clé status.

Exemple #3 Renvoyer un statut personnalisé

/**
 * Dit Bonjour
 *
 * @param string $qui
 * @param string $quand
 * @return array
 */
function ditBonjour($qui, $quand)
{
    return array('msg' => "Une erreur est apparue", 'status' => false);
}
 
$server = new Zend_Rest_Server();
$server->addFunction('ditBonjour');
$server->handle();

Renvoyer une réponse XML personnalisée

Si vous voulez retourner du XML personnalisé, retournez simplement un objet DOMDocument, DOMElement ou SimpleXMLElement.

Exemple #4 Renvoyer une réponse XML personnalisée

/**
 * Dit Bonjour
 *
 * @param string $who
 * @param string $when
 * @return SimpleXMLElement
 */
function ditBonjour($qui, $quand)
{
    $xml ='<?xml version="1.0" encoding="ISO-8859-1"?>
<mysite>
    <value>Salut $qui! J\'espère que tu passes une bonne $when</value>
    <constant>200</constant>
</mysite>';
 
    $xml = simplexml_load_string($xml);
    return $xml;
}
 
$server = new Zend_Rest_Server();
$server->addFunction('ditBonjour');
 
$server->handle();

La réponse du service sera retournée sans modification au client.

Zend_Rest_Client

Zend_Rest
Guide de référence du programmeur

Zend_Search_Lucene

Comments

Posted by: Aash on: 2011-08-05 15:58:00 ⁋

@Andrew: Agreed. I wish this was more informative.

Posted by: Andrew on: 2011-08-03 17:04:04 ⁋

How is requesting a "sayHello" method RESTful? "sayHello" is not a resource, so I don't understand how this is RESTful at all. Calling a custom method is a SOAP paradigm.

I also don't understand what this "Zend_Rest_Server" is supposed to do and why it's useful. "Zend_Rest_Server is intended as a fully-featured REST server." is not enough to explain what this class is intended to be used for. A REST server should be able to:

1. receive and parse a request
2. retrieve, create, update, or delete the requested resource
3. then respond with a representation of the resource in the appropriate format (XML or JSON)

...and that's it! Nothing more. Nothing less.

There is nothing in this documentation that makes me think that Zend_Rest_Server does any of that. How are we even supposed to use this?

Posted by: Vincent Franco on: 2011-08-18 17:50:59 ⁋

Thanks again Zend for providing useful documentation.

Posted by: Basavaraj on: 2011-11-16 04:18:23 ⁋

I doubt if Zend really have to provide the server and client APIs, coz they are not adding any value to RESTfulness of a Web Service

I would expect these server and client classes to provide some common framework method on handling requests, responses, errors, GET, POST, PUT, DELETE methods

Like a POST and PUT methods should always return the URI of the resource just got created or updated.

I don't see any such thing in these classes, hence better these should be removed, else programmers will wrongly use these, which is more of SOAP or RPC rest invocation classes.

Posted by: matthew day on: 2011-11-22 01:50:02 ⁋

to use put you have to add this

resources.frontController.plugins.putHandler = "Zend_Controller_Plugin_PutHandler"

it's basically a crappy little helper that checks to see if there's a put request and if so then it puts the variables you're sending along with it into the params. idk why the params aren't included by default when trying to see your vars passed in the putAction

Posted by: Jeremy Warne on: 2012-01-07 03:42:57 ⁋

You're right, this class's documentation is shocking. But Zend does come with a good Rest solution, it's just not here. It's hidden in the Controller docs:

http://framework.zend.com/manual/en/zend.controller.router.html#zend.controller.router.routes.rest

Zend_Rest_Server, as pointed out in this comments, isn't really that useful and is probably on its way out.