Difference between revisions of "API:EPrints/Handle/CGI"

From EPrints Documentation
Jump to: navigation, search
Line 1: Line 1:
 
<!-- Pod2Wiki=_preamble_  
 
<!-- Pod2Wiki=_preamble_  
This page has been automatically generated from the EPrints 3.2 source . Any wiki changes made between the 'Pod2Wiki=*' and 'End of Pod2Wiki' comments will be lost.
+
This page has been automatically generated from the EPrints 3.2 source. Any wiki changes made between the 'Pod2Wiki=*' and 'End of Pod2Wiki' comments will be lost.
 
  -->{{Pod2Wiki}}{{API:Source|file=EPrints/Handle/CGI.pm|package_name=EPrints::Handle::CGI}}[[Category:API|CGI]]<!-- End of Pod2Wiki -->
 
  -->{{Pod2Wiki}}{{API:Source|file=EPrints/Handle/CGI.pm|package_name=EPrints::Handle::CGI}}[[Category:API|CGI]]<!-- End of Pod2Wiki -->
<!-- Pod2Wiki=head_name -->=NAME=
+
<!-- Pod2Wiki=head_name --><div style='border: dashed 1px green'>=NAME=
 
'''EPrints::Handle::CGI''' - CGI methods for EPrints::Handle
 
'''EPrints::Handle::CGI''' - CGI methods for EPrints::Handle
  
<!-- End of Pod2Wiki -->
+
</div><!-- End of Pod2Wiki -->
<!-- Pod2Wiki=head_description -->=DESCRIPTION=
+
<!-- Pod2Wiki=head_description --><div style='border: dashed 1px green'>=DESCRIPTION=
 
This module provides additional methods to EPrints::Handle and is not an object in its own right.
 
This module provides additional methods to EPrints::Handle and is not an object in its own right.
  
 
Look at EPrints::Handle for further information on how to access the  Handle methods.
 
Look at EPrints::Handle for further information on how to access the  Handle methods.
  
<!-- End of Pod2Wiki -->
+
</div><!-- End of Pod2Wiki -->
<!-- Pod2Wiki=head_synopsis -->=SYNOPSIS=
+
<!-- Pod2Wiki=head_synopsis --><div style='border: dashed 1px green'>=SYNOPSIS=
 
   my $user = $handle-&gt;current_user;
 
   my $user = $handle-&gt;current_user;
 
   EPrints::abort() unless( defined $user );
 
   EPrints::abort() unless( defined $user );
Line 22: Line 22:
 
   my $current_page_uri = $handle-&gt;get_uri();
 
   my $current_page_uri = $handle-&gt;get_uri();
 
    
 
    
<!-- End of Pod2Wiki -->
+
</div><!-- End of Pod2Wiki -->
<!-- Pod2Wiki=head_methods -->=METHODS=
+
<!-- Pod2Wiki=head_methods --><div style='border: dashed 1px green'>=METHODS=
<!-- End of Pod2Wiki -->
+
</div><!-- End of Pod2Wiki -->
 
<!-- Pod2Wiki=item_get_request -->==get_request==
 
<!-- Pod2Wiki=item_get_request -->==get_request==
  
Line 31: Line 31:
 
Return the Apache request object (from mod_perl) or undefined if  this isn't a CGI script.
 
Return the Apache request object (from mod_perl) or undefined if  this isn't a CGI script.
  
<!-- End of Pod2Wiki -->
+
</div><!-- End of Pod2Wiki -->
 
<!-- Pod2Wiki=item_get_query -->==get_query==
 
<!-- Pod2Wiki=item_get_query -->==get_query==
  
Line 38: Line 38:
 
Return the CGI.pm object describing the current HTTP query, or  undefined if this isn't a CGI script.
 
Return the CGI.pm object describing the current HTTP query, or  undefined if this isn't a CGI script.
  
<!-- End of Pod2Wiki -->
+
</div><!-- End of Pod2Wiki -->
 
<!-- Pod2Wiki=item_get_uri -->==get_uri==
 
<!-- Pod2Wiki=item_get_uri -->==get_uri==
  
Line 45: Line 45:
 
Returns the URL of the current script. Or "undef".
 
Returns the URL of the current script. Or "undef".
  
<!-- End of Pod2Wiki -->
+
</div><!-- End of Pod2Wiki -->
 
<!-- Pod2Wiki=item_get_full_url -->==get_full_url==
 
<!-- Pod2Wiki=item_get_full_url -->==get_full_url==
  
Line 52: Line 52:
 
Returns the URL of the current script plus the CGI params.
 
Returns the URL of the current script plus the CGI params.
  
<!-- End of Pod2Wiki -->
+
</div><!-- End of Pod2Wiki -->
 
<!-- Pod2Wiki=item_get_secure -->==get_secure==
 
<!-- Pod2Wiki=item_get_secure -->==get_secure==
  
Line 59: Line 59:
 
Returns true if we're using HTTPS/SSL (checks get_online first).
 
Returns true if we're using HTTPS/SSL (checks get_online first).
  
<!-- End of Pod2Wiki -->
+
</div><!-- End of Pod2Wiki -->
 
<!-- Pod2Wiki=item_redirect -->==redirect==
 
<!-- Pod2Wiki=item_redirect -->==redirect==
  
Line 66: Line 66:
 
Redirects the browser to $url.
 
Redirects the browser to $url.
  
