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

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

NAME

       HTML::Mason::ComponentSource - represents information about an component

SYNOPSIS

	   my $info = $resolver->get_info($comp_path);

DESCRIPTION

       Mason uses the ComponentSource class to store information about a source component, one that has yet to be compiled.

METHODS

       new This method takes the following arguments:

	   o   comp_path

	       The component's component path.

	   o   last_modified

	       This is the last modificatoin time for the component, in Unix time (seconds since the epoch).

	   o   comp_id

	       This is a unique id for the component used to distinguish two components with the same name in different component roots.

	       If your resolver does not support multiple component roots, this can simply be the same as the "comp_path" key or it can be any
	       other id you wish.

	       This value will be used when constructing filesystem paths so it needs to be something that works on different filesystems.  If it
	       contains forward slashes, these will be converted to the appropriate filesystem-specific path separator.

	       In fact, we encourage you to make sure that your component ids have some forward slashes in them or also all of your generated
	       object files will end up in a single directory, which could affect performance.

	   o   comp_class

	       The component class into which this particular component should be blessed when it is created.  This must be a subclass of
	       "HTML::Mason::Component", which is the default.

	   o   friendly_name

	       This is used when displaying error messages related to the component, like parsing errors.  This should be something that will help
	       whoever sees the message identify the component.  For example, for component stored on the filesystem, this should be the absolute
	       path to the component.

	   o   source_callback

	       This is a subroutine reference which, when called, returns the component source.

	       The reasoning behind using this parameter is that it helps avoid a profusion of tiny little "HTML::Mason::ComponentSource"
	       subclasses that don't do very much.

	   o   extra

	       This optional parameter should be a hash reference.  It is used to pass information from the resolver to the component class.

	       This is needed since a "HTML::Mason::Resolver" subclass and a "HTML::Mason::Component" subclass can be rather tightly coupled, but
	       they must communicate with each through the interpreter (this may change in the future).

       comp_path
       last_modified
       comp_id
       comp_class
       friendly_name
       extra
	   These are all simple accessors that return the value given to the constructor.

       comp_source
	   Returns the source of the component.

       object_code ( compiler => $compiler )
	   Given a compiler, this method returns the object code for the component.

       HTML::Mason, HTML::Mason::Admin, HTML::Mason::Component

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

Check Out this Related Man Page

Jifty::View::Mason::Handler(3pm)			User Contributed Perl Documentation			  Jifty::View::Mason::Handler(3pm)

NAME

       Jifty::View::Mason::Handler - Handler for Mason requests inside of Jifty

SUMMARY

       Jifty controls all of the input and output from the Mason templating engine; this means that we cannot use the Mason's standard
       HTML::Mason::CGIHandler interface to interact with it.

   new PARAMHASH
       Takes a number of key-value parameters; see HTML::Mason::Params.  Defaults the "out_method" to appending to "buffer" in Jifty::Handler and
       the "request_class" to Jifty::View::Mason::Request (below).  Finally, adds "h" and "u" escapes, which map to "escape_uri" and escape_utf8
       respectively.

   config
       Returns our Mason config.  We use the component root specified in the "Web/TemplateRoot" framework configuration variable (or "html" by
       default).  Additionally, we set up a "jifty" component root, as specified by the "Web/DefaultTemplateRoot" configuration.  All
       interpolations are HTML-escaped by default, and we use the fatal error mode.

   escape_utf8 SCALARREF
       Does a css-busting but minimalist escaping of whatever html you're passing in.

   escape_uri SCALARREF
       Escapes in-place URI component according to RFC2396. Takes a reference to perl string.

       *Note* that octets would be treated as latin1 encoded sequence and converted to UTF-8 encoding and then escaped. So this sub always provide
       UTF-8 escaped string. See also Encode for more info about converting.

   template_exists COMPONENT
       Checks if the "COMPONENT" exists, or if "COMPONENT/index.html" exists, and returns which one did.  If neither did, it searches for
       "dhandler" components which could match, returning "COMPONENT" if it finds one.	Finally, if it finds no possible component matches,
       returns undef.

       Note that this algorithm does not actually decisively return if Mason will handle a given component; the dhandlers could defer handling,
       for instance.

   show COMPONENT
       Takes a component path to render.  Deals with setting up a global HTML::Mason::FakeApache and Request object, and calling the component.

   handle_comp
       A synonym for show

   request_args
       The official source for request arguments is from the current Jifty::Request object.

   create_cache_directories
       Attempts to create our application's mason cache directory.

perl v5.14.2							    2010-12-08					  Jifty::View::Mason::Handler(3pm)

Linux and UNIX Man Pages

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

Check Out this Related Man Page