Class WebService

Class WebService - IS AN INTERFACE to Web Service Classes

IMPORTANT: this class has to be extended by an actual web service Example: class Listings extends WebService

Actual service call methods needs to be defined within the web service class Example: get(); search(); authenticate(); etc. each service call should execute corresponding APIClient method as follows:

function search() { $this->_execute('ListingsSearch'); }

TODO: refactor why define methods? Instead register them as

$webservice->registerEndpoint('search', 'ListingsSearch'); // endpoint, api client method $webservice->search() would execute API Client method via magic method.

The final refactoring goal should be: $webservice->register('search', 'v1/new-construction/listings/search'); $webservice->call('search'); <-- this needs to accept array for call chaining

hji\membership\services\DependencyInjector

hji\membership\abstracts\Component

hji\membership\abstracts\Model

hji\membership\models\webservice\abstracts\WebService implements hji\membership\models\webservice\interfaces\ISearchable, hji\membership\models\webservice\interfaces\IGettable

hji\construction\core\WebService

Direct known subclasses

hji\construction\models\listings\ListingsModel, hji\construction\models\subdivisions\SubdivisionsModel

Namespace: hji\construction\core
Package: hji\construction\core
Located at Core/WebService.php

Methods summary

`public`	# `__construct( )` Overrides `hji\membership\models\webservice\abstracts\WebService::__construct`
`public`	# `getObjectName( )`
`public`	# `getItemModelClass( )`
`public`	# `setFilters( $filters )`
`public`	# `setOptions( $options )`
`public`	# `getData( )` Overrides `hji\membership\models\webservice\abstracts\WebService::getData`
`public`	# `getTotal( )`
`public`	# `getPaging( )`
`public`	# `getSorting( )`
`protected`	# `handleResponse( $response )`
`protected`	# `handleResponseError( $response )`
`protected mixed`	# `_execute( $method )` Executes provided webservice method and returns result Executes provided webservice method and returns result Parameters `$method` Returns mixed Throws Exception
`protected mixed`	# `_sendRequest( $method, $params )` Dispatches API request Dispatches API request Parameters `$method` `$params` Returns mixed Throws Exception

Properties summary

`protected`	`$objectName`	#
`protected`	`$itemModelClass`	#
`protected static array`	`$_cache`	# `array()`

Properties inherited from hji\membership\models\webservice\abstracts\WebService

$filters, $method, $options, $path, $rawParameters

Namespaces

Classes

Class WebService

Direct known subclasses

Methods summary

Overrides

Overrides

Parameters

Returns

Throws

Parameters

Returns

Throws

Methods inherited from hji\membership\models\webservice\abstracts\WebService

Methods inherited from hji\membership\abstracts\Component

Methods inherited from hji\membership\services\DependencyInjector

Properties summary

Properties inherited from hji\membership\models\webservice\abstracts\WebService