1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
|
.\" -*- 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 "parent 3perl"
.TH parent 3perl 2024-05-30 "perl v5.38.2" "Perl Programmers Reference Guide"
.\" 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
parent \- Establish an ISA relationship with base classes at compile time
.SH SYNOPSIS
.IX Header "SYNOPSIS"
.Vb 2
\& package Baz;
\& use parent qw(Foo Bar);
.Ve
.SH DESCRIPTION
.IX Header "DESCRIPTION"
Allows you to both load one or more modules, while setting up inheritance from
those modules at the same time. Mostly similar in effect to
.PP
.Vb 6
\& package Baz;
\& BEGIN {
\& require Foo;
\& require Bar;
\& push @ISA, qw(Foo Bar);
\& }
.Ve
.PP
By default, every base class needs to live in a file of its own.
If you want to have a subclass and its parent class in the same file, you
can tell \f(CW\*(C`parent\*(C'\fR not to load any modules by using the \f(CW\*(C`\-norequire\*(C'\fR switch:
.PP
.Vb 2
\& package Foo;
\& sub exclaim { "I CAN HAS PERL" }
\&
\& package DoesNotLoadFooBar;
\& use parent \-norequire, \*(AqFoo\*(Aq, \*(AqBar\*(Aq;
\& # will not go looking for Foo.pm or Bar.pm
.Ve
.PP
This is equivalent to the following code:
.PP
.Vb 2
\& package Foo;
\& sub exclaim { "I CAN HAS PERL" }
\&
\& package DoesNotLoadFooBar;
\& push @DoesNotLoadFooBar::ISA, \*(AqFoo\*(Aq, \*(AqBar\*(Aq;
.Ve
.PP
This is also helpful for the case where a package lives within
a differently named file:
.PP
.Vb 3
\& package MyHash;
\& use Tie::Hash;
\& use parent \-norequire, \*(AqTie::StdHash\*(Aq;
.Ve
.PP
This is equivalent to the following code:
.PP
.Vb 3
\& package MyHash;
\& require Tie::Hash;
\& push @ISA, \*(AqTie::StdHash\*(Aq;
.Ve
.PP
If you want to load a subclass from a file that \f(CW\*(C`require\*(C'\fR would
not consider an eligible filename (that is, it does not end in
either \f(CW\*(C`.pm\*(C'\fR or \f(CW\*(C`.pmc\*(C'\fR), use the following code:
.PP
.Vb 3
\& package MySecondPlugin;
\& require \*(Aq./plugins/custom.plugin\*(Aq; # contains Plugin::Custom
\& use parent \-norequire, \*(AqPlugin::Custom\*(Aq;
.Ve
.SH HISTORY
.IX Header "HISTORY"
This module was forked from base to remove the cruft
that had accumulated in it.
.SH CAVEATS
.IX Header "CAVEATS"
.SH "SEE ALSO"
.IX Header "SEE ALSO"
.IP base 4
.IX Item "base"
.PD 0
.IP parent::versioned 4
.IX Item "parent::versioned"
.PD
A fork of parent that provides version checking in parent class modules.
.SH "AUTHORS AND CONTRIBUTORS"
.IX Header "AUTHORS AND CONTRIBUTORS"
Rafaël Garcia-Suarez, Bart Lateur, Max Maischein, Anno Siegel, Michael Schwern
.SH MAINTAINER
.IX Header "MAINTAINER"
Max Maischein \f(CW\*(C` corion@cpan.org \*(C'\fR
.PP
Copyright (c) 2007\-2017 Max Maischein \f(CW\*(C`<corion@cpan.org>\*(C'\fR
Based on the idea of \f(CW\*(C`base.pm\*(C'\fR, which was introduced with Perl 5.004_04.
.SH LICENSE
.IX Header "LICENSE"
This module is released under the same terms as Perl itself.
|
