Class IdxApp

Class Component to use for extending components, controllers and models in other plugins

hji\membership\services\DependencyInjector

hji\membership\abstracts\Component

hji\membership\extension\abstracts\Component implements hji\membership\extension\interfaces\ExtensionInterface

hji\ResponsiveIDX\core\abstracts\Component

hji\ResponsiveIDX\core\Controller

hji\ResponsiveIDX\controllers\BaseController

hji\ResponsiveIDX\controllers\IdxApp

Namespace: hji\ResponsiveIDX\controllers
Package: hji\membership\extension\abstracts
Codecoverageignore
Located at classes/controllers/IdxApp.php

Methods summary

`public`	# `__construct( )` Overrides `hji\ResponsiveIDX\controllers\BaseController::__construct`
`public static hji\ResponsiveIDX\controllers\IdxApp`	# `getInstance( )` Returns current IdxApp instance. Returns current IdxApp instance. Returns `hji\ResponsiveIDX\controllers\IdxApp`
`public`	# `setSearchParams( $rawParams )`
`public`	# `getSearchParams( )`
`public`	# `init( )`
`public`	# `registerActions( )` Front-End Actions & Filters => only if license keys are valid Front-End Actions & Filters => only if license keys are valid
`public`	# `AuthenticateIDXAPI( $force = false )`
`public`	# `set_license_key( string $license_key )` Sets current license key Sets current license key Parameters `$license_key` Home Junction License Key
`public`	# `loadAdminScripts( )`
`public`	# `adminFooterScripts( )`
`public`	# `loadScripts( )` Loads Styles and JS Scripts Loads Styles and JS Scripts
`public static`	# `setJsVar( $key, $value )`
`public static`	# `getJsVars( )`
`public`	# `loadJsVars( )` Creates rIDXdata JavaScript object with rIDX related data and loads it on the page before DOM is ready. Creates rIDXdata JavaScript object with rIDX related data and loads it on the page before DOM is ready. Use IdxApp::setJsVar($key, $value) to add additional data.
`public`	# `loadCustomGmapIcon( )` Renders JS code on the page to declare custom GMap icon. Renders JS code on the page to declare custom GMap icon.
`public boolean`	# `is_listing_details_page( )` Is current page a listing details page Is current page a listing details page Returns boolean
`public boolean`	# `is_listing_print_page( )` Is current page a listing details page Is current page a listing details page Returns boolean
`public`	# `clearQuery( $query )`
`public`	# `preactivate( $q )` this is a roundabout way to make sure that any other plugin / widget / etc that uses the WP_Query object doesn't get our IDX data in their query. since we don't actually get the query itself in the "the_posts" filter, we have to step around the issue by checking it BEFORE it gets to the the_posts filter. later, i n the the_posts filter, we restore the previous state of things. this is a roundabout way to make sure that any other plugin / widget / etc that uses the WP_Query object doesn't get our IDX data in their query. since we don't actually get the query itself in the "the_posts" filter, we have to step around the issue by checking it BEFORE it gets to the the_posts filter. later, i n the the_posts filter, we restore the previous state of things.
`public mixed`	# `listingPermalink( $permalink, $post, $leavename )` Returns correct listing URL when get_permalink() is being called on listing details pages. page_link filter implementation Returns correct listing URL when get_permalink() is being called on listing details pages. page_link filter implementation Parameters `$permalink` `$post` `$leavename` Returns mixed Since 3.0
`public mixed`	# `removeIdxSearchWidgetSortcode( $content )` Removes idx search widget shortcode from content to avoid duplication on a search results page. Bad logic... Removes idx search widget shortcode from content to avoid duplication on a search results page. Bad logic... Parameters `$content` Returns mixed
`public`	# `preprocessQueryParams( )` If search is initiated pre-process parameters and trigger next action. This should be before any content is rendered (before headers sent). If search is initiated pre-process parameters and trigger next action. This should be before any content is rendered (before headers sent).
`public boolean\|string`	# `renderSearchResultsPage( $content )` Renders search results page via the_content filter. Renders search results page via the_content filter. Parameters `$content` Returns boolean\|string
`public boolean\|string`	# `renderSearchResultsView( hji\ResponsiveIDX\models\IdxSearchModel $idxSearchModel )` Renders search results view Renders search results view Parameters `$idxSearchModel` Returns boolean\|string
`public boolean\|string`	# `getIdxContentView( hji\ResponsiveIDX\models\IdxSearchModel $idxSearchModel )` Returns IDX content view from whatever action was set: search results; listing details, scrolling listings etc. Returns IDX content view from whatever action was set: search results; listing details, scrolling listings etc. Parameters `$idxSearchModel` Returns boolean\|string
`public array\|boolean`	# `renderListingDetailsPage( $posts )` Renders Listing Details page view Renders Listing Details page view Parameters `$posts` Returns array\|boolean
`public array`	# `getPostObj( $listing, $title, $content, $slug )` Generating a fake post object for listing details page this object is exactly the same as WP native post object created during the_posts filter Generating a fake post object for listing details page this object is exactly the same as WP native post object created during the_posts filter Parameters `$listing` object `$title` title `$content` content `$slug` slug Returns array
`public static boolean\|string`	# `hCard( )` Contact Info hCard http://microformats.org/wiki/hCard Contact Info hCard http://microformats.org/wiki/hCard Returns boolean\|string
`public`	# `renderCustomColorsStylesheet( )` Renders custom colors stylesheet on the page Renders custom colors stylesheet on the page
`public`	# `renderListingDetailsPrintPage( )` Renders Listing Details Print Page Renders Listing Details Print Page
`public string`	# `getSearchWidgetHTML( $atts )` Returns HTML for search widget Returns HTML for search widget Parameters `$atts` passed to search widget shortcode Returns string HTML code

Properties summary

`public`	`$settingsController`	#
`public`	`$idxSearchModel`	#
`public`	`$searchParams`	#
`public`	`$shortcodesModel`	#
`public boolean`	`$is_listing_details_page` Set if current page is listing details Set if current page is listing details	# `false`
`public boolean`	`$is_listing_print_page` Set if current page is a listing print page Set if current page is a listing print page	# `false`
`public static boolean`	`$jsVars`	# `false`

Properties inherited from hji\ResponsiveIDX\controllers\BaseController

$eventDispatcher, $membership, $view

Namespaces

Classes

Class IdxApp

Methods summary

Overrides

Returns

Parameters

Returns

Returns

Parameters

Returns

Since

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Returns

Parameters

Returns

Methods inherited from hji\ResponsiveIDX\core\abstracts\Component

Methods inherited from hji\membership\extension\abstracts\Component

Methods inherited from hji\membership\services\DependencyInjector

Properties summary

Properties inherited from hji\ResponsiveIDX\controllers\BaseController