Docs For Class PHRUTS_MessageResourcesConfig

Description

A PHPBean representing the configuration information of a <message-resources> element in a PHruts 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_MessageResourcesConfig.php,v 1.6 2008/05/28 15:52:27 ohenry Exp $
copyright: Copyright PHruts 2008

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

Variable Summary

boolean $configured

string $factory

string $key

boolean $nullValue

string $parameter

Method Summary

void freeze ()

string getFactory ()

string getKey ()

boolean getNull ()

string getParameter ()

void setFactory (string $factory)

void setKey (string $key)

void setNull (boolean $nullValue)

void setParameter (string $parameter)

string __toString ()

Variables

boolean $configured = false (line 37)

Has this component been completely configured?

access: protected

string $factory = 'phruts::util::PHRUTS_PropertyMessageResourcesFactory' (line 52)

Fully qualified PHP class name of the PHRUTS_MessageResourcesFactory class we should use.

access: protected

string $key = PHRUTS_Globals::MESSAGES_KEY (line 104)

The service context attributes key under which this PHRUTS_MessageResources instance is stored.

access: protected

boolean $nullValue = true (line 129)

Should we return null for unknown message keys?

access: protected

string $parameter = null (line 78)

Parameter that is passed to the createResources method of our PHRUTS_MessageResourcesFactory implementation.

access: protected

Methods

freeze (line 42)

Freeze the configuration of this component.

access: public

void freeze ()

getFactory (line 57)

access: public

string getFactory ()

getKey (line 109)

access: public

string getKey ()

getNull (line 134)

access: public

boolean getNull ()

getParameter (line 83)

access: public

string getParameter ()

setFactory (line 65)

throws: PHRUTS_IllegalStateException
access: public

void setFactory (string $factory)

string $factory

setKey (line 117)

throws: PHRUTS_IllegalStateException
access: public

void setKey (string $key)

string $key

setNull (line 142)

throws: PHRUTS_IllegalStateException
access: public

void setNull (boolean $nullValue)

boolean $nullValue

setParameter (line 91)

throws: PHRUTS_IllegalStateException
access: public

void setParameter (string $parameter)

string $parameter

__toString (line 159)

Return a String representation of this object.

access: public

string __toString ()