API:EPrints/Apache/AnApache - Revision history

Pod2wiki at 12:33, 15 March 2023

2023-03-15T12:33:55Z

Pod2wiki at 12:07, 15 March 2023

2023-03-15T12:07:31Z

Pod2wiki at 20:48, 14 December 2021

2021-12-14T20:48:33Z

Pod2wiki at 19:38, 14 December 2021

2021-12-14T19:38:20Z

Pod2wiki at 17:08, 14 December 2021

2021-12-14T17:08:45Z

Drn@ecs.soton.ac.uk at 17:08, 14 December 2021

2021-12-14T17:08:36Z

Pod2wiki at 17:06, 14 December 2021

2021-12-14T17:06:25Z

Drn@ecs.soton.ac.uk at 17:05, 14 December 2021

2021-12-14T17:05:36Z

Pod2wiki at 16:01, 14 December 2021

2021-12-14T16:01:47Z

Kgoetz: adding Category:Rubbish

2018-10-03T00:22:02Z

adding Category:Rubbish

@@ Line 26: / Line 26: @@
 <!-- Pod2Wiki= -->
 </div>
-<!-- Pod2Wiki=head_constantsfor_backwards_compatibility_use_c_http_constants_instead_of_c_common_constants -->
+<!-- Pod2Wiki=head_constants -->
-==CONSTANTSFor backwards compatibility - use <tt>HTTP_</tt> constants instead of <tt>:common</tt> constants.==
+==CONSTANTS==
 <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce;  padding: 0em 1em 0em 1em; font-size: 80%; '>
 <span style='display:none'>User Comments</span>

@@ Line 18: / Line 18: @@
 ==DESCRIPTION==
 This module provides a number of utility methods for interacting with the request object.
 <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce;  padding: 0em 1em 0em 1em; font-size: 80%; '>
@@ Line 41: / Line 86: @@
 Send the HTTP header, if needed.
-$request is the current Apache request.
+<tt>$request</tt> is the current Apache request.
 <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce;  padding: 0em 1em 0em 1em; font-size: 80%; '>
@@ Line 54: / Line 99: @@
   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.
+Set a value in the HTTP headers of the response. <tt>$request</tt> is the apache request object, <tt>$header</tt> is the name of the header and  <tt>$value</tt> is the value to give that header.
 <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce;  padding: 0em 1em 0em 1em; font-size: 80%; '>
@@ Line 108: / Line 153: @@
   EPrints::Apache::AnApache::upload_doc_file( $session, $document, $paramid );
-Collect a file named $paramid uploaded via HTTP and add it to the  specified $document.
+Collect a file named $paramid uploaded via HTTP and add it to the  specified <tt>$document</tt>.
 <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce;  padding: 0em 1em 0em 1em; font-size: 80%; '>
@@ Line 134: / Line 179: @@
   EPrints::Apache::AnApache::send_status_line( $request, $code, $message )
-Send a HTTP status to the client with $code and $message.
+Send a HTTP status to the client with <tt>$code</tt> and <tt>$message</tt>.
 <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce;  padding: 0em 1em 0em 1em; font-size: 80%; '>
@@ Line 149: / Line 209: @@
 Populates the byte-ranges in $chunks requested by the client.
-$maxlength is the length, in bytes, of the resource.
+<tt>$maxlength</tt> is the length, in bytes, of the resource.
-Returns the appropriate byte-range result code or OK if no "Range" header is set.
+Returns the appropriate byte-range result code or <tt>OK</tt> if no <tt>Range</tt> header is set.
 <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce;  padding: 0em 1em 0em 1em; font-size: 80%; '>

@@ Line 1: / Line 1: @@
 <!-- Pod2Wiki=_preamble_
-This page has been automatically generated from the EPrints 3.2 source. Any wiki changes made between the 'Pod2Wiki=*' and 'Edit below this comment' comments will be lost.
+This page has been automatically generated from the EPrints 3.4 source. Any wiki changes made between the 'Pod2Wiki=*' and 'Edit below this comment' comments will be lost.
   -->{{API}}{{Pod2Wiki}}{{API:Source|file=EPrints/Apache/AnApache.pm|package_name=EPrints::Apache::AnApache}}[[Category:API|ANAPACHE]][[Category:API:EPrints/Apache|ANAPACHE]]<div><!-- Edit below this comment -->
@@ Line 162: / Line 162: @@
 <!-- Pod2Wiki=head_copyright -->
 ==COPYRIGHT==
 <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce;  padding: 0em 1em 0em 1em; font-size: 80%; '>
 <span style='display:none'>User Comments</span>

@@ Line 11: / Line 11: @@
 <span style='display:none'>User Comments</span>
 <!-- Edit below this comment -->
 <!-- Pod2Wiki= -->
@@ Line 21: / Line 22: @@
 <span style='display:none'>User Comments</span>
 <!-- Edit below this comment -->
 <!-- Pod2Wiki= -->
