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

From EPrints Documentation
Jump to: navigation, search
Line 11: Line 11:
  
 
</div><!-- End of Pod2Wiki -->
 
</div><!-- End of Pod2Wiki -->
 
+
====comments====
 
 
 
<!-- Pod2Wiki=head_description --><div style='background-color: #eef; margin: 1em 0em 1em 0em; border: solid 1px #cce;  padding: 1em;'>
 
<!-- Pod2Wiki=head_description --><div style='background-color: #eef; margin: 1em 0em 1em 0em; border: solid 1px #cce;  padding: 1em;'>
 
==DESCRIPTION==
 
==DESCRIPTION==
Line 20: Line 19:
  
 
</div><!-- End of Pod2Wiki -->
 
</div><!-- End of Pod2Wiki -->
 
+
====comments====
 
 
 
<!-- Pod2Wiki=head_synopsis --><div style='background-color: #eef; margin: 1em 0em 1em 0em; border: solid 1px #cce;  padding: 1em;'>
 
<!-- Pod2Wiki=head_synopsis --><div style='background-color: #eef; margin: 1em 0em 1em 0em; border: solid 1px #cce;  padding: 1em;'>
 
==SYNOPSIS==
 
==SYNOPSIS==
Line 34: Line 32:
 
    
 
    
 
</div><!-- End of Pod2Wiki -->
 
</div><!-- End of Pod2Wiki -->
 
+
====comments====
 
 
 
<!-- Pod2Wiki=head_methods --><div style='background-color: #eef; margin: 1em 0em 1em 0em; border: solid 1px #cce;  padding: 1em;'>
 
<!-- Pod2Wiki=head_methods --><div style='background-color: #eef; margin: 1em 0em 1em 0em; border: solid 1px #cce;  padding: 1em;'>
 
==METHODS==
 
==METHODS==
 
</div><!-- End of Pod2Wiki -->
 
</div><!-- End of Pod2Wiki -->
 
+
====comments====
 
 
 
<!-- Pod2Wiki=item_get_request --><div style='background-color: #eef; margin: 1em 0em 1em 0em; border: solid 1px #cce;  padding: 1em;'>
 
<!-- Pod2Wiki=item_get_request --><div style='background-color: #eef; margin: 1em 0em 1em 0em; border: solid 1px #cce;  padding: 1em;'>
 
===get_request===
 
===get_request===
Line 49: Line 45:
  
 
</div><!-- End of Pod2Wiki -->
 
</div><!-- End of Pod2Wiki -->
 
+
====comments====
 
 
 
<!-- Pod2Wiki=item_get_query --><div style='background-color: #eef; margin: 1em 0em 1em 0em; border: solid 1px #cce;  padding: 1em;'>
 
<!-- Pod2Wiki=item_get_query --><div style='background-color: #eef; margin: 1em 0em 1em 0em; border: solid 1px #cce;  padding: 1em;'>
 
===get_query===
 
===get_query===
Line 59: Line 54:
  
 
</div><!-- End of Pod2Wiki -->
 
</div><!-- End of Pod2Wiki -->
 
+
====comments====
 
 
 
<!-- Pod2Wiki=item_get_uri --><div style='background-color: #eef; margin: 1em 0em 1em 0em; border: solid 1px #cce;  padding: 1em;'>
 
<!-- Pod2Wiki=item_get_uri --><div style='background-color: #eef; margin: 1em 0em 1em 0em; border: solid 1px #cce;  padding: 1em;'>
 
===get_uri===
 
===get_uri===
Line 69: Line 63:
  
 
</div><!-- End of Pod2Wiki -->
 
</div><!-- End of Pod2Wiki -->
 
+
====comments====
 
 
 
<!-- Pod2Wiki=item_get_full_url --><div style='background-color: #eef; margin: 1em 0em 1em 0em; border: solid 1px #cce;  padding: 1em;'>
 
<!-- Pod2Wiki=item_get_full_url --><div style='background-color: #eef; margin: 1em 0em 1em 0em; border: solid 1px #cce;  padding: 1em;'>
 
===get_full_url===
 
===get_full_url===
Line 79: Line 72:
  
 
</div><!-- End of Pod2Wiki -->
 
</div><!-- End of Pod2Wiki -->
 
+
====comments====
 
 
 
<!-- Pod2Wiki=item_get_secure --><div style='background-color: #eef; margin: 1em 0em 1em 0em; border: solid 1px #cce;  padding: 1em;'>
 
<!-- Pod2Wiki=item_get_secure --><div style='background-color: #eef; margin: 1em 0em 1em 0em; border: solid 1px #cce;  padding: 1em;'>
 
===get_secure===
 
===get_secure===
Line 89: Line 81:
  
 
</div><!-- End of Pod2Wiki -->
 
</div><!-- End of Pod2Wiki -->
 
