Used to specify the default template that should be processed by the environment service. It can be specified as anything that the Template::TT3::Templates template() method will accept, e.g. a template name, text references, subroutine reference, etc.

template is the default option for the service. Thus the following:

my $environment = Template::TT3::Services->service(
    environment => 'site/environment.tt3',
);

is syntactic sugar for:

my $environment = Template::TT3::Services->service(
    environment => {
        template => 'site/environment.tt3',
    },
);

This can be used to change the name of the service component. The default name is environment. If a environment is specified in the environment passed to the pipeline service function then it will be used in preference to the default template .

$pipeline->(
    context     => $context,
    input       => 'example.tt3',
    environment => 'my/env.tt3',        # over-ride default template
);

This is the main service method. It is called automatically when the service is bound in a pipeline that is executed. A copy of the environment is passed as the first argument (a reference to a hash array). A reference to a subroutine representing the rest of the pipeline is passed as the second argument.

The method looks in the environment for an item named environment, or whatever alternate name the service has been given. It processes the template, passing a reference to the environment hash array as the env variable. The template may alter the environment to affect subsequent services in the template processing pipeline.

It discards any output generated by the template and then executes the $pipeline function to render the rest of the service pipeline. It returns the output generated from the $pipeline function.

If no environment template is specified, or if it is set to any false value (e.g. 0 or the empty string '') then it goes straight on to call the $pipeline function and returns its result.