P5EEx::Blue::Request

• NAME
• SYNOPSIS
• DESCRIPTION
• Class Group: Request
• Constructor Methods:
• new()
• Protected Methods:
• init()
• Public Methods
• user()

NAME

P5EEx::Blue::Request - the request

SYNOPSIS

   # ... official way to get a Request object ...
   use P5EEx::Blue::P5EE;
   $context = P5EEx::Blue::P5EE->context();
   $request = $context->request();  # get the request

   # ... alternative way (used internally) ...
   use P5EEx::Blue::Request;
   $request = P5EEx::Blue::Request->new();

DESCRIPTION

A Request class ...

Class Group: Request

The following classes might be a part of the Request Class Group.

• Class: P5EEx::Blue::Request
  
• Class: P5EEx::Blue::Request::CGI
  

Constructor Methods:

new()

The P5EEx::Blue::Request->new() method is rarely called directly. That is because the current request is usually accessed through the $context object.

    * Signature: $request = P5EEx::Blue::Request->new($context, $named);
    * Return: $request     P5EEx::Blue::Request
    * Throws: P5EEx::Blue::Exception
    * Since:  0.01

    Sample Usage:

    $request = P5EEx::Blue::Request->new();

Protected Methods:

The following methods are intended to be called by subclasses of the current class (or environmental, ``main'' code).

init()

The init() method is called from within the standard Request constructor. The init() method in this class does nothing. It allows subclasses of the Request to customize the behavior of the constructor by overriding the init() method.

    * Signature: $request->init()
    * Param:     void
    * Return:    void
    * Throws:    P5EEx::Blue::Exception
    * Since:     0.01

    Sample Usage:

    $request->init();

Public Methods

user()

The user() method returns the username of the authenticated user. The special name, ``guest'', refers to the unauthenticated (anonymous) user.

    * Signature: $username = $request->user();
    * Param:  void
    * Return: string
    * Throws: <none>
    * Since:  0.01

    Sample Usage:

    $username = $request->user();