stas 2004/07/15 18:53:20 Modified: src/docs/2.0/api/Apache PerlSections.pod Log: complete the manpages Revision Changes Path 1.13 +46 -21 modperl-docs/src/docs/2.0/api/Apache/PerlSections.pod Index: PerlSections.pod =================================================================== RCS file: /home/cvs/modperl-docs/src/docs/2.0/api/Apache/PerlSections.pod,v retrieving revision 1.12 retrieving revision 1.13 diff -u -u -r1.12 -r1.13 --- PerlSections.pod 13 Jul 2004 03:59:46 -0000 1.12 +++ PerlSections.pod 16 Jul 2004 01:53:20 -0000 1.13 @@ -13,7 +13,7 @@ #run the server as whoever starts it $User = getpwuid(>) || >; - $Group = getgrgid()) || ); + $Group = getgrgid()) || ); $ServerAdmin = $User; @@ -110,18 +110,20 @@ - -=head1 @PerlConfig and $PerlConfig -This array and scalar can be used to introduce litteral configuration + +=head1 C<@PerlConfig> and C<$PerlConfig> + +This array and scalar can be used to introduce literal configuration into the apache configuration. For example: push @PerlConfig, 'Alias /foo /bar'; Or: $PerlConfig .= "Alias /foo /bar\n"; - -See also C<L<$r-E<gt>add_config|docs::2.0::api::Apache::RequestUtil/C_add_config_>> + +See also +C<L<$r-E<gt>add_config|docs::2.0::api::Apache::RequestUtil/C_add_config_>> @@ -148,15 +150,17 @@ -=head1 PerlSections dumping +=head1 PerlSections Dumping + + =head2 Apache::PerlSections-E<gt>dump This method will dump out all the configuration variables mod_perl will be feeding to the apache config gears. The output is suitable to -read back in via C<eval> +read back in via C<eval>. -Example: +For example: <Perl> @@ -181,7 +185,7 @@ Allow => 'from foo.com', }, }, - }; + }; print Apache::PerlSections->dump; @@ -218,11 +222,19 @@ 1; __END__ + + + + =head2 Apache::PerlSections-E<gt>store This method will call the C<dump> method, writing the output to a file, suitable to be pulled in via C<require> or C<do>. + + + + =head1 Advanced API mod_perl 2.0 now introduces the same general concept of handlers to @@ -234,7 +246,7 @@ <Perl handler="My::PerlSection::Handler" somearg="test1"> $foo = 1; - $bar = 2; + $bar = 2; </Perl> And in My/PerlSection/Handler.pm: @@ -246,25 +258,34 @@ So, when that given C<E<lt>Perl E<gt>> block in encountered, the code within will first be evaluated, then the handler routine will be -invoked with 3 arguments +invoked with 3 arguments: + +=over + +=item arg1: C<$self> + +self-explanatory + +=item arg2: C<$parms> +( C<L<Apache::CmdParms|docs::2.0::api::Apache::CmdParms>> ) -C<$self> is self-explanatory +C<$parms> is specific for the current Container, for example, you +might want to call C<$parms-E<gt>server()> to get the current server. -C<$parms> is the -C<L<Apache::CmdParms|docs::2.0::api::Apache::CmdParms>> for this -Container, for example, you might want to call C<$parms>-E<gt>server() -to get the current server. +=item arg3: C<$args> +( C<L<APR::Table object|docs::2.0::api::APR::Table>>) -C<$args> is an C<L<APR::Table|docs::2.0::api::APR::Table>> object of -the section arguments, the 2 guaranteed ones will be: +the table object of the section arguments. The 2 guaranteed ones will +be: $args->{'handler'} = 'My::PerlSection::Handler'; - - $args->{'package'} = 'Apache::ReadConfig'; + $args->{'package'} = 'Apache::ReadConfig'; Other C<name="value"> pairs given on the C<E<lt>Perl E<gt>> line will also be included. +=back + At this point, it's up to the handler routing to inspect the namespace of the C<$args>-E<gt>{'package'} and chooses what to do. @@ -312,9 +333,13 @@ + + =head1 See Also L<mod_perl 2.0 documentation|docs::2.0::index>. + +
--------------------------------------------------------------------- To unsubscribe, e-mail: [EMAIL PROTECTED] For additional commands, e-mail: [EMAIL PROTECTED]