Chano functions¶

This document describes all the functions that Chano supports. Most of this documentation is adapated from https://docs.djangoproject.com/en/dev/ref/templates/builtins/.

Filters¶

Modifies the value of the current item. All filters are chainable.

unorderedlist()¶

Recursively takes an array and returns an HTML unordered list - without opening and closing <ul> tags.

The array is assumed to be in the proper format. For example, if var contains:

array(
    'States', array(
        'Kansas', array(
              'Lawrence', 'Topeka'
        ), 'Illinois'
    )
)

then <?=$item->var->unordered_list()?> will render:

<li>States
<ul>
        <li>Kansas
        <ul>
                <li>Lawrence</li>
                <li>Topeka</li>
        </ul>
        </li>
        <li>Illinois</li>
</ul>
</li>

Returns: Chano instance

striptags()¶

Strips all [X]HTML tags.

For example:

<?=$item->value->striptags()?>

If $value is "<b>Joel</b> <button>is</button> a <span>slug</span>", the output will be "Joel is a slug".

Returns: Chano instance

now($format)¶

Displays the current date and/or time, using a format according to the given string which can contain format specifiers characters as described in the date($format) filter section.

Example:

Current time is: <?=$item->now("%B %e, %Y, %R %P")?>

This will display as "Current time is: March 10, 2001, 5:16 pm".

Returns: Chano instance

widthratio($max_in, $max_out)¶

For creating bar charts and such, this tag calculates the ratio of a given value to a maximum value, and then applies that ratio to a constant.

For example:

<img src="bar.gif" height="10" width="<?=$item->value->widthratio(175, 100)?>" />

Above, if value is 175 and, the image in the above example will be 88 pixels wide (because 175/200 = .875; .875 * 100 = 87.5 which is rounded up to 88).

Arguments

numeric $max_in - The maximum before value.
numeric $max_out - The maximum after value.

Returns: Chano instance

add($amount)¶

Adds the given amount to the current value.

If value is 2, then <?=$item->value->add(2)?> will render 4.

Arguments

numeric $amount

Returns: Chano instance

addslashes()¶

Adds slashes before quotes. Useful for escaping strings in CSV, for example.

For example:

<?=$item->value->addslashes()?>

If value is "I'm using Chano", the output will be "I\'m using Chano" .

Returns: Chano instance

capfirst()¶

Capitalizes the first character of the value.

For example:

<?=$item->value->capfirst()?>

If value is "chano", the output will be "Chano".

Returns: Chano instance

upper()¶

Converts a string into all uppercase.

For example:

<?=$item->value->upper()?>

If value is "Joel is a slug", the output will be "JOEL IS A SLUG".

Returns: Chano instance

center($width)¶

Centers the value in a field of a given width.

For example:

<?=$item->value->center(15)?>

If value is "Chano!", the output will be " Chano! ".

Arguments

int $width

Returns: Chano instance

ljust($width)¶

Left-aligns the value in a field of a given width.

For example:

"<?=$item->value->ljust(10)?>"

If value is Chano!, the output will be "Chano! ".

Arguments

int $width

Returns: Chano instance

rjust($width)¶

Right-aligns the value in a field of a given width.

For example:

"<?=$item->value->rjust(10)?>"

If value is Chano!, the output will be " Chano!".

Arguments

int $width

Returns: Chano instance

cut($string)¶

Removes all values of passed argument from the current value.

For example:

<?=$item->value->cut(" ")?>

If value is "String with spaces", the output will be "Stringwithspaces".

Arguments

string $string - The string to remove.

Returns: Chano instance

date($format)¶

Formats a date according to the given format.

The format must be in a syntax supported by the strftime() function.

The used timezone is the one found by the date_default_timezone_get() function.

Uses the current locale as set by the setlocale() function.

The input value can be a digit, which will be interpreted as a linux timestamp, a DateTime() class or a string recognized by the strtotime() class.

For example:

<?=$item->value->date("%d %B %Y")?>

If value is the string “2000-01-01”, a DateTime object like new DateTime("2000-01-01") or the linux timestamp integer 946684800, the output will be the string '01 January 2000'.

Arguments

string $format

Returns: Chano instance

filesizeformat()¶

Format the value like a ‘human-readable’ file size (i.e. '13 KB', '4.1 MB', '102 bytes', etc).

For example:

<?=$item->value->filesizeformat()?>

If value is 123456789, the output will be 117.7 MB.

Returns: Chano instance

yesno($yes=’yes’, $no=’no’, $maybe=’maybe’)¶

Given a string mapping values for true, false and (optionally) null, returns one of those strings according to the value:

