Class PHRUTS_ForwardConfig

Description

A PHPBean representing the configuration information of a <forward> element from a PHruts application configuration file.

  • author: John WILDENAUER <jwilde@users.sourceforge.net> (PHP4 port of Struts)
  • author: Olivier HENRY <oliv.henry@gmail.com> (PHP5 port of Struts)
  • version: $Id: PHRUTS_ForwardConfig.php,v 1.4 2008/05/21 15:12:33 ohenry Exp $
  • copyright: Copyright PHruts 2008

Located in /config/PHRUTS_ForwardConfig.php (line 31)


	
			
Variable Summary
boolean $configured
string $name
string $path
boolean $redirect
Method Summary
void freeze ()
string getName ()
string getPath ()
boolean getRedirect ()
void setName (string $name)
void setPath (string $path)
void setRedirect (boolean $redirect)
string __toString ()
Variables
boolean $configured = false (line 37)

Has this component been completely configured?

  • access: protected
string $name = null (line 52)

The unique identifier of this forward, which is used to reference it in PHRUTS_Action classes.

  • access: protected
string $path = null (line 77)

The URL to which this PHRUTS_ForwardConfig entry points.

  • access: protected
boolean $redirect = false (line 102)

Should a redirect be used to transfer control to the specified path?

  • access: protected
Methods
freeze (line 42)

Freeze the configuration of this component.

  • access: public
void freeze ()
getName (line 57)
  • access: public
string getName ()
getPath (line 82)
  • access: public
string getPath ()
getRedirect (line 107)
  • access: public
boolean getRedirect ()
setName (line 65)
  • throws: PHRUTS_IllegalStateException
  • access: public
void setName (string $name)
  • string $name
setPath (line 90)
  • throws: PHRUTS_IllegalStateException
  • access: public
void setPath (string $path)
  • string $path
setRedirect (line 115)
  • throws: PHRUTS_IllegalStateException
  • access: public
void setRedirect (boolean $redirect)
  • boolean $redirect
__toString (line 132)

Return a String representation of this object.

  • access: public
string __toString ()

Documentation generated on Sat, 31 May 2008 15:46:04 +0200 by phpDocumentor 1.4.1