@@ Line 29: / Line 31: @@
 <span style='display:none'>User Comments</span>
 <!-- Edit below this comment -->
 <!-- Pod2Wiki= -->
@@ Line 43: / Line 46: @@
 <span style='display:none'>User Comments</span>
 <!-- Edit below this comment -->
 <!-- Pod2Wiki= -->
@@ Line 55: / Line 59: @@
 <span style='display:none'>User Comments</span>
 <!-- Edit below this comment -->
 <!-- Pod2Wiki= -->
@@ Line 67: / Line 72: @@
 <span style='display:none'>User Comments</span>
 <!-- Edit below this comment -->
 <!-- Pod2Wiki= -->
@@ Line 79: / Line 85: @@
 <span style='display:none'>User Comments</span>
 <!-- Edit below this comment -->
 <!-- Pod2Wiki= -->
@@ Line 93: / Line 100: @@
 <span style='display:none'>User Comments</span>
 <!-- Edit below this comment -->
 <!-- Pod2Wiki= -->
@@ Line 105: / Line 113: @@
 <span style='display:none'>User Comments</span>
 <!-- Edit below this comment -->
 <!-- Pod2Wiki= -->
@@ Line 117: / Line 126: @@
 <span style='display:none'>User Comments</span>
 <!-- Edit below this comment -->
 <!-- Pod2Wiki= -->
@@ Line 129: / Line 139: @@
 <span style='display:none'>User Comments</span>
 <!-- Edit below this comment -->
 <!-- Pod2Wiki= -->
@@ Line 145: / Line 156: @@
 <span style='display:none'>User Comments</span>
 <!-- Edit below this comment -->
 <!-- Pod2Wiki= -->
@@ Line 153: / Line 165: @@
 <span style='display:none'>User Comments</span>
 <!-- Edit below this comment -->
 <!-- Pod2Wiki= -->
 </div>
 <!-- Pod2Wiki=_postamble_ --><!-- Edit below this comment -->

@@ Line 11: / Line 11: @@
 <span style='display:none'>User Comments</span>
 <!-- Edit below this comment -->
 <!-- Pod2Wiki= -->
@@ Line 22: / Line 21: @@
 <span style='display:none'>User Comments</span>
 <!-- Edit below this comment -->
 <!-- Pod2Wiki= -->
@@ Line 31: / Line 29: @@
 <span style='display:none'>User Comments</span>
 <!-- Edit below this comment -->
 <!-- Pod2Wiki= -->
@@ Line 46: / Line 43: @@
 <span style='display:none'>User Comments</span>
 <!-- Edit below this comment -->
 <!-- Pod2Wiki= -->
@@ Line 59: / Line 55: @@
 <span style='display:none'>User Comments</span>
 <!-- Edit below this comment -->
 <!-- Pod2Wiki= -->
@@ Line 72: / Line 67: @@
 <span style='display:none'>User Comments</span>
 <!-- Edit below this comment -->
 <!-- Pod2Wiki= -->
@@ Line 85: / Line 79: @@
 <span style='display:none'>User Comments</span>
 <!-- Edit below this comment -->
 <!-- Pod2Wiki= -->
@@ Line 100: / Line 93: @@
 <span style='display:none'>User Comments</span>
 <!-- Edit below this comment -->
 <!-- Pod2Wiki= -->
@@ Line 113: / Line 105: @@
 <span style='display:none'>User Comments</span>
 <!-- Edit below this comment -->
 <!-- Pod2Wiki= -->
@@ Line 126: / Line 117: @@
 <span style='display:none'>User Comments</span>
 <!-- Edit below this comment -->
 <!-- Pod2Wiki= -->
@@ Line 139: / Line 129: @@
 <span style='display:none'>User Comments</span>
 <!-- Edit below this comment -->
 <!-- Pod2Wiki= -->
@@ Line 156: / Line 145: @@
 <span style='display:none'>User Comments</span>
 <!-- Edit below this comment -->
 <!-- Pod2Wiki= -->
@@ Line 165: / Line 153: @@
 <span style='display:none'>User Comments</span>
 <!-- Edit below this comment -->
 <!-- Pod2Wiki= -->
 </div>
 <!-- Pod2Wiki=_postamble_ --><!-- Edit below this comment -->

← Older revision		Revision as of 17:08, 14 December 2021
Line 11:		Line 11:
	<span style='display:none'>User Comments</span>		<span style='display:none'>User Comments</span>
	<!-- Edit below this comment -->		<!-- Edit below this comment -->
−
−
−	~~Testing user comments.~~

