mod_perl logo
perl icon







previous page: Apache::FilterRec - Perl API for manipulating the Apache filter recordpage up: mod_perl APIsnext page: Apache::Log - Perl API for Apache Logging Methods


Apache::HookRun - Perl API for XXX











Practical mod_perl

Practical mod_perl

By Stas Bekman, Eric Cholet
The mod_perl Developer's Cookbook

The mod_perl Developer's Cookbook

By Geoffrey Young, Paul Lindner, Randy Kobes
mod_perl Pocket Reference

mod_perl Pocket Reference

By Andrew Ford


Table of Contents

Synopsis

  use Apache::HookRun ();

META: to be completed



TOP

Description

META: to be completed



TOP

API

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



TOP

die

META: Autogenerated - needs to be reviewed/completed

Kill the current request

  $r->die($type);


TOP

invoke_handler

META: Autogenerated - needs to be reviewed/completed

Run the handler phase of each module until a module accepts the responsibility of serving the request

  $ret = $r->invoke_handler();


TOP

run_access_checker

META: Autogenerated - needs to be reviewed/completed

This hook is used to apply additional access control to this resource. It runs *before* a user is authenticated, so this hook is really to apply additional restrictions independent of a user. It also runs independent of 'Require' directive usage.

  $ret = $r->run_access_checker();


TOP

run_auth_checker

META: Autogenerated - needs to be reviewed/completed

This hook is used to check to see if the resource being requested is available for the authenticated user (r->user and r->ap_auth_type). It runs after the access_checker and check_user_id hooks. Note that it will *only* be called if Apache determines that access control has been applied to this resource (through a 'Require' directive).

  $ret = $r->run_auth_checker();


TOP

run_check_user_id

META: Autogenerated - needs to be reviewed/completed

This hook is used to analyze the request headers, authenticate the user, and set the user information in the request record (r->user and r->ap_auth_type). This hook is only run when Apache determines that authentication/authorization is required for this resource (as determined by the 'Require' directive). It runs after the access_checker hook, and before the auth_checker hook.

  $ret = $r->run_check_user_id();


TOP

run_create_request

META: Autogenerated - needs to be reviewed/completed

Gives modules a chance to create their request_config entry when the request is created.

  $ret = $r->run_create_request();


TOP

run_fixups

META: Autogenerated - needs to be reviewed/completed

Allows modules to perform module-specific fixing of header fields. This is invoked just before any content-handler

  $ret = $r->run_fixups();


TOP

run_handler

META: Autogenerated - needs to be reviewed/completed

Run the handler functions for each module

  $ret = $r->run_handler();

non-wildcard handlers should HOOK_MIDDLE, wildcard HOOK_LAST



TOP

run_header_parser

META: Autogenerated - needs to be reviewed/completed

Run the header parser functions for each module

  $ret = $r->run_header_parser();


TOP

run_log_transaction

META: Autogenerated - needs to be reviewed/completed

This hook allows modules to perform any module-specific logging activities over and above the normal server things.

  $ret = $r->run_log_transaction();


TOP

run_map_to_storage

META: Autogenerated - needs to be reviewed/completed

This hook allow modules to set the per_dir_config based on their own context (such as <Proxy> sections) and responds to contextless requests such as TRACE that need no security or filesystem mapping. based on the filesystem.

  $ret = $r->run_map_to_storage();


TOP

run_post_read_request

META: Autogenerated - needs to be reviewed/completed

post_read_request --- run right after read_request or internal_redirect, and not run during any subrequests. This hook allows modules to affect the request immediately after the request has been read, and before any other phases have been processes. This allows modules to make decisions based upon the input header fields

  $ret = $r->run_post_read_request();


TOP

run_translate_name

META: Autogenerated - needs to be reviewed/completed

This hook allow modules an opportunity to translate the URI into an actual filename. If no modules do anything special, the server's default rules will be followed.

  $ret = $r->run_translate_name();


TOP

run_type_checker

META: Autogenerated - needs to be reviewed/completed

This routine is called to determine and/or set the various document type information bits, like Content-type (via r->content_type), language, etc.

  $ret = $r->run_type_checker();


TOP

See Also

mod_perl 2.0 documentation.



TOP

Copyright

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



TOP

Authors

The mod_perl development team and numerous contributors.







TOP
previous page: Apache::FilterRec - Perl API for manipulating the Apache filter recordpage up: mod_perl APIsnext page: Apache::Log - Perl API for Apache Logging Methods