Difference between revisions of "API:EPrints/Apache/AnApache"

From EPrints Documentation
Jump to: navigation, search
(New page: <!-- Pod2Wiki=_preamble_ This page has been automatically generated from the EPrints source. Any wiki changes made between the 'Pod2Wiki=*' and 'End of Pod2Wiki' comments will be lost. -...)
 
(Removing all content from page)
Line 1: Line 1:
<!-- Pod2Wiki=_preamble_
 
This page has been automatically generated from the EPrints source. Any wiki changes made between the 'Pod2Wiki=*' and 'End of Pod2Wiki' comments will be lost.
 
-->{{Pod2Wiki}}{{API:Source|file=EPrints/Apache/AnApache.pm|package_name=EPrints::Apache::AnApache}}[[Category:API|AnApache]]<!-- End of Pod2Wiki -->
 
<!-- Pod2Wiki=head_name -->=NAME=
 
'''EPrints::Apache::AnApache''' - Load appropriate Apache Module
 
  
<!-- End of Pod2Wiki -->
 
<!-- Pod2Wiki=head_description -->=DESCRIPTION=
 
Handy way of loading Apache or Apache2 depending on value in SystemSettings.
 
 
Plus functions to paper over the cracks between the two interfaces.
 
 
<!-- End of Pod2Wiki -->
 
<!-- Pod2Wiki=item_upload_doc_file -->==upload_doc_file==
 
 
  EPrints::Apache::AnApache::upload_doc_file( $session, $document, $paramid );
 
 
Collect a file named $paramid uploaded via HTTP and add it to the  specified $document.
 
 
<!-- End of Pod2Wiki -->
 
<!-- Pod2Wiki=item_upload_doc_archive -->==upload_doc_archive==
 
 
  EPrints::Apache::AnApache::upload_doc_archive( $session, $document, $paramid, $archive_format );
 
 
Collect an archive file (.ZIP, .tar.gz, etc.) uploaded via HTTP and  unpack it then add it to the specified document.
 
 
<!-- End of Pod2Wiki -->
 
<!-- Pod2Wiki=item_send_http_header -->==send_http_header==
 
 
  EPrints::Apache::AnApache::send_http_header( $request )
 
 
Send the HTTP header, if needed.
 
 
$request is the current Apache request.
 
 
<!-- End of Pod2Wiki -->
 
<!-- Pod2Wiki=item_header_out -->==header_out==
 
 
  EPrints::Apache::AnApache::header_out( $request, $header, $value )
 
 
Set a value in the HTTP headers of the response. $request is the apache request object, $header is the name of the header and  $value is the value to give that header.
 
 
<!-- End of Pod2Wiki -->
 
<!-- Pod2Wiki=item_header_in -->==header_in==
 
 
  $value = EPrints::Apache::AnApache::header_in( $request, $header )
 
 
Return the specified HTTP header from the current request.
 
 
<!-- End of Pod2Wiki -->
 
<!-- Pod2Wiki=item_$request -->==$request==
 
 
  $request = EPrints::Apache::AnApache::get_request
 
 
Return the current Apache request object.
 
 
<!-- End of Pod2Wiki -->
 
<!-- Pod2Wiki=item_cookie -->==cookie==
 
 
  $value = EPrints::Apache::AnApache::cookie( $request, $cookieid )
 
 
Return the value of the named cookie, or undef if it is not set.
 
 
This avoids using {{API:PodLink|file=CGI|package_name=CGI|section=|text=CGI}}, so does not consume the POST data.
 
 
<!-- End of Pod2Wiki -->
 
<!-- Pod2Wiki=item_send_status_line -->==send_status_line==
 
 
  EPrints::Apache::AnApache::send_status_line( $request, $code, $message )
 
 
Send a HTTP status to the client with $code and $message.
 
 
<!-- End of Pod2Wiki -->
 
<!-- Pod2Wiki=head_undocumented_methods -->=UNDOCUMENTED METHODS=
 
{{API:Undocumented Methods}}<!-- End of Pod2Wiki -->
 
<!-- Pod2Wiki=item_auth_required -->==auth_required==
 
 
  AUTH_REQUIRED
 
 
<!-- End of Pod2Wiki -->
 
<!-- Pod2Wiki=item_declined -->==declined==
 
 
  DECLINED
 
 
<!-- End of Pod2Wiki -->
 
<!-- Pod2Wiki=item_done -->==done==
 
 
  DONE
 
 
<!-- End of Pod2Wiki -->
 
<!-- Pod2Wiki=item_forbidden -->==forbidden==
 
 
  FORBIDDEN
 
 
<!-- End of Pod2Wiki -->
 
<!-- Pod2Wiki=item_not_found -->==not_found==
 
 
  NOT_FOUND
 
 
<!-- End of Pod2Wiki -->
 
<!-- Pod2Wiki=item_ok -->==ok==
 
 
  OK
 
 
<!-- End of Pod2Wiki -->
 
<!-- Pod2Wiki=item_redirect -->==redirect==
 
 
  REDIRECT
 
 
<!-- End of Pod2Wiki -->
 
<!-- Pod2Wiki=item_server_error -->==server_error==
 
 
  SERVER_ERROR
 
 
<!-- End of Pod2Wiki -->
 
<!-- Pod2Wiki=_postamble_ --><!-- End of Pod2Wiki -->
 

Revision as of 15:40, 12 August 2009