For example:

<?=$item->value->yesno("yeah", "no", "maybe")?>

Value	Arguments	Outputs
`true`	`("yeah", "no", "maybe")`	`yeah`
`false`	`("yeah", "no", "maybe")`	`no`
`null`	`("yeah", "no", "maybe")`	`maybe`
`null`	`("yeah", "no")`	`"no"` (converts null to false if no mapping for null is given)

Arguments

string $yes
string $no
string $maybe

Returns: Chano instance

wordwrap($width)¶

Wraps words at specified line length.

For example:

<?=$item->value->wordwrap(5)?>

If value is Joel is a slug, the output will be:

Joel
is a
slug

Arguments

int $width - Number of characters at which to wrap the text.

Returns: Chano instance

wordcount()¶

Returns the number of words.

For example:

<?=$item->value->wordcount()?>

If value is "Joel is a slug", the output will be 4.

Returns: Chano instance

stringformat($format)¶

Formats the variable according to the argument, a string formatting specifier. This specifier uses the syntax of the sprintf function.

For example:

<?=$item->value->stringformat:("%03d")?>

If value is 1, the output will be "001".

Arguments

string $format

Returns: Chano instance

escapejs()¶

Escapes characters for use in JavaScript strings. This does not make the string safe for use in HTML, but does protect you from syntax errors when using templates to generate JavaScript/JSON.

For example:

<?=$item->value->escapejs()?>

If value is "testing\r\njavascript \'string" <b>escaping</b>", the output will be "testing\\u000D\\u000Ajavascript \\u0027string\\u0022 \\u003Cb\\u003Eescaping\\u003C/b\\u003E".

Returns: Chano instance

first()¶

Outputs the first item in an array, stdClass or Traversable.

For example:

<?=$item->value->first()?>

If value is the array array('a', 'b', 'c'), the output will be 'a'.

Returns: Chano instance

fixampersands()¶

Replaces ampersands with & entities.

This is rarely useful as ampersands are automatically escaped. See escape() for more information.

For example:

<?=$item->value->fixampersands()?>

If value is Tom & Jerry, the output will be Tom & Jerry.

Returns: Chano instance

floatformat($decimal_places=null)¶

When used without an argument, rounds a floating-point number to one decimal place – but only if there’s a decimal part to be displayed.

For example:

`value`	Template	Output
`34.23234`	`<?=$item->value->floatformat()?>`	`34.2`
`34.00000`	`<?=$item->value->floatformat()?>`	`34`
`34.26000`	`<?=$item->value->floatformat()?>`	`34.3`

If used with a numeric integer argument, floatformat rounds a number to that many decimal places. For example:

`value`	Template	Output
`34.23234`	`<?=$item->value->floatformat(3)?>`	`34.232`
`34.00000`	`<?=$item->value->floatformat(3)?>`	`34.000`
`34.26000`	`<?=$item->value->floatformat(3)?>`	`34.260`

If the argument passed to floatformat is negative, it will round a number to that many decimal places – but only if there’s a decimal part to be displayed. For example:

`value`	Template	Output
`34.23234`	`<?=$item->value->floatformat(-3)?>`	`34.232`
`34.00000`	`<?=$item->value->floatformat(-3)?>`	`34`
`34.26000`	`<?=$item->value->floatformat(-3)?>`	`34.260`

Using floatformat with no argument is equivalent to using floatformat with an argument of -1.

Arguments

string $format

Returns: Chano instance

getdigit($number)¶

Given a whole number, returns the requested digit, where 1 is the right-most digit, 2 is the second-right-most digit, etc. Returns the original value for invalid input (if input or argument is not an integer, or if argument is less than 1). Otherwise, output is always an integer.

For example:

<?=$item->value->get_digit(2)?>

If value is 123456789, the output will be 8.

Arguments

int $number

Returns: Chano instance

lower()¶

Converts a string into all lowercase.

For example:

<?=$item->value->lower()?>

If value is Still MAD At Yoko, the output will be still mad at yoko.

Returns: Chano instance

title()¶

Converts a string into titlecase.

For example:

<?=$item->value->title()?>

If value is "my first post", the output will be "My First Post".

Returns: Chano instance

urlize()¶

Converts URLs in text into clickable links.

Works on links prefixed with http://, https://, or www.. For example, http://goo.gl/aia1t will get converted but goo.gl/aia1t won’t.

Also works on domain-only links ending in one of the common .com, .net, or .org top level domains. For example, chano.readthedocs.org will still get converted.

Links can have trailing punctuation (periods, commas, close-parens) and leading punctuation (opening parens) and urlize will still do the right thing.

