Dominique.Fournier/DomFramework
1
0
Fork 0
Code Issues Pull Requests Projects Releases Activity

rest : rewrite to support the bestChoice of the user, and to be tested

Browse Source 
rest : add tests


git-svn-id: https://svn.fournier38.fr/svn/ProgSVN/trunk@5803 bf3deb0d-5f1a-0410-827f-c0cc1f45334c
This commit is contained in:
Dominique Fournier
2019-12-06 15:51:40 +00:00
parent df20f6c372
commit 66495ee503
2 changed files with 109 additions and 16 deletions
Download Patch File Download Diff File Expand all files Collapse all files

60
Tests/restTest.php Normal file
View File

@@ -0,0 +1,60 @@
<?php
/** DomFramework
* @package domframework
* @author Dominique Fournier <dominique@fournier38.fr>
*/
/** Test the domframework REST part */
class restTest extends PHPUnit_Framework_TestCase
{
/** No param, JSON by default
*/
public function testChooseType1 ()
{
$rest = new \rest ();
$res = $rest->chooseType ();
$this->assertSame ($res, "json");
}
/** If limited allowedTypes, return the first one as default
*/
public function testChooseType2 ()
{
$rest = new \rest ();
$rest->allowedtypes = array ("xml", "csv");
$res = $rest->chooseType ();
$this->assertSame ($res, "xml");
}
/** Choose by the user specification : exact match
*/
public function testChooseType3 ()
{
$rest = new \rest ();
$_SERVER["HTTP_ACCEPT"] = "text/html,application/xml;q=0.9,*/*;q=0.8";
$res = $rest->chooseType ();
$this->assertSame ($res, "xml");
}
/** Choose by the user specification : generic match
*/
public function testChooseType4 ()
{
$rest = new \rest ();
$_SERVER["HTTP_ACCEPT"] = "text/html;q=0.9,*/*;q=0.8";
$res = $rest->chooseType ();
$this->assertSame ($res, "json");
}
/** Choose by the user specification : generic match with limited allowed
* types
*/
public function testChooseType5 ()
{
$rest = new \rest ();
$rest->allowedtypes = array ("xml", "csv");
$_SERVER["HTTP_ACCEPT"] = "text/html;q=0.9,*/*;q=0.8";
$res = $rest->chooseType ();
$this->assertSame ($res, "xml");
}
}

65
rest.php
View File

@@ -1,36 +1,69 @@
<?php
/** DomFramework
@package domframework
@author Dominique Fournier <dominique@fournier38.fr> */
* @package domframework
* @author Dominique Fournier <dominique@fournier38.fr>
*/
require_once ("domframework/http.php");
/** Allow to manage the REST protocol by using the users output types */
/** Allow to manage the REST protocol by using the users output types
*/
class rest
{
/** Allowed types by default */
/** Allowed types by default
*/
public $allowedtypes = array ("json", "xml", "txt", "csv");
/** Converted types
*/
private $convert = array (
"application/json" => "json",
"application/xml" => "xml",
"text/plain" => "txt",
"text/csv" => "csv",
);
/** This method allow to choose the type of plugin to use on output
* Based on the HTTP_ACCEPT parameter provided by the user
* @return string like "json", "xml", "txt", "csv"
*/
public function chooseType ()
// {{{
{
$type = reset ($this->allowedtypes);
if (isset ($_SERVER["HTTP_ACCEPT"]))
{
// Must work with the complete definition to match, and by the name of
// the output plugin at the end
$convert = array_intersect ($this->convert, $this->allowedtypes);
$type = array_search (reset ($this->allowedtypes), $this->convert);
$http = new http;
$type = $http->bestChoice ($_SERVER["HTTP_ACCEPT"], array_keys ($convert),
$type);
$type = $this->convert[$type];
}
return $type;
}
// }}}
/** Display the message (which can be a string, an array, an integer...)
into the type asked by the client if it is allowed.
By default, the JSON type is used
@param string $message Message to be displayed by the output type
@param integer $code HTTP code to use */
function display ($message, $code=200)
* into the type asked by the client if it is allowed.
* By default, the JSON type is used
* @param string $message Message to be displayed by the output type
* @param integer|null $code HTTP code to use
*/
function display ($message, $code = 200)
// {{{
{
$http = new http;
$text = $http->codetext ($code);
header ($_SERVER["SERVER_PROTOCOL"]." $code $text");
$type = reset ($this->allowedtypes);
if (isset ($_SERVER["HTTP_ACCEPT"]))
{
$type = $http->bestChoice ($_SERVER["HTTP_ACCEPT"], $this->allowedtypes,
$type);
}
$type = $this->chooseType ();
require_once ("domframework/output$type.php");
$constr = __NAMESPACE__."\\output$type";
$method = "out";
$obj = new $constr ();
$obj->$method ($message);
}
// }}}
}