<?php

/* <wee>

Templating library for PHP

Author: Oria Adam

2012

License: GPLv3

http://softov.org/webdevtools

http://code.google.com/p/wee-templating

Functions:

wee_process($string,$weeArray)

Return the $string with all the wee keys replaced, as they were found in the $weeArray

Read wee syntax below.

wee_get_keys($string)

Will return all keys found in $string as keys in an array.

Currently does not support weeLoad calls.

wee_val($key,$wee,$might_be_string)

Return a wee value for $key from $wee array

When $might_be_string is true, returns "$key" when $key not found in $wee.

Supports:

$wee[$key]

$wee->$key

If $key is 'foo[bar]' returns $wee[foo][wee_val('bar')] or $wee->foo[wee_val('bar')]

if $key has spaces, tabs or enters it will be trimmed.

If $key is a number, and it was not found in $wee, it will be returned.

If $key was not found in $wee,

when $might_be_string==false empty string will be returned and a user_notice error will be logged.

when $might_be_string==true the key will be returned and no error will be logged.

wee_val_global($key)

This function exists for auto retrieving the global arrays POST GET SERVER SESSION ENV FILES and COOKIE

For example, weeGlobal('SERVER[foo]') would return the value of $_SERVER['foo']

If the key does not exists in the array return null.

If the key does not fit any of the arrays return false.

Called from wee_val() when WEE_MAGIC_GLOBALS is true

///////////////////////////// wee Syntax ///////////////////////////

<wee KeyName>

Will be replaced with the value of $weeArray['KeyName'].

If KeyName was not found in $weeArray, the KeyName will be used.

If $weeArray['KeyName'] is an array, the item count of this array will be used.

* This is not recursive! To process a wee value recursively see <weeProcess>

<weeVal KeyName> TBD

Same as <wee KeyName> but the value will not be parsed.

<wee KeyArray[Key]>

Will be replaced with the value of $weeArray['KeyArray'][$wee['Key']||'Key']

For example:

$wee=array('selected'=1,'names'=array('foo','bar'));

echo wee_process('<wee names[0]>',$wee); // foo

echo wee_process('<wee names[selected]>',$wee); // bar

<weeComment>something</weeComment>

Everything inside <weeComment> tags will be removed completely.

This is usefull for dry data examples, for the designer's usage.

<weeIf key1 operator key2>...</weeIf>

Remember that the keys are case sensitive.

Foo!=foo returns true.

The '>' operator is not allowed inside a <weeIf> because it looks like the end of the tag. Use {weeIf} tag or 'gt' operator.

The available operators are:

equal to : = e eq

different from : != ne d dif diff

greater than : > gt

less than : < lt

bigger/equal : >= gte

smaller/equal : <= lte

modulu is 0 : % mod

<weeFor Key>...</weeFor> -

Repeat a section using an inner wee array.

$wee['Key'] must be an array.

When $wee['Key'] is an array, the inside string will be repeatedly processed using wee values from the $wee['Key'] array.

Using inner weeFor keys:

<wee weeFor> and <weeIf weeFor...> tags will retrieve the current loop index (starting 1)

<wee weeForKey> and <weeIf weeForKey...> tags will retrieve the current index in the array

<wee weeForTotal> is the total number of loops

<wee weeForValue> and <weeIf weeForValue...> tags will retrieve the current item value (for single dimention arrays)

<weeIf weeForLast=1> will only run on the last loop iteration (same as <wee weeFor=weeForTotal> )

<weeIf weeForLast=0> will not run on the last loop iteration (same as <wee weeFor!=weeForTotal> )

<weeFor X>...</weeFor> -

Repeat a section X (or $wee[X]) times

$wee['X'] must be a number, unless X is a number.

Using weeFor: <wee weeFor> and <weeIf weeFor...> tags will retrieve the current loop index (starting 0)

<weeInclude filename.ext>

Include and process the content of file named 'filename.ext'.

<weeInclude key>

Include and process the content of file named $wee['key'].

If $wee['key'] is an array, I assume that the array contains multiple file names - so I include them all one by one.

<weeProcess key>

Include and Process the value string of $wee['key'].

If $wee['key'] is an array, I assume that the array contains multiple strings - so I process them all one by one.

<weeNoProcess>...</weeNoProcess> TBD

Anything inside this section will NOT be parsed.

<weeSet key=value>

Experimental - add a value to the wee values array, for use later.

Usually only works on the same template, and not recursive.

You can use {} instead of <>

{wee} {weeIf} {weeFor} {weeComment} {weeLoad}

All {wee tags} will be processed AFTER all <wee tags> are done.

NOTES:

* The tags are case sensitive. For example, <WeeComment> is invalid: the W should be lower cased.

* All {wee tags} will be processed AFTER all <wee tags> are done.

* The input $string syntax should be correct. Please use wee_syntax($string).

For example: <weeComment> must have a corresponding </weeComment>

* You cannot use <weeIf> inside <weeIf> nor <weeFor> inside <weeFor>.

To workaround it use both <> and {} tags.

For example:

<weeIf bases gt 0>

{weeIf male=false}female{/weeIf}

{weeIf male!=false}male{/weeIf}

</weeIf>

Another workaround - use external files.

For example:

<weeIf bases gt 0>

<weeInclude templates/malefemale.htm>

</weeIf>

* Tags are processed by order of appearance.

* You can use automagic PHP globals POST/GET/SERVER/ENV/FILES/SESSION/COOKIE like that:

<wee SESSION[foobar]> will return $_SESSION['foobar']

(unless WEE_MAGIC_GLOBALS is false)

*/