Links generated by urlize have a rel="nofollow" attribute added to them.

For example:

<?=$item->value->urlize()?>

If value is "Check out chano.readthedocs.org", the output will be "Check out <a href="http://chano.readthedocs.org" rel="nofollow">chano.readthedocs.org</a>".

Returns: Chano instance

urlizetrunc($len)¶

Converts URLs into clickable links just like urlize, but truncates URLs longer than the given character limit.

For example:

<?=$item->value->urlizetrunc(15)?>

If value is "Check out chano.readthedocs.org", the output will be 'Check out <a href="http://chano.readthedocs.org" rel="nofollow">chano.readth...</a>'.

As with urlize, this filter should only be applied to plain text.

Arguments

int $length - Number of characters that link text should be truncated to, including the ellipsis that's added if truncation is necessary.

Returns: Chano instance

truncatewords($number)¶

Truncates a string after a certain number of words.

For example:

<?=$item->value->truncatewords(2)?>

If value is "Joel is a slug", the output will be "Joel is ...".

Arguments

string $number - Number of words to truncate after.

Returns: Chano instance

truncatewordshtml($number)¶

Similar to truncatewords, except that it is aware of HTML tags.

Any tags that are opened in the string and not closed before the truncation point, are closed immediately after the truncation.

This is less efficient than truncatewords, so should only be used when it is being passed HTML text.

For example:

<?=$item->value->truncatewords_html(2)?>

If value is "<p>Joel is a slug</p>", the output will be "<p>Joel is ...</p>".

Newlines in the HTML content will be preserved.

Arguments

string $number - Number of words to truncate after.

Returns: Chano instance

truncatechars($length, $ellipsis=’...’)¶

Truncates a string if it is longer than the specified number of characters. Truncated strings will end with an ellipsis, which defaults to (”...”) but can be set by the second argument.

For example:

<?=$item->value->truncatechars(9)?>

If value is "Joel is a slug", the output will be "Joel i...".

Arguments

int $length
string $ellipsis - Custom ellipsis character(s).

Returns: Chano instance

urlencode()¶

Escapes a value for use in an URL.

For example:

<?=$item->value->urlencode()?>

If value is "http://www.example.org/foo?a=b&c=d", the output will be "http%3A//www.example.org/foo%3Fa%3Db%26c%3Dd".

Returns: Chano instance

iriencode()¶

Converts an IRI (Internationalized Resource Identifier) to a string that is suitable for including in an URL. This is necessary if you’re trying to use strings containing non-ASCII characters in an URL.

It’s safe to use this filter on a string that has already gone through the urlencode filter.

For example:

<?=$item->value->iriencode()?>

If value is "?test=1&me=2", the output will be "?test=1&me=2".

Returns: Chano instance

slice($slice_string)¶

Returns a slice of a string.

Uses the same syntax as Python’s list slicing. See http://diveintopython.org/native_data_types/lists.html#odbchelper.list.slice for an introduction.

Example:

<?=$item->value->slice("0")?>
<?=$item->value->slice("1")?>
<?=$item->value->slice("-1")?>
<?=$item->value->slice("1:2")?>
<?=$item->value->slice("1:3")?>
<?=$item->value->slice("0::2")?>

If value is "abcdefg", the outputs will be "", "a", "abcdef", "b", "bc" and "aceg" respectively.

Arguments

string $slice_string

Returns: Chano instance

linenumbers()¶

Displays text with line numbers.

For example:

<?=$item->value->linenumbers()?>

If value is:

one
two
three

the output will be:

one
two
three

Returns: Chano instance

removetags()¶

Removes given arguments of [X]HTML tags from the output.

For example:

<?=$item->value->removetags("b", "span", "ol")?>

If value is "<b>Joel</b> <button>is</button> a <span>slug</span>" the output will be "Joel <button>is</button> a slug".

Note that this filter is case-sensitive.

If value is "<B>Joel</B> <button>is</button> a <span>slug</span>" the output will be "<B>Joel</B> <button>is</button> a slug".

Arguments

string $tag1 ... $tagN - An arbitrary number of tags to be removed.

Returns: Chano instance

linebreaks()¶

Replaces line breaks in plain text with appropriate HTML; a single newline becomes an HTML line break (<br />) and a new line followed by a blank line becomes a paragraph break (</p>).

For example:

<?=$item->value->linebreaks()?>

If value is Joel\nis a slug, the output will be <p>Joel<br />is a slug</p>.

Returns: Chano instance

linebreaksbr()¶

Converts all newlines in a piece of plain text to HTML line breaks (<br />).

For example:

<?=$item->value->linebreaksbr()?>

