home *** CD-ROM | disk | FTP | other *** search
/ PC Professionell 2004 December / PCpro_2004_12.ISO / files / webserver / xampp / xampp-perl-addon-1.4.9-installer.exe / Global.pm < prev    next >
Encoding:
Perl POD Document  |  2004-09-23  |  3.8 KB  |  202 lines
  1. # 
  2. # /*
  3. #  * *********** WARNING **************
  4. #  * This file generated by ModPerl::WrapXS/0.01
  5. #  * Any changes made here will be lost
  6. #  * ***********************************
  7. #  * 01: lib/ModPerl/Code.pm:701
  8. #  * 02: O:\147xampp\sources\mod_perl-1.99_16\blib\lib/ModPerl/WrapXS.pm:584
  9. #  * 03: O:\147xampp\sources\mod_perl-1.99_16\blib\lib/ModPerl/WrapXS.pm:1100
  10. #  * 04: Makefile.PL:335
  11. #  * 05: Makefile.PL:283
  12. #  * 06: Makefile.PL:51
  13. #  */
  14. # 
  15.  
  16.  
  17. package ModPerl::Global;
  18.  
  19. use strict;
  20. use warnings FATAL => 'all';
  21.  
  22.  
  23.  
  24. use Apache::XSLoader ();
  25. our $VERSION = '0.01';
  26. Apache::XSLoader::load __PACKAGE__;
  27.  
  28.  
  29.  
  30. 1;
  31. __END__
  32.  
  33. =head1 NAME
  34.  
  35. ModPerl::Global -- Perl API for manipulating special Perl lists
  36.  
  37.  
  38.  
  39.  
  40. =head1 Synopsis
  41.  
  42.   use ModPerl::Global ();
  43.   my $package = 'MyApache::Package';
  44.   
  45.   # make the END blocks of this package special
  46.   ModPerl::Global::special_list_register(END => $package);
  47.   
  48.   # Execute all encoutered END blocks from this package now
  49.   ModPerl::Global::special_list_call(    END => $package);
  50.   
  51.   # delete the list of END blocks
  52.   ModPerl::Global::special_list_clear(   END => $package);
  53.  
  54.  
  55.  
  56.  
  57. =head1 Description
  58.  
  59. C<ModPerl::Global> provides an API to manipulate special perl
  60. lists. At the moment only the C<END> blocks list is supported.
  61.  
  62. This API allows you to change the normal Perl behavior, and execute
  63. special lists when you need to.
  64.  
  65. For example
  66. C<L<ModPerl::RegistryCooker|docs::2.0::api::ModPerl::RegistryCooker>>
  67. uses it to run C<END> blocks in the scripts at the end of each
  68. request.
  69.  
  70. Before loading a module containing package C<$package>, you need to
  71. register it, so the special blocks will be intercepted by mod_perl and
  72. not given to
  73. Perl. C<L<special_list_register|/C_special_list_register_>> does
  74. that. Later on when you want to execute the special blocks,
  75. C<L<special_list_call|/C_special_list_call_>> should be called. Unless
  76. you want to call the list more than once, clear the list with
  77. C<L<special_list_clear|/C_special_list_clear_>>.
  78.  
  79. =head1 API
  80.  
  81. C<ModPerl::Global> provides the following methods:
  82.  
  83.  
  84.  
  85.  
  86.  
  87.  
  88.  
  89.  
  90.  
  91.  
  92. =head2 C<special_list_call>
  93.  
  94. Call the special list
  95.  
  96.   $ok = special_list_call($key => $package);
  97.  
  98. =over 4
  99.  
  100. =item arg1: C<$key> ( string )
  101.  
  102. The name of the special list. At the moment only C<'END'> is
  103. supported.
  104.  
  105. =item arg2: C<$package> ( string )
  106.  
  107. what package to special list is for
  108.  
  109. =item ret: C<$ok> ( boolean )
  110.  
  111. true value if C<$key> is known, false otherwise.
  112.  
  113. =item since: 1.99_14
  114.  
  115. =back
  116.  
  117.  
  118.  
  119.  
  120.  
  121. =head2 C<special_list_clear>
  122.  
  123. Clear the special list
  124.  
  125.   $ok = special_list_clear($key => $package);
  126.  
  127. =over 4
  128.  
  129. =item arg1: C<$key> ( string )
  130.  
  131. The name of the special list. At the moment only C<'END'> is
  132. supported.
  133.  
  134. =item arg2: C<$package> ( string )
  135.  
  136. what package to special list is for
  137.  
  138. =item ret: C<$ok> ( boolean )
  139.  
  140. true value if C<$key> is known, false otherwise.
  141.  
  142. =item since: 1.99_14
  143.  
  144. =back
  145.  
  146.  
  147.  
  148.  
  149. =head2 C<special_list_register>
  150.  
  151. Register the special list
  152.  
  153.   $ok = special_list_call($key => $package);
  154.  
  155. =over 4
  156.  
  157. =item arg1: C<$key> ( string )
  158.  
  159. The name of the special list. At the moment only C<'END'> is
  160. supported.
  161.  
  162. =item arg2: C<$package> ( string )
  163.  
  164. what package to special list is for
  165.  
  166. =item ret: C<$ok> ( boolean )
  167.  
  168. true value if C<$key> is known, false otherwise.
  169.  
  170. =item since: 1.99_14
  171.  
  172. =back
  173.  
  174. Notice that you need to register the package before it is loaded. If
  175. you register it after, Perl has already compiled the C<END> blocks and
  176. there are no longer under your control.
  177.  
  178.  
  179.  
  180. =head1 See Also
  181.  
  182. L<mod_perl 2.0 documentation|docs::2.0::index>.
  183.  
  184.  
  185.  
  186.  
  187. =head1 Copyright
  188.  
  189. mod_perl 2.0 and its core modules are copyrighted under
  190. The Apache Software License, Version 2.0.
  191.  
  192.  
  193.  
  194.  
  195. =head1 Authors
  196.  
  197. L<The mod_perl development team and numerous
  198. contributors|about::contributors::people>.
  199.  
  200. =cut
  201.  
  202.