[new feature] tpl: if_funcs more aliases

I just added several function aliases for the “if_funcs” feature inside templating engine.

Here is the full list of built-in aliases:

{if_empty()} / {if_not_empty()}
{if_isset()} / {if_not_isset()}
{if_true()} / {if_not_true()}
{if_false()} / {if_not_false()}
{if_ok()} / {if_not_ok()}

To remind: any other function can also be used in addition to these built-ins + validate class methods can be used too.

Also all these aliases available for the “elseif_funcs” feature like this:

{elseif_empty()} / {elseif_not_empty()}
{elseif_isset()} / {elseif_not_isset()}
{elseif_true()} / {elseif_not_true()}
{elseif_false()} / {elseif_not_false()}
{elseif_ok()} / {elseif_not_ok()}

[new feature] tpl: elseif

Long time ago I was asked to add “elseif” to YF template engine. It was hard to achive without deep refactoring, and now it is easy and fast to add. Also elseif feature supports if_funcs too.

So welcome this new feature onboard and feel free to start using it in your projects 🙂

Examples:

$data = array('name1' => '', 'name2' => 'something');
{if(name1 ne "")}
  bad
{elseif(name2 ne "")}
  ok
{/if}

{if_empty(name2)}
  bad
{elseif_empty(name1)}
  ok
{/if}

[howto] tpl: variable filter functions

Here I want to explain YF template engine feature, which was inspired from other modern templating engines (smarty, twig) – variable filtering.

It can accept one or several filtering functions,separated by vertical colon “|”.

Filter function can be any of functions that can be found by templating engine at the moment of compiling template.

It looks like this:

{myvar|trim|_prepare_html}

Where:

* myvar is variable passed into template

* trim – php built-in function

* _prepare_html – YF built-in function, that is used to escape input to be embedded into any html arguments.

Full example:

$tpl_str = '<div data-test="{data|trim|_prepare_html}"></div>';
tpl()->parse_string($tpl_str, array(
  'data' => ' some string with <tags>, quotes "" and spaces  ',
));

[new feature] tpl: elseforeach

New functionality was added today to the YF templating engine: {elseforeach}.

It is used in pair with {foreach(var)} and makes code simpler and more clean by providing ability to set template part, when array inside foreach is empty.

Example of usage:

{foreach(my_array)}
  <li>{_key} = {_val}</li>
{elseforeach}
  <h1 class="alert-error">no rows</h1>
{/foreach}

[new feature] tpl: if_func

YF built-in template engine today was armored with new useful element, inspired from other modern template engines: ability to do custom condition with function/method.

Also, it is possible to negate condition by adding “not_” to function name.

Another feature: it is possible to use public methods from validate class to check if condition is true.

I think you can better understand this and what it does by looking into examples:

name1 => '', name2 => 'value2'
{if_empty(name1)} good {else} bad {/if}
{if_not_empty(name2)} good {else} bad {/if}
{if_not_isset(data.name3)} good {/if}
{if_isset(name1)} good {/if}

'data' => 'abcd efgh ijkl mnop qrst uvwx yz'
{if_validate:alpha_spaces(data)} good {/if}

[howto] show one time living messages to user

Here I want to describe by examples how to show messages to user, that works one time, means that message is destroyed after being displayed.

Text can contain any complex html inside, css class names are got from bootstrap with these default colors:

success (green),

warning (yellow),

error (red),

notice (blue)

common()->message_success('Success text');
common()->message_warning('Warning tex');
common()->message_error('Error text');
common()->message_notice('Notice text');

Example of usage inside form custom validation/processing of posted data:

form()->on_post(function(){
  if ($error) {
    common()->message_error('Error');
  }
})

[new feature] tpl engine now supports objects as replace items

New feature just added to YF fraemwork:

tpl engine now supports objects as replace items.

This can be useful for future cases, when dealing with ORM/models or just passing objects directly to template engine.

$data = new stdClass();
 $data->key1 = 'val1';
 $data->key2 = 'val2';
 $data->key3 = 'val3';

$this->assertEquals('val1 val2 val3', self::_tpl('{key1} {key2} {key3}', $data));
 $this->assertEquals('val1', self::_tpl('{data.key1}', array('data' => $data)));
 $this->assertEquals('val1,val2', self::_tpl('{data.key1},{data.key2}', array('data' => $data)));
 $this->assertEquals('val1,val2,val3', self::_tpl('{data.key1},{data.key2},{data.key3}', array('data' => $data)));
 $this->assertEquals('good', self::_tpl('{if(data.key1 eq val1)}good{else}bad{/if}', array('data' => $data)));
 $this->assertEquals('good', self::_tpl('{if(data.key1 ne fsdfsfsd)}good{else}bad{/if}', array('data' => $data)));
 $this->assertEquals(' key1=val1 key2=val2 key3=val3 ', self::_tpl('{foreach(data)} {_key}={_val} {/foreach}', array('data' => $data)));
 $data->key4 = array(1,2,3);
 $this->assertEquals(' key1=val1 key2=val2 key3=val3 key4=1,2,3 ', self::_tpl('{foreach(data)} {_key}={_val} {/foreach}', array('data' => $data)));

Link to unit tests, implementing this feature:

https://github.com/yfix/yf/blob/master/.dev/tests/tpl/tpl_driver_yf_core.Test.php#L346

[tip] quickly disable left area from any code place

Quick tip about disabling left area html from been output to user.

Place this snippet in any place of code/module, that is working with YF.

P.S. this can be done with any named block, not only “left_area”

events()->listen('block.append[left_area]', function(&$body) {
  $body = '';
});

tpl improvements

Today I’ve added ability to use tpl()->_avail_arrays directly inside “if” and “foreach” template constructs.

Example:

tpl()->_avail_arrays = array(
  'get' => '_GET',
  'post' => '_POST'
);
$_GET['test_key'] = 'test_val';
tpl()->parse_string('{get.test_key}');

$data = array(
‘k1’ => ‘v1’, ‘k2’ => ‘v2’, ‘k3’ => ‘v3’,
);
$_GET[‘test_data’] = $data;
tpl()->parse_string(‘{foreach(get.test_data)}{/foreach}’);

More examples can be seen inside unit tests (test_avail_arrays):

https://github.com/yfix/yf/blob/master/.dev/tests/tpl/tpl_driver_yf_core.Test.php#L312

admin side area toggler

This component was created using latest additions to the YF framework – core events system.

https://github.com/yfix/yf/blob/master/share/events/admin_side_area_toggler.listener.php

It is adding fixed style button on the left of the admin area and allows to hide/display side panel.

This is useful for smaller screens, when main content table float below side area and looks not very good.

Also, it remembers state of the toggler inside cookie and on the next page visit it applies this setting immediately.

Advantages of writing code like this component, which is based on core events:

* Loose coupling of components between each other (event listener and and/or event fires can be absent and nothing breaks)

* There can be several listeners for one event, this is especially useful for plugins system, each new plugin can listen to existing events and can optionally fire new events, not existed before that plugin arrived.

* Pieces of code starting to look like easier and smaller, no need to think how to inject some piece of code into specific engine processing stage.

* Writing events listeners into separate file (optionally) or inside any other place of code (class or function)