If value is "Joel\nis a slug", the output will be Joel<br />is a slug.

Returns: Chano instance

join($glue=’, ‘)¶

Joins a list with a string, like the implode() function.

For example:

<?=$item->value->join(" // ")?>

If value is the array array('a', 'b', 'c'), the output will be the string "a // b // c".

Arguments

string $glue

Returns: Chano instance

makelist()¶

Returns the value turned into an array.

For example:

<?=$item->value->makelist()?>

If value is the string "Joel", the output will be the array array('J', 'o', 'e', 'l').

Returns: Chano instance

slugify()¶

Converts to lowercase, removes non-word characters (alphanumerics and underscores) and converts spaces to hyphens. Also strips leading and trailing whitespace.

For example:

<?=$item->value->slugify()?>

If value is "Joel is a slug", the output will be "joel-is-a-slug".

Returns: Chano instance

phone2numeric()¶

Converts a phone number (possibly containing letters) to its numerical equivalent.

The input doesn’t have to be a valid phone number. This will happily convert any string.

For example:

<?=$item->value->phone2numeric()?>

If value is 800-COLLECT, the output will be 800-2655328.

Returns: Chano instance

Questions¶

Conditionally returns a value based on the value of the current item or other parameters. All questions are nonchainable.

emptyor($default)¶

If value evaluates to false, use given default. Otherwise, use the value.

For example:

<?=$item->value->default("nothing")?>

If value is "" (the empty string), the output will be nothing.

Returns: mixed

isfirst()¶

True if this is the first time through the loop.

For example:

<?foreach (new Chano($players) as $player):?>
    <?if ($player->score->first()):?>
        First!
    <?endif?>
<?endforeach?

Returns: bool

islast()¶

True if this is the last time through the loop.

For example:

<?foreach (new Chano($players) as $player):?>
     <?if ($player->score->islast()):?>
         Last!
     <?endif?>
 <?endforeach?>

Returns: bool

changed()¶

Check if a value has changed from the last iteration of a loop.

For example:

<?foreach (new Chano($players) as $player):?>
    <?if ($player->score->changed()):?>
        Changed!
    <?endif?>
<?endforeach?>

Returns: bool

same()¶

Check if a value is the same as the last iteration of a loop.

For example:

<?foreach (new Chano($players) as $player):?>
    <?if ($player->score->same()):?>
        Same!
    <?endif?>
<?endforeach?>

Returns: bool

divisibleby($divisor)¶

Returns true if the value is divisible by the argument.

For example:

<?=$item->value->divisibleby(3)?>

If value is 21, the output will be true.

Returns: bool

Counters¶

Different methods of counting to/from the current item. Works on the base instance, e.g. you don’t have to ask for a key first. All counters are chainable.

counter()¶

The current iteration of the loop (1-indexed).

For example:

<?foreach(new Chano($items) as $item):?>
     <?=$item->counter()?>
<?endforeach?>

If $items is:

array(
    array('value' => 'foo'),
    array('value' => 'foo'),
    array('value' => 'foo'),
)

The output will be 123.

Returns: Chano Instance

counter0()¶

The current iteration of the loop (0-indexed).

For example:

<?foreach(new Chano($items) as $item):?>
     <?=$item->counter0()?>
<?endforeach?>

If $items is:

array(
    array('value' => 'foo'),
    array('value' => 'foo'),
    array('value' => 'foo'),
)

The output will be 012.

Returns: Chano Instance

revcounter()¶

The number of iterations from the end of the loop (1-indexed).

For example:

<?foreach(new Chano($items) as $item):?>
     <?=$item->revcounter()?>
<?endforeach?>

If $items is:

array(
    array('value' => 'foo'),
    array('value' => 'foo'),
    array('value' => 'foo'),
)

The output will be 321.

Returns: Chano Instance

revcounter0()¶

The number of iterations from the end of the loop (0-indexed).

For example:

<?foreach(new Chano($items) as $item):?>
     <?=$item->revcounter0()?>
<?endforeach?>

If $items is:

array(
    array('value' => 'foo'),
    array('value' => 'foo'),
    array('value' => 'foo'),
)

The output will be 210.

Returns: Chano Instance

Other¶

Other functions.

firstfull()¶

Returns the first not empty value of the given arguments. This function is chainable. Works on the base instance.

For example:

<?=$item->firstfull(0, null, array(), new stdClass, 42)?>

Will output 42.

Arguments

mixed $arg1 ... $argN - $return Chano instance

cycle()¶

Cycle among the given arguments, each time this function is called. Works multiple times with different arguments inside the same loop. This function is chainable.