/* wee.config.php file example:

define('WEE_DEBUG_MODE',false);

// Currently not in use. Default false.

define('WEE_SHOW_ERRORS',false); // print errors to the screen

// When debug mode is true, any errors that wee might encounter will be printed to the screen. Default true. Note that either way errors are reported using error_log().

define('WEE_ERROR_SOURCE_LENGTH',70); // increase bad excerpt from template

// When wee encounters a syntax error in a template it shows an excerpt of the error location. This is the length of the excerpt. Can be 0. Default 30.

define('WEE_ENDLESS_LOOP',100000); // increase allowed number of loops

// To avoid endless loops, wee uses a global counter that increases in all loops. When the counter reaches this number wee assumes it is stuck on an endless loop so it dies with an error. Default 8888. Increase this number if your project might repeat a block more than that.

define('WEE_KEY_CI',true); // allow key insensitive template placeholders

// Are the keys (placeholders) in $wee array and the template case-insensitive? Default false. Note that the <tags> are ALWAYS case sensitive!

define('WEE_MAGIC_GLOBALS',false); // disable access to global PHP arrays from the template

// Magic globals are wee key values from POST/GET/SERVER/ENV/FILES/SESSION/COOKIE. For example <wee GET[foo]> returns $_GET['foo']. Default true.

*/

if (file_exists('wee.config.php')) {

require_once('wee.config.php');

}

// set default settings where not defined

if (!defined('WEE_DEBUG_MODE' )) define('WEE_DEBUG_MODE',false); // currently not in use

if (!defined('WEE_SHOW_ERRORS' )) define('WEE_SHOW_ERRORS',true); // should wee print errors to screen?

if (!defined('WEE_ERROR_SOURCE_LENGTH')) define('WEE_ERROR_SOURCE_LENGTH',30); // template source length to show in on-the-fly syntax errors

if (!defined('WEE_ENDLESS_LOOP' )) define('WEE_ENDLESS_LOOP',8888); // when the endless-loop-counter reaches this number, die

if (!defined('WEE_KEY_CI' )) define('WEE_KEY_CI',false); // are the $wee keys (placeholders) case in-sensitive? Note that this does not affect the <tags>, wee tags are ALWAYS case sensitive.

if (!defined('WEE_MAGIC_GLOBALS' )) define('WEE_MAGIC_GLOBALS',true); // allow keys from automagic arrays? such as <wee GET[foo]> keys supported: POST/GET/SERVER/ENV/FILES/SESSION/COOKIE

global $wee_endless_loop,$weeval_endless_loop;

$wee_endless_loop=0;

$weeval_endless_loop=0;

//////// the wee tags

// all tags MUST start with 'wee'

// all tags are case sensitive

