[%# # IMPORTANT NOTE # This documentation is generated automatically from source # templates. Any changes you make here may be lost. # # The 'docsrc' documentation source bundle is available for download # from http://www.template-toolkit.org/docs.html and contains all # the source templates, XML files, scripts, etc., from which the # documentation for the Template Toolkit is built. -%] [% META book = 'Manual' page = 'VMethods' %] [% WRAPPER toc; PROCESS tocitem title ="DESCRIPTION" subs = [ "Scalar Virtual Methods", "Hash Virtual Methods", "List Virtual Methods", "Automagic Promotion of Scalar to List for Virtual Methods", "Defining Custom Virtual Methods" ]; PROCESS tocitem title ="AUTHOR" subs = []; PROCESS tocitem title ="VERSION" subs = []; PROCESS tocitem title ="COPYRIGHT" subs = []; END %] [% WRAPPER section title="DESCRIPTION" -%][% WRAPPER subsection title = "Scalar Virtual Methods" -%]

- defined

  Returns true if the value is defined.

          [% tt_start_tag %] user = get_user(uid) IF uid.defined [% tt_end_tag %]

- length

  Returns the length of the string representation of the item:

          [% tt_start_tag %] IF password.length < 8 [% tt_end_tag %]
             Password too short, dumbass!
          [% tt_start_tag %] END [% tt_end_tag %]

- repeat(n)

  Repeat the string a specified number of times.

          [% tt_start_tag %] name = 'foo' [% tt_end_tag %]
          [% tt_start_tag %] name.repeat(3) [% tt_end_tag %]		# foofoofoo

- replace(search, replace)

  Outputs the string with all instances of the first argument (specified as a Perl regular expression) with the second.

          [% tt_start_tag %] name = 'foo, bar & baz' [% tt_end_tag %]
          [% tt_start_tag %] name.replace('\W+', '_') [% tt_end_tag %]    # foo_bar_baz

- remove(pattern)

  Outputs the string with all instances of the pattern (specified as a Perl regular expression) removed.

          [% tt_start_tag %] name = 'foo, bar & baz' [% tt_end_tag %]
          [% tt_start_tag %] name.remove('\W+') [% tt_end_tag %]    # foobarbaz

- match(pattern, global)

  Performs a regular expression match on the string using the pattern passed as an argument. If the pattern matches the string then the method returns a reference to a list of any strings captured within parenthesis in the pattern.

          [% tt_start_tag %] name = 'Larry Wall' [% tt_end_tag %]
          [% tt_start_tag %] matches = name.match('(\w+) (\w+)') [% tt_end_tag %]
          [% tt_start_tag %] matches.1 [% tt_end_tag %], [% tt_start_tag %] matches.0 [% tt_end_tag %]		# 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.

          [% tt_start_tag %] "We're not worthy!" IF name.match('Larry Wall') [% tt_end_tag %]

          [% tt_start_tag %] IF (matches = name.match('(\w+) (\w+)')) [% tt_end_tag %]
             pattern matches: [% tt_start_tag %] matches.join(', ') [% tt_end_tag %]
          [% tt_start_tag %] ELSE [% tt_end_tag %]
             pattern does not match
          [% tt_start_tag %] END [% tt_end_tag %]

  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:

          [% tt_start_tag %] re = '(?x)
                     (\w+)
                     [ ]
                     (\w+)
                   ';
            matches = name.match(re);
          [% tt_end_tag %]

  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.

          [% tt_start_tag %] text = 'bandanna';
             text.match('an+', 1).join(', )      # an, ann
          [% tt_end_tag %]

- search(pattern)

  Performs a similar function to 'match' but simply returns true if the string matches the regular expression pattern passed as an argument.

          [% tt_start_tag %] name = 'foo bar baz' [% tt_end_tag %]
          [% tt_start_tag %] name.search('bar') ? 'bar' : 'no bar' [% tt_end_tag %]	    # bar

  This virtual method is now deprecated in favour of 'match'. Move along now, there's nothing more to see here.

- split(pattern)

  Calls Perl's split() function to split a string into a list of strings.

          [% tt_start_tag %] FOREACH dir = mypath.split(':') [% tt_end_tag %]
             [% tt_start_tag %] dir [% tt_end_tag %]
          [% tt_start_tag %] END [% tt_end_tag %]

- chunk(size)

  Splits the value into a list of chunks of a certain size.

          [% tt_start_tag %] ccard_no = "1234567824683579";
             ccard_no.chunk(4).join
          [% tt_end_tag %]

  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.

          [% tt_start_tag %] number = 1234567;
             number.chunk(-3).join(',')
          [% tt_end_tag %]

  Output:

          1,234,567

- substr(offset, length, replacement)

  Returns a substring starting at 'offset', for 'length' characters.

          [% tt_start_tag %] str 'foo bar baz wiz waz woz') [% tt_end_tag %]
          [% tt_start_tag %] str.substr(4, 3) [% tt_end_tag %]    # bar

  If 'length' is not specified then it returns everything from the 'offset' to the end of the string.

          [% tt_start_tag %] str.substr(12) [% tt_end_tag %]      # 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.

          [% tt_start_tag %] str.substr(0, 11, 'FOO') [% tt_end_tag %]   # foo bar baz
          [% tt_start_tag %] str [% tt_end_tag %]                        # FOO wiz waz woz

- list

  Return the value as a single element list. This can be useful if you have a variable which may contain a single item or a list and you want to treat them equally. The 'list' method can be called against a list reference and will simply return the original reference, effectively a no-op.

          [% tt_start_tag %] thing.list.size [% tt_end_tag %]  # thing can be a scalar or a list

- hash

  Return the value as a hash reference containing a single entry with the key 'value' indicating the original scalar value. As with the 'list' virtual method, this is generally used to help massage data into different formats.

- size

  Always returns 1 for scalar values. This method is provided for consistency with the hash and list size methods.

[%- END %] [% WRAPPER subsection title = "Hash Virtual Methods" -%]

- keys

  Returns a list of keys in the hash. They are not returned in any particular order, but the order is the same as for the corresponding values method.

          [% tt_start_tag %] FOREACH key IN hash.keys [% tt_end_tag %]
             * [% tt_start_tag %] key [% tt_end_tag %]
          [% tt_start_tag %] END [% tt_end_tag %]

  If you want the keys in sorted order, use the list 'sort' method.

          [% tt_start_tag %] FOREACH key IN hash.keys.sort [% tt_end_tag %]
             * [% tt_start_tag %] key [% tt_end_tag %]
          [% tt_start_tag %] END [% tt_end_tag %]

  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.

          [% tt_start_tag %] FOREACH key IN hash.keys.sort [% tt_end_tag %]
             * [% tt_start_tag %] key [% tt_end_tag %] = [% tt_start_tag %] hash.$key [% tt_end_tag %]
          [% tt_start_tag %] END [% tt_end_tag %]

  Alternately, you can use the 'pairs' method to get a list of key/value pairs in sorted order.

- values

  Returns a list of the values in the hash. As with the 'keys' method, they are not returned in any particular order, although it is the same order that the keys are returned in.

          [% tt_start_tag %] hash.values.join(', ') [% tt_end_tag %]

- items

  Returns a list of both the keys and the values expanded into a single list.

          [% tt_start_tag %] hash = {
                a = 10
                b = 20
             };

             hash.items.join(', ')    # a, 10, b, 20
          [% tt_end_tag %]

- each

  This method currently returns the same thing as the 'items' method.

  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'.

- pairs

  This method returns a list of key/value pairs. They are returned in sorted order according to the keys.

          [% tt_start_tag %] FOREACH pair IN product.pairs [% tt_end_tag %]
             * [% tt_start_tag %] pair.key [% tt_end_tag %] is [% tt_start_tag %] pair.value [% tt_end_tag %]
          [% tt_start_tag %] END [% tt_end_tag %]

- list

  Returns the contents of the hash in list form. An argument can be passed to indicate the desired items required in the list: 'keys' to return a list of the keys (same as hash.keys), 'values' to return a list of the values (same as hash.values), 'each' to return as list of key and values (same as hash.each), or 'pairs' to return a list of key/value pairs (same as hash.pairs).

          [% tt_start_tag %] keys   = hash.list('keys') [% tt_end_tag %]
          [% tt_start_tag %] values = hash.list('values') [% tt_end_tag %]
          [% tt_start_tag %] items  = hash.list('each') [% tt_end_tag %]
          [% tt_start_tag %] pairs  = hash.list('pairs') [% tt_end_tag %]

  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'.

- sort, nsort

  Return a list of the keys, sorted alphabetically (sort) or numerically (nsort) according to the corresponding values in the hash.

          [% tt_start_tag %] FOREACH n = phones.sort [% tt_end_tag %]
             [% tt_start_tag %] phones.$n [% tt_end_tag %] is [% tt_start_tag %] n [% tt_end_tag %],
          [% tt_start_tag %] END [% tt_end_tag %]

- import

  The import method can be called on a hash array to import the contents of another hash array.

          [% tt_start_tag %] hash1 = {
      	   foo => 'Foo',
                 bar => 'Bar',
             }
             hash2 = {
                 wiz => 'Wiz',
                 woz => 'Woz',
             }
          [% tt_end_tag %]

          [% tt_start_tag %] hash1.import(hash2) [% tt_end_tag %]
          [% tt_start_tag %] hash1.wiz [% tt_end_tag %]			# Wiz

  You can also call the import() method by itself to import a hash array into the current namespace hash.

          [% tt_start_tag %] user = { id => 'lwall', name => 'Larry Wall' } [% tt_end_tag %]
          [% tt_start_tag %] import(user) [% tt_end_tag %]
          [% tt_start_tag %] id [% tt_end_tag %]: [% tt_start_tag %] name [% tt_end_tag %]		# lwall: Larry Wall

- defined, exists

  Returns a true or false value if an item in the hash denoted by the key passed as an argument is defined or exists, respectively.

          [% tt_start_tag %] hash.defined('somekey') ? 'yes' : 'no' [% tt_end_tag %]
          [% tt_start_tag %] hash.exists('somekey') ? 'yes' : 'no' [% tt_end_tag %]

  When called without any argument, hash.defined returns true if the hash itself is defined (e.g. the same effect as scalar.defined).

- delete

  Delete one or more items from the hash.

          [% tt_start_tag %] hash.delete('foo', 'bar') [% tt_end_tag %]

- size

  Returns the number of key/value pairs in the hash.

- item

  Returns an item from the hash using a key passed as an argument.

          [% tt_start_tag %] hash.item('foo') [% tt_end_tag %]  # same as hash.foo

[%- END %] [% WRAPPER subsection title = "List Virtual Methods" -%]

- first, last

  Returns the first/last item in the list. The item is not removed from the list.

          [% tt_start_tag %] results.first [% tt_end_tag %] to [% tt_start_tag %] results.last [% tt_end_tag %]

  If either is given a numeric argument `'n'`, they return the first or last `'n'` elements:

          The first 5 results are [% tt_start_tag %] results.first(5).join(", ") [% tt_end_tag %].

- size, max

  Returns the size of a list (number of elements) and the maximum index number (size - 1), respectively.

          [% tt_start_tag %] results.size [% tt_end_tag %] search results matched your query

- defined

  Returns a true or false value if the item in the list denoted by the argument is defined.

          [% tt_start_tag %] list.defined(3) ? 'yes' : 'no' [% tt_end_tag %]

  When called without any argument, list.defined returns true if the list itself is defined (e.g. the same effect as scalar.defined).

- reverse

  Returns the items of the list in reverse order.

          [% tt_start_tag %] FOREACH s = scores.reverse [% tt_end_tag %]
             ...
          [% tt_start_tag %] END [% tt_end_tag %]

- join

  Joins the items in the list into a single string, using Perl's join function.

          [% tt_start_tag %] items.join(', ') [% tt_end_tag %]

- grep

  Returns a list of the items in the list that match a regular expression pattern.

          [% tt_start_tag %] FOREACH directory.files.grep('\.txt$') [% tt_end_tag %]
             ...
          [% tt_start_tag %] END [% tt_end_tag %]

- sort, nsort

  Returns the items in alpha (sort) or numerical (nsort) order.

          [% tt_start_tag %] library = books.sort [% tt_end_tag %]

  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.

          [% tt_start_tag %] library = books.sort('author') [% tt_end_tag %]

  In the example, the 'books' list can contains hash references with an 'author' key or objects with an 'author' method.

- unshift(item), push(item)

  The push() method adds an item or items to the end of list.

          [% tt_start_tag %] mylist.push(foo) [% tt_end_tag %]
          [% tt_start_tag %] mylist.push(foo, bar) [% tt_end_tag %]

      The unshift() method adds an item or items to the start of a list.

          [% tt_start_tag %] mylist.unshift(foo) [% tt_end_tag %]
          [% tt_start_tag %] mylist.push(foo, bar)    [% tt_end_tag %]

- shift, pop

  Removes the first/last item from the list and returns it.

          [% tt_start_tag %] first = mylist.shift [% tt_end_tag %]
          [% tt_start_tag %] last  = mylist.pop   [% tt_end_tag %]

- unique

  Returns a list of the unique elements in a list, in the same order as in the list itself.

          [% tt_start_tag %] mylist = [ 1, 2, 3, 2, 3, 4, 1, 4, 3, 4, 5 ] [% tt_end_tag %]
          [% tt_start_tag %] numbers = mylist.unique [% tt_end_tag %]

  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).

          [% tt_start_tag %] numbers = mylist.unique.sort [% tt_end_tag %]

