view release on metacpan or  search on metacpan

lib/Gantry/Engine/MP13.pm  view on Meta::CPAN

=item $self->get_dbh

Returns the current regular database connection if one is available or
undef otherwise.

=item $self->get_post_body

If C<consume_post_body> was used by a plugin during the pre_init phase,
this method returns the consumed body of the HTTP POST request.

=item $self->header_in

The $r->headers_in method will return a %hash of client request headers.
This can be used to initialize a perl hash, or one could use the
$r->header_in() method (described below) to retrieve a specific header
value directly.

See mod_perl docs.

=item $self->header_out( $r, $header_key, $header_value )

Change the value of a response header, or create a new one.

=item $self->is_connection_secure()

Return whether the current request is being served by an SSL-enabled host.

=item $self->is_status_declined

Returns a true value if the status is currently DECLINED or false otherwise.

=item $self->log_error( message )

Writes message to the apache web server log

=item $self->port

Returns port number in which the request came in on.

=item $self->print_output( $response_page )

This method sends the contents of $response page back to apache.  It
uses the print method on the request object.

=item $self->redirect_response

Returns the proper numeric status code for REDIRECT.

=item $self->remote_ip

Returns the IP address for the remote user

=item $self->send_error_output

Returns the content of custom_error.  It gives $@ to the custom_error method.

=item $self->send_http_header( $r )

Send the response line and all headers to the client. Takes an optional
parameter indicating the content-type of the response, i.e. 'text/html'.

This method will create headers from the $r->content_xxx() and $r->no_cache() 
attributes (described below) and then append the headers defined by 
$r->header_out (or $r->err_header_out if status indicates an error).

See mod_perl 1.0 docs.

=item $self->server_root

Returns the value set by the top-level ServerRoot directive

=item set_cached_config

For internal use.  Used to place a config hash into pnotes for reuse
during the current page request.

=item $self->set_content_type()

Sets the content type stored in the site object's content_type attribute
on the apache request object.

=item $self->set_no_cache

Sets the no_cache flag in the apache request object with the value
for no_cache in the site object.

=item set_req_params

Sets up the apreq object and the form parameters from it.

=item $self->status_const( 'OK | DECLINED | REDIRECT' )

Get or set the reply status for the client request. The Apache::Constants
module provide mnemonic names for the status codes.

=item $self->success_code

Returns the proper numeric status code for OK.

=item url_encode

  url_encode($value)

Accepts a value and returns it url encoded.

=item url_decode

  url_decode($value)

Accepts a value and returns it url decoded.

=item $self->file_upload

Uploads a file from the client's disk.

Parameter: The name of the file input element on the html form.

Returns: A hash with these keys:

=over 4