For example:

<?foreach (new Chano($items) as $item):?>
    <tr class="<?=$item->cycle('row1', 'row2')?>">
        ...
    </tr>
<?endforeach?>

Arguments

mixed $arg1 ... $argN

Returns: Chano Instance

length()¶

Returns the length of the current value. If the current value is a scalar (string, int, etc.) the string length will be returned, otherwise the count. This function is non chainable.

For example:

<?=$item->value->length()?>

If value is "joel" or array("j", "o", "e", "l") the output will be 4.

If length is called on the base instance, the count of the main dataset is given.

For example if $items is:

new Chano(array(
    array('title' => 'foo'),
    array('title' => 'bar'),
))

then:

<?$items->length()?>

will output 2.

Returns: int

pluralize($plural=’s’, $singular=null)¶

Returns a plural suffix if the value is not 1. By default, this suffix is 's'.

Example:

You have <?$item->num_messages?> message<?$item->num_messages->pluralize()?>.

If num_messages is 1, the output will be You have 1 message. If num_messages is 2 the output will be You have 2 messages.

For words that require a suffix other than 's', you can provide an alternate suffix as the first argument to the filter.

Example:

You have <?$item->num_walruses?> walrus<?$item->num_messages->pluralize("es")?>.

For words that don’t pluralize by simple suffix, you can specify both a plural and singular suffix as arguments.

Example:

You have <?$item->num_cherries?> cherr<?$item->num_cherries->pluralize("y", "ies")?>.

If pluralize is called on the base instance, what is being pluralized is the main dataset. See length.

Arguments

string $plural
string $singular

Returns: string

deepcopy()¶

For performance reasons, Chano changes the values of the current item by reference. So if you apply a function to a value, and accesses that same value again, the value is still changed. deepcopy clones the values in the current item, and rebuilds it after every __toString() call.

For example if $items is:

array(
    array('title' => 'foo')
)

The following:

<?foreach(new Chano($items) as $item)?>
    <?=$item->title->upper()?>
    - <?=$item->title?>
<?endforeach?>

Will output FOO - FOO. But using deepcopy like:

<?foreach(new Chano($items) as $item)?>
    <?=$item->deepcopy()->title->upper()?>
    - <?=$item->title?>
<?endforeach?>

Will output FOO - foo.

Returns: Chano instance

vd()¶

var_dumps() the content of the current value to screen.

Returns: Chano instance

Escaping¶

By default all output from Chano is escaped but this behavior can be modified by the functions in this section. All escaping functions are chainable.

autoescapeon()¶

Switches on auto-escaping behavior. This only has any effect after the autoescapeoff() method has been called as the default behavior of Chano is to escape all output.

When auto-escaping is in effect, all variable content has HTML escaping applied to it before placing the result into the output (but after any filters have been applied).

Sample usage:

<?foreach(new Chano($items) as $item)?>
    <?=$item->autoescapeoff()->body?>
    <?=$item->comments?>
    <?=$item->autoescapeon()?>
    <?=$item->title?>
<?endforeach?>

Returns: Chano instance

autoescapeoff()¶

Switches off the default auto-escaping behavior. This means that all output until the end or until autoescapeon() is called will not be escaped unless escape() is specifically called.

Sample usage:

<?foreach(new Chano($items) as $item)?>
    <?=$item->autoescapeoff()->body?>
    <?=$item->comments?> <!-- body and comments are not escaped -->
    <?=$item->autoescapeon()?>
    <?=$item->title?> <!-- title is escaped -->
<?endforeach?>

Returns: Chano instance

escape()¶

Forces escaping on the next output, e.g. when __toString() is called, overruling the autoescapeoff() flag a single time. When autoescaping is on this flag has no effect.

The opposite of safe.

For example:

<?foreach(new Chano($items) as $item)?>
    <?=$item->autoescapeoff()?>
    <?=$item->escape()->body?> <!-- body is escaped -->
    <?=$item->comments?> <!-- comments is not escaped -->
<?endforeach?>

Returns: Chano instance

safe()¶

Marks a string as not requiring further HTML escaping prior to output.

When autoescaping is off, this filter has no effect.

The opposite of escape.

If you are chaining filters, a filter applied after safe can make the contents unsafe again. For example, the following code prints as escaped:

<?=$item->value->safe()->escape()?>

Returns: Chano instance

forceescape()¶

Applies HTML escaping to a string (see the escape filter for details). This filter is applied immediately and returns a new, escaped string. This is useful in the rare cases where you need multiple escaping or want to apply other filters to the escaped results. Normally, you want to use the escape filter.

Returns: Chano instance