GSP
Quick Navigator

Search Site

Unix VPS
A - Starter
B - Basic
C - Preferred
D - Commercial
MPS - Dedicated
Previous VPSs
* Sign Up! *

Support
Contact Us
Online Help
Handbooks
Domain Status
Man Pages

FAQ
Virtual Servers
Pricing
Billing
Technical

Network
Facilities
Connectivity
Topology Map

Miscellaneous
Server Agreement
Year 2038
Credits
 

USA Flag

 

 

Man Pages
Text::Haml(3) User Contributed Perl Documentation Text::Haml(3)

Text::Haml - Haml Perl implementation

    use Text::Haml;

    my $haml = Text::Haml->new;

    my $html = $haml->render('%p foo'); # <p>foo</p>

    $html = $haml->render('= $user', user => 'friend'); # <div>friend</div>

    # Use Haml file
    $html = $haml->render_file('tmpl/index.haml', user => 'friend');

Text::Haml implements Haml <http://haml.info/docs/yardoc/file.REFERENCE.html> specification.

Text::Haml passes specification tests written by Norman Clarke https://github.com/haml/haml-spec and supports only cross-language Haml features. Do not expect ruby or Rails specific extensions to work.

Text::Haml implements the following attributes:

Holds the string of code that is appended to the generated Perl code.

Holds the Perl code.

Holds compiled code.

    $haml->encoding('utf-8');

Default is utf-8.

Escape subroutine presented as string.

Default is

    $haml->escape(<<'EOF');
        my $s = shift;
        return unless defined $s;
        $s =~ s/&/&amp;/g;
        $s =~ s/</&lt;/g;
        $s =~ s/>/&gt;/g;
        $s =~ s/"/&quot;/g;
        $s =~ s/'/&apos;/g;
        return $s;
    EOF

    $haml->escape_html(0);

Switch on/off Haml output html escaping. Default is on.

Holds filters.

    $haml->format('xhtml');

Supported formats: xhtml, html, html5.

Default is xhtml.

Holds the namespace under which the Perl package is generated.

Holds the string of code that is prepended to the generated Perl code.

Holds the variables that are passed during the rendering.

When options is NOT SET (by default) passed variables are normal Perl variables and are used with "$" prefix.

    $haml->render('%p $var', var => 'hello');

When this option is SET passed variables are Perl lvalue subroutines and are used without "$" prefix.

    $haml->render('%p var', var => 'hello');

But if you declare Perl variable in a block, it must be used with "$" prefix.

    $haml->render('<<EOF')
        - my $foo;
        %p= $foo
    EOF

    helpers => {
        foo => sub {
            my $self   = shift;
            my $string = shift;

            $string =~ s/r/z/;

            return $string;
        }
    }

Holds helpers subroutines. Helpers can be called in Haml text as normal Perl functions. See also add_helper.

    $haml->helpers_args($my_context);

First argument passed to the helper (Text::Haml instance by default).

    $haml->error;

Holds the last error.

Holds parsed haml elements.

Holds path of Haml templates. Current directory is a default. If you want to set several paths, arrayref can also be set up. This way is the same as Text::Xslate.

Holds cache level of Haml templates. 1 is a default. 0 means "Not cached", 1 means "Checked template mtime" and 2 means "Used always cached". This way is the same as Text::Xslate.

Holds cache directory of Haml templates. $ENV{HOME}/.text_haml_cache is a default. Unless $ENV{HOME}, File::Spec->tempdir was used. This way is the same as Text::Xslate.

    my $haml = Text::Haml->new;

    $haml->add_helper(current_time => sub { time });

Adds a new helper.

    $haml->add_filter(compress => sub { $_[0] =~ s/\s+/ /g; $_[0]});

Adds a new filter.

    $haml->build(@_);

Builds the Perl code.

    $haml->compile;

Compiles parsed code.

    $haml->interpret(@_);

Interprets compiled code.

    $haml->parse('%p foo');

Parses Haml string building a tree.

    my $text = $haml->render('%p foo');

    my $text = $haml->render('%p var', var => 'hello');

Renders Haml string. Returns undef on error. See error attribute.

    my $text = $haml->render_file('foo.haml', var => 'hello');

A helper method that loads a file and passes it to the render method. Since "%____vars" is used internally, you cannot use this as parameter name.

Despite of existing string interpolation in Perl, Ruby interpolation is also supported.

$haml->render('%p Hello #{user}', user => 'foo')

When declaring tag attributes ":" symbol can be used.

$haml->render("%a{:href => 'bar'}");

Perl-style is supported but not recommented, since your Haml template won't work with Ruby Haml implementation parser.

$haml->render("%a{href => 'bar'}");

When using the Data::Section::Simple, you need to unset the variable "encoding" in the constructor or using the "encoding" attribute of the Text::Haml:

    use Data::Section::Simple qw/get_data_section/;
    my $vpath = get_data_section;

    my $haml = Text::Haml->new(cache => 0, path => $vpath, encoding => '');
    # or
    #my $haml = Text::Haml->new(cache => 0, path => $vpath);
    #$haml->encoding(''); # encoding attribute

    my $index = $haml->render_file('index.haml');
    say $index;

    __DATA__

    @@ index.haml
    %strong XXXXX

see <https://metacpan.org/pod/Data::Section::Simple#utf8-pragma>

    http://github.com/vti/text-haml

Viacheslav Tykhanovskyi, "vti@cpan.org".

In order of appearance:

Nick Ragouzis

Norman Clarke

rightgo09

Breno G. de Oliveira (garu)

Yuya Tanaka

Wanradt Koell (wanradt)

Keedi Kim

Carlos Lima

Jason Younker

TheAthlete

Mark Aufflick (aufflick)

Graham Todd (grtodd)

Copyright (C) 2009-2017, Viacheslav Tykhanovskyi.

This program is free software, you can redistribute it and/or modify it under the terms of the Artistic License version 2.0.

2017-01-18 perl v5.32.1

Search for    or go to Top of page |  Section 3 |  Main Index

Powered by GSP Visit the GSP FreeBSD Man Page Interface.
Output converted with ManDoc.