Docs For Class ActionForward

Class ActionForward

Object
   |
   --ActionForward

Classes extended from ActionForward:

Located in File: Program_Root/ActionForward.php

The ActionForward class represents a destination to which the
 ActionController might be directed to forward or redirect to, as a result of
 the processing activities of an Action class. Instances of this class may be
 created dynamically as necessary, or configured in association with an
 ActionMapping instance for named lookup of potentially multiple destinations
 for a particular ActionMapping instance.

 An ActionForward has the following minimal set of properties. Additional
 properties can be provided as needed by subclasses.
 
 name - Logical name by which this instance may be looked up in
 relationship to a particular ActionMapping.
 path - The absolute or relative URI to which control should be
 forwarded or redirected.
 redirect - Set to 1 if the ActionController should kill the
 session and redirect on the URI. [0]

Package - phrame
Version - $Id: ActionForward.html,v 1.1.1.1 2002/11/19 16:47:22 arcano Exp $
Author - Arnold Cano

Class Variable Summary

$_name

Default Value: -><-

$_path

Default Value: -><-

$_redirect

Default Value: ->0<-

Inherited Class Variable Summary

Inherited Method Summary

Inherited From Class Object

Function Description

clone ( )
equals ( [$object = ] )
toString ( )

Method Summary

void constructor ActionForward ( $name, $forward )

string getName ( )

string getPath ( )

integer getRedirect ( )

void setName ( $name )

void setPath ( $path )

void setRedirect ( $redirect )

Variable Detail

$_name

Data type: string

$_path

Data type: string

$_redirect

Data type: integer

Method Detail

constructor ActionForward

void constructor ActionForward ( $name, $forward )

Create an ActionForward with the specified values.

Function Parameters:: - string $name:; - array $forward:
Function Info:: Access - public

getName

string getName ( )

Get the name of the ActionForward.

Function Parameters:
Function Info:: Access - public

getPath

string getPath ( )

Get the path of the ActionForward.

Function Parameters:
Function Info:: Access - public

getRedirect

integer getRedirect ( )

Get the redirect flag of the ActionForward.

Function Parameters:
Function Info:: Access - public

setName

void setName ( $name )

Set the name of the ActionForward.

Function Parameters:: - string $name:
Function Info:: Access - public

setPath

void setPath ( $path )

Set the path of the ActionForward.

Function Parameters:: - string $path:
Function Info:: Access - public

setRedirect

void setRedirect ( $redirect )

Set the redirect flag of the ActionForward.

Function Parameters:: - integer $redirect:
Function Info:: Access - public