HTML::...:Params(3pm)

📦
version 1.60 · 9 versions
, in debian trixie, ubuntu noble, ubuntu resolute

okay bestie, buckle UP 💖 this is HTML::Mason::Params(3pm), straight out of the User Contributed Perl Documentation, and it's literally the master list of every Mason configuration parameter that actual end users are supposed to touch. no cap. 🎀

✨ NAME ✨

HTML::Mason::Params — Mason configuration parameters 🦋

🌸 DESCRIPTION 🌸

This doc lists every single Mason configuration parameter that's meant to be used by end users. that's the whole vibe. 💅

🧚 PERL AND APACHE NAMES 🧚

so every parameter lowkey has two names: a Perl version and an Apache version. the Perl one is all lowercase_with_underscores, and the Apache one is StudlyCaps with a Mason prefix. the conversion between them is otherwise very predictable, bestie. for example:

  • autohandler_name <--> MasonAutohandlerName
  • comp_root <--> MasonCompRoot
  • data_cache_defaults <--> MasonDataCacheDefaults

🌈 Where Apache Names Are Used

the Apache parameter names get used in the Apache configuration file, in an httpd-based configuration. that's their whole moment. ✨

💜 Where Perl Names Are Used

the Perl parameter names get used from Perl code — aka anywhere that is not the Apache configuration file. for example:

  • in a custom wrapper-based configuration, you can pass most of these parameters to the ApacheHandler constructor.
  • in a standalone Mason script, you can pass most of these parameters to the Interp constructor.
  • when launching a subrequest, you can pass any of the HTML::Mason::Request parameters to make_subrequest.

👑 PARAMETERS 👑

🍓 allow_globals

  • Perl name: allow_globals
  • Apache name: MasonAllowGlobals
  • Type in httpd.conf: list
  • Default: []
  • Belongs to: HTML::Mason::Compiler

a list of variable names, complete with prefix ($@%), that you intend to use as globals in your components. normally global variables are forbidden by strict, but any variable mentioned in this list gets a reprieve via a use vars statement. like:

allow_globals => [qw($DBH %session)]

and in a mod_perl environment, $r (the request object) is automatically added to this list. slay. 💅

🌸 apache_status_title

  • Perl name: apache_status_title
  • Apache name: MasonApacheStatusTitle
  • Type in httpd.conf: string
  • Default: HTML::Mason status
  • Belongs to: HTML::Mason::ApacheHandler

the title you want this ApacheHandler to appear as under Apache::Status. default is HTML::Mason status. this is useful if you create more than one ApacheHandler object and want them all visible via Apache::Status. multiple icons? we love to see it. 👑

🦋 args_method

  • Perl name: args_method
  • Apache name: MasonArgsMethod
  • Type in httpd.conf: string
  • Default: mod_perl
  • Belongs to: HTML::Mason::ApacheHandler

the method used for unpacking GET and POST arguments. the valid options are 'CGI' and 'mod_perl'; these indicate that a CGI.pm or Apache::Request object (respectively) will be created for the purposes of argument handling.

'mod_perl' is the default under mod_perl-1, and it requires that you have installed the Apache::Request package. under mod_perl-2, the default is 'CGI' because Apache2::Request is still in development. 😭

if args_method is 'mod_perl', the $r global gets upgraded to an Apache::Request object. this object inherits all Apache methods and adds a few of its own, dealing with parameters and file uploads. see Apache::Request for more info.

if the args_method is 'CGI', the Mason request object ($m) will have a method called cgi_object available. this method returns the CGI object used for argument processing.

while Mason will load Apache::Request or CGI as needed at runtime, it is recommended that you preload the relevant module either in your httpd.conf or handler.pl file, because this will save some memory. do it for the savings, bestie. 🫶

✨ auto_send_headers

  • Perl name: auto_send_headers
  • Apache name: MasonAutoSendHeaders
  • Type in httpd.conf: boolean
  • Default: 1
  • Belongs to: HTML::Mason::Request::ApacheHandler

