Class TBrookAction

Creates an instance of a TBrookAction class.

Creates an instance of a TBrookAction class passing params to request/response.

Frees an instance of TBrookAction class.

Registers an action.

Parameters

APattern

Is an expression defining which URLs is used to call an action. It is possible to use variables inside URLs:

:name – Represents a variable that spans single URL component between slashes.

Examples:

TMyAction.Register('/foo/:myvar');

Value of a variable "myvar" can be read from the property Variables or Variable, e.g.:

Write(Variables.Values['myvar']);

Write(Variable['myvar']);

Any number of variables can be combined:

TMyAction.Register('/foo/:cat/:id');

*name – Represents a variable that spans one or more levels between slashes in the current URL.

Examples:

TMyAction.Register('/home/*path');

Any of the following URLs will match:

http://localhost/cgi-bin/cgi1/home/file
http://localhost/cgi-bin/cgi1/home/dir/file
http://localhost/cgi-bin/cgi1/home/dir/subdir/file etc.

Variable Variables.Values['path'] will receive 'file', 'dir/file' or 'dir/subdir/file' correspondingly.

You can also add static text after variable part:

TMyAction.Register('/home/*path/download');

http://localhost/cgi-bin/cgi1/home/dir/file/download – This will match,
http://localhost/cgi-bin/cgi1/home/dir/file/info – but not this, because ending is different.

Multi-level variable can be combined with any number of single-level variables in any order:

TMyAction.Register('/home/user/:uid/file/*fpath/version/:vid/info');

NOTE: Only one multi-level variable can be specified per URL.

url/ – Adds a slash to the end of the URL if does not exist.

Example:

TMyAction.Register('/foo/');

An action can be accessed as http://localhost/cgi-bin/cgi1/foo or http://localhost/cgi-bin/cgi1/foo/. When called as http://localhost/cgi-bin/cgi1/foo, it will be automatically redirected to http://localhost/cgi-bin/cgi1/foo/. If the pathinfo is different from /foo a 404 page is returned;

NOTE: Two actions can't be registered with the same pattern except when they are called by means of different HTTP methods.

ADefault

A action registered as Default will be called automatically if the URL does not match with Pattern of any registered actions. It is not allowed to register more than one action as default. A typical example of use is:

TMyAction.Register('*', True);

Registers an action specifying the HTTP request method.

Parameters

AMethod

Informs the HTTP request method being valid the following options: rmAll, rmGet, rmHead, rmOptions, rmPost, rmPut or rmDelete. The only way to register two actions with the same pattern is differentiating the value of this parameter. If at least one action has this parameter changed, the route mapping is enabled in Mapped. A typical example of use is:

@(longcode
procedure TMyAction1.Get;
begin
  Write('GET');
end;

procedure TMyAction1.Put;
begin
  Write('PUT');
end;

procedure TMyAction2.Post;
begin
  Write('POST');
end;

initialization
  TMyAction1.Register('/foo1', rmGet);
  TMyAction1.Register('/foo1', rmPut);
  TMyAction2.Register('/foo1', rmPost);)

Returns the path of action. Exemple:

/cgi-bin/cgi1/myaction.

Fills the Variables with the registered variables passed through the URL.

Fills the Variables with the registered variables passed one by one through the URL.

Creates a cookie.

Get a cookie value.

Deletes a cookie.

Calls the method Request.

Is triggered by a request of any HTTP method.

Get an object with the fields coming from a x-www-form-urlencoded form.

Get an object with the params coming from a QUERY_STRING.

Get an object with the variables coming from an URL.

Creates an URL for action.

Creates an URL for an action informing an array of parameters. Exemple:

@(longcode
      procedure TMyAction.Get;
      begin
        // When calling with http://localhost/cgi-bin/cgi1/foo/myvalue
        // the output will be /cgi-bin/cgi1/foo/myvalue
        Write(UrlFor(TMyAction, ['myvalue']));
      end;

      initialization
        TMyAction.Register('/foo/:myvar');)

Creates an URL for an action passing an array of parameters however informing the class name as string.

Creates an URL for an action informing the class name as string.

Is triggered by a GET HTTP request method.

Is triggered by a POST HTTP request method.

Is triggered by a PUT HTTP request method.

Is triggered by a PATCH HTTP request method.

Is triggered by a DELETE HTTP request method.

Is triggered by a HEAD HTTP request method.

Is triggered by an OPTIONS HTTP request method.

Redirects to an URL.

Redirects to an URL informing the (302, 307) status code.

Redirects to an URL informing the root URL.

Redirects to an URL informing the (302, 307) status code and the ScriptName.

Raises a message for action exceptions.

Raises a formated message for action exceptions.

Stops the action showing an exception message.

Stops the action showing a formatted exception message.

Writes the content of a file.

Writes the content of a file passing parameters to the output.

Clears all written content with Write(), WriteLn(), Render() etc.

Checks if a name exists in fields.

Writes a string.

Writes a boolean.

Writes an integer.

Writes a float.

Writes an object.

Writes an object allowing to ignore properties via an array of strings.

Writes an object allowing to ignore properties via a list of strings.

Writes a content of stream.

Writes a formatted string.

Handles the fields of a form.

Handles the Query_String parameters of a URL.

Handles variables from a parametrized URL.

Handles a file list of fields of a form.

Handles a string list of fields of a form.

Handles a string list of the Query_String parameters of a URL.

Handles a string list of variables from a parametrized URL.

Returns the HTTP request method.

Provides services related to HTTP requests drived to a webserver.

Provides services related to the HTTP responses comming back from a webserver.