.\" -*- mode: troff; coding: utf-8 -*-
.\" Automatically generated by Pod::Man 5.01 (Pod::Simple 3.43)
.\"
.\" 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
..
.\" \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>.
.ie n \{\
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    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 "PPI::Statement::Scheduled 3pm"
.TH PPI::Statement::Scheduled 3pm 2024-03-16 "perl v5.38.2" "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
PPI::Statement::Scheduled \- A scheduled code block
.SH INHERITANCE
.IX Header "INHERITANCE"
.Vb 5
\&  PPI::Statement::Scheduled
\&  isa PPI::Statement::Sub
\&      isa PPI::Statement
\&          isa PPI::Node
\&              isa PPI::Element
.Ve
.SH DESCRIPTION
.IX Header "DESCRIPTION"
A scheduled code block is one that is intended to be run at a specific
time during the loading process.
.PP
There are five types of scheduled block:
.PP
.Vb 4
\&  BEGIN {
\&        # Executes as soon as this block is fully defined
\&        ...
\&  }
\&
\&  CHECK {
\&        # Executes after overall compile\-phase in reverse order
\&        ...
\&  }
\&
\&  UNITCHECK {
\&        # Executes after compile\-phase of individual module in reverse order
\&        ...
\&  }
\&
\&  INIT {
\&        # Executes just before run\-time
\&        ...
\&  }
\&
\&  END {
\&        # Executes as late as possible in reverse order
\&        ...
\&  }
.Ve
.PP
Technically these scheduled blocks are actually subroutines, and in fact
may have 'sub' in front of them.
.SH METHODS
.IX Header "METHODS"
.SS type
.IX Subsection "type"
The \f(CW\*(C`type\*(C'\fR method returns the type of scheduled block, which should always be
one of \f(CW\*(AqBEGIN\*(Aq\fR, \f(CW\*(AqCHECK\*(Aq\fR, \f(CW\*(AqUNITCHECK\*(Aq\fR, \f(CW\*(AqINIT\*(Aq\fR or \f(CW\*(AqEND\*(Aq\fR.
.SH "TO DO"
.IX Header "TO DO"
\&\- Write unit tests for this package
.SH SUPPORT
.IX Header "SUPPORT"
See the support section in the main module.
.SH AUTHOR
.IX Header "AUTHOR"
Adam Kennedy <adamk@cpan.org>
.SH COPYRIGHT
.IX Header "COPYRIGHT"
Copyright 2001 \- 2011 Adam Kennedy.
.PP
This program is free software; you can redistribute
it and/or modify it under the same terms as Perl itself.
.PP
The full text of the license can be found in the
LICENSE file included with this module.