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

From EPrints Documentation
Jump to: navigation, search
Line 2: Line 2:
 
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 --><div style='background-color: #f0f0ff; border: solid 1px: #e8e8ef;  padding: 0.25em;'>
+
<!-- Pod2Wiki=head_name --><div style='background-color: #eef; margin: 1em 0em 1em 0em; border: solid 1px: #cce;  padding: 1em;'>
 
==NAME==
 
==NAME==
 
'''EPrints::Handle::CGI''' - CGI methods for EPrints::Handle
 
'''EPrints::Handle::CGI''' - CGI methods for EPrints::Handle
  
 
</div><!-- End of Pod2Wiki -->
 
</div><!-- End of Pod2Wiki -->
<!-- Pod2Wiki=head_description --><div style='background-color: #f0f0ff; border: solid 1px: #e8e8ef;  padding: 0.25em;'>
+
<!-- Pod2Wiki=head_description --><div style='background-color: #eef; margin: 1em 0em 1em 0em; border: solid 1px: #cce;  padding: 1em;'>
 
==DESCRIPTION==
 
==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.
Line 14: Line 14:
  
 
</div><!-- End of Pod2Wiki -->
 
</div><!-- End of Pod2Wiki -->
<!-- Pod2Wiki=head_synopsis --><div style='background-color: #f0f0ff; border: solid 1px: #e8e8ef;  padding: 0.25em;'>
+
<!-- Pod2Wiki=head_synopsis --><div style='background-color: #eef; margin: 1em 0em 1em 0em; border: solid 1px: #cce;  padding: 1em;'>
 
==SYNOPSIS==
 
==SYNOPSIS==
 
   my $user = $handle-&gt;current_user;
 
   my $user = $handle-&gt;current_user;
Line 26: Line 26:
 
    
 
    
 
</div><!-- End of Pod2Wiki -->
 
</div><!-- End of Pod2Wiki -->
<!-- Pod2Wiki=head_methods --><div style='background-color: #f0f0ff; border: solid 1px: #e8e8ef;  padding: 0.25em;'>
+
<!-- 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 -->
<!-- Pod2Wiki=item_get_request --><div style='border: dashed 1px green'>
+
<!-- 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 37: Line 37:
  
 
</div><!-- End of Pod2Wiki -->
 
</div><!-- End of Pod2Wiki -->
<!-- Pod2Wiki=item_get_query --><div style='border: dashed 1px green'>
+
<!-- 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 45: Line 45:
  
 
</div><!-- End of Pod2Wiki -->
 
</div><!-- End of Pod2Wiki -->
<!-- Pod2Wiki=item_get_uri --><div style='border: dashed 1px green'>
+
<!-- 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 53: Line 53:
  
 
</div><!-- End of Pod2Wiki -->
 
</div><!-- End of Pod2Wiki -->
<!-- Pod2Wiki=item_get_full_url --><div style='border: dashed 1px green'>
+
<!-- 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 61: Line 61:
  
 
</div><!-- End of Pod2Wiki -->
 
</div><!-- End of Pod2Wiki -->
<!-- Pod2Wiki=item_get_secure --><div style='border: dashed 1px green'>
+
<!-- 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 69: Line 69:
  
 
</div><!-- End of Pod2Wiki -->
 
</div><!-- End of Pod2Wiki -->
<!-- Pod2Wiki=item_redirect --><div style='border: dashed 1px green'>
+
<!-- Pod2Wiki=item_redirect --><div style='background-color: #eef; margin: 1em 0em 1em 0em; border: solid 1px: #cce;  padding: 1em;'>
 
===redirect===
 
===redirect===
  
Line 77: Line 77:
  
 
</div><!-- End of Pod2Wiki -->
 
</div><!-- End of Pod2Wiki -->
<!-- Pod2Wiki=item_send_http_header --><div style='border: dashed 1px green'>
+
<!-- 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 91: Line 91:
  
 
</div><!-- End of Pod2Wiki -->
 
</div><!-- End of Pod2Wiki -->
<!-- Pod2Wiki=item_param --><div style='border: dashed 1px green'>
+
<!-- Pod2Wiki=item_param --><div style='background-color: #eef; margin: 1em 0em 1em 0em; border: solid 1px: #cce;  padding: 1em;'>
 
===param===
 
===param===
  
Line 105: Line 105:
  
 
</div><!-- End of Pod2Wiki -->
 
</div><!-- End of Pod2Wiki -->
<!-- Pod2Wiki=item_have_parameters --><div style='border: dashed 1px green'>
+
<!-- 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 113: Line 113:
  
 
</div><!-- End of Pod2Wiki -->
 
</div><!-- End of Pod2Wiki -->
<!-- Pod2Wiki=item_current_user --><div style='border: dashed 1px green'>
+
<!-- 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 123: Line 123:
  
 
</div><!-- End of Pod2Wiki -->
 
</div><!-- End of Pod2Wiki -->
<!-- Pod2Wiki=item_client --><div style='border: dashed 1px green'>
+
<!-- Pod2Wiki=item_client --><div style='background-color: #eef; margin: 1em 0em 1em 0em; border: solid 1px: #cce;  padding: 1em;'>
 
===client===
 
===client===
  
Line 139: Line 139:
  
 
</div><!-- End of Pod2Wiki -->
 
</div><!-- End of Pod2Wiki -->
<!-- Pod2Wiki=item_get_http_status --><div style='border: dashed 1px green'>
+
<!-- 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===
  

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