- import

  Appends the contents of one or more other lists to the end of the current list.

          [% tt_start_tag %] 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
          [% tt_end_tag %]

- merge

  Returns a list composed of zero or more other lists:

          [% tt_start_tag %] list_one = [ 1 2 3 ];
             list_two = [ 4 5 6 ];
             list_three = [ 7 8 9 ];
             list_four = list_one.merge(list_two, list_three);
          [% tt_end_tag %]

  The original lists are not modified.

- slice(from, to)

  Returns a slice of items in the list between the bounds passed as arguments. If the second argument, 'to', isn't specified, then it defaults to the last item in the list. The original list is not modified.

          [% tt_start_tag %] first_three = list.slice(0,2) [% tt_end_tag %]

          [% tt_start_tag %] last_three  = list.slice(-3, -1) [% tt_end_tag %]

- splice(offset, length, list)

  Behaves just like Perl's 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'.

         [% tt_start_tag %] 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
         [% tt_end_tag %]

  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.

          [% tt_start_tag %] CALL play_game.splice(1, 1, ping_pong) [% tt_end_tag %]

  As well as providing a reference to a list of replacement values, you can pass in a list of items.

         [% tt_start_tag %] CALL list.splice(-1, 0, 'foo', 'bar') [% tt_end_tag %]

  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:

        [% tt_start_tag %] # 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 ]);
        [% tt_end_tag %]

- hash

  Returns a reference to a hash array comprised of the elements in the list. The even-numbered elements (0, 2, 4, etc) become the keys and the odd-numbered elements (1, 3, 5, etc) the values.

          [% tt_start_tag %] list = ['pi', 3.14, 'e', 2.718] [% tt_end_tag %]
          [% tt_start_tag %] hash = list.hash [% tt_end_tag %]
          [% tt_start_tag %] hash.pi [% tt_end_tag %]               # 3.14
          [% tt_start_tag %] hash.e  [% tt_end_tag %]               # 2.718

  If a numerical argument is provided then the hash returned will have keys generated for each item starting at the number specified.

          [% tt_start_tag %] list = ['beer', 'peanuts'] [% tt_end_tag %]
          [% tt_start_tag %] hash = list.hash(1) [% tt_end_tag %]
          [% tt_start_tag %] hash.1  [% tt_end_tag %]               # beer
          [% tt_start_tag %] hash.2  [% tt_end_tag %]               # peanuts

[%- END %] [% WRAPPER subsection title = "Automagic Promotion of Scalar to List for Virtual Methods" -%]

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:

        [% tt_start_tag %] FOREACH item IN something [% tt_end_tag %]
           ...
        [% tt_start_tag %] END [% tt_end_tag %]

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:

        [% tt_start_tag %] something.first   [% tt_end_tag %]
        [% tt_start_tag %] something.join    [% tt_end_tag %]
        [% tt_start_tag %] something.reverse.join(', ') [% tt_end_tag %]

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.

[%- END %] [% WRAPPER subsection title = "Defining Custom Virtual Methods" -%]

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:

        [% tt_start_tag %] primes = [ 2, 3, 5, 7, 9 ] [% tt_end_tag %]
        [% tt_start_tag %] primes.odd.join(', ') [% tt_end_tag %]		# 3, 5, 7, 9

[%- END %] [%- END %] [% WRAPPER section title="AUTHOR" -%]

Andy Wardley <abw@wardley.org>

[% ttlink('http://wardley.org/', 'http://wardley.org/') -%]

[%- END %] [% WRAPPER section title="VERSION" -%]

Template Toolkit version 2.19, released on 27 April 2007.

[%- END %] [% WRAPPER section title="COPYRIGHT" -%]

      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.

[%- END %]