OXID eShop CE  4.8.10
 All Classes Files Functions Variables Pages
oxOnlineModuleVersionNotifier Class Reference

Public Member Functions

 setModules ($aModules)
 getModules ()
 setRawResponseMessage ($sRawResponseMessage)
 getRawResponseMessage ()
 setWebServiceUrl ($sWebServiceUrl)
 getWebServiceUrl ()
 isException ()
 versionNotify ()

Protected Member Functions

 _setIsException ($blIsException)
 _prepareModulesInformation ()
 _doRequest ($oRequestParams)
 _sendRequestMessage ()

Protected Attributes

 $_sProtocolversion = '1.0'
 $_sWebServiceUrl = 'https://omvn.oxid-esales.com/check.php'
 $_sRawResponseMessage = ''
 $_aModules = array()
 $_blIsException = false

Detailed Description

Performs Online Module Version Notifier check

The Online Module Version Notification is used for checking if newer versions of modules are available. Will be used by the upcoming online one click installer. Is still under development - still changes at the remote server are necessary - therefore ignoring the results for now

Definition at line 12 of file oxonlinemoduleversionnotifier.php.

Member Function Documentation

oxOnlineModuleVersionNotifier::_doRequest (   $oRequestParams)
protected

Performs Web service request

Parameters
object$oRequestParamsObject with request parameters
Exceptions
oxException
Returns
string

Definition at line 172 of file oxonlinemoduleversionnotifier.php.

oxOnlineModuleVersionNotifier::_prepareModulesInformation ( )
protected

Collects only required modules information and returns as array.

Returns
null

Definition at line 135 of file oxonlinemoduleversionnotifier.php.

oxOnlineModuleVersionNotifier::_sendRequestMessage ( )
protected

Send request message to Online Module Version Notifier web service.

Exceptions
oxException

Definition at line 197 of file oxonlinemoduleversionnotifier.php.

oxOnlineModuleVersionNotifier::_setIsException (   $blIsException)
protected

Sets exception flag

Parameters
$blIsExceptionException flag

Definition at line 125 of file oxonlinemoduleversionnotifier.php.

oxOnlineModuleVersionNotifier::getModules ( )

Get modules array.

Returns
array

Definition at line 66 of file oxonlinemoduleversionnotifier.php.

oxOnlineModuleVersionNotifier::getRawResponseMessage ( )

Get raw response message received from Online Module Version Notifier web service.

Returns
string

Definition at line 86 of file oxonlinemoduleversionnotifier.php.

oxOnlineModuleVersionNotifier::getWebServiceUrl ( )

Get Online Module Version Notifier web service url.

Returns
string

Definition at line 106 of file oxonlinemoduleversionnotifier.php.

oxOnlineModuleVersionNotifier::isException ( )

Indicates whether the exception was thrown

Returns
bool

Definition at line 116 of file oxonlinemoduleversionnotifier.php.

oxOnlineModuleVersionNotifier::setModules (   $aModules)

Set modules array.

Parameters
$aModulesarray

Definition at line 56 of file oxonlinemoduleversionnotifier.php.

oxOnlineModuleVersionNotifier::setRawResponseMessage (   $sRawResponseMessage)

Set raw response message received from Online Module Version Notifier web service.

Parameters
$sRawResponseMessagestring

Definition at line 76 of file oxonlinemoduleversionnotifier.php.

oxOnlineModuleVersionNotifier::setWebServiceUrl (   $sWebServiceUrl)

Set Online Module Version Notifier web service url.

Parameters
$sWebServiceUrlstring

Definition at line 96 of file oxonlinemoduleversionnotifier.php.

oxOnlineModuleVersionNotifier::versionNotify ( )

Perform Online Module version Notification. Returns result

Returns
bool

Definition at line 224 of file oxonlinemoduleversionnotifier.php.

Member Data Documentation

oxOnlineModuleVersionNotifier::$_aModules = array()
protected

Definition at line 42 of file oxonlinemoduleversionnotifier.php.

oxOnlineModuleVersionNotifier::$_blIsException = false
protected

Definition at line 49 of file oxonlinemoduleversionnotifier.php.

oxOnlineModuleVersionNotifier::$_sProtocolversion = '1.0'
protected

Definition at line 20 of file oxonlinemoduleversionnotifier.php.

oxOnlineModuleVersionNotifier::$_sRawResponseMessage = ''
protected

Definition at line 35 of file oxonlinemoduleversionnotifier.php.

oxOnlineModuleVersionNotifier::$_sWebServiceUrl = 'https://omvn.oxid-esales.com/check.php'
protected

Definition at line 28 of file oxonlinemoduleversionnotifier.php.


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