html::mason::resolver(3pm) [debian 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)

Check Out this Related Man Page

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

NAME

       Mason::Manual::Subclasses - Creating custom subclasses of Mason's classes

DESCRIPTION

       You can subclass the following Mason classes for your application:

	   Mason::CodeCache
	   Mason::Compilation
	   Mason::Component
	   Mason::Component::ClassMeta
	   Mason::Component::Import
	   Mason::Component::Moose
	   Mason::Interp
	   Mason::Request
	   Mason::Result

       and arrange things so that Mason always uses your subclass instead of its default class.

       Note: if you want to create a general purpose modification to Mason to use in multiple applications, you should probably create a plugin
       instead of a subclass.

CREATING A SUBCLASS

       A subclass should look something like this:

	   package My::Mason::Interp;
	   use Moose;
	   extends 'Mason::Interp';

	   # put your modifications here

	   1;

LETTING MASON KNOW ABOUT YOUR SUBCLASSES

       There are two ways to let Mason know about your subclasses: by naming convention, and by parameters to "Mason->new".

   By naming convention
       First, create a subclass of Mason itself:

	   package My::Mason;
	   use Moose;
	   extends 'Mason';

	   1;

       and use that in place of "Mason" in construction:

	   my $interp = My::Mason->new();

       Now, you can place any subclasses under 'My::Mason' and they'll automatically be picked up. e.g.

	   My::Mason::Compilation
	   My::Mason::Interp
	   My::Mason::Request

By constructor parameter
       You can specify your subclasses via "base_*" parameters to "Mason->new()".  e.g.

	   my $interp = Mason->new(
		base_compilation_class => 'My::Mason::Compilation',
		base_interp_class => 'My::Mason::Interp'
		base_request_class => 'Some::Other::Mason::Request'
	   );

       See "CUSTOM MASON CLASSES" in Mason::Interp for a complete list.

SEE ALSO

       Mason

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::Subclasses(3pm)

Linux and UNIX Man Pages

html::mason::resolver(3pm) [debian man page]

Check Out this Related Man Page