← Older revision		Revision as of 16:01, 14 December 2021
Line 1:		Line 1:
−	[[Category: ~~Rubbish~~]]	+	<!-- Pod2Wiki=_preamble_
		+	This page has been automatically generated from the EPrints 3.2 source. Any wiki changes made between the 'Pod2Wiki=*' and 'Edit below this comment' comments will be lost.
		+	-->{{API}}{{Pod2Wiki}}{{API:Source\|file=EPrints/Apache/AnApache.pm\|package_name=EPrints::Apache::AnApache}}[[Category:API\|ANAPACHE]][[Category:API:EPrints/Apache\|ANAPACHE]][[Category:API:EPrints/Apache/AnApache\|ANAPACHE]]<div><!-- Edit below this comment -->
		+
		+
		+	<!-- Pod2Wiki=_private_ --><!-- Pod2Wiki=head_name -->
		+	==NAME==
		+	'''EPrints::Apache::AnApache''' - Utility methods for talking to mod_perl
		+
		+	<div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '>
		+	<span style='display:none'>User Comments</span>
		+	<!-- Edit below this comment -->
		+
		+
		+	<!-- Pod2Wiki= -->
		+	</div>
		+	<!-- Pod2Wiki=head_description -->
		+	==DESCRIPTION==
		+	This module provides a number of utility methods for interacting with the request object.
		+
		+	<div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '>
		+	<span style='display:none'>User Comments</span>
		+	<!-- Edit below this comment -->
		+
		+
		+	<!-- Pod2Wiki= -->
		+	</div>
		+	<!-- Pod2Wiki=head_methods -->
		+	==METHODS==
		+	<div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '>
		+	<span style='display:none'>User Comments</span>
		+	<!-- Edit below this comment -->
		+
		+
		+	<!-- Pod2Wiki= -->
		+	</div>
		+	<!-- 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.
		+
		+	<div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '>
		+	<span style='display:none'>User Comments</span>
		+	<!-- Edit below this comment -->
		+
		+
		+	<!-- Pod2Wiki= -->
		+	</div>
		+	<!-- 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.
		+
		+	<div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '>
		+	<span style='display:none'>User Comments</span>
		+	<!-- Edit below this comment -->
		+
		+
		+	<!-- Pod2Wiki= -->
		+	</div>
		+	<!-- Pod2Wiki=item_header_in -->
		+	===header_in===
		+
		+	$value = EPrints::Apache::AnApache::header_in( $request, $header )
		+	Return the specified HTTP header from the current request.
		+
		+	<div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '>
		+	<span style='display:none'>User Comments</span>
		+	<!-- Edit below this comment -->
		+
		+
		+	<!-- Pod2Wiki= -->
		+	</div>
		+	<!-- Pod2Wiki=item_$request -->
		+	===$request===
		+
		+	$request = EPrints::Apache::AnApache::get_request
		+	Return the current Apache request object.
		+
		+	<div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '>
		+	<span style='display:none'>User Comments</span>
		+	<!-- Edit below this comment -->
		+
		+
		+	<!-- Pod2Wiki= -->
		+	</div>
		+	<!-- 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 CGI, so does not consume the POST data.
		+
		+	<div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '>
		+	<span style='display:none'>User Comments</span>
		+	<!-- Edit below this comment -->
		+
		+
		+	<!-- Pod2Wiki= -->
		+	</div>
		+	<!-- 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.
		+
		+	<div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '>
		+	<span style='display:none'>User Comments</span>
		+	<!-- Edit below this comment -->
		+
		+
		+	<!-- Pod2Wiki= -->
		+	</div>
		+	<!-- 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.
		+
		+	<div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '>
		+	<span style='display:none'>User Comments</span>
		+	<!-- Edit below this comment -->
		+
		+
		+	<!-- Pod2Wiki= -->
		+	</div>
		+	<!-- 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.
		+
		+	<div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '>
		+	<span style='display:none'>User Comments</span>
		+	<!-- Edit below this comment -->
		+
		+
		+	<!-- Pod2Wiki= -->
		+	</div>
		+	<!-- Pod2Wiki=item_ranges -->
		+	===ranges===
		+
		+	$rc = EPrints::Apache::AnApache::ranges( $r, $maxlength, $chunks )
		+	Populates the byte-ranges in $chunks requested by the client.
		+
		+	$maxlength is the length, in bytes, of the resource.
		+
		+	Returns the appropriate byte-range result code or OK if no "Range" header is set.
		+
		+	<div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '>
		+	<span style='display:none'>User Comments</span>
		+	<!-- Edit below this comment -->
		+
		+
		+	<!-- Pod2Wiki= -->
		+	</div>
		+	<!-- Pod2Wiki=head_copyright -->
		+	==COPYRIGHT==
		+	<div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '>
		+	<span style='display:none'>User Comments</span>
		+	<!-- Edit below this comment -->
		+
		+
		+	<!-- Pod2Wiki= -->
		+	</div>
		+	<!-- Pod2Wiki=_postamble_ --><!-- Edit below this comment -->

← Older revision	Revision as of 00:22, 3 October 2018
Line 1:	Line 1:
−	+	[[Category: Rubbish]]