Richard Clamp > OpenFrame-3.05 > OpenFrame::Response

Download:
OpenFrame-3.05.tar.gz

Dependencies

Annotate this POD

CPAN RT

New  4
Open  3
View/Report Bugs
Module Version: 3.05   Source  

NAME ^

OpenFrame::Response - An abstract response class

SYNOPSIS ^

  use OpenFrame;
  use OpenFrame::Constants;
  my $r = OpenFrame::Response->new();
  $r->message("<html><body>Hello world!</body></html>");
  $r->mimetype('text/html');
  $r->code(ofOK);
  $r->cookies(OpenFrame::Cookies->new());

DESCRIPTION ^

OpenFrame::Response represents responses inside OpenFrame. Responses represent some kind of response following a request for information.

This module abstracts the way clients can respond with data from OpenFrame.

METHODS ^

new()

This method creates a new OpenFrame::Response object. It takes no parameters.

cookies()

This method gets and sets the OpenFrame::Cookietin that is associated with this response.

  my $cookietin = $r->cookies();
  $r->cookies(OpenFrame::Cookies->new());

message()

This method gets and sets the message string associated with this response. A scalar reference can be stored. It will always be returned as a scalar.

  my $message = $r->message();
  $r->message("<html><body>Hello world!</body></html>");

code()

This method gets and sets the message code associated with this response. The following message codes are exported when you use OpenFrame::Constants: ofOK, ofERROR, ofREDIRECT, ofDECLINE.

  my $code = $r->code();
  $r->code(ofOK);

mimetype()

This method gets and sets the MIME type associated with this response.

  my $type = $r->mimetype();
  $r->mimetype('text/html');

AUTHOR ^

James Duncan <jduncan@fotango.com>

syntax highlighting: