HJI WP Membership Code Reference
  • Namespace
  • Class
  • Tree
  • Deprecated
  • Todo
  • Hook Reference
  • Slipstream API Docs

Namespaces

  • hji
    • AgentRoster
      • controllers
      • models
      • utils
    • common
      • factories
      • interfaces
      • models
      • utils
    • construction
      • admin
        • controllers
        • models
      • core
      • front
        • controllers
      • interfaces
      • models
        • listings
        • subdivisions
      • views
    • geofarms
      • common
      • controllers
      • models
      • widgets
    • homevalue
      • controllers
      • core
        • abstracts
      • models
    • lifestylefinder
    • listingstoblog
      • controllers
    • membership
      • abstracts
      • controllers
      • entities
      • extension
        • abstracts
        • interfaces
      • factories
      • includes
      • interfaces
      • models
        • data
        • webservice
          • abstracts
          • actions
          • interfaces
      • observers
      • services
    • recentsales
      • controllers
      • tinymce
      • widgets
    • ResponsiveIDX
      • abstracts
      • adapters
      • controllers
      • core
        • abstracts
      • entities
      • models
      • services
      • tinymce
      • utils
      • widgets
    • schools
      • controllers
      • tinymce
      • widgets
    • users
      • abstracts
      • admin
        • controllers
        • models
      • controllers
      • core
        • abstracts
      • entities
      • models
      • utils
  • None
  • REL
    • controllers
    • Models
    • Taxonomies
    • Utils
      • Convert
    • widgets

Classes

  • SubdivisionModel
  • SubdivisionsGetFilters
  • SubdivisionsGetOptions
  • SubdivisionsModel
  • SubdivisionsSearchFilters
  • SubdivisionsSearchOptions

Class SubdivisionsModel

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
Extended by hji\membership\abstracts\Component
Extended by hji\membership\abstracts\Model
Extended by hji\membership\models\webservice\abstracts\WebService implements hji\membership\models\webservice\interfaces\ISearchable, hji\membership\models\webservice\interfaces\IGettable
Extended by hji\construction\core\WebService
Extended by hji\construction\models\subdivisions\SubdivisionsModel
Namespace: hji\construction\models\subdivisions
Package: hji\construction\core
Located at App/models/subdivisions/SubdivisionsModel.php

Methods summary

public
# __construct( )

Overrides

hji\construction\core\WebService::__construct
public
# search( )

Overrides

hji\membership\models\webservice\abstracts\WebService::search
public
# get( )

Overrides

hji\membership\models\webservice\abstracts\WebService::get
public
# setSearchParams( $params )
public
# setGetParams( $params )
public
# getPostType( )

Methods inherited from hji\construction\core\WebService

_execute(), _sendRequest(), getData(), getItemModelClass(), getObjectName(), getPaging(), getSorting(), getTotal(), handleResponse(), handleResponseError(), setFilters(), setOptions()

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

call(), getFilters(), getOptions(), getParameters(), getPath(), setMethod(), setParameters()

Methods inherited from hji\membership\abstracts\Component

getServiceContainer(), services()

Methods inherited from hji\membership\services\DependencyInjector

di()

Properties summary

protected $filters
#
protected $options
#
protected $error
#
protected array $data
# array()
protected $total
#
protected $paging
#
protected $sorting
#
protected $itemModelClass
#

Properties inherited from hji\construction\core\WebService

$_cache, $objectName

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

$method, $path, $rawParameters

HJI WP Membership Code Reference API documentation generated by ApiGen