-
-
+ + + +Limonade, the fizzy PHP micro-framework
+
+
+
+
+
-
-
+
+ + + + +
+
- Limonade
+
+
+
+
+
+
+
+ +
+* // fails with [ PHP Fatal error: Can't use function return value in write context ]
+* if ( isset( option('dir.views) ) ) { }
+*
+* // Works just fine
+* if ( option_isset('dir.views) ) { }
+*
+*
+* @param string $name => the option key to test for
+* @return boolean TRUE if value is set, FALSE if value is undefined ie: NULL
+*/
+function option_isset($name)
+{
+ $res = option($name);
+ return ( isset( $res);
+}
+
+// syntactic sugar
+function isset_option($name) { return option_isset($name); }
+// syntactic sugar: reads better when testing for the value
+function option_defined($name) { return option_isset($name); }
+// syntactic sugar: reads better when testing for the value
+// returns the opposite of option_isset()
+function option_undefined($name) { return ! option_isset($name); }
+function option_missing($name) { return ! option_isset($name); }
+
+/**
+ * Shortcut to test for presence and value of an option
*
- * * If first argument is an array, merge it with current params
+ * Provides a safe and quick way to test for the presence and value of an option setting.
*
- * * If there is a second argument $value, set param $name (first argument) with $value
- *
- * params('name', 'Doe') // set 'name' => 'Doe'
- *
- * * If there is more than 2 arguments, set param $name (first argument) value with
- * an array of next arguments
*
- * params('months', 'jan', 'feb', 'mar') // set 'month' => array('months', 'jan', 'feb', 'mar')
- *
+ * // the long way
+ * if ( option_isset('dir.views) && ( option('dir.views') === 'some value' ) ) { }
*
- * @param mixed $name_or_array_or_null could be null || array of params || name of a param (optional)
- * @param mixed $value,... for the $name param (optional)
- * @return mixed all params, or one if a first argument $name is provided
+ * // the smart way
+ * if ( option_equals('dir.views', 'some value') ) { }
+ *
+ *
+ * @param string $name
+ * @param string $value
+ * @return boolean => TRUE if present and the same, FALSE if undefined or not the same
*/
+function option_equals($name, $value)
+{
+ if( option_undefined($name) ) { return FALSE; }
+ return ( option($name) === $value );
+}
+
+/**
+* Set and returns params
+*
+* Depending on provided arguments:
+*
+* * Reset params if first argument is null
+*
+* * If first argument is an array, merge it with current params
+*
+* * If there is a second argument $value, set param $name (first argument) with $value
+*
+* params('name', 'Doe') // set 'name' => 'Doe'
+*
+*
+* * If there is more than 2 arguments, set param $name (first argument) value with
+* an array of next arguments
+*
+* params('months', 'jan', 'feb', 'mar') // set 'month' => array('months', 'jan', 'feb', 'mar')
+*
+*
+* @param mixed $name_or_array_or_null could be null || array of params || name of a param (optional)
+*
+* @param mixed $value,... for the $name param (optional)
+*
+* @return mixed all params, or one if a first argument $name is provided
+*
+*/
function params($name_or_array_or_null = null, $value = null)
{
static $params = array();
@@ -251,7 +323,7 @@ function params($name_or_array_or_null = null, $value = null)
$name = array_shift($args);
if(is_null($name))
{
- # Reset params
+ // Reset params
$params = array();
return $params;
}
@@ -273,119 +345,148 @@ function params($name_or_array_or_null = null, $value = null)
}
/**
- * Set and returns template variables
- *
- * If multiple values are provided, set $name variable with an array of those values.
- * If there is only one value, set $name variable with the provided $values
- *
- * @param string $name
- * @param mixed $values,...
- * @return mixed variable value for $name if $name argument is provided, else return all variables
- */
+* Set and returns template variables
+*
+* If multiple values are provided, set $name variable with an array of those values.
+* If there is only one value, set $name variable with the provided $values
+*
+* @param string $name
+*
+* @param mixed $values,...
+*
+* @return mixed variable value for $name if $name argument is provided, else return all variables
+*
+*/
function set($name = null, $values = null)
{
static $vars = array();
$args = func_get_args();
$name = array_shift($args);
- if(is_null($name)) return $vars;
+ if(is_null($name)) { return $vars; }
if(!empty($args))
{
$vars[$name] = count($args) > 1 ? $args : $args[0];
}
- if(array_key_exists($name, $vars)) return $vars[$name];
+ if(array_key_exists($name, $vars)) { return $vars[$name]; }
return $vars;
}
/**
- * Sets a template variable with a value or a default value if value is empty
- *
- * @param string $name
- * @param string $value
- * @param string $default
- * @return mixed setted value
- */
+* Sets a template variable with a value or a default value if value is empty
+*
+* * @param string $name
+* * @param string $value
+* * @param string $default
+*
+* @return mixed set value
+*
+*/
function set_or_default($name, $value, $default)
{
return set($name, value_or_default($value, $default));
}
/**
- * Running application
- *
- * @param string $env
- * @return void
- */
+* Running application
+*
+* @param string $env
+*
+* @return void
+*
+*/
function run($env = null)
{
if(is_null($env)) $env = env();
- # 0. Set default configuration
+ // 0. Set default configuration
$root_dir = dirname(app_file());
- $lim_dir = dirname(__FILE__);
$base_path = dirname(file_path($env['SERVER']['SCRIPT_NAME']));
$base_file = basename($env['SERVER']['SCRIPT_NAME']);
$base_uri = file_path($base_path, (($base_file == 'index.php') ? '?' : $base_file.'?'));
-
- option('root_dir', $root_dir);
- option('limonade_dir', file_path($lim_dir));
- option('limonade_views_dir', file_path($lim_dir, 'limonade', 'views'));
- option('limonade_public_dir',file_path($lim_dir, 'limonade', 'public'));
- option('public_dir', file_path($root_dir, 'public'));
- option('views_dir', file_path($root_dir, 'views'));
- option('controllers_dir', file_path($root_dir, 'controllers'));
- option('lib_dir', file_path($root_dir, 'lib'));
- option('error_views_dir', option('limonade_views_dir'));
+ $lim_dir = dirname(__FILE__);
+ option('dir.root', $root_dir);
option('base_path', $base_path);
option('base_uri', $base_uri); // set it manually if you use url_rewriting
+ option('dir.limonade', file_path($lim_dir));
+ option('dir.limonade.views', file_path($lim_dir, 'limonade', 'views'));
+ option('dir.limonade.public',file_path($lim_dir, 'limonade', 'public'));
+ option('dir.public', file_path($root_dir, 'public'));
+ option('dir.views', file_path($root_dir, 'views'));
+ option('dir.controllers', file_path($root_dir, 'controllers'));
+ option('dir.lib', file_path($root_dir, 'lib'));
+ option('dir.views.errors', option('dir.limonade.views'));
+ # custom dirs
+ option('dir.lib.cores', file_path($lim_dir, 'core'));
+ option('dir.lib.core', file_path($lim_dir, 'core'));
+ option('dir.lib.helpers', file_path($lim_dir, 'helpers'));
+ option('dir.lib.lexts', file_path($lim_dir, 'lexts'));
+
+ option('dir.db', file_path(dirname($root_dir), 'db'));
+ option('dir.app', file_path(dirname($lim_dir)));
+ option('dir.app.assets', file_path(dirname($lim_dir), 'assets'));
+ option('dir.app.conf', file_path(dirname($lim_dir), 'conf'));
+ option('dir.app.lib', file_path($lim_dir));
+ option('dir.app.models', file_path(dirname($lim_dir), 'models'));
+ option('dir.app.views', file_path(dirname($lim_dir), 'views'));
+
option('env', ENV_PRODUCTION);
option('debug', true);
- option('session', LIM_SESSION_NAME); // true, false or the name of your session
+ option('settings.show', false);
+ option('session', LIM_SESSION_NAME); # true, false or the name of your session
option('encoding', 'utf-8');
- option('signature', LIM_NAME); // X-Limonade header value or false to hide it
+ option('signature', LIM_NAME); # X-Limonade header value or false to hide it
option('gzip', false);
- option('x-sendfile', 0); // 0: disabled,
- // X-SENDFILE: for Apache and Lighttpd v. >= 1.5,
- // X-LIGHTTPD-SEND-FILE: for Apache and Lighttpd v. < 1.5
-
+ option('x-sendfile', 0); # 0: disabled,
+ # X-SENDFILE: for Apache and Lighttpd v. >= 1.5,
+ # X-LIGHTTPD-SEND-FILE: for Apache and Lighttpd v. < 1.5
- # 1. Set handlers
- # 1.1 Set error handling
+ // 1. Set handlers
+ // 1.1 Set error handling
ini_set('display_errors', 1);
set_error_handler('error_handler_dispatcher', E_ALL ^ E_NOTICE);
- # 1.2 Register shutdown function
+ // 1.2 Register shutdown function
register_shutdown_function('stop_and_exit');
- # 2. Set user configuration
+ # 1.3 Load extras
+ # extras(true);
+
+ // 2. Set user configuration
+ event('configure.before', true, array($env));
call_if_exists('configure');
+ event('configure.after', true, array($env));
- # 2.1 Set gzip compression if defined
+ // 2.1 Set gzip compression if defined
if(is_bool(option('gzip')) && option('gzip'))
{
ini_set('zlib.output_compression', '1');
}
- # 2.2 Set X-Limonade header
- if($signature = option('signature')) send_header("X-Limonade: $signature");
+ // 2.2 Set X-Limonade header
+ if($signature = option('signature')) { header("X-Limonade: $signature"); }
- # 3. Loading libs
- require_once_dir(option('lib_dir'));
+ // 3. Loading libs
+ event('libs.before', true, array($env));
+ require_once_dir(option('dir.lib'));
+ event('libs.after', true, array($env));
+
fallbacks_for_not_implemented_functions();
- # 4. Starting session
+ // 4. Starting session
+ event('session.before', true, array($env));
+
if(!defined('SID') && option('session'))
{
- if(!is_bool(option('session'))) session_name(option('session'));
- if(!session_start()) trigger_error("An error occured while trying to start the session", E_USER_WARNING);
+ if(!is_bool(option('session'))) { session_name(option('session')); }
+ if(!session_start()) { trigger_error("An error occurred while trying to start the session", E_USER_WARNING); }
}
- # 5. Set some default methods if needed
+ event('session.after', true, array($env));
+
+ // 5. Set some default methods if needed
if(!function_exists('after'))
{
- function after($output)
- {
- return $output;
- }
+ function after($output) { return $output; }
}
if(!function_exists('route_missing'))
{
@@ -395,56 +496,93 @@ function route_missing($request_method, $request_uri)
}
}
+ event('initialize.before', true, array($env));
+
call_if_exists('initialize');
- # 6. Check request
+ event('initialize.after', true, array($env));
+
+
+ // 6. Check request
if($rm = request_method($env))
{
if(request_is_head($env)) ob_start(); // then no output
if(!request_method_is_allowed($rm))
+ {
halt(HTTP_NOT_IMPLEMENTED, "The requested method '$rm' is not implemented");
+ }
- # 6.1 Check matching route
+ // 6.1 Check matching route
if($route = route_find($rm, request_uri($env)))
{
params($route['params']);
- # 6.2 Load controllers dir
+ // 6.2 Load controllers dir
if(!function_exists('autoload_controller'))
{
function autoload_controller($callback)
{
- require_once_dir(option('controllers_dir'));
+ require_once_dir(option('dir.controllers'));
}
}
+
+ event('controller_autoload.before', true, array($env, $route));
+
autoload_controller($route['callback']);
+ event('controller_autoload.after', true, array($env, $route));
+
if(is_callable($route['callback']))
{
- # 6.3 Call before function
+ // 6.3 Call before function
+ event('before.before', true, array($env, $route));
+
call_if_exists('before', $route);
- # 6.4 Call matching controller function and output result
+ event('before.after', true, array($env, $route));
+
+ // 6.4 Call matching controller function and output result
+ event('render.before', true, array($env, $route));
+
$output = call_user_func_array($route['callback'], array_values($route['params']));
if(is_null($output)) $output = call_if_exists('autorender', $route);
- echo after(error_notices_render() . $output, $route);
+
+ event('render.after', true, array($env, $route, &$output));
+
+ event('after.before', true, array($env, $route, &$output));
+ $output = after(error_notices_render() . $output, $route);
+ event('after.after', true, array($env, $route, &$output));
+ echo $output;
+
+ # echo after(error_notices_render() . $output, $route);
+ }
+ else
+ {
+ halt(SERVER_ERROR, "Routing error: undefined function '{$route['callback']}'", $route);
}
- else halt(SERVER_ERROR, "Routing error: undefined function '{$route['callback']}'", $route);
}
- else route_missing($rm, request_uri($env));
-
+ else
+ {
+ route_missing($rm, request_uri($env));
+ }
+ }
+ else
+ {
+ halt(HTTP_NOT_IMPLEMENTED, "The requested method '$rm' is not implemented");
}
- else halt(HTTP_NOT_IMPLEMENTED, "The requested method '$rm' is not implemented");
}
/**
- * Stop and exit limonade application
- *
- * @access private
- * @param boolean exit or not
- * @return void
- */
+* Stop and exit limonade application
+*
+* @access private
+*
+* @param boolean exit or not
+*
+* @return void
+*
+*/
function stop_and_exit($exit = true)
{
call_if_exists('before_exit', $exit);
@@ -452,12 +590,14 @@ function stop_and_exit($exit = true)
if(request_is_head())
{
ob_end_clean();
- } else {
+ }
+ else
+ {
$flash_sweep = true;
foreach($headers as $header)
{
- // If a Content-Type header exists, flash_sweep only if is text/html
- // Else if there's no Content-Type header, flash_sweep by default
+ # If a Content-Type header exists, flash_sweep only if is text/html
+ # Else if there's no Content-Type header, flash_sweep by default
if(stripos($header, 'Content-Type:') === 0)
{
$flash_sweep = stripos($header, 'Content-Type: text/html') === 0;
@@ -471,16 +611,18 @@ function stop_and_exit($exit = true)
}
/**
- * Returns limonade environment variables:
- *
- * 'SERVER', 'FILES', 'REQUEST', 'SESSION', 'ENV', 'COOKIE',
- * 'GET', 'POST', 'PUT', 'DELETE'
- *
- * If a null argument is passed, reset and rebuild environment
- *
- * @param null @reset reset and rebuild environment
- * @return array
- */
+* Returns limonade environment variables:
+*
+* 'SERVER', 'FILES', 'REQUEST', 'SESSION', 'ENV', 'COOKIE',
+* 'GET', 'POST', 'PUT', 'DELETE'
+*
+* If a null argument is passed, reset and rebuild environment
+*
+* @param null @reset reset and rebuild environment
+*
+* @return array
+*
+*/
function env($reset = null)
{
static $env = array();
@@ -494,8 +636,8 @@ function env($reset = null)
{
if(empty($GLOBALS['_SERVER']))
{
- // Fixing empty $GLOBALS['_SERVER'] bug
- // http://sofadesign.lighthouseapp.com/projects/29612-limonade/tickets/29-env-is-empty
+ # Fixing empty $GLOBALS['_SERVER'] bug
+ # http://sofadesign.lighthouseapp.com/projects/29612-limonade/tickets/29-env-is-empty
$GLOBALS['_SERVER'] =& $_SERVER;
$GLOBALS['_FILES'] =& $_FILES;
$GLOBALS['_REQUEST'] =& $_REQUEST;
@@ -536,10 +678,11 @@ function env($reset = null)
}
/**
- * Returns application root file path
- *
- * @return string
- */
+* Returns application root file path
+*
+* @return string
+*
+*/
function app_file()
{
static $file;
@@ -551,26 +694,170 @@ function app_file()
}
return file_path($file);
}
-
-
-
-
- # # #
-
-
-
-
-# ============================================================================ #
-# 2. ERROR #
-# ============================================================================ #
/**
- * Associate a function with error code(s) and return all associations
+ * Simplistic event handler.
+ *
+ * Usage:
+ * # Adds a callback to an event.
+ * event($event, string $callback);
+ *
+ * # Adds multiple callbacks to an event.
+ * event(array('event', array('callback_1, callback_2')));
+ *
+ * # Adds callbacks to multiple events.
+ * event(array('event_1' => 'callback', 'event_2' => array('callback', 'callback_2')));
+ *
+ * # Fires an event with arguments arg_1, arg2, ..., arg_n.
+ * event('event_name', true, array(arg_1, arg_2, ..., arg_n));
+ *
+ * # Clears an event queue.
+ * event('event_name', false);
+ *
+ *
+ * @param mixed $event The event name or an array of type event => callback(s).
+ * @param mixed $callback optional, the callback name, set to false to clear the event, set true to fire the event
*
- * @param string $errno
- * @param string $function
- * @return array
+ * @return void
*/
+function event($event = null, $callback = null, $args = array())
+{
+ static $events = array();
+ if ( is_null($event))
+ {
+ return $events;
+ }
+ if(is_array($event))
+ {
+ foreach($event as $e => $callback)
+ {
+ if(is_string($callback)) { event($e, $callback); }
+ }
+ return;
+ }
+
+ if(!isset($events[$event])) { $events[$event] = array(); }
+
+ if(true === $callback)
+ {
+ foreach($events[$event] as $callback => $_)
+ {
+ if(function_exists($callback)) { call_user_func_array($callback, array_force($args)); }
+ }
+ }
+ elseif(false === $callback)
+ {
+ $events[$event] = array();
+ }
+ else
+ {
+ foreach(array_force($callback) as $c)
+ {
+ # add callback as array key to allow easier overrides.
+ if(is_string($c)) { $events[$event][$c] = null; }
+ }
+ }
+}
+
+# TODO:: Work on this implementation
+# /**
+# * Extras manager.
+# *
+# * @todo fix this mechanism so it can handle extras requiring other extras.
+# * @todo handle cyclic references.
+# *
+# * @access private
+# *
+# * @param mixed $name set to true to load all extras, array for multiple extras
+# * @return array $extras the list of extras to load
+# */
+# function extras($extra)
+# {
+# static $extras = array();
+# static $loaded = array();
+#
+# if(is_array($extra))
+# {
+# foreach($extra as $e){ extras((string)$e); }
+# }
+# elseif(true === $extra)
+# {
+# foreach(array_diff_assoc($extras, $loaded) as $e => $ignore)
+# {
+# $file = file_path(option('dir.limonade.extras'), 'limonade.'.$e.'.php');
+# if(file_exists($file))
+# {
+# require_once($file);
+# if(function_exists($e.'_init'))
+# {
+# call_user_func($e.'_init');
+# }
+# $loaded[$e] = null;
+# }
+# else
+# {
+# error_notice(E_WARNING, sprintf('Requested extras file "%s" could not be found', $file));
+# }
+# }
+# }
+# else
+# {
+# # protect against invalid extras name.
+# if(preg_match('/^(\w+)/', $extra, $matches))
+# {
+# $extra = $matches[1];
+# $extras[$extra] = null;
+# }
+# }
+# return $extras;
+# }
+#
+# /**
+# * Shortcut function for @see{extras()} for naming consistency.
+# *
+# * @param string $name the name of the extra to use
+# */
+# function use_extra($name) { extras((string) $name); }
+#
+# function use_helper($name)
+# {
+# $file = file_path(option('dir.lib.helpers'), $name.'.helper.php');
+# if(file_exists($file))
+# {
+# require_once($file);
+# }
+# else
+# {
+# error_notice( E_WARNING, sprintf('Helper file "%s" not found.', $file ));
+# }
+# }
+#
+# function use_model($name)
+# {
+# $file = file_path(option('dir.app.models'), $name.'.model.php');
+# if(file_exists($file))
+# {
+# require_once($file);
+# }
+# else
+# {
+# error_notice( E_WARNING, sprintf('Model file "%s" not found.', $file ));
+# }
+# }
+#
+
+// -----
+// ### 2. ERROR
+
+
+/**
+* Associate a function with error code(s) and return all associations
+*
+* @param string $errno
+* @param string $function
+* @return array
+*
+*/
function error($errno = null, $function = null)
{
static $errors = array();
@@ -582,24 +869,29 @@ function error($errno = null, $function = null)
}
/**
- * Raise an error, passing a given error number and an optional message,
- * then exit.
- * Error number should be a HTTP status code or a php user error (E_USER...)
- * $errno and $msg arguments can be passsed in any order
- * If no arguments are passed, default $errno is SERVER_ERROR (500)
- *
- * @param int,string $errno Error number or message string
- * @param string,string $msg Message string or error number
- * @param mixed $debug_args extra data provided for debugging
- * @return void
- */
+* Raise an error, passing a given error number and an optional message,
+* then exit.
+*
+* Error number should be a HTTP status code or a php user error (E_USER...)
+*
+* $errno and $msg arguments can be passsed in any order
+*
+* If no arguments are passed, default $errno is SERVER_ERROR (500)
+*
+* * @param int,string $errno Error number or message string
+* * @param string,string $msg Message string or error number
+* * @param mixed $debug_args extra data provided for debugging
+*
+* @return void
+*
+*/
function halt($errno = SERVER_ERROR, $msg = '', $debug_args = null)
{
$args = func_get_args();
$error = array_shift($args);
# switch $errno and $msg args
- # TODO cleanup / refactoring
+ // ### TODO cleanup / refactoring
if(is_string($errno))
{
$msg = $errno;
@@ -614,21 +906,24 @@ function halt($errno = SERVER_ERROR, $msg = '', $debug_args = null)
set('_lim_err_debug_args', $debug_args);
error_handler_dispatcher($errno, $msg, null, null);
-
}
/**
- * Internal error handler dispatcher
- * Find and call matching error handler and exit
- * If no match found, call default error handler
- *
- * @access private
- * @param int $errno
- * @param string $errstr
- * @param string $errfile
- * @param string $errline
- * @return void
- */
+* Internal error handler dispatcher
+*
+* Find and call matching error handler and exit
+* If no match found, call default error handler
+*
+* @access private
+*
+* * @param int $errno
+* * @param string $errstr
+* * @param string $errfile
+* * @param string $errline
+*
+* @return void
+*
+*/
function error_handler_dispatcher($errno, $errstr, $errfile, $errline)
{
$back_trace = debug_backtrace();
@@ -646,7 +941,7 @@ function error_handler_dispatcher($errno, $errstr, $errfile, $errline)
if(error_wont_halt_app($errno))
{
error_notice($errno, $errstr, $errfile, $errline);
- return;
+ return;
}
else
{
@@ -676,14 +971,19 @@ function error_handler_dispatcher($errno, $errstr, $errfile, $errline)
/**
- * Default error handler
- *
- * @param string $errno
- * @param string $errstr
- * @param string $errfile
- * @param string $errline
- * @return string error output
- */
+* Default error handler
+*
+* @param string $errno
+*
+* @param string $errstr
+*
+* @param string $errfile
+*
+* @param string $errline
+*
+* @return string error output
+*
+*/
function error_default_handler($errno, $errstr, $errfile, $errline)
{
$is_http_err = http_response_status_is_valid($errno);
@@ -697,28 +997,33 @@ function error_default_handler($errno, $errstr, $errfile, $errline)
}
/**
- * Returns not found error output
- *
- * @access private
- * @param string $msg
- * @return string
- */
+* Returns not found error output
+*
+* @access private
+*
+* @param string $msg
+*
+* @return string
+*
+*/
function error_not_found_output($errno, $errstr, $errfile, $errline)
{
if(!function_exists('not_found'))
{
/**
- * Default not found error output
- *
- * @param string $errno
- * @param string $errstr
- * @param string $errfile
- * @param string $errline
- * @return string
- */
+ * Default not found error output
+ *
+ * * @param string $errno
+ * * @param string $errstr
+ * * @param string $errfile
+ * * @param string $errline
+ *
+ * @return string
+ *
+ */
function not_found($errno, $errstr, $errfile=null, $errline=null)
{
- option('views_dir', option('error_views_dir'));
+ option('dir.views', option('dir.views.errors'));
$msg = h(rawurldecode($errstr));
return html("{$msg}
json_encode() function beore using json().
- *
- * @param string $data
- * @param int $json_option
- * @return string
- */
+* Returns json representation of data with proper http headers
+*
+* On PHP 5 < PHP 5.2.0, you must provide your own implementation of the
+* json_encode() function beore using json().
+*
+* @param string $data
+* @param int $json_option
+*
+* @return string
+*/
function json($data, $json_option = 0)
{
send_header('Content-Type: application/json; charset='.strtolower(option('encoding')));
@@ -1560,25 +1945,26 @@ function json($data, $json_option = 0)
}
/**
- * undocumented function
- *
- * @param string $filename
- * @param string $return
- * @return mixed number of bytes delivered or file output if $return = true
- */
+* undocumented function
+*
+* @param string $filename
+* @param string $return
+*
+* @return mixed number of bytes delivered or file output if $return = true
+*/
function render_file($filename, $return = false)
{
- # TODO implements X-SENDFILE headers
- // if($x-sendfile = option('x-sendfile'))
- // {
- // // add a X-Sendfile header for apache and Lighttpd >= 1.5
- // if($x-sendfile > X-SENDFILE) // add a X-LIGHTTPD-send-file header
- //
- // }
- // else
- // {
- //
- // }
+ // TODO implements X-SENDFILE headers
+ # if($x-sendfile = option('x-sendfile'))
+ # {
+ # // add a X-Sendfile header for apache and Lighttpd >= 1.5
+ # if($x-sendfile > X-SENDFILE) // add a X-LIGHTTPD-send-file header
+ #
+ # }
+ # else
+ # {
+ #
+ # }
$filename = str_replace('../', '', $filename);
if(file_exists($filename))
{
@@ -1592,42 +1978,39 @@ function render_file($filename, $return = false)
}
/**
- * Call before_sending_header() if it exists, then send headers
- *
- * @param string $header
- * @return void
- */
+* Call before_sending_header() if it exists, then send headers
+*
+* @param string $header
+*
+* @return void
+*/
function send_header($header = null, $replace = true, $code = false)
{
- if(!headers_sent())
- {
- call_if_exists('before_sending_header', $header);
- header($header, $replace, $code);
- }
+ if(!headers_sent())
+ {
+ call_if_exists('before_sending_header', $header);
+ header($header, $replace, $code);
+ }
}
+// -----
+// ### 6. HELPERS
- # # #
-
-
-
-
-# ============================================================================ #
-# 6. HELPERS #
-# ============================================================================ #
-
/**
- * Returns an url composed of params joined with /
- * A param can be a string or an array.
- * If param is an array, its members will be added at the end of the return url
- * as GET parameters "&key=value".
- *
- * @param string or array $param1, $param2 ...
- * @return string
- */
+* Returns an url composed of params joined with /
+*
+* A param can be a string or an array.
+*
+* If param is an array, its members will be added at the end of the return url
+* as GET parameters "&key=value".
+*
+* @param string or array $param1, $param2 ...
+*
+* @return string
+*/
function url_for($params = null)
{
$paths = array();
@@ -1657,7 +2040,7 @@ function url_for($params = null)
if(!filter_var_url($path))
{
# it's a relative URL or an URL without a schema
- $base_uri = option('base_uri');
+ $base_uri = option('base.uri');
$path = file_path($base_uri, $path);
}
@@ -1681,14 +2064,16 @@ function url_for($params = null)
}
/**
- * An alias of {@link htmlspecialchars()}.
- * If no $charset is provided, uses option('encoding') value
- *
- * @param string $str
- * @param string $quote_style
- * @param string $charset
- * @return void
- */
+* An alias of {@link htmlspecialchars()}.
+* If no $charset is provided, uses option('encoding') value
+*
+* @param string $str
+* @param string $quote_style
+* @param string $charset
+*
+* @return void
+*
+*/
function h($str, $quote_style = ENT_NOQUOTES, $charset = null)
{
if(is_null($charset)) $charset = strtoupper(option('encoding'));
@@ -1696,17 +2081,19 @@ function h($str, $quote_style = ENT_NOQUOTES, $charset = null)
}
/**
- * Set and returns flash messages that will be available in the next action
- * via the {@link flash_now()} function or the view variable $flash.
- *
- * If multiple values are provided, set $name variable with an array of those values.
- * If there is only one value, set $name variable with the provided $values
- * or if it's $name is an array, merge it with current messages.
- *
- * @param string, array $name
- * @param mixed $values,...
- * @return mixed variable value for $name if $name argument is provided, else return all variables
- */
+* Set and returns flash messages that will be available in the next action
+* via the {@link flash_now()} function or the view variable $flash.
+*
+* If multiple values are provided, set $name variable with an array of those values.
+*
+* If there is only one value, set $name variable with the provided $values
+* or if it's $name is an array, merge it with current messages.
+*
+* @param string, array $name
+* @param mixed $values,...
+*
+* @return mixed variable value for $name if $name argument is provided, else return all variables
+*/
function flash($name = null, $value = null)
{
if(!defined('SID')) trigger_error("Flash messages can't be used because session isn't enabled", E_USER_WARNING);
@@ -1725,19 +2112,22 @@ function flash($name = null, $value = null)
}
/**
- * Set and returns flash messages available for the current action, included those
- * defined in the previous action with {@link flash()}
- * Those messages will also be passed to the views and made available in the
- * $flash variable.
- *
- * If multiple values are provided, set $name variable with an array of those values.
- * If there is only one value, set $name variable with the provided $values
- * or if it's $name is an array, merge it with current messages.
- *
- * @param string, array $name
- * @param mixed $values,...
- * @return mixed variable value for $name if $name argument is provided, else return all variables
- */
+* Set and returns flash messages available for the current action, included those
+* defined in the previous action with {@link flash()}
+*
+* Those messages will also be passed to the views and made available in the
+* $flash variable.
+*
+* If multiple values are provided, set $name variable with an array of those values.
+*
+* If there is only one value, set $name variable with the provided $values
+* or if it's $name is an array, merge it with current messages.
+*
+* @param string, array $name
+* @param mixed $values,...
+*
+* @return mixed variable value for $name if $name argument is provided, else return all variables
+*/
function flash_now($name = null, $value = null)
{
static $messages = null;
@@ -1761,13 +2151,16 @@ function flash_now($name = null, $value = null)
}
/**
- * Delete current flash messages in session, and set new ones stored with
- * flash function.
- * Called before application exit.
- *
- * @access private
- * @return void
- */
+* Delete current flash messages in session, and set new ones stored with
+* flash function.
+*
+* Called before application exit.
+*
+* @access private
+*
+* @return void
+*
+*/
function flash_sweep()
{
if(defined('SID'))
@@ -1778,18 +2171,20 @@ function flash_sweep()
}
/**
- * Starts capturing block of text
- *
- * Calling without params stops capturing (same as end_content_for()).
- * After capturing the captured block is put into a variable
- * named $name for later use in layouts. If second parameter
- * is supplied, its content will be used instead of capturing
- * a block of text.
- *
- * @param string $name
- * @param string $content
- * @return void
- */
+* Starts capturing block of text
+*
+* Calling without params stops capturing (same as end_content_for()).
+*
+* After capturing the captured block is put into a variable
+* named $name for later use in layouts. If second parameter
+* is supplied, its content will be used instead of capturing
+* a block of text.
+*
+* @param string $name
+* @param string $content
+*
+* @return void
+*/
function content_for($name = null, $content = null)
{
static $_name = null;
@@ -1810,61 +2205,61 @@ function content_for($name = null, $content = null)
}
/**
- * Stops capturing block of text
- *
- * @return void
- */
+* Stops capturing block of text
+*
+* @return void
+*
+*/
function end_content_for()
{
content_for();
}
/**
- * Shows current memory and execution time of the application.
- * Returns only execution time if memory_get_usage()
- * isn't available.
- * ( That's the case before PHP5.2.1 if PHP isn't compiled with option
- * --enable-memory-limit. )
- *
- * @access public
- * @return array
- */
+* Shows current memory and execution time of the application.
+*
+* Returns only execution time if memory_get_usage() is not available.
+* ( That's the case before PHP5.2.1 if PHP isn't compiled with option
+* --enable-memory-limit. )
+*
+* @access public
+*
+* @return array
+*
+*/
function benchmark()
{
- $res = array( 'execution_time' => (microtime() - LIM_START_MICROTIME) );
+ $res = array( 'execution_time' => (microtime() - LIM_START_MICROTIME) );
if(defined('LIM_START_MEMORY'))
- {
- $current_mem_usage = memory_get_usage();
- $res['current_memory'] = $current_mem_usage;
- $res['start_memory'] = LIM_START_MEMORY;
- $res['average_memory'] = (LIM_START_MEMORY + $current_mem_usage) / 2;
- }
+ {
+ $current_mem_usage = memory_get_usage();
+ $res['current_memory'] = $current_mem_usage;
+ $res['start_memory'] = LIM_START_MEMORY;
+ $res['average_memory'] = (LIM_START_MEMORY + $current_mem_usage) / 2;
+ }
- return $res;
+ return $res;
}
-
- # # #
+// -----
+// ### 7. UTILS
-
-
-# ============================================================================ #
-# 7. UTILS #
-# ============================================================================ #
/**
- * Calls a function if exists
- *
- * @param callback $callback a function stored in a string variable,
- * or an object and the name of a method within the object
- * See {@link http://php.net/manual/en/language.pseudo-types.php#language.types.callback php documentation}
- * to learn more about callbacks.
- * @param mixed $arg,.. (optional)
- * @return mixed
- */
+* Calls a function if exists
+*
+* @param callback $callback a function stored in a string variable,
+* or an object and the name of a method within the object
+* See {@link http://php.net/manual/en/language.pseudo-types.php#language.types.callback php documentation}
+* to learn more about callbacks.
+*
+* @param mixed $arg,.. (optional)
+*
+* @return mixed
+*/
function call_if_exists($callback)
{
$args = func_get_args();
@@ -1874,50 +2269,54 @@ function call_if_exists($callback)
}
/**
- * Define a constant unless it already exists
- *
- * @param string $name
- * @param string $value
- * @return void
- */
+* Define a constant unless it already exists
+*
+* @param string $name
+* @param string $value
+*
+* @return void
+*/
function define_unless_exists($name, $value)
{
if(!defined($name)) define($name, $value);
}
/**
- * Return a default value if provided value is empty
- *
- * @param mixed $value
- * @param mixed $default default value returned if $value is empty
- * @return mixed
- */
+* Return a default value if provided value is empty
+*
+* @param mixed $value
+* @param mixed $default default value returned if $value is empty
+*
+* @return mixed
+*/
function value_or_default($value, $default)
{
return empty($value) ? $default : $value;
}
/**
- * An alias of {@link value_or_default()}
- *
- *
- * @param mixed $value
- * @param mixed $default
- * @return mixed
- */
+* An alias of {@link value_or_default()}
+*
+*
+* @param mixed $value
+* @param mixed $default
+*
+* @return mixed
+*/
function v($value, $default)
{
return value_or_default($value, $default);
}
/**
- * Load php files with require_once in a given dir
- *
- * @param string $path Path in which are the file to load
- * @param string $pattern a regexp pattern that filter files to load
- * @param bool $prevents_output security option that prevents output
- * @return array paths of loaded files
- */
+* Load php files with require_once in a given dir
+*
+* @param string $path Path in which are the file to load
+* @param string $pattern a regexp pattern that filter files to load
+* @param bool $prevents_output security option that prevents output
+*
+* @return array paths of loaded files
+*/
function require_once_dir($path, $pattern = "*.php", $prevents_output = true)
{
if($path[strlen($path) - 1] != "/") $path .= "/";
@@ -1930,12 +2329,13 @@ function require_once_dir($path, $pattern = "*.php", $prevents_output = true)
}
/**
- * Dumps a variable into inspectable format
- *
- * @param anything $var the variable to debug
- * @param bool $output_as_html sets whether to wrap output in tags. default: true
- * @return string the variable with output
- */
+* Dumps a variable into inspectable format
+*
+* @param anything $var the variable to debug
+* @param bool $output_as_html sets whether to wrap output in tags. default: true
+*
+* @return string the variable with output
+*/
function debug($var, $output_as_html = true)
{
if ( is_null($var) ) { return '[NULL]'; };
@@ -1967,10 +2367,55 @@ function debug($var, $output_as_html = true)
}
-## HTTP utils _________________________________________________________________
+/**
+ * Provides debugging output of all system settings, enabling easy inspection of
+ * all current values and settings.
+ *
+ * Depends on option('settings.show') being set and true, else outputs simple HTML comment.
+ *
+ * @return string the html output displaying all the settings.
+ */
+
+function settings_show_output()
+{
+ if ( option('settings.show') )
+ {
+ $c_view_dir = option('dir.views'); # keep for restore after render
+ option('dir.views', option('dir.limonade.views'));
+ $o = render('_settings.html.php', null);
+ option('dir.views', $c_view_dir); # restore current views dir
+ return $o;
+ }
+ else
+ {
+ return "";
+ }
+}
+
+/**
+* Syntactic sugar for var_export()
+*
+* Params
+*
+* @param (string) $var => the variable/object/array to dump
+*
+* @return (string)
+*
+* Examples
+*
+*
+*
+*/
+function _dump($var)
+{
+ return var_export($var, true);
+}
+
+// -----
+// #### HTTP utils
-### Constants: HTTP status codes
+# Constants: HTTP status codes
define( 'HTTP_CONTINUE', 100 );
define( 'HTTP_SWITCHING_PROTOCOLS', 101 );
@@ -2026,11 +2471,12 @@ function debug($var, $output_as_html = true)
define( 'HTTP_NOT_EXTENDED', 510 );
/**
- * Output proper HTTP header for a given HTTP code
- *
- * @param string $code
- * @return void
- */
+* Output proper HTTP header for a given HTTP code
+*
+* @param string $code
+*
+* @return void
+*/
function status($code = 500)
{
if(!headers_sent())
@@ -2041,20 +2487,25 @@ function status($code = 500)
}
/**
- * Http redirection
- *
- * Same use as {@link url_for()}
- * By default HTTP status code is 302, but a different code can be specified
- * with a status key in array parameter.
- *
- *
- * redirecto('new','url'); # 302 HTTP_MOVED_TEMPORARILY by default
- * redirecto('new','url', array('status' => HTTP_MOVED_PERMANENTLY));
- *
- *
- * @param string or array $param1, $param2...
- * @return void
- */
+* Http redirection
+*
+* Same use as {@link url_for()}
+*
+* By default HTTP status code is 302, but a different code can be specified
+* with a status key in array parameter.
+*
+*
+* redirecto('new','url'); # 302 HTTP_MOVED_TEMPORARILY by default
+*
+*
+* redirecto('new','url', array('status' => HTTP_MOVED_PERMANENTLY));
+*
+*
+* @param string or array $param1, $param2...
+*
+* @return void
+*
+*/
function redirect_to($params)
{
# [NOTE]: (from php.net) HTTP/1.1 requires an absolute URI as argument to » Location:
@@ -2063,7 +2514,7 @@ function redirect_to($params)
# $_SERVER['PHP_SELF'] and dirname() to make an absolute URI from a relative
# one yourself.
- # TODO make absolute uri
+ // ### TODO make absolute uri
if(!headers_sent())
{
$status = HTTP_MOVED_TEMPORARILY; # default for a redirection in PHP
@@ -2091,12 +2542,14 @@ function redirect_to($params)
}
/**
- * Http redirection
- *
- * @deprecated deprecated since version 0.4. Please use {@link redirect_to()} instead.
- * @param string $url
- * @return void
- */
+* HTTP redirection
+*
+* @deprecated deprecated since version 0.4. Please use {@link redirect_to()} instead.
+*
+* @param string $url
+*
+* @return void
+*/
function redirect($uri)
{
# halt('redirect() is deprecated. Please use redirect_to() instead.', E_LIM_DEPRECATED);
@@ -2105,12 +2558,14 @@ function redirect($uri)
}
/**
- * Returns HTTP response status for a given code.
- * If no code provided, return an array of all status
- *
- * @param string $num
- * @return string,array
- */
+* Returns HTTP response status for a given code.
+*
+* If no code provided, return an array of all status
+*
+* @param string $num
+*
+* @return string,array
+*/
function http_response_status($num = null)
{
$status = array(
@@ -2175,11 +2630,12 @@ function http_response_status($num = null)
}
/**
- * Checks if an HTTP response code is valid
- *
- * @param string $num
- * @return bool
- */
+* Checks if an HTTP response code is valid
+*
+* @param string $num
+*
+* @return bool
+*/
function http_response_status_is_valid($num)
{
$r = http_response_status($num);
@@ -2187,11 +2643,12 @@ function http_response_status_is_valid($num)
}
/**
- * Returns an HTTP response status string for a given code
- *
- * @param string $num
- * @return string
- */
+* Returns an HTTP response status string for a given code
+*
+* @param string $num
+*
+* @return string
+*/
function http_response_status_code($num)
{
$protocole = empty($_SERVER["SERVER_PROTOCOL"]) ? "HTTP/1.1" : $_SERVER["SERVER_PROTOCOL"];
@@ -2199,17 +2656,18 @@ function http_response_status_code($num)
}
/**
- * Check if the _Accept_ header is present, and includes the given `type`.
- *
- * When the _Accept_ header is not present `true` is returned. Otherwise
- * the given `type` is matched by an exact match, and then subtypes. You
- * may pass the subtype such as "html" which is then converted internally
- * to "text/html" using the mime lookup table.
- *
- * @param string $type
- * @param string $env
- * @return bool
- */
+* Check if the _Accept_ header is present, and includes the given `type`.
+*
+* When the _Accept_ header is not present `true` is returned. Otherwise
+* the given `type` is matched by an exact match, and then subtypes. You
+* may pass the subtype such as "html" which is then converted internally
+* to "text/html" using the mime lookup table.
+*
+* @param string $type
+* @param string $env
+*
+* @return bool
+*/
function http_ua_accepts($type, $env = null)
{
if(is_null($env)) $env = env();
@@ -2219,13 +2677,13 @@ function http_ua_accepts($type, $env = null)
if($type)
{
- // Allow "html" vs "text/html" etc
+ # Allow "html" vs "text/html" etc
if(!strpos($type, '/')) $type = mime_type($type);
- // Check if we have a direct match
+ # Check if we have a direct match
if(strpos($accept, $type) > -1) return true;
- // Check if we have type/*
+ # Check if we have type/*
$type_parts = explode('/', $type);
$type = $type_parts[0].'/*';
return (strpos($accept, $type) > -1);
@@ -2234,16 +2692,19 @@ function http_ua_accepts($type, $env = null)
return false;
}
-## FILE utils _________________________________________________________________
+// -----
+// #### FILE utils
+
/**
- * Returns mime type for a given extension or if no extension is provided,
- * all mime types in an associative array, with extensions as keys.
- * (extracted from Orbit source http://orbit.luaforge.net/)
- *
- * @param string $ext
- * @return string, array
- */
+* Returns mime type for a given extension or if no extension is provided,
+* all mime types in an associative array, with extensions as keys.
+* (extracted from Orbit source http://orbit.luaforge.net/)
+*
+* @param string $ext
+*
+* @return string, array
+*/
function mime_type($ext = null)
{
$types = array(
@@ -2410,14 +2871,16 @@ function mime_type($ext = null)
}
/**
- * Detect MIME Content-type for a file
- *
- * @param string $filename Path to the tested file.
- * @return string
- */
+* Detect MIME Content-type for a file
+*
+* @param string $filename Path to the tested file.
+*
+* @return string
+*
+*/
function file_mime_content_type($filename)
{
- $ext = file_extension($filename); /* strtolower isn't necessary */
+ $ext = file_extension($filename); # strtolower isn't necessary
if($mime = mime_type($ext)) return $mime;
elseif (function_exists('finfo_open'))
{
@@ -2435,18 +2898,20 @@ function file_mime_content_type($filename)
/**
- * Read and output file content and return filesize in bytes or status after
- * closing file.
- * This function is very efficient for outputing large files without timeout
- * nor too expensive memory use
- *
- * @param string $filename
- * @param string $retbytes
- * @return bool, int
- */
+* Read and output file content and return file size in bytes or status after
+* closing file.
+*
+* This function is very efficient for outputting large files without timeout
+* nor too expensive memory use
+*
+* @param string $filename
+* @param string $retbytes
+*
+* @return bool, int
+*/
function file_read_chunked($filename, $retbytes = true)
{
- $chunksize = 1*(1024*1024); // how many bytes per chunk
+ $chunksize = 1*(1024*1024); # how many bytes per chunk
$buffer = '';
$cnt = 0;
$handle = fopen($filename, 'rb');
@@ -2464,17 +2929,19 @@ function file_read_chunked($filename, $retbytes = true)
ob_end_flush();
$status = fclose($handle);
- if ($retbytes && $status) return $cnt; // return num. bytes delivered like readfile() does.
+ if ($retbytes && $status) return $cnt; # return num. bytes delivered like readfile() does.
return $status;
}
/**
- * Create a file path by concatenation of given arguments.
- * Windows paths with backslash directory separators are normalized in *nix paths.
- *
- * @param string $path, ...
- * @return string normalized path
- */
+* Create a file path by concatenation of given arguments.
+*
+* Windows paths with backslash directory separators are normalized in *nix paths.
+*
+* @param string $path, ...
+*
+* @return string normalized path
+*/#
function file_path($path)
{
$args = func_get_args();
@@ -2483,16 +2950,16 @@ function file_path($path)
$n_path = count($args) > 1 ? implode($ds, $args) : $path;
if(strpos($n_path, $win_ds) !== false) $n_path = str_replace( $win_ds, $ds, $n_path );
$n_path = preg_replace( "#$ds+#", $ds, $n_path);
-
return $n_path;
}
/**
- * Returns file extension or false if none
- *
- * @param string $filename
- * @return string, false
- */
+* Returns file extension or false if none
+*
+* @param string $filename
+*
+* @return string, false
+*/
function file_extension($filename)
{
$pos = strrpos($filename, '.');
@@ -2501,11 +2968,12 @@ function file_extension($filename)
}
/**
- * Checks if $filename is a text file
- *
- * @param string $filename
- * @return bool
- */
+* Checks if $filename is a text file
+*
+* @param string $filename
+*
+* @return bool
+*/
function file_is_text($filename)
{
if($mime = file_mime_content_type($filename)) return substr($mime,0,5) == "text/";
@@ -2513,11 +2981,13 @@ function file_is_text($filename)
}
/**
- * Checks if $filename is a binary file
- *
- * @param string $filename
- * @return void
- */
+* Checks if $filename is a binary file
+*
+* @param string $filename
+*
+* @return void
+*
+*/
function file_is_binary($filename)
{
$is_text = file_is_text($filename);
@@ -2525,12 +2995,11 @@ function file_is_binary($filename)
}
/**
- * Return or output file content
- *
- * @return string, int
- *
- **/
-
+* Return or output file content
+*
+* @return string, int
+*
+*/
function file_read($filename, $return = false)
{
if(!file_exists($filename)) trigger_error("$filename doesn't exists", E_USER_ERROR);
@@ -2539,11 +3008,12 @@ function file_read($filename, $return = false)
}
/**
- * Returns an array of files contained in a directory
- *
- * @param string $dir
- * @return array
- */
+* Returns an array of files contained in a directory
+*
+* @param string $dir
+*
+* @return array
+*/
function file_list_dir($dir)
{
$files = array();
@@ -2558,19 +3028,37 @@ function file_list_dir($dir)
return $files;
}
-## Extra utils ________________________________________________________________
+
+
+// -----
+// #### Extra utils
+
+
+/**
+ * Force a value to be an array.
+ *
+ * @param mixed $value The value to make sure is an array.
+ *
+ * @return array The provided $value if it was an array or array($value)
+ */
+function array_force($value)
+{
+ return (is_array($value) ? $value : array($value));
+}
if(!function_exists('array_replace'))
{
/**
- * For PHP 5 < 5.3.0 (backward compatibility)
- * (from {@link http://www.php.net/manual/fr/function.array-replace.php#92549 this php doc. note})
- *
- * @see array_replace()
- * @param string $array
- * @param string $array1
- * @return $array
- */
+ * For PHP 5 < 5.3.0 (backward compatibility)
+ * (from {@link http://www.php.net/manual/fr/function.array-replace.php#92549 this php doc. note})
+ *
+ * @see array_replace()
+ *
+ * @param string $array
+ * @param string $array1
+ *
+ * @return $array
+ */
function array_replace( array &$array, array &$array1 )
{
$args = func_get_args();
@@ -2596,15 +3084,15 @@ function array_replace( array &$array, array &$array1 )
}
/**
- * Check if a string is an url
- *
- * This implementation no longer requires
- * {@link http://www.php.net/manual/en/book.filter.php the filter extenstion},
- * so it will improve compatibility with older PHP versions.
- *
- * @param string $str
- * @return false, str the string if true, false instead
- */
+* Check if a string is an url
+*
+* This implementation no longer requires
+* {@link http://www.php.net/manual/en/book.filter.php the filter extenstion},
+* so it will improve compatibility with older PHP versions.
+*
+* @param string $str
+* @return false, str the string if true, false instead
+*/
function filter_var_url($str)
{
$regexp = '@^https?://([-[:alnum:]]+\.)+[a-zA-Z]{2,6}(:[0-9]+)?(.*)?$@';
@@ -2612,44 +3100,40 @@ function filter_var_url($str)
return preg_match($regexp, $str) ? $str : false;
}
-
/**
- * For PHP 5 < 5.1.0 (backward compatibility)
- * (from {@link http://www.php.net/manual/en/function.htmlspecialchars-decode.php#82133})
- *
- * @param string $string
- * @param string $quote_style, one of: ENT_COMPAT, ENT_QUOTES, ENT_NOQUOTES
- * @return the decoded string
- */
+* For PHP 5 < 5.1.0 (backward compatibility)
+* (from {@link http://www.php.net/manual/en/function.htmlspecialchars-decode.php#82133})
+*
+* @param string $string
+* @param string $quote_style, one of: ENT_COMPAT, ENT_QUOTES, ENT_NOQUOTES
+*
+* @return the decoded string
+*/
function limonade_htmlspecialchars_decode($string, $quote_style = ENT_COMPAT)
{
- $table = array_flip(get_html_translation_table(HTML_SPECIALCHARS, $quote_style));
- if($quote_style === ENT_QUOTES)
- $table['''] = $table['''] = '\'';
- return strtr($string, $table);
+ $table = array_flip(get_html_translation_table(HTML_SPECIALCHARS, $quote_style));
+ if($quote_style === ENT_QUOTES) { $table['''] = $table['''] = '\''; }
+ return strtr($string, $table);
}
if(!function_exists('htmlspecialchars_decode'))
{
- function htmlspecialchars_decode($string, $quote_style = ENT_COMPAT)
- {
- return limonade_htmlspecialchars_decode($string, $quote_style);
- }
+ function htmlspecialchars_decode($string, $quote_style = ENT_COMPAT)
+ {
+ return limonade_htmlspecialchars_decode($string, $quote_style);
+ }
}
/**
- * Called just after loading libs, it provides fallback for some
- * functions if they don't exists.
- *
- */
+* Called just after loading libs, it provides fallback for some
+* functions if they don't exists.
+*
+*/
function fallbacks_for_not_implemented_functions()
{
if(!function_exists('json_encode'))
{
- /**
- * for PHP 5 < PHP 5.2.0
- *
- */
+ # for PHP 5 < PHP 5.2.0
function json_encode()
{
trigger_error(
@@ -2660,5 +3144,5 @@ function json_encode()
}
-
-# ================================= END ================================== #
+#/EOF
+?>
diff --git a/lib/limonade/assertions.php b/lib/limonade/assertions.php
index 952bd59..e9b5f76 100644
--- a/lib/limonade/assertions.php
+++ b/lib/limonade/assertions.php
@@ -1,19 +1,22 @@
should be TRUE')
{
test_run_assertion();
@@ -110,24 +113,24 @@ function assert_trigger_error($callable, $args = array(), $message = '<1> should
return assert('$trigger_errors < count($GLOBALS["limonade"]["test_errors"]); //'.$message);
}
-# TODO add web browser assertions assert_http_get, assert_http_response... as in SimpleTest (http://www.simpletest.org/en/web_tester_documentation.html)
+# #### TODO add web browser assertions assert_http_get, assert_http_response... as in SimpleTest (http://www.simpletest.org/en/web_tester_documentation.html)
function assert_header($response, $expected_name, $expected_value = null, $message = "expected header '%s' to be equal to '%s' but received '%s: %s'")
{
test_run_assertion();
- # see assert_header in http://github.com/fnando/voodoo-test/blob/f3b0994ef138a6ba94d5e7cef6c1fb1720797a86/lib/assertions.php
+ // see assert_header in http://github.com/fnando/voodoo-test/blob/f3b0994ef138a6ba94d5e7cef6c1fb1720797a86/lib/assertions.php
$headers = preg_split("/^\s*$/ms", $response);
- //var_dump($headers);
+ // var_dump($headers);
$headers = preg_replace("/\s*$/sm", "", $headers[0]);
- //var_dump($headers);
+ // var_dump($headers);
$regex_header = str_replace("/", "\\/", $expected_name);
$regex_header = str_replace(".", "\\.", $regex_header);
$header = $expected_name;
- # from http://www.faqs.org/rfcs/rfc2616
- # Field names are case-insensitive
+ // from http://www.faqs.org/rfcs/rfc2616
+ // Field names are case-insensitive
if ($expected_value) {
$regex = "/^{$regex_header}:(.*?)$/ism";
$header .= ": {$expected_value}";
diff --git a/lib/limonade/public/css/screen.css b/lib/limonade/public/css/screen.css
index cf8578e..0a0a73b 100644
--- a/lib/limonade/public/css/screen.css
+++ b/lib/limonade/public/css/screen.css
@@ -106,115 +106,115 @@ hr.space {background:#fff;color:#fff;}
----------------------------------------------------------------------- */
html {
- background-color: #b4a689;
- text-align: center;
- }
- body {
- width: auto; /* 16 col */
- margin: 0 20px;
- text-align: left;
- /*background: #fff url(blueprint/src/grid.png);*/
- font-family: Verdana, Geneva, sans-serif;
- color: #303030;
- }
- a, a:hover, a:visited {
- color: #4596cd;
- }
- a:hover {
- text-decoration: none;
- }
- #header, h1, h2, h3, h4 {
- font-family: "Arial Black", Gadget, sans-serif;
- }
- h1 {
- color: #b4a689;
- font-size: 2em;
- line-height: 2;
- border-bottom: 7px solid #000;
- margin-bottom: 0.75em;
- margin-top:0;
- }
- h2 {
- font-size: 1.5em;
- color: #cddb12;
- margin-top: 2em;
- line-height: 0.8;
- margin-bottom: 1.2em;
- }
- h3 {
- font-size: 1.33em;
- line-height: 0.89;
- margin-top: 2.66em;
- margin-bottom: 1.33em;
- color:#95b383;
- }
- pre {
- background-color: #cddb12;
- font-size: 12px;
- padding: 1.5em;
- margin-bottom: 1.5em;
- overflow: auto;
- }
- code {
- font: 10px Monaco, "Courier New", Courier, monospace;
- color: #0d562a;
- }
- #header {
- /*position:relative;*/
- height: 187px; /* 12 lines */
- background: #fff url() no-repeat 0 0;
- margin-top: 10px;
+ background-color: #b4a689;
+ text-align: center;
+ }
+ body {
+ width: auto; /* 16 col */
+ margin: 0 20px;
+ text-align: left;
+ /*background: #fff url(blueprint/src/grid.png);*/
+ font-family: Verdana, Geneva, sans-serif;
+ color: #303030;
+ }
+ a, a:hover, a:visited {
+ color: #4596cd;
+ }
+ a:hover {
+ text-decoration: none;
+ }
+ #header, h1, h2, h3, h4 {
+ font-family: "Arial Black", Gadget, sans-serif;
+ }
+ h1 {
+ color: #b4a689;
+ font-size: 2em;
+ line-height: 2;
+ border-bottom: 7px solid #000;
+ margin-bottom: 0.75em;
+ margin-top:0;
+ }
+ h2 {
+ font-size: 1.5em;
+ color: #cddb12;
+ margin-top: 2em;
+ line-height: 0.8;
+ margin-bottom: 1.2em;
+ }
+ h3 {
+ font-size: 1.33em;
+ line-height: 0.89;
+ margin-top: 2.66em;
+ margin-bottom: 1.33em;
+ color:#95b383;
+ }
+ pre {
+ background-color: #cddb12;
+ font-size: 12px;
+ padding: 1.5em;
+ margin-bottom: 1.5em;
+ overflow: auto;
+ }
+ code {
+ font: 10px Monaco, "Courier New", Courier, monospace;
+ color: #0d562a;
+ }
+ #header {
+ /*position:relative;*/
+ height: 187px; /* 12 lines */
+ background: #fff url() no-repeat 0 0;
+ margin-top: 10px;
padding:0;
- }
- #header h1 {
- position: absolute;
- left:-9999px;
- margin:0;
- }
- #footer {
- padding: 0 55px;
- background-color: #1a1818;
- color: #999;
- height: 2em;
- line-height: 2em;
- text-align: right;
- }
- #footer a {
- color: #a3d8de;
- text-decoration: none;
- }
- #footer a:hover {
- color: #fff;
- }
- #content {
- background-color: #fff;
- padding: 0 55px;
- min-height: 400px;
- }
- p.bt {
- text-align:right;
- }
- p.bt a {
- text-decoration:none;
- padding: 2px 4px;
- }
- p.bt a:hover {
- background-color: #4596cd;
- color: #fff;
- }
- #debug-menu {
- position: fixed;
- top: 0px;
- right:20px;
- background-color: rgba(100,100,100, 0.7);
- padding:5px;
- }
- #debug-menu a {
- color: #fff;
- font-size: 90%;
- text-decoration:none;
- }
- #debug-menu a:hover {
- text-decoration: underline;
- }
+ }
+ #header h1 {
+ position: absolute;
+ left:-9999px;
+ margin:0;
+ }
+ #footer {
+ padding: 0 55px;
+ background-color: #1a1818;
+ color: #999;
+ height: 2em;
+ line-height: 2em;
+ text-align: right;
+ }
+ #footer a {
+ color: #a3d8de;
+ text-decoration: none;
+ }
+ #footer a:hover {
+ color: #fff;
+ }
+ #content {
+ background-color: #fff;
+ padding: 0 55px;
+ min-height: 400px;
+ }
+ p.bt {
+ text-align:right;
+ }
+ p.bt a {
+ text-decoration:none;
+ padding: 2px 4px;
+ }
+ p.bt a:hover {
+ background-color: #4596cd;
+ color: #fff;
+ }
+ #debug-menu {
+ position: fixed;
+ top: 0px;
+ right:20px;
+ background-color: rgba(100,100,100, 0.7);
+ padding:5px;
+ }
+ #debug-menu a {
+ color: #fff;
+ font-size: 90%;
+ text-decoration:none;
+ }
+ #debug-menu a:hover {
+ text-decoration: underline;
+ }
\ No newline at end of file
diff --git a/lib/limonade/public/img/404.png b/lib/limonade/public/img/404.png
new file mode 100644
index 0000000..902110e
Binary files /dev/null and b/lib/limonade/public/img/404.png differ
diff --git a/lib/limonade/public/img/500.png b/lib/limonade/public/img/500.png
new file mode 100644
index 0000000..57c84c3
Binary files /dev/null and b/lib/limonade/public/img/500.png differ
diff --git a/lib/limonade/tests.php b/lib/limonade/tests.php
index 5e723d0..73dd082 100644
--- a/lib/limonade/tests.php
+++ b/lib/limonade/tests.php
@@ -1,15 +1,11 @@
E_USER_NOTICE)
- echo test_cli_format("!!! ERROR", "red") . " [$errno], $errstr in $errfile at line $errline\n";
- $GLOBALS["limonade"]["test_errors"][] = array($errno, $errstr, $errfile, $errline);
- return true;
+{
+ if($errno < E_USER_ERROR || $errno > E_USER_NOTICE)
+ echo test_cli_format("!!! ERROR", "red") . " [$errno], $errstr in $errfile at line $errline\n";
+ $GLOBALS["limonade"]["test_errors"][] = array($errno, $errstr, $errfile, $errline);
+ return true;
}
/**
@@ -292,7 +288,8 @@ function test_assert_failure($script, $line, $message)
$GLOBALS["limonade"]["test_cases"][$name]['failures']++;
}
-function test_cli_format($text, $format) {
+function test_cli_format($text, $format)
+{
$formats = array(
"blue" => 34,
"bold" => 1,
@@ -310,41 +307,47 @@ function test_cli_format($text, $format) {
return chr(27) . "[01;{$format} m{$text}" . chr(27) . "[00m";
}
-/**
- * Do HTTP request and return the response content.
- *
- * @param string $url
- * @param string $method
- * @param bool $include_header
- * @return string
- * @author Nando Vieira
- */
-function test_request($url, $method="GET", $include_header=false, $post_data=array(), $http_header=array()) {
- $method = strtoupper($method);
- $allowed_methods = array("GET", "PUT", "POST", "DELETE", "HEAD");
- if(!in_array($method, $allowed_methods))
- {
- $message = "The requested method '$method' is not allowed";
- return assert('false; //'.$message);
- }
-
- $curl = curl_init($url);
- curl_setopt($curl, CURLOPT_RETURNTRANSFER, 1);
- curl_setopt($curl, CURLOPT_HEADER, $include_header);
- curl_setopt($curl, CURLOPT_HTTPHEADER, $http_header);
- curl_setopt($curl, CURLOPT_CUSTOMREQUEST, $method);
- curl_setopt($curl, CURLOPT_FOLLOWLOCATION, 1);
- if($method == 'POST')
- {
- curl_setopt($curl, CURLOPT_POST, 1);
- curl_setopt($curl, CURLOPT_POSTFIELDS, $post_data);
- }
- if($method == 'HEAD')
- {
- curl_setopt($curl, CURLOPT_NOBODY, true);
- }
- $response = curl_exec($curl);
- curl_close($curl);
-
- return $response;
+##
+# Do HTTP request and return the response content.
+#
+# @param string $url
+#
+# @param string $method
+#
+# @param bool $include_header
+#
+# @return string
+#
+# @author Nando Vieira
+#
+##
+function test_request($url, $method="GET", $include_header=false, $post_data=array(), $http_header=array())
+{
+ $method = strtoupper($method);
+ $allowed_methods = array("GET", "PUT", "POST", "DELETE", "HEAD");
+ if(!in_array($method, $allowed_methods))
+ {
+ $message = "The requested method '$method' is not allowed";
+ return assert('false; //'.$message);
+ }
+
+ $curl = curl_init($url);
+ curl_setopt($curl, CURLOPT_RETURNTRANSFER, 1);
+ curl_setopt($curl, CURLOPT_HEADER, $include_header);
+ curl_setopt($curl, CURLOPT_HTTPHEADER, $http_header);
+ curl_setopt($curl, CURLOPT_CUSTOMREQUEST, $method);
+ curl_setopt($curl, CURLOPT_FOLLOWLOCATION, 1);
+ if($method == 'POST')
+ {
+ curl_setopt($curl, CURLOPT_POST, 1);
+ curl_setopt($curl, CURLOPT_POSTFIELDS, $post_data);
+ }
+ if($method == 'HEAD')
+ {
+ curl_setopt($curl, CURLOPT_NOBODY, true);
+ }
+ $response = curl_exec($curl);
+ curl_close($curl);
+
+ return $response;
}
diff --git a/lib/limonade/views/_debug.html.php b/lib/limonade/views/_debug.html.php
index ce40e3c..b6978a4 100644
--- a/lib/limonade/views/_debug.html.php
+++ b/lib/limonade/views/_debug.html.php
@@ -1,14 +1,14 @@
- ENV_PRODUCTION && option('debug')): ?>
-
+
+
[]
- (in line )
-
-
+ (in line )
+
+
Debug arguments
-
+
Options
diff --git a/lib/limonade/views/_settings.html.php b/lib/limonade/views/_settings.html.php
new file mode 100644
index 0000000..816cc9c
--- /dev/null
+++ b/lib/limonade/views/_settings.html.php
@@ -0,0 +1,318 @@
+
+
+ LimonadePHP v - APPLICATION SETTINGS
+
+
+
+
+ OPTIONS (Limonade)
+
+
+
+
+ Variable
+ Value
+
+ $val): ?>
+
+
+
+
+
+ No Options set.
+
+
+
+
+
+
+ SERVER ($_SERVER)
+
+
+
+ Variable
+ Value
+
+ $val):
+ ?>
+
+
+
+
+
+ No SERVER data.
+
+
+
+
+
+ GET ($_GET)
+
+
+
+ Variable
+ Value
+
+ $val): ?>
+
+
+
+
+
+ No GET data.
+
+
+
+
+
+ POST ($_POST)
+
+
+
+ Variable
+ Value
+
+ $val): ?>
+
+
+
+
+
+ No POST data.
+
+
+
+
+
+ SESSIONS ($_SESSION)
+
+
+
+ Variable
+ Value
+
+ $val): ?>
+
+
+
+
+
+ No SESSION data.
+
+
+
+
+
+
+
+
+ ENV ($_ENV)
+
+
+
+ Variable
+ Value
+
+ $val): ?>
+
+
+
+
+
+ No ENV data.
+
+
+
+
+
+ FILES ($_FILES)
+
+
+
+ Variable
+ Value
+
+ $val): ?>
+
+
+
+
+
+ No FILES data.
+
+
+
+
+
+
+ REQUEST ($_REQUEST)
+
+
+
+ Variable
+ Value
+
+ $val): ?>
+
+
+
+
+
+ No REQUEST data.
+
+
+
+
+
+ PUT (env()['PUT'])
+
+
+
+ Variable
+ Value
+
+ $val): ?>
+
+
+
+
+
+ No PUT data.
+
+
+
+
+
+ DELETE (env()['DELETE'])
+
+
+
+ Variable
+ Value
+
+ $val): ?>
+
+
+
+
+
+ No DELETE data.
+
+
+
+
+
+ HEAD (env()['HEAD'])
+
+
+
+ Variable
+ Value
+
+ $val): ?>
+
+
+
+
+
+ No HEAD data.
+
+
+
+
+
+ You're seeing this output because you have enabled option('show_settings').
+
+
+
\ No newline at end of file
diff --git a/lib/limonade/views/default_layout.php b/lib/limonade/views/default_layout.php
index 7b15a30..316870f 100644
--- a/lib/limonade/views/default_layout.php
+++ b/lib/limonade/views/default_layout.php
@@ -1,22 +1,24 @@
-
-
- Limonade, the fizzy PHP micro-framework
-
-
-
-
- Limonade
-
-
-
-
-
-
-
+
+
+
+ Limonade, the fizzy PHP micro-framework
+
+
+
+
+
+ Limonade
-
-
-
+
+
+
+
+
+
+
+
+
+