This framework is in the early stages of it's first beta. If you come across any issues in the documentation or the framework, please make note of it via the Google Group.

Templates ↑ top

The template system built into the framework utilizes PHP's output buffer functionality to capture and parse the content of a page, replace certain variables in a separate template file with that content, then render the results. This functionality is optional and will only be available if a template file is defined before the framework is called.

Example:

$ob_template = file_get_contents('templates/main.tpl');

Site Level ↑ top

The site level template is used to easily build sites with a global template. This type of template file requires the variables %TITLE% and %BODY%. (Optional variable is %HEAD%.)

Example:

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN" "http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en">
<head>
<title>%TITLE%</title>
%HEAD%
</head>

<body>

<h1>%TITLE%</h1>

%BODY%

</body>
</html>

The %TITLE% and %BODY% variables will both be replaced by the contents of their similarly named HTML tags; <title> and <body>. Likewise, the contents of the <head> tag (minus the <title> tag) will replace the %HEAD% variable.

Example:

<?php

$ob_template = file_get_contents('templates/main.tpl');
require_once('scripts/framework.php');

?>
<html>
<head>
<title>Lorem ipsum</title>
<link type="text/css" rel="stylesheet" href="style.css" />
</head>

<body>

<p>Lorem ipsum dolor sit amet, consectetuer adipiscing elit. Nullam sed nibh quis
enim pellentesque porttitor. Aenean vel turpis. Nam blandit velit ut est. Integer
non sem a neque mollis aliquet. Nam magna. Nullam interdum, augue ut semper
dignissim, massa massa adipiscing nulla, volutpat rutrum nisl lacus ac erat.</p>

</body>
</html>

Element ↑ top

Element templates are for displaying multiple, similarly structured elements of data with repeating HTML in conjunction with $Template->Parse(); and $Template->Render();. The below example shows a template that will render the contents of  first, followed by either  or  and ending with .

Example:

<!--{header:start}-->

<div>

<!--{header:end}-->


<!--{data:start}-->

<div class="bookmark">

<h3><a href="%URL%">%DESCRIPTION%</a></h3>
<span class="dim">to %TAG%</span>

</div>

<!--{data:end}-->

<!--{nodata:start}-->

<p>No bookmarks.</p>

<!--{nodata:end}-->


<!--{footer:start}-->

</div>

<!--{footer:end}-->

The data passed along with this template defines wether or not the  or  section of the template is used. Below is an example of data that can be passed along with element templates.

Example:

$data = array();

$data[] = array('url'=>'http://www.latherrinserepeat.org/',
		'description'=>'Lather Rinse Repeat', 'tag'=>'blog');
$data[] = array('url'=>'http://www.jemjabella.co.uk/',
		'description'=>'Jemjabella.co.uk', 'tag'=>'blog');
$data[] = array('url'=>'http://www.justinshattuck.com/',
		'description'=>'Justin Shattuck', 'tag'=>'blog');
$data[] = array('url'=>'http://chunkysoup.net/',
		'description'=>'ChunkySoup.net', 'tag'=>'blog');
$data[] = array('url'=>'http://ejohn.org/',
		'description'=>'John Resig', 'tag'=>'blog');

echo $Template->Render('template.tpl', $data);

Based on the number of arrays within $data (above), the contents of  will be repeated four separate times, each time replacing the variables with the array's keys and values. If the array passed was empty, then the contents of  will be returned. If you require that certain variables be replaced within the  or  section of the template, setup the data array like the below example.

Example:

$data = array();

$data['header'][] = array('var'=>'All your items (4)');

$data['data'][] = array('url'=>'http://www.latherrinserepeat.org/',
			'description'=>'Lather Rinse Repeat', 'tag'=>'blog');
$data['data'][] = array('url'=>'http://www.jemjabella.co.uk/',
			'description'=>'Jemjabella.co.uk', 'tag'=>'blog');
$data['data'][] = array('url'=>'http://www.justinshattuck.com/',
			'description'=>'Justin Shattuck', 'tag'=>'blog');
$data['data'][] = array('url'=>'http://chunkysoup.net/',
			'description'=>'ChunkySoup.net', 'tag'=>'blog');
$data['data'][] = array('url'=>'http://ejohn.org/',
			'description'=>'John Resig', 'tag'=>'blog');

$data['footer'][] = array('var'=>'All your items (4)');

echo $Template->Render('template.tpl', $data);

Constants ↑ top

When setting preset values for constants, define them before calling the framework. If the constant already exists on framework load, the preexisting constant will take precedence over the default.

error_log ↑ top

The default value of error_log is false. This should remain false if you don't want errors to be logged. Replacing false with a file name will send all errors to that file.

It is good programming practice to check to see if a constant already exists.

Example:

if (!defined('error_log')) { define('error_log', 'errors.log'); }

Example:

echo constant(error_log);

error_reporting ↑ top

The default value of error_reporting is false. This should remain false if you don't want errors to display.

It is good programming practice to check to see if a constant already exists.

Example:

if (!defined('error_reporting')) { define('error_reporting', false); }

Example:

echo constant('error_reporting');

int_microtime ↑ top

The default value of int_microtime is the Unix timestamp (with microseconds) of the time your application starts (used with endtime()).

The preset value of this constant should not be changed!

Example:

echo constant('int_microtime');

lnbr ↑ top

The default value of lnbr is PHP_EOL. This built in PHP constant reflects the new-line character of the server.

It is good programming practice to check to see if a constant already exists.

