bn8/eesyphp
1
0
Fork 0
Code Issues Pull requests Projects Releases Wiki Activity

Url: add optional additional info to Url handler

Browse source
This commit is contained in:
Benjamin Renard 2023-02-15 18:58:17 +01:00
parent 73dc860972
commit d304d4741f
3 changed files with 66 additions and 22 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

1
src/Tpl.php
View file

@ -613,6 +613,7 @@ class Tpl {
Url :: add_url_handler( Url :: add_url_handler(
$pattern, $pattern,
array('EesyPHP\\Tpl', 'handle_static_file'), array('EesyPHP\\Tpl', 'handle_static_file'),
null, // additionnal info
false, // authenticated false, // authenticated
false, // override false, // override
false, // API mode false, // API mode

22
src/Url.php
View file

@ -14,12 +14,14 @@ class Url {
* array ( * array (
* '|get/(?P<name>[a-zA-Z0-9]+)$|' => array ( * '|get/(?P<name>[a-zA-Z0-9]+)$|' => array (
* 'handler' => 'get', * 'handler' => 'get',
* 'additional_info' => array(),
* 'authenticated' => true, * 'authenticated' => true,
* 'api_mode' => false, * 'api_mode' => false,
* 'methods' => array('GET'), * 'methods' => array('GET'),
* ), * ),
* '|get/all$|' => => array ( * '|get/all$|' => => array (
* 'handler' => 'get_all', * 'handler' => 'get_all',
* 'additional_info' => array(),
* 'authenticated' => true, * 'authenticated' => true,
* 'api_mode' => false, * 'api_mode' => false,
* 'methods' => array('GET', 'POST'), * 'methods' => array('GET', 'POST'),
@ -72,6 +74,7 @@ class Url {
* *
* @param string|array $pattern The URL pattern or an array of patterns (required) * @param string|array $pattern The URL pattern or an array of patterns (required)
* @param callable $handler The URL pattern handler (must be callable, required) * @param callable $handler The URL pattern handler (must be callable, required)
* @param array|null $additional_info Array of information to pass to the URL handler
* @param boolean $authenticated Permit to define if this URL is accessible only for * @param boolean $authenticated Permit to define if this URL is accessible only for
* authenticated users (optional, default: true if the * authenticated users (optional, default: true if the
* special force_authentication function is defined, * special force_authentication function is defined,
@ -81,8 +84,9 @@ class Url {
* @param boolean $api_mode Enable API mode (optional, default: false) * @param boolean $api_mode Enable API mode (optional, default: false)
* @param array|string|null $methods HTTP method (optional, default: array('GET', 'POST')) * @param array|string|null $methods HTTP method (optional, default: array('GET', 'POST'))
**/ **/
public static function add_url_handler($pattern, $handler=null, $authenticated=null, $override=true, public static function add_url_handler($pattern, $handler=null, $additional_info=null,
$api_mode=false, $methods=null) { $authenticated=null, $override=true, $api_mode=false,
$methods=null) {
$authenticated = ( $authenticated = (
is_null($authenticated)? is_null($authenticated)?
function_exists('force_authentication'): function_exists('force_authentication'):
@ -95,15 +99,21 @@ class Url {
if (is_array($pattern)) { if (is_array($pattern)) {
if (is_null($handler)) if (is_null($handler))
foreach($pattern as $p => $h) foreach($pattern as $p => $h)
self :: add_url_handler($p, $h, $authenticated, $override, $api_mode, $methods); self :: add_url_handler(
$p, $h, $additional_info, $authenticated, $override, $api_mode, $methods);
else else
foreach($pattern as $p) foreach($pattern as $p)
self :: add_url_handler($p, $handler, $authenticated, $override, $api_mode, $methods); self :: add_url_handler(
$p, $handler, $additional_info, $authenticated, $override, $api_mode, $methods);
} }
else { else {
if (!isset(self :: $patterns[$pattern])) { if (!isset(self :: $patterns[$pattern])) {
self :: $patterns[$pattern] = array( self :: $patterns[$pattern] = array(
'handler' => $handler, 'handler' => $handler,
'additional_info' => (
is_array($additional_info)?
$additional_info:array()
),
'authenticated' => $authenticated, 'authenticated' => $authenticated,
'api_mode' => $api_mode, 'api_mode' => $api_mode,
'methods' => $methods, 'methods' => $methods,
@ -116,6 +126,10 @@ class Url {
); );
self :: $patterns[$pattern] = array( self :: $patterns[$pattern] = array(
'handler' => $handler, 'handler' => $handler,
'additional_info' => (
is_array($additional_info)?
$additional_info:array()
),
'authenticated' => $authenticated, 'authenticated' => $authenticated,
'api_mode' => $api_mode, 'api_mode' => $api_mode,
'methods' => $methods, 'methods' => $methods,

65
src/UrlRequest.php
View file

@ -13,31 +13,56 @@ namespace EesyPHP;
*/ */
class UrlRequest { class UrlRequest {
// The URL requested handler /**
private $current_url = null; * The URL requested handler
* @var string
*/
private $current_url;
// The URL requested handler /**
private $handler = null; * The URL requested handler
* @var callable
*/
private $handler;
// Request need authentication ? /**
private $authenticated = true; * Request need authentication ?
* @var bool|null
*/
private $authenticated = null;
// API mode enabled ? /**
private $api_mode = false; * API mode enabled ?
* @var bool
*/
private $api_mode;
// Parameters detected on requested URL /**
* Parameters detected on requested URL
* @var array<string,mixed>
*/
private $url_params = array(); private $url_params = array();
public function __construct($current_url, $handler_infos, $url_params=array()) { /**
* Additional info pass when the URL handler was registered
* @var array<string,mixed>
*/
private $additional_info = array();
public function __construct($current_url, $handler_info, $url_params=array()) {
$this -> current_url = $current_url; $this -> current_url = $current_url;
$this -> handler = $handler_infos['handler']; $this -> handler = $handler_info['handler'];
$this -> authenticated = ( $this -> authenticated = (
isset($handler_infos['authenticated'])? isset($handler_info['authenticated'])?
boolval($handler_infos['authenticated']):true); boolval($handler_info['authenticated']):true);
$this -> api_mode = ( $this -> api_mode = (
isset($handler_infos['api_mode'])? isset($handler_info['api_mode'])?
boolval($handler_infos['api_mode']):false); boolval($handler_info['api_mode']):false);
$this -> url_params = $url_params; $this -> url_params = $url_params;
$this -> additional_info = (
isset($handler_info['additional_info']) && is_array($handler_info['additional_info'])?
$handler_info['additional_info']:array()
);
} }
/** /**
@ -60,9 +85,10 @@ class UrlRequest {
return $this -> get_referer(); return $this -> get_referer();
if ($key == 'http_method') if ($key == 'http_method')
return $_SERVER['REQUEST_METHOD']; return $_SERVER['REQUEST_METHOD'];
if (array_key_exists($key, $this->url_params)) { if (array_key_exists($key, $this->url_params))
return urldecode($this->url_params[$key]); return urldecode($this->url_params[$key]);
} if (array_key_exists($key, $this->additional_info))
return urldecode($this->additional_info[$key]);
// Unknown key, log warning // Unknown key, log warning
Log :: warning( Log :: warning(
"__get($key): invalid property requested\n%s", "__get($key): invalid property requested\n%s",
@ -103,7 +129,10 @@ class UrlRequest {
) )
) )
return True; return True;
return array_key_exists($key, $this->url_params); return (
array_key_exists($key, $this->url_params)
|| array_key_exists($key, $this->additional_info)
);
} }
/** /**