+
====comments====
 
 
 
<!-- Pod2Wiki=item_redirect --><div style='background-color: #eef; margin: 1em 0em 1em 0em; border: solid 1px #cce;  padding: 1em;'>
 
<!-- Pod2Wiki=item_redirect --><div style='background-color: #eef; margin: 1em 0em 1em 0em; border: solid 1px #cce;  padding: 1em;'>
 
===redirect===
 
===redirect===
Line 99: Line 90:
  
 
</div><!-- End of Pod2Wiki -->
 
</div><!-- End of Pod2Wiki -->
 
+
====comments====
 
 
 
<!-- Pod2Wiki=item_send_http_header --><div style='background-color: #eef; margin: 1em 0em 1em 0em; border: solid 1px #cce;  padding: 1em;'>
 
<!-- Pod2Wiki=item_send_http_header --><div style='background-color: #eef; margin: 1em 0em 1em 0em; border: solid 1px #cce;  padding: 1em;'>
 
===send_http_header===
 
===send_http_header===
Line 115: Line 105:
  
 
</div><!-- End of Pod2Wiki -->
 
</div><!-- End of Pod2Wiki -->
 
+
====comments====
 
 
 
<!-- Pod2Wiki=item_param --><div style='background-color: #eef; margin: 1em 0em 1em 0em; border: solid 1px #cce;  padding: 1em;'>
 
<!-- Pod2Wiki=item_param --><div style='background-color: #eef; margin: 1em 0em 1em 0em; border: solid 1px #cce;  padding: 1em;'>
 
===param===
 
===param===
Line 131: Line 120:
  
 
</div><!-- End of Pod2Wiki -->
 
</div><!-- End of Pod2Wiki -->
 
+
====comments====
 
 
 
<!-- Pod2Wiki=item_have_parameters --><div style='background-color: #eef; margin: 1em 0em 1em 0em; border: solid 1px #cce;  padding: 1em;'>
 
<!-- Pod2Wiki=item_have_parameters --><div style='background-color: #eef; margin: 1em 0em 1em 0em; border: solid 1px #cce;  padding: 1em;'>
 
===have_parameters===
 
===have_parameters===
Line 141: Line 129:
  
 
</div><!-- End of Pod2Wiki -->
 
</div><!-- End of Pod2Wiki -->
 
+
====comments====
 
 
 
<!-- Pod2Wiki=item_current_user --><div style='background-color: #eef; margin: 1em 0em 1em 0em; border: solid 1px #cce;  padding: 1em;'>
 
<!-- Pod2Wiki=item_current_user --><div style='background-color: #eef; margin: 1em 0em 1em 0em; border: solid 1px #cce;  padding: 1em;'>
 
===current_user===
 
===current_user===
Line 153: Line 140:
  
 
</div><!-- End of Pod2Wiki -->
 
</div><!-- End of Pod2Wiki -->
 
+
====comments====
 
 
 
<!-- Pod2Wiki=item_client --><div style='background-color: #eef; margin: 1em 0em 1em 0em; border: solid 1px #cce;  padding: 1em;'>
 
<!-- Pod2Wiki=item_client --><div style='background-color: #eef; margin: 1em 0em 1em 0em; border: solid 1px #cce;  padding: 1em;'>
 
===client===
 
===client===
Line 171: Line 157:
  
 
</div><!-- End of Pod2Wiki -->
 
</div><!-- End of Pod2Wiki -->
 
+
====comments====
 
 
 
<!-- Pod2Wiki=item_get_http_status --><div style='background-color: #eef; margin: 1em 0em 1em 0em; border: solid 1px #cce;  padding: 1em;'>
 
<!-- Pod2Wiki=item_get_http_status --><div style='background-color: #eef; margin: 1em 0em 1em 0em; border: solid 1px #cce;  padding: 1em;'>
 
===get_http_status===
 
===get_http_status===
Line 181: Line 166:
  
 
</div><!-- End of Pod2Wiki -->
 
</div><!-- End of Pod2Wiki -->
 
+
====comments====
 
 
 
<!-- Pod2Wiki=_postamble_ --><!-- End of Pod2Wiki -->
 
<!-- Pod2Wiki=_postamble_ --><!-- End of Pod2Wiki -->

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

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.

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

comments

METHODS

comments

get_request

 $request = $handle->get_request;

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

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.

comments

get_uri

 $uri = $handle->get_uri

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

comments

get_full_url

 $uri = $handle->get_full_url

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

comments

get_secure

 $secure = $handle->get_secure

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

comments

redirect

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

Redirects the browser to $url.

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.

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.

comments

have_parameters

 $bool = $handle->have_parameters

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

comments

current_user

 $user = $handle->current_user

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

Return undef if there isn't one.

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.

comments

get_http_status

 $status = $handle->get_http_status

Return the status of the current HTTP request.

comments