3
Apache::Module - Perl API for creating and working with Apache modules
10
use Apache::Module ();
21
See L<Apache Server Configuration Customization in
22
Perl|docs::2.0::user::config::custom>.
27
C<Apache::Module> provides the following functions and/or methods:
32
=head2 C<find_linked_module>
34
META: Autogenerated - needs to be reviewed/completed
36
Find a module based on the name of the module
38
$ret = find_linked_module($name);
42
=item obj: C<$name> (string)
44
the name of the module
46
=item ret: C<$ret> (C<L<Apache::Module|docs::2.0::api::Apache::Module>>)
48
the module structure if found, NULL otherwise
56
=head2 C<find_module_name>
58
META: Autogenerated - needs to be reviewed/completed
60
Find the name of the specified module
62
$ret = $module->find_module_name();
66
=item obj: C<$module> (C<L<Apache::Module|docs::2.0::api::Apache::Module>>)
68
The module to get the name for
70
=item ret: C<$ret> (string)
72
the name of the module
80
=head2 C<remove_loaded_module>
82
META: Autogenerated - needs to be reviewed/completed
84
Remove a module from the chained modules list and the list of loaded
87
$module->remove_loaded_module();
91
=item obj: C<$module> (C<L<Apache::Module|docs::2.0::api::Apache::Module>>)
95
=item ret: no return value
103
=head2 C<remove_module>
105
META: Autogenerated - needs to be reviewed/completed
107
Remove a module from the server. There are some caveats:
108
when the module is removed, its slot is lost so all the current
109
per-dir and per-server configurations are invalid. So we should
110
only ever call this function when you are invalidating almost
111
all our current data. I.e. when doing a restart.
113
$module->remove_module();
117
=item obj: C<$module> (C<L<Apache::Module|docs::2.0::api::Apache::Module>>)
119
the module structure of the module to remove
121
=item ret: no return value
131
META: Autogenerated - needs to be reviewed/completed
135
$ret = Apache::Module->top_module();
139
=item obj: C<Apache::Module> (class name)
141
=item ret: C<$ret> (C<L<Apache::Module|docs::2.0::api::Apache::Module>>)
151
META: Autogenerated - needs to be reviewed/completed
153
API version, *not* module version; check that module is
154
compatible with this version of the server.
156
$version = $module->version();
160
=item obj: C<$module> (C<L<Apache::Module|docs::2.0::api::Apache::Module>>)
162
=item ret: C<$version> (integer)
170
=head2 C<minor_version>
172
META: Autogenerated - needs to be reviewed/completed
174
API minor version. Provides API feature milestones. Not checked
177
$minor_version = $module->minor_version();
181
=item obj: C<$module> (C<L<Apache::Module|docs::2.0::api::Apache::Module>>)
183
=item ret: C<$minor_version> (integer)
191
=head2 C<module_index>
193
META: Autogenerated - needs to be reviewed/completed
195
Index to this modules structures in config vectors.
197
$index = $module->module_index();
201
=item obj: C<$module> (C<L<Apache::Module|docs::2.0::api::Apache::Module>>)
203
=item ret: C<$index> (integer)
213
META: Autogenerated - needs to be reviewed/completed
215
The name of the module's C file
217
$name = $module->name();
221
=item obj: C<$module> (C<L<Apache::Module|docs::2.0::api::Apache::Module>>)
223
=item ret: C<$name> (string)
231
=head2 C<dynamic_load_handle>
233
META: Autogenerated - needs to be reviewed/completed
235
The handle for the DSO. Internal use only
237
$dl_handle = $module->dynamic_load_handle();
241
=item obj: C<$module> (C<L<Apache::Module|docs::2.0::api::Apache::Module>>)
243
=item ret: C<$dl_handle> (SCALAR)
253
META: Autogenerated - needs to be reviewed/completed
255
A pointer to the next module in the list
257
$next_module = $module->next();
261
=item obj: C<$module> (C<L<Apache::Module|docs::2.0::api::Apache::Module>>)
263
=item ret: C<$next_module> (C<L<Apache::Module|docs::2.0::api::Apache::Module>>)
273
META: Autogenerated - needs to be reviewed/completed
275
A command_rec table that describes all of the directives this module
278
$cmd_rec = $module->cmds();
282
=item obj: C<$module> (C<L<Apache::Module|docs::2.0::api::Apache::Module>>)
284
=item ret: C<$cmd_rec> (C<L<Apache::Command|docs::2.0::api::Apache::Command>>)
293
L<mod_perl 2.0 documentation|docs::2.0::index>.
300
mod_perl 2.0 and its core modules are copyrighted under
301
The Apache Software License, Version 1.1.
308
L<The mod_perl development team and numerous
309
contributors|about::contributors::people>.
added
removed
docs/api/Apache/Module.pod
