UserDefinedFilters

1. summary How to write your own filters for use with Haml.
2. labels Phase-Implementation

Also see PredefinedFilters

Table of Contents Introduction Details Usage An Example Filter

Introduction

Filters provide a means to extend the functionality of Haml. They allows you to pass an indented block of text as input to another filtering program and add the result to the output of Haml.

This page describes how to write your own filter for use with PHamlP.

Details

Your filter class must be named "Haml`Filter", where ` = ucfirst(filterName). So if the name of your filter is "refine" your filter class must be named "HamlRefineFilter".

The file containing you filter must be named "Haml`Filter.php" and be placed in the filterDir directory.

Your filter class must extend "HamlBaseFilter" or a child class .

Your filter class must implement the "run($text)" method or may override it if defined in a child class you are extending.
$text is the input text.
This method must return a string that is the filtered text.

Your filter class may implement the "init()" method to provide initialisation of the filter. This method should call the parent init() method.

It is a good idea to provide PHP interpolation #{PHP code} in your filter. See the example below and the built in filters for examples of how this is done.

Usage

Using your filter is the same as using a built in filter, i.e. a colon followed by the name of the filter.

So to use the "refine" filter:

An Example Filter