Apache::Module - Perl API for creating and working with Apache modules

NAME

Apache::Module - Perl API for creating and working with Apache modules

Synopsis

  use Apache::Module ();
  # iterate over the whole module list
  for (my $modp = Apache::Module->top_module; $modp; $modp = $modp->next) {
      my $name = $modp->name;
      my $version = $modp->version;
      my $minor_version = $modp->minor_version;
      my $index = $modp->module_index;
      my $commands = $modp->cmds;
  }


  # find a specific module
  my $module = Apache::Module::find_linked_module('mod_ssl.c');

  # remove a specific module
  $module->remove_loaded_module();

  # access module configuration from a directive
  sub MyDirective {
      my ($self, $parms, $args) = @_;
      my  $srv_cfg = Apache::Module->get_config($self, $parms->server);
      [...]
  }

  # test if an Apache module is loaded
  if (Apache::Module::loaded('mod_ssl.c')) {
      [...]
  }

  # test if a Perl module is loaded
  if (Apache::Module::loaded('Apache::Status')) {
      [...]
  }

Description

Apache::Module provides the Perl API for creating and working with Apache modules

See Apache Server Configuration Customization in Perl.

API

Apache::Module provides the following functions and/or methods:

cmds

The Apache::Command|docs::2.0::api::Apache::Command object that describes all of the directives this module defines.

  $commands = $module->cmds();
obj: $module ( Apache::Module object|docs::2.0::api::Apache::Module )
ret: $commands ( Apache::Command object|docs::2.0::api::Apache::Command )
since: 1.99_12

get_config

Retrieves a module's configuration. Used by configuration directives.

  $cfg = Apache::Module->get_config($class, $server, [$dir_config]);
  $cfg = $self->get_config($server, [$dir_config]);
obj: $module ( Apache::Module object|docs::2.0::api::Apache::Module )
arg1: $class ( string )
The perl package this configuration is for

arg1: $server ( Apache::ServerRec object|docs::2.0::api::Apache::ServerRec )
The current server, typically $r->server or $parms->server

opt arg1: $dir_config ( Apache::ConfVector object|docs::2.0::api::Apache::ConfVector )
By default, the configuration returned is the server level one. To retrieve the per directory configuration, use $r->per_dir_config as a last argument.

ret: $cfg (HASH reference)
A reference to the hash holding the module configuration data.

since: 1.99_12

See also Apache Server Configuration Customization in Perl

find_linked_module

Find a module based on the name of the module

  $module = Apache::Module::find_linked_module($name);
arg1: $name ( string )
The name of the module ending in .c

ret: $module ( Apache::Module object|docs::2.0::api::Apache::Module )
The module object if found, undef otherwise

since: 1.99_12

loaded

Determines if a certain module is loaded

  $loaded = Apache::Module::loaded($module);
name: $module ( string )
The name of the module to search for.

If $module ends with .c, search all the modules, statically compiled and dynamically loaded.

If $module ends with .so, search only the dynamically loaded modules.

If $module doesn't contain a ., search the loaded Perl modules.

ret: $loaded ( boolean )
Returns true if the module is loaded, false otherwise.

since: 1.99_12

For example, to test if this server supports ssl:

  if (Apache::Module::loaded('mod_ssl.c')) {
      [...]
  }

To test is this server dynamically loaded mod_perl:

  if (Apache::Module::loaded('mod_perl.so')) {
      [...]
  }

To test if Apache::Status|docs::2.0::api::Apache::Status is loaded:

  if (Apache::Module::loaded('Apache::Status')) {
      [...]
  }

minor_version

API minor version. Provides API feature milestones. Not checked during module init

  $minor_version = $module->minor_version();
obj: $module ( Apache::Module object|docs::2.0::api::Apache::Module )
ret: $minor_version ( integer )
since: 1.99_12

module_index

Index to this modules structures in config vectors.

  $index = $module->module_index();
obj: $module ( Apache::Module object|docs::2.0::api::Apache::Module )
ret: $index ( integer )
since: 1.99_12

name

The name of the module's C file

  $name = $module->name();
obj: $module ( Apache::Module object|docs::2.0::api::Apache::Module )
ret: $name ( string )
since: 1.99_12

next

The next module in the list, undef if the last module in the list.

  $next_module = $module->next();
obj: $module ( Apache::Module object|docs::2.0::api::Apache::Module )
ret: $next_module ( Apache::Module object|docs::2.0::api::Apache::Module )
since: 1.99_12

remove_loaded_module

Remove a module from the list of loaded modules permanently.

  $module->remove_loaded_module();
obj: $module ( Apache::Module object|docs::2.0::api::Apache::Module )
ret: no return value
since: 1.99_12

top_module

Returns the first module in the module list. Usefull to start a module iteration.

  $ret = Apache::Module->top_module();
obj: Apache::Module ( class name )
ret: $ret ( Apache::Module object|docs::2.0::api::Apache::Module )
since: 1.99_12

version

API version, not module version; check that module is compatible with this version of the server.

  $version = $module->version();
obj: $module ( Apache::Module object|docs::2.0::api::Apache::Module )
ret: $version ( integer )
since: 1.99_12

See Also

mod_perl 2.0 documentation.

Copyright

mod_perl 2.0 and its core modules are copyrighted under The Apache Software License, Version 2.0.

Authors

The mod_perl development team and numerous contributors.

 Apache::Module - Perl API for creating and working with Apache modules