true or false, default is true. indicates whether Mason should automatically send HTTP headers before sending content back to the client. if you set it to false, you should call $r->send_http_header manually. your problem now. 🙈

see the sending HTTP headers section of the developer's manual for more details about the automatic header feature.

NOTE: this parameter has no effect under mod_perl-2, since calling $r->send_http_header is no longer needed. so if you're on mod_perl-2, this one's just vibing.

🎀 autoflush

  • Perl name: autoflush
  • Apache name: MasonAutoflush
  • Type in httpd.conf: boolean
  • Default: 0
  • Belongs to: HTML::Mason::Request

true or false, default is false. indicates whether to flush the output buffer ($m->flush_buffer) after every string is output. turn on autoflush if you need to send partial output to the client — for example in a progress meter. main character progress bar energy. 📊

as of Mason 1.3, autoflush will only work if enable_autoflush has been set. components can be compiled more efficiently if they don't have to check for autoflush. before using autoflush you might consider whether a few manual $m->flush_buffer calls would work nearly as well. just saying. 👀

🌈 autohandler_name

  • Perl name: autohandler_name
  • Apache name: MasonAutohandlerName
  • Type in httpd.conf: string
  • Default: autohandler
  • Belongs to: HTML::Mason::Interp

the file name used for autohandlers. default is autohandler. if this is set to an empty string ("") then autohandlers are turned off entirely. gone. ghosted. 💀

🍓 buffer_preallocate_size

  • Perl name: buffer_preallocate_size
  • Apache name: MasonBufferPreallocateSize
  • Type in httpd.conf: string
  • Default: 0
  • Belongs to: HTML::Mason::Interp

the number of bytes to preallocate in the output buffer for each request. defaults to 0. setting this to, say, your maximum page size (or close to it) can reduce the number of reallocations Perl performs as components add to the output buffer. pre-planning? we love a girl who pre-plans. 💅

💜 code_cache_max_size

  • Perl name: code_cache_max_size
  • Apache name: MasonCodeCacheMaxSize
  • Type in httpd.conf: string
  • Default: unlimited
  • Belongs to: HTML::Mason::Interp

specifies the maximum number of components that should be held in the in-memory code cache. the default is 'unlimited', meaning no components will ever be discarded — and Mason can perform certain optimizations in this mode. setting this to zero disables the code cache entirely. see the code cache section of the administrator's manual for further details. ✨

🦋 comp_class

  • Perl name: comp_class
  • Apache name: MasonCompClass
  • Type in httpd.conf: string
  • Default: HTML::Mason::Component
  • Belongs to: HTML::Mason::Compiler::ToObject

the class into which component objects are blessed. this defaults to HTML::Mason::Component. bless up. 🙏

👑 comp_root

  • Perl name: comp_root
  • Apache name: MasonCompRoot
  • Type in httpd.conf: list
  • Default: Varies
  • Belongs to: HTML::Mason::Interp

the component root marks the top of your component hierarchy and defines how component paths are translated into real file paths. for example, if your component root is /usr/local/httpd/docs, a component path of /products/index.html translates to the file /usr/local/httpd/docs/products/index.html. it's giving map. 🗺️

under Apache and CGI, comp_root defaults to the server's document root. in standalone mode, comp_root defaults to the current working directory.

this parameter may be either a scalar or an array reference. if it is a scalar, it should be a filesystem path indicating the component root. if it is an array reference, it should be of the following form:

 [ [ foo => '/usr/local/foo' ],
   [ bar => '/usr/local/bar' ] ]

this is an array of two-element array references, not a hash. the keys for each path must be unique and their values must be filesystem paths. these paths will be searched in the provided order whenever a component path is resolved. for example, given the above component roots and a component path of /products/index.html, Mason would search first for /usr/local/foo/products/index.html, then for /usr/local/bar/products/index.html.

the keys are used in several ways. they help to distinguish component caches and object files between different component roots, and they appear in the title() of a component.

when you specify a single path for a component root, this is actually translated into

  [ [ MAIN => path ] ]

if you have turned on dynamic_comp_root, you may modify the component root(s) of an interpreter between requests by calling $interp->comp_root with a value. however, the path associated with any given key may not change between requests. for example, if the initial component root is

 [ [ foo => '/usr/local/foo' ],
   [ bar => '/usr/local/bar' ], ]

then it may not be changed to

 [ [ foo => '/usr/local/bar' ],
   [ bar => '/usr/local/baz' ],

but it may be changed to

 [ [ foo   => '/usr/local/foo' ],
   [ blarg => '/usr/local/blarg' ] ]

in other words, you may add or remove key/path pairs but not modify an already-used key/path pair. the reason for this restriction is that the interpreter maintains a component cache per key that would become invalid if the associated paths were to change. so like, don't do that. 🚫

🌸 compiler_class

  • Perl name: compiler_class
  • Apache name: MasonCompilerClass
  • Type in httpd.conf: string
  • Default: HTML::Mason::Compiler::ToObject
  • Belongs to: HTML::Mason::Interp

the class to use when creating a compiler. defaults to HTML::Mason::Compiler::ToObject. easy.

💖 component_error_handler

  • Perl name: component_error_handler
  • Apache name: MasonComponentErrorHandler
  • Type in httpd.conf: code
  • Default:
sub { package HTML::Mason::Exceptions; use warnings; use strict 'refs'; my($err) = @_; return unless $err; if (UNIVERSAL::can($err, 'rethrow')) { $err->rethrow; } elsif (ref $err) { die $err; } 'HTML::Mason::Exception'->throw('error', $err); }
  • Belongs to: HTML::Mason::Request

a code reference used to handle errors thrown during component compilation or runtime. by default, this is a subroutine that turns non-exception object errors in components into exceptions. if this parameter is set to a false value, these errors are simply rethrown as-is. no filter, no drama. 😌

okay that's the first chunk bestie, more is coming so don't go anywhere 💜

okay so turning exceptions into objects is expensive, bestie — every single error has to generate a whole stack trace 😭. So if your code throws plain strings or unblessed references as exceptions, you might lowkey want to switch this off for a performance boost. ✨

🦋 data_cache_api

  • Perl name: data_cache_api
  • Apache name: MasonDataCacheApi
  • Type in httpd.conf: string
  • Default: 1.1
  • Belongs to: HTML::Mason::Request

This is the API that $m->cache uses, and you've got three choices, no cap:

  • '1.1' — the default, and it means a Cache::Cache based API. 💅
  • 'chi' — means a CHI based API. 🦋
  • '1.0' — the custom cache API from Mason 1.0x and earlier. This compatibility layer is just a lil convenience for people upgrading from older Mason versions, but heads up: it will not be supported indefinitely. ⚠️

🌸 data_cache_defaults

  • Perl name: data_cache_defaults
  • Apache name: MasonDataCacheDefaults
  • Type in httpd.conf: hash_list
  • Default: None
  • Belongs to: HTML::Mason::Request

A hash reference of default options to hand to the $m->cache command. So like, if you wanna use Cache::Cache's MemoryCache implementation by default:

data_cache_defaults => {cache_class => 'MemoryCache'}

And if you wanna use the CHI FastMmap driver by default:

data_cache_api      => 'CHI',
data_cache_defaults => {driver => 'FastMmap'},

important: these settings get overridden by whatever options you pass to a particular $m->cache call. Periodt. 💅

🎀 data_dir

  • Perl name: data_dir
  • Apache name: MasonDataDir
  • Type in httpd.conf: string
  • Default: None
  • Belongs to: HTML::Mason::Interp

The data directory is a writable directory where Mason stashes stuff for various features and optimizations — component object files, data cache files, that whole vibe. Mason will create the directory on startup if it needs to, and set its permissions according to the web server User/Group. 🫶

Under Apache, data_dir defaults to a directory called mason under the Apache server root. You will need to change this on certain systems that assign a high-level server root like /usr! 💀

In non-Apache environments, data_dir has no default. If you leave it unspecified, Mason won't use object files, and the default data cache class becomes MemoryCache instead of FileCache. ✨

🌈 decline_dirs

  • Perl name: decline_dirs
  • Apache name: MasonDeclineDirs
  • Type in httpd.conf: boolean
  • Default: 1
  • Belongs to: HTML::Mason::ApacheHandler

True or false, default is true. This says whether Mason should decline directory requests and leave Apache to serve up a directory index or a FORBIDDEN error, whichever is appropriate. Wanna know more about handling directories with Mason? Go read the allowing directory requests section of the administrator's manual. 📖

🧚 default_escape_flags

  • Perl name: default_escape_flags
  • Apache name: MasonDefaultEscapeFlags
  • Type in httpd.conf: string
  • Default: []
  • Belongs to: HTML::Mason::Compiler

Escape flags that get applied to all <% %> expressions by default. The currently valid flags are:

h - escape for HTML ('<' => '&lt;', etc.)
u - escape for URL (':' => '%3A', etc.)

The developer can override the default escape flags on a per-expression basis — check the escaping expressions section of the developer's manual for that. 🌸

And if you wanna set multiple flags as the default? Then you give this as a reference to an array of flags. 💅

⭐ define_args_hash

  • Perl name: define_args_hash
  • Apache name: MasonDefineArgsHash
  • Type in httpd.conf: string
  • Default: auto
  • Belongs to: HTML::Mason::Compiler::ToObject

One of always, auto, or never. This decides whether an %ARGS hash gets created in components or not:

  • always — one is always defined. 🎀
  • never — it is never defined. 🙈
  • auto — the default. The hash only gets defined if some part of the component contains the string ARGS. This is somewhat crude and may result in some false positives, but like, that's preferable to false negatives, fr fr.

Not defining the args hash means we can avoid copying component arguments, which saves memory and slightly improves execution speed. 🔥

💜 dhandler_name

  • Perl name: dhandler_name
  • Apache name: MasonDhandlerName
  • Type in httpd.conf: string
  • Default: dhandler
  • Belongs to: HTML::Mason::Request

The file name used for dhandlers. Default is dhandler. And if you set this to an empty string (""), then dhandlers are turned off entirely. 💀

🦋 dynamic_comp_root

  • Perl name: dynamic_comp_root
  • Apache name: MasonDynamicCompRoot
  • Type in httpd.conf: boolean
  • Default: 0
  • Belongs to: HTML::Mason::Interp

True or false, defaults to false. Says whether the comp_root can be modified on this interpreter between requests. Mason can pull off a few optimizations when the component root is fixed, so only set this to true if you actually need it. 👑

✨ enable_autoflush

  • Perl name: enable_autoflush
  • Apache name: MasonEnableAutoflush
  • Type in httpd.conf: boolean
  • Default: 1
  • Belongs to: HTML::Mason::Compiler

True or false, default is true. Says whether components are compiled with support for autoflush. A component can be compiled into a more efficient form if it doesn't have to check for autoflush mode, so you should set this to 0 if you can. 💅

😭 error_format

  • Perl name: error_format
  • Apache name: MasonErrorFormat
  • Type in httpd.conf: string
  • Default: Varies
  • Belongs to: HTML::Mason::Request

Says how errors get formatted. The built-in choices are:

  • brief — just the error message, no trace information
  • text — a multi-line text format
  • line — a single-line text format, with the different pieces of info separated by tabs (useful for log files)
  • html — a fancy html format

The default format under Apache and CGI is either line or html, depending on whether the error mode is fatal or output, respectively. The default for standalone mode is text.

The formats correspond to HTML::Mason::Exception methods named as_format. You can define your own format by creating an appropriately named method — like, to define an xml format, create a method HTML::Mason::Exception::as_xml patterned after one of the built-in methods. 🌈

🔥 error_mode

  • Perl name: error_mode
  • Apache name: MasonErrorMode
  • Type in httpd.conf: string
  • Default: Varies
  • Belongs to: HTML::Mason::Request

Says how errors get returned to the caller. The choices are:

  • fatal — meaning die with the error 💀
  • output — meaning output the error just like regular output

The default under Apache and CGI is output, which causes the error to be displayed in the browser. The default for standalone mode is fatal. 👑

🎀 escape_flags

  • Perl name: escape_flags
  • Apache name: MasonEscapeFlags
  • Type in httpd.conf: hash_list
  • Default: None
  • Belongs to: HTML::Mason::Interp

A hash reference of escape flags to set for this object. Peep the section on the set_escape method for more deets. 💅

🌸 ignore_warnings_expr

  • Perl name: ignore_warnings_expr
  • Apache name: MasonIgnoreWarningsExpr
  • Type in httpd.conf: regex
  • Default: qr/Subroutine .* redefined/i
  • Belongs to: HTML::Mason::Interp

A regular expression saying which warnings to ignore when loading components. Any warning that is not ignored will stop the component from being loaded and executed. Like, for example:

ignore_warnings_expr =>
    'Global symbol.*requires explicit package'

If it's set to undef, all warnings are heeded. If it's set to ., warnings get turned off completely as a specially optimized case. ✨

By default, this is set to 'Subroutine .* redefined'. That lets you declare global subroutines inside <%once> sections and not catch an error when the component is reloaded. 🫶

💜 in_package

  • Perl name: in_package
  • Apache name: MasonInPackage
  • Type in httpd.conf: string
  • Default: HTML::Mason::Commands
  • Belongs to: HTML::Mason::Compiler::ToObject

This is the package in which a component's code gets executed. And for historical reasons, it defaults to HTML::Mason::Commands. 🎀

🦋 interp_class

  • Perl name: interp_class
  • Apache name: MasonInterpClass
  • Type in httpd.conf: string
  • Default: HTML::Mason::Interp
  • Belongs to: HTML::Mason::ApacheHandler

The class to use when creating an interpreter. Defaults to HTML::Mason::Interp. ✨

🧚 lexer_class

  • Perl name: lexer_class
  • Apache name: MasonLexerClass
  • Type in httpd.conf: string
  • Default: HTML::Mason::Lexer
  • Belongs to: HTML::Mason::Compiler

The class to use when creating a lexer. Defaults to HTML::Mason::Lexer. 💅

🔥 max_recurse

  • Perl name: max_recurse
  • Apache name: MasonMaxRecurse
  • Type in httpd.conf: string
  • Default: 32
  • Belongs to: HTML::Mason::Request

The maximum recursion depth for the component stack, the request stack, and the inheritance stack. Exceed the max and an error gets signalled. Default is 32. ⚠️

⭐ named_component_subs

  • Perl name: named_component_subs
  • Apache name: MasonNamedComponentSubs
  • Type in httpd.conf: boolean
  • Default: 0
  • Belongs to: HTML::Mason::Compiler::ToObject

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

💜 object_file_extension

  • Perl name: object_file_extension
  • Apache name: MasonObjectFileExtension
  • Type in httpd.conf: string
  • Default: .obj
  • Belongs to: HTML::Mason::Interp

So, to close out extension: it's the extension tacked onto the end of your object files, and the default is .obj. Slay, moving on 💅

🎀 out_method

  • Perl name: out_method
  • Apache name: MasonOutMethod
  • Type in httpd.conf: code
  • Default: Print to STDOUT
  • Belongs to: HTML::Mason::Request

Where does the output go, bestie? That's the whole vibe of this one. If out_method is a reference to a scalar, your output gets appended to that scalar. If out_method is a reference to a subroutine, that sub gets called with every single output string. Like, every one. 💖

So say you wanna send output to a file called mason.out:

my $fh = new IO::File ">mason.out";
...
out_method => sub { $fh->print($_[0]) }

By default, out_method prints to standard output. And under Apache, standard output is redirected to $r->print. iykyk ✨

🦋 plugins

  • Perl name: plugins
  • Apache name: MasonPlugins
  • Type in httpd.conf: list
  • Default: []
  • Belongs to: HTML::Mason::Request

An array of plugins that get called at various stages of request processing. Wanna know the stages? Please see HTML::Mason::Plugin for details, because that's where the tea is 🫖

🌸 postamble

  • Perl name: postamble
  • Apache name: MasonPostamble
  • Type in httpd.conf: string
  • Default: None
  • Belongs to: HTML::Mason::Compiler::ToObject

Whatever text you hand over here gets placed at the end of each component. See also preamble (they're a matched set, obviously 👑). The request will be available as $m in postamble code.

✨ postprocess_perl

  • Perl name: postprocess_perl
  • Apache name: MasonPostprocessPerl
  • Type in httpd.conf: code
  • Default: None
  • Belongs to: HTML::Mason::Compiler

A sub reference that gets called to postprocess the Perl portion of a compiled component, right before it's assembled into its final subroutine form. The sub is called with a single parameter: a scalar reference to the Perl portion of the component. It's expected to process the string in-place, no cap. See also preprocess and postprocess_text 💜

🧚 postprocess_text

  • Perl name: postprocess_text
  • Apache name: MasonPostprocessText
  • Type in httpd.conf: code
  • Default: None
  • Belongs to: HTML::Mason::Compiler

Same energy as above but for the text portion of a compiled component 🎀 The sub reference gets called to postprocess that text right before the whole thing is assembled into its final subroutine form. Single parameter: a scalar reference to the text portion of the component. Process it in-place, bestie. See also preprocess and postprocess_perl.

💖 preamble

  • Perl name: preamble
  • Apache name: MasonPreamble
  • Type in httpd.conf: string
  • Default: None
  • Belongs to: HTML::Mason::Compiler::ToObject

The text you give here lands at the beginning of each component — but after any <%once> block has executed, okay? That ordering matters, don't skip it. See also postamble. The request will be available as $m in preamble code ✨

🌈 preloads

  • Perl name: preloads
  • Apache name: MasonPreloads
  • Type in httpd.conf: list
  • Default: None
  • Belongs to: HTML::Mason::Interp

A list of component paths — optionally with glob wildcards — that get loaded when the interpreter initializes. Like:

preloads => ['/foo/index.html','/bar/*.pl']

Default is the empty list. For maximum performance, this should only be used for components that are frequently viewed and rarely updated. Want more? See the preloading components section of the administrator's manual for further details 👑

⚠️ Heads up, this part is important: as mentioned in the developer's manual, a component's <%once> section is executed when it is loaded. For preloaded components, that means this section executes before a Mason or Apache request exist — so preloading a component that uses $m or $r inside a <%once> section will fail. Not "might", not "could". Will. 😭

🍓 preprocess

  • Perl name: preprocess
  • Apache name: MasonPreprocess
  • Type in httpd.conf: code
  • Default: None
  • Belongs to: HTML::Mason::Compiler

A sub reference that gets called to preprocess each component before the compiler does its magic ✨ The sub is called with a single parameter: a scalar reference to the script. It's expected to process the script in-place.

This is one way to extend the HTML::Mason syntax with new tags, etc. — though a much more flexible way is to subclass the Lexer or Compiler class. See also postprocess_text and postprocess_perl 💅

👑 request_class

  • Perl name: request_class
  • Apache name: MasonRequestClass
  • Type in httpd.conf: string
  • Default: HTML::Mason::Request
  • Belongs to: HTML::Mason::Interp

The class to use when creating requests. Defaults to HTML::Mason::Request. That's it, that's the whole thing 💖

🦋 resolver_class

  • Perl name: resolver_class
  • Apache name: MasonResolverClass
  • Type in httpd.conf: string
  • Default: HTML::Mason::Resolver::File
  • Belongs to: HTML::Mason::Interp

The class to use when creating a resolver. Defaults to HTML::Mason::Resolver::File 🌸

⭐ static_source

  • Perl name: static_source
  • Apache name: MasonStaticSource
  • Type in httpd.conf: boolean
  • Default: 0
  • Belongs to: HTML::Mason::Interp

True or false, default is false. Here's the teaaa ☕

When it's false, Mason checks the timestamp of the component source file every single time the component is used, to see if it changed. That's what gives you the instant feedback on source changes that everyone expects for development. But — and this is the tradeoff — it entails a file stat for each component executed.

When it's true, Mason assumes the component source tree is unchanging: it will not check component source files to determine if the memory cache or object file has expired. That can save many file stats per request 🔥 But in order to get Mason to recognize a component source change, you must flush the memory cache and remove object files. See static_source_touch_file for one easy way to arrange this.

We recommend turning this mode on in your production sites if possible, if performance is of any concern. Periodt 💅

🎀 static_source_touch_file

  • Perl name: static_source_touch_file
  • Apache name: MasonStaticSourceTouchFile
  • Type in httpd.conf: string
  • Default: None
  • Belongs to: HTML::Mason::Interp

Specifies a filename that Mason will check once at the beginning of every request. When the file timestamp changes, Mason will:

  1. clear its in-memory component cache, and
  2. remove object files if they haven't already been deleted by another process.

This gives you a convenient way to implement static_source mode. All you need to do is make sure that a single file gets touched whenever components change. And from Mason's side? Checking one file at the beginning of a request is much cheaper than checking every component file when static_source=0. Ate 🍽️

💜 subcomp_class

  • Perl name: subcomp_class
  • Apache name: MasonSubcompClass
  • Type in httpd.conf: string
  • Default: HTML::Mason::Component::Subcomponent
  • Belongs to: HTML::Mason::Compiler::ToObject

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

🔥 use_object_files

  • Perl name: use_object_files
  • Apache name: MasonUseObjectFiles
  • Type in httpd.conf: boolean
  • Default: 1
  • Belongs to: HTML::Mason::Interp

True or false, default is true. Specifies whether Mason creates object files to save the results of component parsing. You may want to turn off object files for disk space reasons, but otherwise this should be left alone. Like, literally leave it alone bestie 🙈

🌸 use_source_line_numbers

  • Perl name: use_source_line_numbers
  • Apache name: MasonUseSourceLineNumbers
  • Type in httpd.conf: boolean
  • Default: 1
  • Belongs to: HTML::Mason::Compiler

True or false, default is true. This one decides whether the component line numbers showing up in error messages, stack traces, etc. are in terms of the source file instead of the object file. Mason pulls this off by inserting #line directives into compiled components.

And the vibe check: source line numbers are more immediately helpful, but object file line numbers may be more appropriate for in-depth debugging sessions. Choose your fighter 💅

🫶 use_strict

  • Perl name: use_strict
  • Apache name: MasonUseStrict
  • Type in httpd.conf: boolean
  • Default: 1
  • Belongs to: HTML::Mason::Compiler::ToObject

True or false, default is true. Indicates whether or not a given component should use strict. Safety first, babe 🔒

🍓 use_warnings

  • Perl name: use_warnings
  • Apache name: MasonUseWarnings
  • Type in httpd.conf: boolean
  • Default: 1
  • Belongs to: HTML::Mason::Compiler::ToObject

True or false, default is false. Indicates whether or not a given component should use warnings.

👀 and yes, bestie, the bullet above literally says 1 while this sentence says false — that's exactly what the page says, I'm just the messenger, not me starting drama 💀

and that's a wrap on the params, gorgeous. every last one of them, accounted for, no cap ✨

This page was served up by perl v5.38.2 on 2024-03-05, straight from the HTML::...:Params(3pm) manual — go forth and configure your Mason like the main character you are 👑💖🌈

📦 where this page comes from