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

From EPrints Documentation
Jump to: navigation, search
Line 10: Line 10:
 
'''EPrints::Handle::CGI''' - CGI methods for EPrints::Handle
 
'''EPrints::Handle::CGI''' - CGI methods for EPrints::Handle
  
<div style='background-color: #eef; margin: 1em 0em 1em 0em; border: solid 1px #cce;  padding: 1em;'>
+
<div style='background-color: #eef; margin: 0.5em 0em 1em 0em; border: solid 1px #cce;  padding: 0em 1em 0em 1em; font-size: 80%;'>
 
====User Comments====
 
====User Comments====
 
<!-- End of Pod2Wiki -->
 
<!-- End of Pod2Wiki -->
Line 23: Line 23:
 
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.
  
<div style='background-color: #eef; margin: 1em 0em 1em 0em; border: solid 1px #cce;  padding: 1em;'>
+
<div style='background-color: #eef; margin: 0.5em 0em 1em 0em; border: solid 1px #cce;  padding: 0em 1em 0em 1em; font-size: 80%;'>
 
====User Comments====
 
====User Comments====
 
<!-- End of Pod2Wiki -->
 
<!-- End of Pod2Wiki -->
Line 41: Line 41:
 
   my $current_page_uri = $handle-&gt;get_uri();
 
   my $current_page_uri = $handle-&gt;get_uri();
 
    
 
    
<div style='background-color: #eef; margin: 1em 0em 1em 0em; border: solid 1px #cce;  padding: 1em;'>
+
<div style='background-color: #eef; margin: 0.5em 0em 1em 0em; border: solid 1px #cce;  padding: 0em 1em 0em 1em; font-size: 80%;'>
 
====User Comments====
 
====User Comments====
 
<!-- End of Pod2Wiki -->
 
<!-- End of Pod2Wiki -->
Line 50: Line 50:
 
<!-- Pod2Wiki=head_methods --></div>
 
<!-- Pod2Wiki=head_methods --></div>
 
==METHODS==
 
==METHODS==
<div style='background-color: #eef; margin: 1em 0em 1em 0em; border: solid 1px #cce;  padding: 1em;'>
+
<div style='background-color: #eef; margin: 0.5em 0em 1em 0em; border: solid 1px #cce;  padding: 0em 1em 0em 1em; font-size: 80%;'>
 
====User Comments====
 
====User Comments====
 
<!-- End of Pod2Wiki -->
 
<!-- End of Pod2Wiki -->
Line 64: Line 64:
 
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.
  
<div style='background-color: #eef; margin: 1em 0em 1em 0em; border: solid 1px #cce;  padding: 1em;'>
+
<div style='background-color: #eef; margin: 0.5em 0em 1em 0em; border: solid 1px #cce;  padding: 0em 1em 0em 1em; font-size: 80%;'>
 
====User Comments====
 
====User Comments====
 
<!-- End of Pod2Wiki -->
 
<!-- End of Pod2Wiki -->
Line 78: Line 78:
 
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.
  
<div style='background-color: #eef; margin: 1em 0em 1em 0em; border: solid 1px #cce;  padding: 1em;'>
+
<div style='background-color: #eef; margin: 0.5em 0em 1em 0em; border: solid 1px #cce;  padding: 0em 1em 0em 1em; font-size: 80%;'>
 
====User Comments====
 
====User Comments====
 
<!-- End of Pod2Wiki -->
 
<!-- End of Pod2Wiki -->
Line 92: Line 92:
 
Returns the URL of the current script. Or "undef".
 
Returns the URL of the current script. Or "undef".
  
<div style='background-color: #eef; margin: 1em 0em 1em 0em; border: solid 1px #cce;  padding: 1em;'>
+
<div style='background-color: #eef; margin: 0.5em 0em 1em 0em; border: solid 1px #cce;  padding: 0em 1em 0em 1em; font-size: 80%;'>
 
====User Comments====
 
====User Comments====
 
<!-- End of Pod2Wiki -->
 
<!-- End of Pod2Wiki -->
Line 106: Line 106:
 
Returns the URL of the current script plus the CGI params.
 
Returns the URL of the current script plus the CGI params.
  
<div style='background-color: #eef; margin: 1em 0em 1em 0em; border: solid 1px #cce;  padding: 1em;'>
+
<div style='background-color: #eef; margin: 0.5em 0em 1em 0em; border: solid 1px #cce;  padding: 0em 1em 0em 1em; font-size: 80%;'>
 
====User Comments====
 
====User Comments====
 
<!-- End of Pod2Wiki -->
 
<!-- End of Pod2Wiki -->
Line 120: Line 120:
 
Returns true if we're using HTTPS/SSL (checks get_online first).
 
Returns true if we're using HTTPS/SSL (checks get_online first).
  
<div style='background-color: #eef; margin: 1em 0em 1em 0em; border: solid 1px #cce;  padding: 1em;'>
+
<div style='background-color: #eef; margin: 0.5em 0em 1em 0em; border: solid 1px #cce;  padding: 0em 1em 0em 1em; font-size: 80%;'>
 
