Class Response

Xoops service manager response object

An instance of this object is passed as the first argument to all contract provider methods. The contract provider should return values and error data in this object. The object is then the return value from the provider.

Namespace: Xoops\Core\Service
Package: Xoops\Core
Category: Xoops\Core\Service\Response
Copyright: 2014 The XOOPS Project https://github.com/XOOPS/XoopsCore
License: GPL 2 or later (http://www.gnu.org/licenses/gpl-2.0.html)
Author: Richard Griffith richard@geekwright.com
Version: Release: 1.0
Since: 2.6.0
Link: http://xoops.org
Located at oops_lib/Xoops/Core/Service/Response.php

Methods summary
`public`	# `__construct( mixed $value = null, boolean $success = true, mixed $errorMessage = null )` __construct __construct Parameters `$value` value returned by provider `$success` true if service request was successful `$errorMessage` string or array of strings of any errors to be reported
`public mixed`	# `getValue( )` getValue - get return value from provider getValue - get return value from provider Returns mixed
`public boolean`	# `isSuccess( )` isSuccess - success of service request as determined by service manager or provider isSuccess - success of service request as determined by service manager or provider Returns boolean
`public mixed`	# `getErrorMessage( )` getErrorMessage - get any messages set by service manager or provider getErrorMessage - get any messages set by service manager or provider Returns mixed
`public Xoops\Core\Service\Response`	# `setValue( mixed $value )` setValue - set value returned by request setValue - set value returned by request Parameters `$value` value returned from provider Returns `Xoops\Core\Service\Response` object
`public Xoops\Core\Service\Response`	# `setSuccess( boolean $success )` setSuccess - record success of request setSuccess - record success of request Parameters `$success` success of service request as determined by manager or provider Returns `Xoops\Core\Service\Response` object
`public Xoops\Core\Service\Response`	# `addErrorMessage( mixed $errorMessage )` addErrorMessage - add a message addErrorMessage - add a message Parameters `$errorMessage` message, or array of messages to be added Returns `Xoops\Core\Service\Response` object

Properties summary
`protected mixed`	`$value` $value - return value from Provider $value - return value from Provider	# `null`
`protected boolean`	`$success` $success - success as determined by service manager or provider $success - success as determined by service manager or provider	# `true`
`protected mixed`	`$errorMessage` $errorMessage - error description(s) as returned by service manager or provider $errorMessage - error description(s) as returned by service manager or provider	# `null`

Namespaces

Classes

Class Response

Parameters

Returns

Returns

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns