Zend_Environment_Security_TestLocated in /Environment/Security/Test.php (line 30)
void
setMessageForResult
(integer $result_code, [string $language_code = self::LANG_DEFAULT], string $message)
mixed
$_current_value
= NULL (line 104)
Enter description here...
mixed
$_data
= array(
string
$_group
= NULL (line 57)
This value is used to group test results together.
For example, all tests related to the mysql lib should be grouped under "mysql."
string
$_language
= self::LANG_DEFAULT (line 97)
the language code. Should be a pointer to the setting in the PhpSecInfo object
string
$_message
= NULL (line 89)
The message corresponding to the result of the test
array
$_messages
= array() (line 116)
This is a hash of messages that correspond to various test result levels.
There are five messages, each corresponding to one of the result constants (self::RESULT_OK, self::RESULT_NOTICE, self::RESULT_WARN, self::RESULT_ERROR, self::RESULT_NOTRUN)
string
$_name
= NULL (line 65)
This should be a unique, human-readable identifier for this test
mixed
$_recommended_value
= NULL (line 73)
This is the recommended value the test will be looking for
integer
$_result
= self::RESULT_NOTRUN (line 81)
The result returned from the test
Constructor __construct (line 132)
Constructor for Test skeleton class
getCurrentTestValue (line 259)
returns the current value. This function should be used to access the value for display. All values are cast as strings
getIniValue (line 434)
This method converts the several possible return values from allegedly "boolean" ini settings to proper booleans
Properly converted input values are: 'off', 'on', 'false', 'true', '', '0', '1' (the last two might not be neccessary, but I'd rather be safe)
If the ini_value doesn't match any of those, the value is returned as-is.
getMessage (line 214)
Retrieves the message for the current result
getMoreInfoURL (line 306)
Returns a link to a page with detailed information about the test
URL is formatted as self::MOREINFO_BASEURL + testName
getRecommendedTestValue (line 269)
returns the recommended value. This function should be used to access the value for display. All values are cast as strings
getResult (line 202)
Retrieves the result
getStringValue (line 413)
This just does the usual PHP string casting, except for the boolean FALSE value, where the string "0" is returned instead of an empty string
getTestGroup (line 354)
Returns the test group this test belongs to
getTestName (line 324)
This retrieves the name of this test.
If a name has not been set, this returns a formatted version of the class name.
isTestable (line 150)
Determines whether or not it's appropriate to run this test (for example, if this test is for a particular library, it shouldn't be run if the lib isn't loaded).
This is a terrible name, but I couldn't think of a better one atm.
osIsWindows (line 495)
A quick function to determine whether we're running on Windows.
Uses the PHP_OS constant.
returnBytes (line 383)
This function takes the shorthand notation used in memory limit settings for PHP and returns the byte value. Totally stolen from http://us3.php.net/manual/en/function.ini-get.php
setMessageForResult (line 236)
Sets the message for a given result code and language
setTestGroup (line 365)
sets the test group. This is private, and intended for loading data from an external config file (to-do)
setTestName (line 344)
sets the test name. This is private, and intended for loading data from an external config file (to-do)
sys_get_temp_dir (line 475)
sys_get_temp_dir provides some temp dir detection capability that is lacking in versions of PHP that do not have the sys_get_temp_dir() function
test (line 189)
This is the wrapper that executes the test and sets the result code and message
_execTest (line 158)
The "meat" of the test. This is where the real test code goes. You should override this when extending
_retrieveCurrentValue (line 182)
Placeholder - extend for tests
_setMessage (line 290)
Sets the $this->_message variable based on the passed result and language codes
_setMessages (line 170)
This function loads up result messages into the $this->_messages array.
Using this method rather than setting $this->_messages directly allows result messages to be inherited. This is broken out into a separate function rather than the constructor for ease of extension purposes (don't have to include a __construct() method in all extended classes).
_setResult (line 279)
Sets the result code
Documentation generated on Wed, 21 Feb 2007 12:03:02 -0800 by phpDocumentor 1.3.1