Docs For Class ActionMapping

Class ActionMapping

Object
   |
   --HashMap
      |
      --ActionMapping

Classes extended from ActionMapping:

Located in File: Program_Root/ActionMapping.php

The ActionMapping class represents the information that the ActionController
 knows about the ActionMapping of a particular request to an instance of a
 particular Action class. The ActionMapping is passed to the perform() method
 of the Action class itself, enabling access to this information directly.

 An ActionMapping has the following minimal set of properties. Additional
 properties can be provided as needed by subclasses.
 
 type - Class name of the Action class used by this ActionMapping.
 
 name - Name of the ActionForm class, if any, associated with this
 Action.
 input - Path of the input form to which control should be
 returned if a validation error is encountered.
 validate - Set to 1 if the validate() method of the ActionForm
 class (if any) associated with this ActionMapping should be called. [0]

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

Class Variable Summary

$_input

Default Value: -><-

$_name

Default Value: -><-

$_type

Default Value: -><-

$_validate

Default Value: ->0<-

Inherited Class Variable Summary

Inherited From Class HashMap

Variable Default Value Description

$_values ->array()<-

Inherited Method Summary

Inherited From Class HashMap

Function Description

constructor HashMap ( [$values = array()] )
clear ( )
containsKey ( $key )
containsValue ( $value )
get ( $key )
isEmpty ( )
keySet ( )
put ( $key, $value )
putAll ( $values )
remove ( $key )
size ( )
values ( )

Inherited From Class Object

Function Description

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

Method Summary

void constructor ActionMapping ( $name, $mapping )

string getInput ( )

string getName ( )

string getType ( )

integer getValidate ( )

void setInput ( $input )

void setName ( $name )

void setType ( $type )

void setValidate ( $validate )

void _initActionForwards ( $forwards )

Variable Detail

$_input

Data type: string

$_name

Data type: string

$_type

Data type: string

$_validate

Data type: string

Method Detail

constructor ActionMapping

void constructor ActionMapping ( $name, $mapping )

Create a ActionMapping with the specified values.

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

getInput

string getInput ( )

Get the input URI of the ActionForward.

Function Parameters:
Function Info:: Access - public

getName

string getName ( )

Get the name of the ActionForward.

Function Parameters:
Function Info:: Access - public

getType

string getType ( )

Get the type of the ActionForward.

Function Parameters:
Function Info:: Access - public

getValidate

integer getValidate ( )

Get the validate flag of the ActionForward.

Function Parameters:
Function Info:: Access - public

setInput

void setInput ( $input )

Set the input URI of the ActionForward.

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

setName

void setName ( $name )

Set the name of the ActionForward.

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

setType

void setType ( $type )

Set the type of the ActionForward.

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

setValidate

void setValidate ( $validate )

Set the validate flag of the ActionForward.

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

_initActionForwards

void _initActionForwards ( $forwards )

Initialize the ActionForwards array associated with this
 ActionMapping.

Function Parameters:: - array $forwards:
Function Info:: Access - private