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

HTML::Mason::Compiler::ToObject(3pm)			User Contributed Perl Documentation		      HTML::Mason::Compiler::ToObject(3pm)

NAME

       HTML::Mason::Compiler::ToObject - A Compiler subclass that generates Mason object code

SYNOPSIS

	 my $compiler = HTML::Mason::Compiler::ToObject->new;

	 my $object_code =
	     $compiler->compile( comp_source => $source,
				 name	     => $comp_name,
				 comp_path   => $comp_path,
			       );

DESCRIPTION

       This Compiler subclass generates Mason object code (Perl code).	It is the default Compiler class used by Mason.

PARAMETERS TO THE new() CONSTRUCTOR
       All of these parameters are optional.

       comp_class
	   The class into which component objects are blessed.	This defaults to HTML::Mason::Component.

       subcomp_class
	   The class into which subcomponent objects are blessed.  This defaults to HTML::Mason::Component::Subcomponent.

       in_package
	   This is the package in which a component's code is executed.  For historical reasons, this defaults to "HTML::Mason::Commands".

       preamble
	   Text given for this parameter is placed at the beginning of each component, but after the execution of any "<%once>" block. See also
	   postamble. The request will be available as $m in preamble code.

       postamble
	   Text given for this parameter is placed at the end of each component. See also preamble.  The request will be available as $m in
	   postamble code.

       use_strict
	   True or false, default is true. Indicates whether or not a given component should "use strict".

       named_component_subs
	   When compiling a component, use uniquely named subroutines for the a component's body, subcomponents, and methods. Doing this allows
	   you to effectively profile Mason components. Without this, all components simply show up as __ANON__ or something similar in the
	   profiler.

       define_args_hash
	   One of "always", "auto", or "never".  This determines whether or not an %ARGS hash is created in components.  If it is set to "always",
	   one is always defined.  If set to "never", it is never defined.

	   The default, "auto", will cause the hash to be defined only if some part of the component contains the string "ARGS".  This is somewhat
	   crude, and may result in some false positives, but this is preferable to false negatives.

	   Not defining the args hash means that we can avoid copying component arguments, which can save memory and slightly improve execution
	   speed.

ACCESSOR METHODS

       All of the above properties have read-only accessor methods of the same name. You cannot change any property of a compiler after it has
       been created (but you can create multiple compilers with different properties).

METHODS

       This class is primarily meant to be used by the Interpreter object, and as such has a very limited public API.

       compile(...)
	   This method will take component source and return the compiled object code for that source. See "compile(...)" in HTML::Mason::Compiler
	   for details on this method.

	   This subclass also accepts a "comp_class" parameter, allowing you to override the class into which the component is compiled.

perl v5.14.2							    2012-02-04				      HTML::Mason::Compiler::ToObject(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::compiler::toobject(3pm) [debian man page]

Check Out this Related Man Page