mason::manual::intro(3pm) [debian man page]

Mason::Manual::Intro(3pm)				User Contributed Perl Documentation				 Mason::Manual::Intro(3pm)

NAME

       Mason::Manual::Intro - Getting started with Mason

DESCRIPTION

       A few quick examples to get your feet wet with Mason.  See Mason::Manual::Setup for how to use Mason to generate web sites.

EXAMPLE 1
   Hello world (from command-line)
       After installing Mason, you should have a "mason" command in your installation path (e.g. "/usr/local/bin"). Try this:

	   % mason
	   Hello! The local time is <% scalar(localtime) %>.
	   ^D

       (where '^D' means ctrl-D or EOF). You should see something like

	   Hello! The local time is Wed Mar  2 17:11:54 2011.

       The "mason" command reads in a Mason component (template), runs it, and prints the result to standard output. Notice that the tag

	   <% scalar(localtime) %>

       was replaced with the value of its expression. This is called a substitution tag and is a central piece of Mason syntax.

EXAMPLE 2
   Email generator (from script)
       The command line is good for trying quick things, but eventually you're going to want to put your Mason components in files.

       In a test directory, create a directory "comps" and create a file "email.mc" with the following:

	   <%class>
	   has 'amount';
	   has 'name';
	   </%class>

	   Dear <% $.name %>,

	       We are pleased to inform you that you have won $<% sprintf("%.2f", $.amount) %>!

	   Sincerely,
	   The Lottery Commission

	   <%init>
	   die "amount must be a positive value!" unless $.amount > 0;
	   </%init>

       In addition to the substitution tag we've seen before, we declare two attributes, "amount" and "name", to be passed into the component; and
       we declare a piece of initialization code to validate the amount.

       In the same test directory, create a script "test.pl" with the following:

	    1  #!/usr/local/bin/perl
	    2  use Mason;
	    3  my $interp = Mason->new(comp_root => 'comps', data_dir => 'data');
	    4  print $interp->run('/email', name => 'Joe', amount => '1500')->output;

       Line 3 creates a Mason interpreter, the main Mason object. It specifies two parameters: a component root, indicating the directory
       hierarchy where your components will live; and a data directory, which Mason will use for internal purposes such as class generation and
       caching.

       Line 4 runs the template - notice that the ".mc" extension is added automatically - passing values for the "name" and "amount" attributes.

       Run "test.pl", and you should see

	   Dear Joe,

	       We are pleased to inform you that you have won $1500.00!

	   Sincerely,
	   The Lottery Commission

SEE ALSO

       Mason::Manual::Tutorial, Mason::Manual

AUTHOR

       Jonathan Swartz <swartz@pobox.com>

COPYRIGHT AND LICENSE

       This software is copyright (c) 2011 by Jonathan Swartz.

       This is free software; you can redistribute it and/or modify it under the same terms as the Perl 5 programming language system itself.

perl v5.14.2							    2012-05-02						 Mason::Manual::Intro(3pm)

Check Out this Related Man Page

HTML::Mason::Resolver(3pm)				User Contributed Perl Documentation				HTML::Mason::Resolver(3pm)

NAME

       HTML::Mason::Resolver - Component path resolver base class

SYNOPSIS

	 # make a subclass and use it

DESCRIPTION

       The resolver is responsible for translating a component path like /foo/index.html into a component.  By default, Mason expects components
       to be stored on the filesystem, and uses the HTML::Mason::Resolver::File class to get information on these components.

       The HTML::Mason::Resolver provides a virtual parent class from which all resolver implementations should inherit.

Class::Container
       This class is used by most of the Mason object's to manage constructor parameters and has-a relationships with other objects.

       See the documentation on this class for details on how to declare what paremeters are valid for your subclass's constructor.

       HTML::Mason::Resolver is a subclass of Class::Container so you do not need to subclass it yourself.

METHODS

       If you are interested in creating a resolver subclass, you must implement the following methods.

       new This method is optional.  The new method included in this class is simply inherited from "Class::Container".  If you need something
	   more complicated done in your new method you will need to override it in your subclass.

       get_info
	   Takes three arguments: an absolute component path, a component root key, and a component root path. Returns a new
	   HTML::Mason::ComponentSource object.

       glob_path
	   Takes two arguments: a path glob pattern, something like "/foo/*" or "/foo/*/bar", and a component root path. Returns a list of
	   component paths for components which match this glob pattern.

	   For example, the filesystem resolver simply appends this pattern to the component root path and calls the Perl "glob()" function to
	   find matching files on the filesystem.

   Using a Resolver with HTML::Mason::ApacheHandler
       If you are creating a new resolver that you intend to use with the HTML::Mason::ApacheHandler module, then you must implement the following
       method as well.

       apache_request_to_comp_path ($r, @comp_root_array)
	   This method, given an Apache object and a list of component root pairs, should return a component path or undef if none exists.  This
	   method is used by the HTML::Mason::ApacheHandler class to translate web requests into component paths.  You can omit this method if
	   your resolver subclass will never be used in conjunction with HTML::Mason::ApacheHandler.

SEE ALSO

       HTML::Mason

perl v5.14.2							    2012-02-04						HTML::Mason::Resolver(3pm)

Linux and UNIX Man Pages

mason::manual::intro(3pm) [debian man page]

Check Out this Related Man Page