The other possible values of this constant \n, \r, or \r\n must be surrounded by double quotes.

Example:

if (!defined('lnbr')) { define('lnbr', "\n"); }

Example:

echo constant('lnbr');

maxview ↑ top

The default value of maxview is 10. This should be changed to reflect the default number of viewable items in your application (used with $Database->Table()).

It is good programming practice to check to see if a constant already exists.

Example:

if (!defined('maxview')) { define('maxview', 10); }

Example:

echo constant('maxview');

page ↑ top

The default value of page is the value of $_SERVER['SCRIPT_NAME'] plus $_SERVER['PATH_INFO'] if it exists.

The preset value of this constant should not be changed!

Example:

echo constant('page');

script ↑ top

The default value of script is the value of $_SERVER['REQUEST_URI'] minus $_SERVER['PATH_INFO'] if it exists and any GET data.

The preset value of this constant should not be changed!

Example:

echo constant('script');

url ↑ top

The default value of url is the address of the page your are currently on.

The preset value of this constant should not be changed!

Example:

echo constant('url');

Functions ↑ top

The majority of the functions included in this framework are to allow for use in both PHP5 and PHP4 as some functions were not available until specific versions of PHP5.

array_clean(array $array [, string $method]); ↑ top

Cleans values of an array (recursively) by either trimming values or clearing empty

Attributes:

$array - Array to be processed.
$method - Default value is null. Alternate value is 'empty'.

Example:

$array1 = array('value1', 'value1', 'value2', ' value2 ', '');
print_array(array_clean($array1));

Result:

Array
(
    [0] => value1
    [1] => value1
    [2] => value2
    [3] => value2
    [4] =>
)

Example:

$array1 = array('value1', 'value1', 'value2', ' value2 ', '');
print_array(array_clean($array1, 'empty'));

Result:

Array
(
    [0] => value1
    [1] => value1
    [2] => value2
    [3] => value2
)

array_move(array $array, integer $key, integer $offset); ↑ top

Used to easily move values of an array.

Only variables can be passed by reference for the first attribute.

Attributes:

$array - Array to be modified.
$key - The key of the array value you want to move.
$offset - The position you want to move the array value to.

Example:

$array = array('value1', 'value2', 'value3', 'value4');
print_array(array_move($array, 1, 2));

Result:

Array
(
    [0] => value1
    [1] => value3
    [2] => value2
    [3] => value4
)

array_sort(array $array [, int $flag]); ↑ top

Sorts and returns an array.

Only variables can be passed by reference for the first attribute.

Attributes:

$array - Array to be modified.
$flag - Default value is null. Alternate values are SORT_REGULAR, SORT_NUMERIC, SORT_STRING, and SORT_LOCALE_STRING. More info on function sort()

Example:

$array = array('value2', 'value3', 'value1', 'value4');
print_array(array_sort($array));

Result:

Array
(
    [0] => value1
    [1] => value3
    [2] => value2
    [3] => value4
)

array_walk_recursive(array $array, function $func); ↑ top

Runs a function on each value of the array recursively.

Only variables can be passed by reference for the first attribute.

Attributes:

$array - Array to be modified.
$func - Function each value of the array will be passed through.

Example:

function custom($key, $value) { return trim($value); }
$array = array(' username', 'password');
print_array(array_walk_recursive($array, 'custom'));

Result:

Array
(
    [0] => username
    [1] => password
)

check_referer(); ↑ top

Checks the current URL against the HTTP referer.

Example:

if (!check_referer() && count($_POST)) { echo 'The HTTP referer is invalid.'; }

dir_get_contents([string $dir, string $filter, constant $sort]); ↑ top

Returns a multi-dimensional array of all the files and directories recursively in a specific directory.

Attributes:

$dir - Directory to search.
$filter - Use a regular expression to filter the results of the search.
$sort - Direction to sort the file types. (SORT_ASC or SORT_DESC)

Example:

$photos = dir_get_contents('photos/', '/(\/$|\.(jpg|jpeg|gif|png)$)/', SORT_ASC);

endtime(); ↑ top

Outputs time elapsed since script started.

Example:

echo 'Script took ' . round(endtime(), 3) . ' second(s) to run.';

Result:

Script took 0.016 second(s) to run.

error(string $text); ↑ top

Used by functions to output or log errors (based on the error_reporting and error_log constants).

Attributes:

$text - Text to send to the error buffer.

Example:

error('Error: This is a sample error');

Result:

<p><b>Error:</b> This is a sample error</p>

fetch_remote_file(string $file); ↑ top

Retrieves the contents of a remote file. Alternative to using file_get_contents() when allow_url_fopen is disabled.

Attributes:

$file - The remote file's URL.

Example:

echo fetch_remote_file('http://www.google.com/favicon.ico');

field_type(string $table, string $field); ↑ top

Outputs the field type of the specified $field within $table.

Attributes:

$table - The name of the table you are querying.
$field - The name of the field you are querying.

Example:

echo field_type('bookmarks', 'url');

Result:

varchar

file_put_contents(string $file [, string $contents, int $flag]); ↑ top

Writes contents to specified file. Use the constant FILE_APPEND in the last attribute to append the contents to already existing files.

Attributes:

$file - File you want to put contents into to.
$contents - Contents to be put into file.
$flag - Default value is null. Alternate value is FILE_APPEND.

Example:

file_put_contents('log.txt', 'This is a test', FILE_APPEND);

is_date(string $value); ↑ top

Validates a date. Returns boolean.

Attributes: