Na}{

Path: ~//usr/local/share/man/man3/

File Content: `Template::Base.3pm`

.\" Automatically generated by Pod::Man 4.14 (Pod::Simple 3.42)
.\"
.\" Standard preamble:
.\" ========================================================================
.de Sp \" Vertical space (when we can't use .PP)
.if t .sp .5v
.if n .sp
..
.de Vb \" Begin verbatim text
.ft CW
.nf
.ne \\$1
..
.de Ve \" End verbatim text
.ft R
.fi
..
.\" Set up some character translations and predefined strings.  \*(-- will
.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
.\" double quote, and \*(R" will give a right double quote.  \*(C+ will
.\" give a nicer C++.  Capital omega is used to do unbreakable dashes and
.\" therefore won't be available.  \*(C` and \*(C' expand to `' in nroff,
.\" nothing in troff, for use with C<>.
.tr \(*W-
.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
.ie n \{\
.    ds -- \(*W-
.    ds PI pi
.    if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
.    if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\"  diablo 12 pitch
.    ds L" ""
.    ds R" ""
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    ds -- \|\(em\|
.    ds PI \(*p
.    ds L" ``
.    ds R" ''
.    ds C`
.    ds C'
'br\}
.\"
.\" Escape single quotes in literal strings from groff's Unicode transform.
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\"
.\" If the F register is >0, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
.\" entries marked with X<> in POD.  Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.\"
.\" Avoid warning from groff about undefined register 'F'.
.de IX
..
.nr rF 0
.if \n(.g .if rF .nr rF 1
.if (\n(rF:(\n(.g==0)) \{\
.    if \nF \{\
.        de IX
.        tm Index:\\$1\t\\n%\t"\\$2"
..
.        if !\nF==2 \{\
.            nr % 0
.            nr F 2
.        \}
.    \}
.\}
.rr rF
.\" ========================================================================
.\"
.IX Title "Template::Base 3"
.TH Template::Base 3 "2024-06-21" "perl v5.32.1" "User Contributed Perl Documentation"
.\" For nroff, turn off justification.  Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.if n .ad l
.nh
.SH "NAME"
Template::Base \- Base class module implementing common functionality
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
.Vb 2
\&    package My::Module;
\&    use base qw( Template::Base );
\&
\&    sub _init {
\&        my ($self, $config) = @_;
\&        $self\->{ doodah } = $config\->{ doodah }
\&            || return $self\->error("No \*(Aqdoodah\*(Aq specified");
\&        return $self;
\&    }
\&
\&    package main;
\&
\&    my $object = My::Module\->new({ doodah => \*(Aqfoobar\*(Aq })
\&        || die My::Module\->error();
.Ve
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
Base class module which implements a constructor and error reporting
functionality for various Template Toolkit modules.
.SH "PUBLIC METHODS"
.IX Header "PUBLIC METHODS"
.SS "new(\e%config)"
.IX Subsection "new(%config)"
Constructor method which accepts a reference to a hash array or a list
of \f(CW\*(C`name => value\*(C'\fR parameters which are folded into a hash.  The
\&\f(CW\*(C`_init()\*(C'\fR method is then called, passing the configuration hash and should
return true/false to indicate success or failure.  A new object reference
is returned, or undef on error.  Any error message raised can be examined
via the \fBerror()\fR class method or directly via the \f(CW$ERROR\fR package variable
in the derived class.
.PP
.Vb 2
\&    my $module = My::Module\->new({ ... })
\&        || die My::Module\->error(), "\en";
\&
\&    my $module = My::Module\->new({ ... })
\&        || die "constructor error: $My::Module::ERROR\en";
.Ve
.SS "error($msg, ...)"
.IX Subsection "error($msg, ...)"
May be called as an object method to get/set the internal \f(CW\*(C`_ERROR\*(C'\fR member
or as a class method to get/set the \f(CW$ERROR\fR variable in the derived class's
package.
.PP
.Vb 2
\&    my $module = My::Module\->new({ ... })
\&        || die My::Module\->error(), "\en";
\&
\&    $module\->do_something()
\&        || die $module\->error(), "\en";
.Ve
.PP
When called with parameters (multiple params are concatenated), this
method will set the relevant variable and return undef.  This is most
often used within object methods to report errors to the caller.
.PP
.Vb 1
\&    package My::Module;
\&
\&    sub foobar {
\&        my $self = shift;
\&
\&        # some other code...
\&
\&        return $self\->error(\*(Aqsome kind of error...\*(Aq)
\&            if $some_condition;
\&    }
.Ve
.SS "debug($msg, ...)"
.IX Subsection "debug($msg, ...)"
Generates a debugging message by concatenating all arguments
passed into a string and printing it to \f(CW\*(C`STDERR\*(C'\fR.  A prefix is
added to indicate the module of the caller.
.PP
.Vb 1
\&    package My::Module;
\&
\&    sub foobar {
\&        my $self = shift;
\&
\&        $self\->debug(\*(Aqcalled foobar()\*(Aq);
\&
\&        # some other code...
\&    }
.Ve
.PP
When the \f(CW\*(C`foobar()\*(C'\fR method is called, the following message
is sent to \f(CW\*(C`STDERR\*(C'\fR:
.PP
.Vb 1
\&    [My::Module] called foobar()
.Ve
.PP
Objects can set an internal \f(CW\*(C`DEBUG\*(C'\fR value which the \f(CW\*(C`debug()\*(C'\fR
method will examine.  If this value sets the relevant bits
to indicate \f(CW\*(C`DEBUG_CALLER\*(C'\fR then the file and line number of
the caller will be append to the message.
.PP
.Vb 1
\&    use Template::Constants qw( :debug );
\&
\&    my $module = My::Module\->new({
\&        DEBUG => DEBUG_SERVICE | DEBUG_CONTEXT | DEBUG_CALLER,
\&    });
\&
\&    $module\->foobar();
.Ve
.PP
This generates an error message such as:
.PP
.Vb 1
\&    [My::Module] called foobar() at My/Module.pm line 6
.Ve
.SS "\fBmodule_version()\fP"
.IX Subsection "module_version()"
Returns the version number for a module, as defined by the \f(CW$VERSION\fR
package variable.
.SH "AUTHOR"
.IX Header "AUTHOR"
Andy Wardley <abw@wardley.org> <http://wardley.org/>
.SH "COPYRIGHT"
.IX Header "COPYRIGHT"
Copyright (C) 1996\-2022 Andy Wardley.  All Rights Reserved.
.PP
This module is free software; you can redistribute it and/or
modify it under the same terms as Perl itself.
.SH "SEE ALSO"
.IX Header "SEE ALSO"
Template

Edit Rename Chmod Delete

FILE FOLDER INFO

Name	Size	Permission
App::Cpan.3pm	12999 bytes	0444
App::cpanminus.3pm	12815 bytes	0444
App::cpanminus::fatscript.3pm	25102 bytes	0444
AppConfig.3pm	33484 bytes	0444
AppConfig::Args.3pm	6184 bytes	0444
AppConfig::CGI.3pm	4801 bytes	0444
AppConfig::File.3pm	10804 bytes	0444
AppConfig::Getopt.3pm	5636 bytes	0444
AppConfig::State.3pm	23123 bytes	0444
AppConfig::Sys.3pm	4887 bytes	0444
CPAN.3pm	114991 bytes	0444
CPAN::API::HOWTO.3pm	3582 bytes	0444
CPAN::Admin.3pm	4390 bytes	0444
CPAN::Debug.3pm	2402 bytes	0444
CPAN::Distroprefs.3pm	6088 bytes	0444
CPAN::FirstTime.3pm	27917 bytes	0444
CPAN::HandleConfig.3pm	3319 bytes	0444
CPAN::Kwalify.3pm	3540 bytes	0444
CPAN::Meta::Requirements.3pm	12698 bytes	0444
CPAN::Meta::Requirements::Range.3pm	7205 bytes	0444
CPAN::Mirrors.3pm	8906 bytes	0444
CPAN::Nox.3pm	2849 bytes	0444
CPAN::Plugin.3pm	3559 bytes	0444
CPAN::Plugin::Specfile.3pm	3764 bytes	0444
CPAN::Queue.3pm	2406 bytes	0444
CPAN::Tarzip.3pm	2420 bytes	0444
CPAN::Version.3pm	3311 bytes	0444
Canary::Stability.3pm	4172 bytes	0444
Capture::Tiny.3pm	17794 bytes	0444
DBD::mysql.3pm	48432 bytes	0444
DBD::mysql::INSTALL.3pm	28794 bytes	0444
Data::Validate::IP.3pm	14567 bytes	0444
Devel::CheckLib.3pm	9914 bytes	0444
Digest::MD5.3pm	14782 bytes	0444
Expect.3pm	60748 bytes	0444
Exporter.3pm	22010 bytes	0444
Exporter::Heavy.3pm	2387 bytes	0444
File::Copy::Recursive.3pm	17273 bytes	0444
HTML::TagParser.3pm	12543 bytes	0444
HTTP::CookieJar.3pm	10065 bytes	0444
HTTP::CookieJar::LWP.3pm	3137 bytes	0444
HTTP::Date.3pm	7859 bytes	0444
HTTP::Tiny.3pm	28305 bytes	0444
IO::Pty.3pm	8575 bytes	0444
IO::Tty.3pm	8344 bytes	0444
IO::Tty::Constant.3pm	9710 bytes	0444
JSON.3pm	64189 bytes	0444
JSON::Syck.3pm	8090 bytes	0444
JSON::XS.3pm	89021 bytes	0444
JSON::XS::Boolean.3pm	2853 bytes	0444
JSON::backportPP.3pm	65640 bytes	0444
JSON::backportPP::Boolean.3pm	2823 bytes	0444
JSON::backportPP::Compat5005.3pm	2692 bytes	0444
JSON::backportPP::Compat5006.3pm	2688 bytes	0444
Mail::RFC822::Address.3pm	5468 bytes	0444
Mock::Config.3pm	6109 bytes	0444
NetAddr::IP.3pm	37262 bytes	0444
NetAddr::IP::InetBase.3pm	13196 bytes	0444
NetAddr::IP::Lite.3pm	25740 bytes	0444
NetAddr::IP::Util.3pm	22243 bytes	0444
NetAddr::IP::UtilPP.3pm	9497 bytes	0444
POD2::DE::local::lib.3pm	22793 bytes	0444
POD2::PT_BR::local::lib.3pm	22682 bytes	0444
Path::Tiny.3pm	56221 bytes	0444
Storable.3pm	44691 bytes	0444
Sub::Uplevel.3pm	8128 bytes	0444
Template.3pm	26992 bytes	0444
Template::App::ttree.3pm	3078 bytes	0444
Template::Base.3pm	6276 bytes	0444
Template::Config.3pm	6877 bytes	0444
Template::Constants.3pm	6003 bytes	0444
Template::Context.3pm	24713 bytes	0444
Template::Directive.3pm	3012 bytes	0444
Template::Document.3pm	10132 bytes	0444
Template::Exception.3pm	4942 bytes	0444
Template::FAQ.3pm	12779 bytes	0444
Template::Filters.3pm	7986 bytes	0444
Template::Grammar.3pm	3231 bytes	0444
Template::Iterator.3pm	9683 bytes	0444
Template::Manual.3pm	4505 bytes	0444
Template::Manual::Config.3pm	77877 bytes	0444
Template::Manual::Credits.3pm	7006 bytes	0444
Template::Manual::Directives.3pm	75189 bytes	0444
Template::Manual::Filters.3pm	19015 bytes	0444
Template::Manual::Internals.3pm	21549 bytes	0444
Template::Manual::Intro.3pm	12213 bytes	0444
Template::Manual::Plugins.3pm	11909 bytes	0444
Template::Manual::Syntax.3pm	12741 bytes	0444
Template::Manual::VMethods.3pm	27381 bytes	0444
Template::Manual::Variables.3pm	31442 bytes	0444
Template::Manual::Views.3pm	23970 bytes	0444
Template::Modules.3pm	8013 bytes	0444
Template::Namespace::Constants.3pm	4186 bytes	0444
Template::Parser.3pm	8109 bytes	0444
Template::Plugin.3pm	9041 bytes	0444
Template::Plugin::Assert.3pm	3639 bytes	0444
Template::Plugin::Datafile.3pm	4974 bytes	0444
Template::Plugin::Date.3pm	8065 bytes	0444
Template::Plugin::Directory.3pm	10116 bytes	0444
Template::Plugin::Dumper.3pm	4270 bytes	0444
Template::Plugin::File.3pm	11160 bytes	0444
Template::Plugin::Filter.3pm	10920 bytes	0444
Template::Plugin::Format.3pm	3083 bytes	0444
Template::Plugin::HTML.3pm	6000 bytes	0444
Template::Plugin::Image.3pm	10140 bytes	0444
Template::Plugin::Iterator.3pm	3248 bytes	0444
Template::Plugin::Math.3pm	4815 bytes	0444
Template::Plugin::Pod.3pm	2972 bytes	0444
Template::Plugin::Procedural.3pm	3823 bytes	0444
Template::Plugin::Scalar.3pm	3217 bytes	0444
Template::Plugin::String.3pm	15436 bytes	0444
Template::Plugin::Table.3pm	9299 bytes	0444
Template::Plugin::URL.3pm	6266 bytes	0444
Template::Plugin::View.3pm	3649 bytes	0444
Template::Plugin::Wrap.3pm	4604 bytes	0444
Template::Plugins.3pm	7903 bytes	0444
Template::Provider.3pm	12855 bytes	0444
Template::Service.3pm	12945 bytes	0444
Template::Stash.3pm	10085 bytes	0444
Template::Stash::Context.3pm	5307 bytes	0444
Template::Stash::XS.3pm	4836 bytes	0444
Template::Test.3pm	13587 bytes	0444
Template::Toolkit.3pm	7410 bytes	0444
Template::Toolkit::Simple.3pm	11876 bytes	0444
Template::Tools.3pm	3193 bytes	0444
Template::Tools::tpage.3pm	3998 bytes	0444
Template::Tools::ttree.3pm	14760 bytes	0444
Template::Tutorial.3pm	2757 bytes	0444
Template::Tutorial::Datafile.3pm	17731 bytes	0444
Template::Tutorial::Web.3pm	32267 bytes	0444
Template::VMethods.3pm	2880 bytes	0444
Template::View.3pm	10791 bytes	0444
Test::Deep.3pm	48398 bytes	0444
Test::Deep::All.3pm	3105 bytes	0444
Test::Deep::Any.3pm	3105 bytes	0444
Test::Deep::Array.3pm	3111 bytes	0444
Test::Deep::ArrayEach.3pm	3123 bytes	0444
Test::Deep::ArrayElementsOnly.3pm	3147 bytes	0444
Test::Deep::ArrayLength.3pm	3129 bytes	0444
Test::Deep::ArrayLengthOnly.3pm	3141 bytes	0444
Test::Deep::Blessed.3pm	3117 bytes	0444
Test::Deep::Boolean.3pm	3117 bytes	0444
Test::Deep::Cache.3pm	3111 bytes	0444
Test::Deep::Cache::Simple.3pm	3135 bytes	0444
Test::Deep::Class.3pm	3111 bytes	0444
Test::Deep::Cmp.3pm	3105 bytes	0444
Test::Deep::Code.3pm	3108 bytes	0444
Test::Deep::Hash.3pm	3108 bytes	0444
Test::Deep::HashEach.3pm	3120 bytes	0444
Test::Deep::HashElements.3pm	3132 bytes	0444
Test::Deep::HashKeys.3pm	3120 bytes	0444
Test::Deep::HashKeysOnly.3pm	3132 bytes	0444
Test::Deep::Ignore.3pm	3114 bytes	0444
Test::Deep::Isa.3pm	3105 bytes	0444
Test::Deep::ListMethods.3pm	3129 bytes	0444
Test::Deep::MM.3pm	3102 bytes	0444
Test::Deep::Methods.3pm	3117 bytes	0444
Test::Deep::NoTest.3pm	3495 bytes	0444
Test::Deep::None.3pm	3108 bytes	0444
Test::Deep::Number.3pm	3114 bytes	0444
Test::Deep::Obj.3pm	3105 bytes	0444
Test::Deep::Ref.3pm	3105 bytes	0444
Test::Deep::RefType.3pm	3117 bytes	0444
Test::Deep::Regexp.3pm	3114 bytes	0444
Test::Deep::RegexpMatches.3pm	3135 bytes	0444
Test::Deep::RegexpOnly.3pm	3126 bytes	0444
Test::Deep::RegexpRef.3pm	3123 bytes	0444
Test::Deep::RegexpRefOnly.3pm	3135 bytes	0444
Test::Deep::RegexpVersion.3pm	3135 bytes	0444
Test::Deep::ScalarRef.3pm	3123 bytes	0444
Test::Deep::ScalarRefOnly.3pm	3135 bytes	0444
Test::Deep::Set.3pm	3105 bytes	0444
Test::Deep::Shallow.3pm	3117 bytes	0444
Test::Deep::Stack.3pm	3111 bytes	0444
Test::Deep::String.3pm	3114 bytes	0444
Test::Exception.3pm	14539 bytes	0444
Test::Fatal.3pm	9647 bytes	0444
Test::File.3pm	22811 bytes	0444
Test::LeakTrace.3pm	8214 bytes	0444
Test::LeakTrace::JA.3pm	14732 bytes	0444
Test::LeakTrace::Script.3pm	3332 bytes	0444
Test::Needs.3pm	5638 bytes	0444
Test::Pod.3pm	7590 bytes	0444
Test::Requires.3pm	4267 bytes	0444
Test::Warnings.3pm	15859 bytes	0444
Try::Tiny.3pm	20800 bytes	0444
Types::Serialiser.3pm	11977 bytes	0444
Types::Serialiser::Error.3pm	2701 bytes	0444
URI.3pm	45262 bytes	0444
URI::Escape.3pm	8203 bytes	0444
URI::Heuristic.3pm	5197 bytes	0444
URI::QueryParam.3pm	2686 bytes	0444
URI::Split.3pm	4056 bytes	0444
URI::URL.3pm	4531 bytes	0444
URI::WithBase.3pm	4246 bytes	0444
URI::_punycode.3pm	4740 bytes	0444
URI::data.3pm	4315 bytes	0444
URI::file.3pm	10552 bytes	0444
URI::geo.3pm	8874 bytes	0444
URI::icap.3pm	3885 bytes	0444
URI::icaps.3pm	3848 bytes	0444
URI::ldap.3pm	5733 bytes	0444
YAML::LibYAML.3pm	2830 bytes	0444
YAML::Syck.3pm	10825 bytes	0444
YAML::XS.3pm	8340 bytes	0444
YAML::XS::LibYAML.3pm	2277 bytes	0444
cPanel::PublicAPI.3pm	23996 bytes	0444
cPanel::PublicAPI::Utils.3pm	4418 bytes	0444
cPanel::PublicAPI::WHM.3pm	8353 bytes	0444
cPanel::PublicAPI::WHM::API.3pm	20052 bytes	0444
cPanel::PublicAPI::WHM::CachedVersion.3pm	4977 bytes	0444
cPanel::PublicAPI::WHM::DNS.3pm	10255 bytes	0444
cPanel::PublicAPI::WHM::JSONAPI.3pm	21164 bytes	0444
cPanel::PublicAPI::WHM::Legacy.3pm	4207 bytes	0444
cPanel::PublicAPI::WHM::XMLAPI.3pm	20886 bytes	0444
common::sense.3pm	0 bytes	0444
lib::core::only.3pm	5641 bytes	0444
local::lib.3pm	31762 bytes	0444
version.3pm	14954 bytes	0444
version::Internals.3pm	28484 bytes	0444

File Content: Template::Base.3pm

File Content: `Template::Base.3pm`