Class APIClient

Direct known subclasses

hji\membership\models\APIClientModel

Namespace: hji\common\utils
Located at common/utils/APIClient.php

Methods summary

`public`	# `__construct( $licenseKey )`
`public`	# `getApiBaseUrl( )`
`public`	# `setCacheTransport( $object )`
`public boolean`	# `isStagingServer( )` Check if current server is a staging HJ server Check if current server is a staging HJ server Returns boolean
`public`	# `InitCurl( )`
`public`	# `__destruct( )`
`public`	# `authenticate( $force = false, array $params = array() )`
`public`	# `isTokenExpired( )`
`public`	# `setDebugMode( $mode = false )`
`public`	# `setDeveloperMode( $enable = false )`
`public boolean`	# `isDeveloperMode( )` Determines if API client is in developer/test mode Determines if API client is in developer/test mode Returns boolean
`public`	# `getErrors( )`
`public boolean`	# `searchListings( $args )` Returns listings that match search parameters Returns listings that match search parameters Parameters `$args` Returns boolean
`public`	# `searchListingsByArea( $listingsArgs, $areaArgs )`
`public boolean`	# `getListings( [type] $args )` Returns all listings for the currently selected market 1st step for a full IDX app. Returns all listings for the currently selected market 1st step for a full IDX app. Parameters `$args` [description] Returns boolean
`public`	# `searchSales( $args )`
`public`	# `getSales( $args )`
`public`	# `geocode( $args )`
`public`	# `standardize( $args )`
`public`	# `updateLog( $args )`
`public`	# `createUser( $args )`
`public`	# `configureAnalytics( $args )`
`public`	# `logAction( $args )`
`public`	# `searchActions( $args )`
`public`	# `getActions( $args )`
`public`	# `getAnalyticsStatus( )`
`public`	# `getUsers( $args )`
`public`	# `updateUser( $args )`
`public`	# `searchUsers( $args )`
`public`	# `deleteUser( $args )`
`public`	# `addFavorites( $args )`
`public`	# `getFavorites( $args )`
`public`	# `searchFavorites( $args )`
`public`	# `removeFavorites( $args )`
`public`	# `addSearches( $args )` Adds user's saved search Adds user's saved search
`public`	# `getSearch( $args )` Returns user saved search by search ID Returns user saved search by search ID
`public`	# `searchSearches( $args )` Returns user's saved searches Returns user's saved searches
`public`	# `removeSearches( $args )` Deletes user's specified saved search. Deletes user's specified saved search.
`public`	# `updateSearches( $args )` Update user's specified saved search. Update user's specified saved search.
`public`	# `getSchool( $args )` Returns a specified school Returns a specified school
`public`	# `searchSchools( $args )` Searches schools Searches schools
`public`	# `getAVM( $args )` Returns automated valuation model (AVM) for a property. Returns automated valuation model (AVM) for a property.
`public`	# `getAgents( $args )`
`public`	# `searchAgents( $args )`
`public`	# `getOffices( $args )`
`public`	# `searchOffices( $args )`
`public`	# `lookupAreas( $args )`
`public`	# `getAreas( $args )`
`public`	# `getNeighborhoods( $args )`
`public`	# `searchNeighborhoods( $args )`
`public`	# `getStates( $args )`
`public`	# `getPlaces( $args )`
`public`	# `searchCounties( $args )`
`public`	# `getCounties( $args )`
`public`	# `getZipCodes( $args )`
`public`	# `searchSchoolDistricts( $args )`
`public boolean\|array`	# `getMarketsMeta( $args )` Returns markets schema https://slipstream-test.homejunction.com/v1/docs/markets#get Returns markets schema https://slipstream-test.homejunction.com/v1/docs/markets#get Parameters `$args` requires market key which can be string\|array Returns boolean\|array of objects
`public boolean`	# `enumerate( $args )` Returns lookup values for a given property https://slipstream-test.homejunction.com/v1/docs/markets#enumerate Returns lookup values for a given property https://slipstream-test.homejunction.com/v1/docs/markets#enumerate Parameters `$args` Returns boolean
`public`	# `searchSessions( $args )`
`public`	# `getSessions( $args )`
`public`	# `searchMarkets( $args )`
`public`	# `searchPublicRecords( $args )`
`public`	# `callWebService( $webService )`
`public`	# `searchNewConstructionListings( $args )`
`public`	# `getNewConstructionListings( $args )`
`public`	# `searchNewConstructionSubdivisions( $args )`
`public`	# `getNewConstructionSubdivisions( $args )`
`public`	# `makeAPIRequest( $method, $uri, $args = array(), $data = array(), $is_auth_request = false, $a_retry = false )`
`public`	# `_handleResponse( $response_body, $info, $uri, $is_auth_request )`
`public`	# `_handleArray( $json, $info, $is_auth_request )`
`public`	# `_handleObject( $json, $info, $is_auth_request )`
`public`	# `_debugRequest( $post_body, $header, $response_body, $info, $uri )`
`public`	# `setErrors( $code = false, $message = false )`
`public`	# `clean_comma_list( $var )`
`public`	# `exception_handler( $exception )`
`public`	# `debug_data( )` Outputs API request info for debugging purposes Outputs API request info for debugging purposes
`public`	# `_validateParams( $args, $acceptedParams )`

Properties summary

`protected`	`$site_url`	# `null`
`protected`	`$licenseKey`	# `null`
`protected boolean`	`$cacheTransport`	# `false`
`public string`	`$api_base`	# `"https://slipstream.homejunction.com"`
`public string`	`$api_dev_base`	# `"https://slipstream-test.homejunction.com"`
`protected boolean`	`$is_staging`	# `false`
`public`	`$last_error_code`	# `null`
`public`	`$last_error_mess`	# `null`
`public`	`$last_token`	# `null`
`public`	`$last_token_expires`	# `null`
`protected string`	`$token_header`	# `'HJI-Slipstream-Token'`
`protected string`	`$productName`	# `'hji-wordpress'`
`protected`	`$ch`	# `null`
`protected`	`$debug_log`	#
`protected boolean`	`$debug_mode`	# `false`
`protected`	`$application_name`	# `null`
`public string`	`$api_version`	# `"v1"`
`protected boolean`	`$authData`	# `false`
`protected array`	`$error_messages`	# `array( '200' => 'Code: 200. Success.', '400' => 'Code: 400. Your request is invalid. Typically this is because you are missing a required parameter.', '401' => 'Code: 401. Invalid license key.', '403' => 'Code: 403. You attempted to access a restricted resource.', '404' => 'Code: 404. These aren\'t the droids you\'re looking for. Move along!', '500' => 'Code: 500. Internal server error.', '503' => 'Code: 503. Service unavailable.' )`
`public integer`	`$last_count`	# `0`
`public integer`	`$page_size`	# `0`
`public integer`	`$total_pages`	# `0`
`public integer`	`$current_page`	# `0`

Namespaces

Classes

Class APIClient

Direct known subclasses

Methods summary

Returns

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Properties summary