$wee_tags=array(

array('tag'=>'weeNoProcess','closing'=>true , 'key'=>false),

array('tag'=>'weeComment' ,'closing'=>true , 'key'=>false),

array('tag'=>'weeSample' ,'closing'=>true , 'key'=>false), // backwards compatibility - weeComment used to be called weeSample

array('tag'=>'weeFor' ,'closing'=>true , 'key'=>true),

array('tag'=>'weeIf' ,'closing'=>true , 'key'=>true),

array('tag'=>'weeInclude' ,'closing'=>false, 'key'=>true),

array('tag'=>'weeProcess' ,'closing'=>false, 'key'=>true),

array('tag'=>'wee' ,'closing'=>false, 'key'=>true),

array('tag'=>'weeSet' ,'closing'=>false, 'key'=>true),

array('tag'=>'weeVal' ,'closing'=>false, 'key'=>true)

);

///////////////////////////////////////////////

function weeError($msg,$errorcode=null){

}

function countenters($string,$to=null,$from=0) {

}

function simplexml_to_array($object) {

}

function object_to_array($object) {

}

function array_to_object($object) {

}

// merge two arrays/objects

function wee_array_merge($array,$arr1=null,$arr2=null,$arr3=null,$arr4=null,$arr5=null,$arr6=null,$arr7=null,$arr8=null,$arr9=null)

}

// Return a value of a $array[$key]

// When $arrayname is given, the $key should look like this: "arrayname[key]"

// If the key was not found in array return FALSE.

// If the key was not found in array, but the array name fits, return null.

function wee_from_array($key,$array,$arrayname='')

}

// this function exists for auto retrieving the global arrays POST GET SERVER SESSION ENV FILES and COOKIE

// for example, weeGlobal('SERVER[FooBar]') would return the value of $_SERVER['FooBar']

// if the key does not exists, a value of null is returned.

// if the key is not one of the arrays, a value of false is returned.

function wee_val_global($key){

}

// return an array of all wee keys found in $string

function wee_get_keys($string) {

}

function wee_get_keys_se($string,$s,$e)

}

// wee_syntax($string)

// check the syntex of the $string

// make sure every starting tag has a closing one

// on success return true

// on fail return an error message

function wee_syntax($string) {

}

/* Process the $string and replace all keys

*/

function wee_process($string,$wee){

}

function substring($str,$start,$end) {

return substr($str,$start,$end-$start);

}

/* Return the value of a wee key

*/

function wee_val($key,$wee,$key_or_string=false){

}

function wee_val_array($key,$wee) {

return wee_val_array_by_value(wee_val($key,$wee),$wee);

}

function wee_val_array_by_value($val,$wee) {

}

// receives the inner string inside a weeFor tag, process and return the output string

function wee_process_weeFor($string,$key,$wee)

}

function wee_process_weeComment($string,$key,$wee)

{

return '';

}

function wee_process_weeSample($string,$key,$wee) // backwards compatibility - weeComment used to be called weeSample

{

return '';

}

function wee_process_weeNoProcess($string,$key,$wee)

{

return $string;

}

function wee_process_weeVal($key,$wee)

{

return "<weeNoProcess>".wee_process_wee($key,$wee)."</weeNoProcess>";

}

function wee_process_wee($key,$wee)

}

function wee_process_weeIf($string,$key,$wee)

}

// TBD: not working, $wee is not passed by reference

function wee_process_weeSet($keyval,$wee)

}

function wee_process_weeProcess($key,$wee)

}

function wee_process_weeInclude($key,$wee)

}

// Process $string, use $s and $tage as the start/end chars for the wee tags.

function wee_process_se($string,$wee,$s,$e)

}

/* Example: weeIf

forgotpassmail.html:

Dear

<weeIf name!=>

<weeIf gender=m>Mr.</weeIf>

<weeElse>Ms.</weeElse>

<wee name>,

</weeIf>

<weeElse>User</weeElse>

Your password is: <wee password>

*/

/* Example: weeFor

results.html:

<table dir=rtl class=results color="{wee tablecolor}" border=0 cellpadding=0 cellspacing=0>

<weeFor results>

<a class=card href="{wee user_link}" target=_blank>

<tr style="background:{wee tr color};" onmouseover="this.style.background='{wee tr up color}';" onmouseout="this.style.background='{wee tr color}';">

<td align=center width=36>

<img src="{wee user_img}" border=0 height=36></a>

</td>

<td align=right>

<wee user_name><weeComment>My Name</weeComment>

</td>

<td align=center class=links>

<wee user_links><weeComment><a href=#>Doggy</a> <a href=#>Catty</a></weeComment>

</td>

</tr>

</a>

</weeFor>

</table>

*/