- STRUCTURAL METHODS
- CLASS METHODS
- OTHER METHODS
- SEE ALSO
- COPYRIGHT AND LICENSE
Mason::Component - Mason Component base class
Every Mason component corresponds to a unique class that inherits, directly or indirectly, from this base class.
A new instance of the component class is created whenever a component is called - whether via a top level request,
<& &> tags, or an << $m->comp >> call. A component instance is only valid for the Mason request in which it was created.
We leave this class as devoid of built-in methods as possible, allowing you to create methods in your own components without worrying about name clashes.
This is the standard call chain for the page component (the initial component of a request).
handle -> render -> wrap -> main
In many cases only
main will actually do anything.
This is the top-most method called on the page component. Its job is to decide how to handle the request, e.g.
throw an error (e.g. permission denied)
defer to another component via
redirect to another URL (if in a web environment)
render the page
It should not output any content itself. By default, it simply calls render.
This method is invoked from render on the page component. By convention,
wrapis an augmented method, with each superclass calling the next subclass. This is useful for cascading templates in which the top-most superclass generates the surrounding content.
<%augment wrap> <h3>Subtitle section</h3> <div class="main"> <% inner() %> </div> </%augment>
inner()to go to the next subclass, and then main at the bottom subclass.
To override a component's parent wrapper, a component can define its own
<%method wrap> <h3>Parent wrapper will be ignored</h3> <% inner() %> </%method>
To do no wrapping at all, a component could do:
<%method render> % $.main(); </%method>
or for convenience, the equivalent:
This method is invoked when a non-page component is called, and from the default wrap method as well. It consists of the code and output in the main part of the component that is not inside a
This method is called when the request path has a path_info portion, to determine whether the path_info is allowed. Default is false. See Mason::Manual::RequestDispatch/Partial Paths.
Returns the hashref of arguments passed to this component's constructor, e.g. the arguments passed in a component call.
Returns the Mason::Component::ClassMeta object associated with this component class, containing information such as the component's path and source file.
my $path = $self->cmeta->path;
Returns the current request. This is also available via
$minside Mason components.
Jonathan Swartz <email@example.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.
1 POD Error
The following errors were encountered while parsing the POD:
- Around line 202:
alternative text 'Mason::Manual::RequestDispatch/Partial Paths' contains non-escaped | or /