| Template::Manual::VMethods - Virtual Methods |
Template::Manual::VMethods - Virtual Methods
[% user = get_user(uid) IF uid.defined %]
[% IF password.length < 8 %]
Password too short, dumbass!
[% END %]
repeat(n)
[% name = 'foo' %]
[% name.repeat(3) %] # foofoofoo
[% name = 'foo, bar & baz' %]
[% name.replace('\W+', '_') %] # foo_bar_baz
remove(pattern)
[% name = 'foo, bar & baz' %]
[% name.remove('\W+') %] # foobarbaz
[% name = 'Larry Wall' %]
[% matches = name.match('(\w+) (\w+)') %]
[% matches.1 %], [% matches.0 %] # Wall, Larry
If the pattern does not match then the method returns false, rather than returning an empty list which Perl and the Template Toolkit both consider to be a true value. This allows you to write expression like this.
[% "We're not worthy!" IF name.match('Larry Wall') %]
[% IF (matches = name.match('(\w+) (\w+)')) %]
pattern matches: [% matches.join(', ') %]
[% ELSE %]
pattern does not match
[% END %]
Any regex modifiers, like /s, should be added in the regex using
the (?s) syntax. For example, to modify the regex to disregard
whitespace (the /x switch), use:
[% re = '(?x)
(\w+)
[ ]
(\w+)
';
matches = name.match(re);
%]
To perform a global search to match the pattern as many times as it appears in the source string, provide a true value for the 'global' argument following the pattern.
[% text = 'bandanna';
text.match('an+', 1).join(', ) # an, ann
%]
search(pattern)
[% name = 'foo bar baz' %]
[% name.search('bar') ? 'bar' : 'no bar' %] # bar
This virtual method is now deprecated in favour of 'match'. Move along now, there's nothing more to see here.
split(pattern)split() function to split a string into a list of
strings.
[% FOREACH dir = mypath.split(':') %]
[% dir %]
[% END %]
chunk(size)
[% ccard_no = "1234567824683579";
ccard_no.chunk(4).join
%]
Output:
1234 5678 2468 3579
If the size is specified as a negative number then the text will be chunked from right-to-left. This gives the correct grouping for numbers, for example.
[% number = 1234567;
number.chunk(-3).join(',')
%]
Output:
1,234,567
[% str 'foo bar baz wiz waz woz') %]
[% str.substr(4, 3) %] # bar
If 'length' is not specified then it returns everything from the 'offset' to the end of the string.
[% str.substr(12) %] # wiz waz woz
If both 'length' and 'replacement' are specified, then the method replaces everything from 'offset' for 'length' characters with $replacement. The substring removed from the string is then returned.
[% str.substr(0, 11, 'FOO') %] # foo bar baz
[% str %] # FOO wiz waz woz
[% thing.list.size %] # thing can be a scalar or a list
[% FOREACH key IN hash.keys %]
* [% key %]
[% END %]
If you want the keys in sorted order, use the list 'sort' method.
[% FOREACH key IN hash.keys.sort %]
* [% key %]
[% END %]
Having got the keys in sorted order, you can then use variable interpolation to fetch the value. This is shown in the following example by the use of '$key' to fetch the item from 'hash' whose key is stored in the 'key' variable.
[% FOREACH key IN hash.keys.sort %]
* [% key %] = [% hash.$key %]
[% END %]
Alternately, you can use the 'pairs' method to get a list of key/value pairs in sorted order.
[% hash.values.join(', ') %]
[% hash = {
a = 10
b = 20
};
hash.items.join(', ') # a, 10, b, 20
%]
However, please note that this method will change in the next major version of the Template Toolkit (v3) to return the same thing as the 'pairs' method. This will be done in an effort to make these virtual method more consistent with each other and how Perl works.
In anticipation of this, we recommend that you stop using 'hash.each' and instead use 'hash.items'.
[% FOREACH pair IN product.pairs %]
* [% pair.key %] is [% pair.value %]
[% END %]
[% keys = hash.list('keys') %]
[% values = hash.list('values') %]
[% items = hash.list('each') %]
[% pairs = hash.list('pairs') %]
When called without an argument it currently returns the same thing as the 'pairs' method. However, please note that this method will change in the next major version of the Template Toolkit (v3) to return a reference to a list containing the single hash reference (as per the scalar list method).
In anticipation of this, we recommend that you stop using 'hash.list' and instead use 'hash.pairs'.
[% FOREACH n = phones.sort %]
[% phones.$n %] is [% n %],
[% END %]
[% hash1 = {
foo => 'Foo',
bar => 'Bar',
}
hash2 = {
wiz => 'Wiz',
woz => 'Woz',
}
%]
[% hash1.import(hash2) %]
[% hash1.wiz %] # Wiz
You can also call the import() method by itself to import a hash array
into the current namespace hash.
[% user = { id => 'lwall', name => 'Larry Wall' } %]
[% import(user) %]
[% id %]: [% name %] # lwall: Larry Wall
[% hash.defined('somekey') ? 'yes' : 'no' %]
[% hash.exists('somekey') ? 'yes' : 'no' %]
When called without any argument, hash.defined returns true if the hash itself is defined (e.g. the same effect as scalar.defined).
[% hash.delete('foo', 'bar') %]
[% hash.item('foo') %] # same as hash.foo
[% results.first %] to [% results.last %]
If either is given a numeric argument n, they return the first or
last n elements:
The first 5 results are [% results.first(5).join(", ") %].
[% results.size %] search results matched your query
[% list.defined(3) ? 'yes' : 'no' %]
When called without any argument, list.defined returns true if the list itself is defined (e.g. the same effect as scalar.defined).
[% FOREACH s = scores.reverse %]
...
[% END %]
[% items.join(', ') %]
[% FOREACH directory.files.grep('\.txt$') %]
...
[% END %]
[% library = books.sort %]
An argument can be provided to specify a search key. Where an item in the list is a hash reference, the search key will be used to retrieve a value from the hash which will then be used as the comparison value. Where an item is an object which implements a method of that name, the method will be called to return a comparison value.
[% library = books.sort('author') %]
In the example, the 'books' list can contains hash references with an 'author' key or objects with an 'author' method.
push(item)push() method adds an item or items to the end of list.
[% mylist.push(foo) %]
[% mylist.push(foo, bar) %]
The unshift() method adds an item or items to the start of a list.
[% mylist.unshift(foo) %]
[% mylist.push(foo, bar) %]
[% first = mylist.shift %]
[% last = mylist.pop %]
[% mylist = [ 1, 2, 3, 2, 3, 4, 1, 4, 3, 4, 5 ] %]
[% numbers = mylist.unique %]
While this can be explicitly sorted, it is not required that the list be sorted before the unique elements are pulled out (unlike the Unix command line utility).
[% numbers = mylist.unique.sort %]
[% one = [ 1 2 3 ];
two = [ 4 5 6 ];
three = [ 7 8 9 ];
one.import(two, three);
one.join(', ); # 1, 2, 3, 4, 5, 6, 7, 8, 9
%]
[% list_one = [ 1 2 3 ];
list_two = [ 4 5 6 ];
list_three = [ 7 8 9 ];
list_four = list_one.merge(list_two, list_three);
%]
The original lists are not modified.
[% first_three = list.slice(0,2) %]
[% last_three = list.slice(-3, -1) %]
splice() function allowing you to selectively
remove and/or replace elements in a list. It removes 'length' items
from the list, starting at 'offset' and replaces them with the items
in 'list'.
[% play_game = [ 'play', 'scrabble' ];
ping_pong = [ 'ping', 'pong' ];
redundant = play_game.splice(1, 1, ping_pong);
redundant.join; # scrabble
play_game.join; # play ping pong
%]
The method returns a list of the items removed by the splice. You can use the CALL directive to ignore the output if you're not planning to do anything with it.
[% CALL play_game.splice(1, 1, ping_pong) %]
As well as providing a reference to a list of replacement values, you can pass in a list of items.
[% CALL list.splice(-1, 0, 'foo', 'bar') %]
Be careful about passing just one item in as a replacement value. If it is a reference to a list then the contents of the list will be used. If it's not a list, then it will be treated as a single value. You can use square brackets around a single item if you need to be explicit:
[% # push a single item, an_item
CALL list.splice(-1, 0, an_item);
# push the items from another_list
CALL list.splice(-1, 0, another_list);
# push a reference to another_list
CALL list.splice(-1, 0, [ another_list ]);
%]
[% list = ['pi', 3.14, 'e', 2.718] %]
[% hash = list.hash %]
[% hash.pi %] # 3.14
[% hash.e %] # 2.718
If a numerical argument is provided then the hash returned will have keys generated for each item starting at the number specified.
[% list = ['beer', 'peanuts'] %]
[% hash = list.hash(1) %]
[% hash.1 %] # beer
[% hash.2 %] # peanuts
In addition to the scalar virtual methods listed in the previous section, you can also call any list virtual method against a scalar. The item will be automagically promoted to a single element list and the appropriate list virtual method will be called.
One particular benefit of this comes when calling subroutines or object methods that return a list of items, rather than the preferred reference to a list of items. In this case, the Template Toolkit automatically folds the items returned into a list.
The upshot is that you can continue to use existing Perl modules or code that returns lists of items, without having to refactor it just to keep the Template Toolkit happy (by returning references to list). Class::DBI module is just one example of a particularly useful module which returns values this way.
If only a single item is returned from a subroutine then the Template Toolkit assumes it meant to return a single item (rather than a list of 1 item) and leaves it well alone, returning the single value as it is. If you're executing a database query, for example, you might get 1 item returned, or perhaps many items which are then folded into a list.
The FOREACH directive will happily accept either a list or a single item which it will treat as a list. So it's safe to write directives like this, where we assume that 'something' is bound to a subroutine which might return 1 or more items:
[% FOREACH item IN something %]
...
[% END %]
The automagic promotion of scalars to single item lists means that you can also use list virtual methods safely, even if you only get one item returned. For example:
[% something.first %]
[% something.join %]
[% something.reverse.join(', ') %]
Note that this is very much a last-ditch behaviour. If the single item return is an object with a 'first' method, for example, then that will be called, as expected, in preference to the list virtual method.
You can define your own virtual methods for scalars, lists and hash arrays. The Template::Stash package variables $SCALAR_OPS, $LIST_OPS and $HASH_OPS are references to hash arrays that define these virtual methods. HASH_OPS and LIST_OPS methods are subroutines that accept a hash/list reference as the first item. SCALAR_OPS are subroutines that accept a scalar value as the first item. Any other arguments specified when the method is called will be passed to the subroutine.
# load Template::Stash to make method tables visible
use Template::Stash;
# define list method to return new list of odd numbers only
$Template::Stash::LIST_OPS->{ odd } = sub {
my $list = shift;
return [ grep { $_ % 2 } @$list ];
};
template:
[% primes = [ 2, 3, 5, 7, 9 ] %]
[% primes.odd.join(', ') %] # 3, 5, 7, 9
Andy Wardley <abw@wardley.org>
http://wardley.org/|http://wardley.org/
Template Toolkit version 2.19, released on 27 April 2007.
Copyright (C) 1996-2007 Andy Wardley. All Rights Reserved.
This module is free software; you can redistribute it and/or modify it under the same terms as Perl itself.
| Template::Manual::VMethods - Virtual Methods |