====User Comments====
 
====User Comments====
 
<!-- End of Pod2Wiki -->
 
<!-- End of Pod2Wiki -->
Line 134: Line 134:
 
Redirects the browser to $url.
 
Redirects the browser to $url.
  
<div style='background-color: #eef; margin: 1em 0em 1em 0em; border: solid 1px #cce;  padding: 1em;'>
+
<div style='background-color: #eef; margin: 0.5em 0em 1em 0em; border: solid 1px #cce;  padding: 0em 1em 0em 1em; font-size: 80%;'>
 
====User Comments====
 
====User Comments====
 
<!-- End of Pod2Wiki -->
 
<!-- End of Pod2Wiki -->
Line 154: Line 154:
 
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.
  
<div style='background-color: #eef; margin: 1em 0em 1em 0em; border: solid 1px #cce;  padding: 1em;'>
+
<div style='background-color: #eef; margin: 0.5em 0em 1em 0em; border: solid 1px #cce;  padding: 0em 1em 0em 1em; font-size: 80%;'>
 
====User Comments====
 
====User Comments====
 
<!-- End of Pod2Wiki -->
 
<!-- End of Pod2Wiki -->
Line 174: Line 174:
 
@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.
  
<div style='background-color: #eef; margin: 1em 0em 1em 0em; border: solid 1px #cce;  padding: 1em;'>
+
<div style='background-color: #eef; margin: 0.5em 0em 1em 0em; border: solid 1px #cce;  padding: 0em 1em 0em 1em; font-size: 80%;'>
 
====User Comments====
 
====User Comments====
 
<!-- End of Pod2Wiki -->
 
<!-- End of Pod2Wiki -->
Line 188: Line 188:
 
Return true if the current script had any parameters (post or get)
 
Return true if the current script had any parameters (post or get)
  
<div style='background-color: #eef; margin: 1em 0em 1em 0em; border: solid 1px #cce;  padding: 1em;'>
+
<div style='background-color: #eef; margin: 0.5em 0em 1em 0em; border: solid 1px #cce;  padding: 0em 1em 0em 1em; font-size: 80%;'>
 
====User Comments====
 
====User Comments====
 
<!-- End of Pod2Wiki -->
 
<!-- End of Pod2Wiki -->
Line 204: Line 204:
 
Return undef if there isn't one.
 
Return undef if there isn't one.
  
<div style='background-color: #eef; margin: 1em 0em 1em 0em; border: solid 1px #cce;  padding: 1em;'>
+
<div style='background-color: #eef; margin: 0.5em 0em 1em 0em; border: solid 1px #cce;  padding: 0em 1em 0em 1em; font-size: 80%;'>
 
====User Comments====
 
====User Comments====
 
<!-- End of Pod2Wiki -->
 
<!-- End of Pod2Wiki -->
Line 226: Line 226:
 
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.
  
<div style='background-color: #eef; margin: 1em 0em 1em 0em; border: solid 1px #cce;  padding: 1em;'>
+
<div style='background-color: #eef; margin: 0.5em 0em 1em 0em; border: solid 1px #cce;  padding: 0em 1em 0em 1em; font-size: 80%;'>
 
====User Comments====
 
====User Comments====
 
<!-- End of Pod2Wiki -->
 
<!-- End of Pod2Wiki -->
Line 240: Line 240:
 
Return the status of the current HTTP request.
 
Return the status of the current HTTP request.
  
<div style='background-color: #eef; margin: 1em 0em 1em 0em; border: solid 1px #cce;  padding: 1em;'>
+
<div style='background-color: #eef; margin: 0.5em 0em 1em 0em; border: solid 1px #cce;  padding: 0em 1em 0em 1em; font-size: 80%;'>
 
====User Comments====
 
====User Comments====
 
<!-- End of Pod2Wiki -->
 
<!-- End of Pod2Wiki -->

Revision as of 15:28, 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

User Comments

comments

comments

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.

User Comments

comments

comments

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();
 

User Comments

comments

comments

METHODS

User Comments

comments

comments

get_request

 $request = $handle->get_request;

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

User Comments

comments

comments

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.

User Comments

comments

comments

get_uri

 $uri = $handle->get_uri

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

User Comments

comments

comments

get_full_url

 $uri = $handle->get_full_url

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

User Comments

comments

comments

get_secure

 $secure = $handle->get_secure

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

User Comments

comments

comments

redirect

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

Redirects the browser to $url.

User Comments

comments

comments

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.

User Comments

comments

comments

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.

User Comments

comments

comments

have_parameters

 $bool = $handle->have_parameters

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

User Comments

comments

comments

current_user

 $user = $handle->current_user

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

Return undef if there isn't one.

User Comments

comments

comments

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.

User Comments

comments

comments

get_http_status

 $status = $handle->get_http_status

Return the status of the current HTTP request.

User Comments

comments

comments