<!-- End of Pod2Wiki -->
+
</div><!-- End of Pod2Wiki -->
 
<!-- Pod2Wiki=item_send_http_header -->==send_http_header==
 
<!-- Pod2Wiki=item_send_http_header -->==send_http_header==
  
Line 79: Line 79:
 
lang. If this is set then a cookie setting the language preference is set in the http header.
 
lang. If this is set then a cookie setting the language preference is set in the http header.
  
<!-- End of Pod2Wiki -->
+
</div><!-- End of Pod2Wiki -->
 
<!-- Pod2Wiki=item_param -->==param==
 
<!-- Pod2Wiki=item_param -->==param==
  
Line 92: Line 92:
 
@values = $handle-&gt;param: returns an array of the names of all the CGI parameters in the current request.
 
@values = $handle-&gt;param: returns an array of the names of all the CGI parameters in the current request.
  
<!-- End of Pod2Wiki -->
+
</div><!-- End of Pod2Wiki -->
 
<!-- Pod2Wiki=item_have_parameters -->==have_parameters==
 
<!-- Pod2Wiki=item_have_parameters -->==have_parameters==
  
Line 99: Line 99:
 
Return true if the current script had any parameters (post or get)
 
Return true if the current script had any parameters (post or get)
  
<!-- End of Pod2Wiki -->
+
</div><!-- End of Pod2Wiki -->
 
<!-- Pod2Wiki=item_current_user -->==current_user==
 
<!-- Pod2Wiki=item_current_user -->==current_user==
  
Line 108: Line 108:
 
Return undef if there isn't one.
 
Return undef if there isn't one.
  
<!-- End of Pod2Wiki -->
+
</div><!-- End of Pod2Wiki -->
 
<!-- Pod2Wiki=item_client -->==client==
 
<!-- Pod2Wiki=item_client -->==client==
  
Line 123: Line 123:
 
These divisions are intended for modifying the way pages are rendered not logging what browser was used. Hence merging mozilla and firefox.
 
These divisions are intended for modifying the way pages are rendered not logging what browser was used. Hence merging mozilla and firefox.
  
<!-- End of Pod2Wiki -->
+
</div><!-- End of Pod2Wiki -->
 
<!-- Pod2Wiki=item_get_http_status -->==get_http_status==
 
<!-- Pod2Wiki=item_get_http_status -->==get_http_status==
  
Line 130: Line 130:
 
Return the status of the current HTTP request.
 
Return the status of the current HTTP request.
  
<!-- End of Pod2Wiki -->
+
</div><!-- End of Pod2Wiki -->
 
<!-- Pod2Wiki=_postamble_ --><!-- End of Pod2Wiki -->
 
<!-- Pod2Wiki=_postamble_ --><!-- End of Pod2Wiki -->

Revision as of 14:54, 19 August 2009

Latest Source Code (3.3, 3.2) | Revision Log | Before editing this page please read Pod2Wiki

=NAME=

EPrints::Handle::CGI - CGI methods for EPrints::Handle

=DESCRIPTION=

This module provides additional methods to EPrints::Handle and is not an object in its own right.

Look at EPrints::Handle for further information on how to access the Handle methods.

=SYNOPSIS=
 my $user = $handle->current_user;
 EPrints::abort() unless( defined $user );
 
 my $epid = $handle->param( "eprintid" );
 
 $handle->redirect( "http://www.eprints.org/" );
 
 my $current_page_uri = $handle->get_uri();
 
=METHODS=

get_request

 $request = $handle->get_request;

Return the Apache request object (from mod_perl) or undefined if this isn't a CGI script.

get_query

 $query = $handle->get_query;

Return the CGI.pm object describing the current HTTP query, or undefined if this isn't a CGI script.

get_uri

 $uri = $handle->get_uri

Returns the URL of the current script. Or "undef".

get_full_url

 $uri = $handle->get_full_url

Returns the URL of the current script plus the CGI params.

get_secure

 $secure = $handle->get_secure

Returns true if we're using HTTPS/SSL (checks get_online first).

redirect

 $handle->redirect( $url, [%opts] )

Redirects the browser to $url.

send_http_header

 $handle->send_http_header( %opts )

Send the HTTP header. Only makes sense if this is running as a CGI script.

Opts supported are:

content_type. Default value is "text/html; charset=UTF-8". This sets the http content type header.

lang. If this is set then a cookie setting the language preference is set in the http header.

param

 $value or @values = $handle->param( $name )

Passes through to CGI.pm param method.

$value = $handle->param( $name ): returns the value of CGI parameter $name.

$value = $handle->param( $name ): returns the value of CGI parameter $name.

@values = $handle->param: returns an array of the names of all the CGI parameters in the current request.

have_parameters

 $bool = $handle->have_parameters

Return true if the current script had any parameters (post or get)

current_user

 $user = $handle->current_user

Return the current EPrints::DataObj::User for this session.

Return undef if there isn't one.

client

 $client = $handle->client

Return a string representing the kind of browser that made the current request.

Options are GECKO, LYNX, MSIE4, MSIE5, MSIE6, ?.

GECKO covers mozilla and firefox.

? is what's returned if none of the others were matched.

These divisions are intended for modifying the way pages are rendered not logging what browser was used. Hence merging mozilla and firefox.

get_http_status

 $status = $handle->get_http_status

Return the status of the current HTTP request.