Xoops\Core\Service\Response Class Reference

Public Member Functions
	__constructor ($value=null, $success=true, $errorMessage=null)
	addErrorMessage ($errorMessage)
	getErrorMessage ()
	getValue ()
	isSuccess ()
	setSuccess ($success)
	setValue ($value)

Protected Attributes
	$errorMessage = null
	$success = true
	$value = null

Detailed Description

Definition at line 30 of file Response.php.

Member Function Documentation

Xoops\Core\Service\Response::__constructor	(		$value = null,
			$success = true,
			$errorMessage = null
	)

__constructor

Parameters

mixed	$value	- value returned by provider
boolean	$success	- true if service request was successful
mixed	$errorMessage	- string or array of strings of any errors to be reported

Returns

void

Definition at line 50 of file Response.php.

References Xoops\Core\Service\Response\$errorMessage, Xoops\Core\Service\Response\$success, Xoops\Core\Service\Response\$value, and Xoops\Core\Service\Response\addErrorMessage().

Here is the call graph for this function:

Xoops\Core\Service\Response::addErrorMessage

(

$errorMessage

)

addErrorMessage - add a message

Parameters

mixed

$errorMessage

- message, or array of messages to be added

Returns

Response object

Definition at line 124 of file Response.php.

References Xoops\Core\Service\Response\$errorMessage.

Referenced by Xoops\Core\Service\Response\__constructor().

Here is the caller graph for this function:

Xoops\Core\Service\Response::getErrorMessage

(

)

getErrorMessage - get any messages set by service manager or provider

Returns

mixed

Definition at line 84 of file Response.php.

References Xoops\Core\Service\Response\$errorMessage.

Xoops\Core\Service\Response::getValue

(

)

getValue - get return value from provider

Returns

mixed

Definition at line 64 of file Response.php.

References Xoops\Core\Service\Response\$value.

Xoops\Core\Service\Response::isSuccess

(

)

isSuccess - success of service request as determined by service manager or provider

Returns

boolean

Definition at line 74 of file Response.php.

References Xoops\Core\Service\Response\$success.

Xoops\Core\Service\Response::setSuccess

(

$success

)

setSuccess - record success of request

Parameters

boolean

$success

- success of service request as determined by manager or provider

Returns

Response object

Definition at line 110 of file Response.php.

References Xoops\Core\Service\Response\$success.

Xoops\Core\Service\Response::setValue

(

$value

)

setValue - set value returned by request

Parameters

mixed

$value

value returned from provider

Returns

Response object

Definition at line 96 of file Response.php.

References Xoops\Core\Service\Response\$value.

Referenced by QrcodeProvider\getImgTag(), CountryFlagProvider\getImgTag(), ThumbsProvider\getImgTag(), QrcodeProvider\getImgUrl(), CountryFlagProvider\getImgUrl(), and ThumbsProvider\getImgUrl().

Here is the caller graph for this function:

Member Data Documentation

Xoops\Core\Service\Response::$errorMessage = null

protected

Definition at line 39 of file Response.php.

Referenced by Xoops\Core\Service\Response\__constructor(), Xoops\Core\Service\Response\addErrorMessage(), and Xoops\Core\Service\Response\getErrorMessage().

Xoops\Core\Service\Response::$success = true

protected

Definition at line 36 of file Response.php.

Referenced by Xoops\Core\Service\Response\__constructor(), Xoops\Core\Service\Response\isSuccess(), and Xoops\Core\Service\Response\setSuccess().

Xoops\Core\Service\Response::$value = null

protected

Definition at line 33 of file Response.php.

Referenced by Xoops\Core\Service\Response\__constructor(), Xoops\Core\Service\Response\getValue(), and Xoops\Core\Service\Response\setValue().

---

The documentation for this class was generated from the following file:

• C:/usr64/htdocs/xoops_lib/Xoops/Core/Service/Response.php