Moodle  2.2.1
http://www.collinsharper.com
environment_results Class Reference

Public Member Functions

 environment_results ($part)
 setStatus ($status)
 setErrorCode ($error_code)
 setLevel ($level)
 setCurrentVersion ($current_version)
 setNeededVersion ($needed_version)
 setInfo ($info)
 setFeedbackStr ($str)
 setBypassStr ($str)
 setRestrictStr ($str)
 getStatus ()
 getErrorCode ()
 getLevel ()
 getCurrentVersion ()
 getNeededVersion ()
 getInfo ()
 getPart ()
 getFeedbackStr ()
 getBypassStr ()
 getRestrictStr ()
 strToReport ($string, $class)

Data Fields

 $part
 $status
 $error_code
 $level
 $current_version
 $needed_version
 $info
 $feedback_str
 $bypass_str
 $restrict_str

Detailed Description

Definition at line 1056 of file environmentlib.php.


Member Function Documentation

environment_results ( part)

Constructor of the environment_result class. Just set default values

Parameters:
string$part

Definition at line 1103 of file environmentlib.php.

Here is the call graph for this function:

Get the bypass string

Returns:
mixed bypass string (can be an array of params for get_string or a single string to fetch from admin.php lang file).

Definition at line 1289 of file environmentlib.php.

Get the current version

Returns:
string current version

Definition at line 1242 of file environmentlib.php.

Get the error code

Returns:
integer error code

Definition at line 1224 of file environmentlib.php.

Get the feedback string

Returns:
mixed feedback string (can be an array of params for get_string or a single string to fetch from admin.php lang file).

Definition at line 1279 of file environmentlib.php.

getInfo ( )

Get the aux info

Returns:
string info

Definition at line 1260 of file environmentlib.php.

Here is the call graph for this function:

getLevel ( )

Get the level

Returns:
string level

Definition at line 1233 of file environmentlib.php.

Get the needed version

Returns:
string needed version

Definition at line 1251 of file environmentlib.php.

getPart ( )

Get the part this result belongs to

Returns:
string part

Definition at line 1269 of file environmentlib.php.

Get the restrict string

Returns:
mixed restrict string (can be an array of params for get_string or a single string to fetch from admin.php lang file).

Definition at line 1299 of file environmentlib.php.

getStatus ( )

Get the status

Returns:
boolean result

Definition at line 1215 of file environmentlib.php.

setBypassStr ( str)

Set the bypass string

Parameters:
string$strthe bypass string that will be fetched from the admin lang file. pass just the string or pass an array of params for get_string You always should put your string in admin.php but a third param is useful to pass an $a object / string to get_string

Definition at line 1194 of file environmentlib.php.

setCurrentVersion ( current_version)

Set the current version

Parameters:
string$current_versionthe current version

Definition at line 1151 of file environmentlib.php.

setErrorCode ( error_code)

Set the error_code

Parameters:
integer$error_codethe error code (see constants above)

Definition at line 1133 of file environmentlib.php.

Here is the caller graph for this function:

setFeedbackStr ( str)

Set the feedback string

Parameters:
mixed$strthe feedback string that will be fetched from the admin lang file. pass just the string or pass an array of params for get_string You always should put your string in admin.php but a third param is useful to pass an $a object / string to get_string

Definition at line 1181 of file environmentlib.php.

setInfo ( info)

Set the auxiliary info

Parameters:
string$infothe auxiliary info

Definition at line 1169 of file environmentlib.php.

Here is the call graph for this function:

setLevel ( level)

Set the level

Parameters:
string$levelthe level (required, optional)

Definition at line 1142 of file environmentlib.php.

setNeededVersion ( needed_version)

Set the needed version

Parameters:
string$needed_versionthe needed version

Definition at line 1160 of file environmentlib.php.

setRestrictStr ( str)

Set the restrict string

Parameters:
string$strthe restrict string that will be fetched from the admin lang file. pass just the string or pass an array of params for get_string You always should put your string in admin.php but a third param is useful to pass an $a object / string to get_string

Definition at line 1206 of file environmentlib.php.

setStatus ( status)

Set the status

Parameters:
boolean$statusthe status (true/false)

Definition at line 1121 of file environmentlib.php.

Here is the call graph for this function:

strToReport ( string,
class 
)
Todo:
Document this function
Parameters:
mixed$stringparams for get_string, either a string to fetch from admin.php or an array of params for get_string.
string$classcss class(es) for message.
Returns:
string feedback string fetched from lang file wrapped in p tag with class $class or returns empty string if $string is empty.

Definition at line 1312 of file environmentlib.php.


Field Documentation

$bypass_str

Definition at line 1092 of file environmentlib.php.

$current_version

Definition at line 1076 of file environmentlib.php.

$error_code

Definition at line 1068 of file environmentlib.php.

$feedback_str

Definition at line 1088 of file environmentlib.php.

$info

Definition at line 1084 of file environmentlib.php.

$level

Definition at line 1072 of file environmentlib.php.

$needed_version

Definition at line 1080 of file environmentlib.php.

$part

Definition at line 1060 of file environmentlib.php.

$restrict_str

Definition at line 1096 of file environmentlib.php.

$status

Definition at line 1064 of file environmentlib.php.


The documentation for this class was generated from the following file:
 All Data Structures Namespaces Files Functions Variables Enumerations