File classes/models/SpatialMatchModel.php | HJI WP Membership Code Reference

  1   2   3   4   5   6   7   8   9  10  11  12  13  14  15  16  17  18  19  20  21  22  23  24  25  26  27  28  29  30  31  32  33  34  35  36  37  38  39  40  41  42  43  44  45  46  47  48  49  50  51  52  53  54  55  56  57  58  59  60  61  62  63  64  65  66  67  68  69  70  71  72  73  74  75  76  77  78  79  80  81  82  83  84  85  86  87  88  89  90  91  92  93  94  95  96  97  98  99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479

<?php
namespace hji\ResponsiveIDX\models;

use hji\membership\Membership;
use \hji\ResponsiveIDX\controllers\IdxApp;
use \hji\ResponsiveIDX\controllers\Settings;

class SpatialMatchModel
{
    private $idxApp;
    private $idxSearchModel;
    private $settingsController;

    /**
     * Map of SM to rIDX filters
     *
     * @since 3.0.0
     * @var array
     */
    static $hashMap = array(
        'layer:listings_propTypes'          => 'propertyType',
        'layer:land_propTypes'              => 'propertyType',
        'layer:multifamily_propTypes'       => 'propertyType',
        'layer:rentals_propTypes'           => 'propertyType',
        'layer:commercial_propTypes'        => 'propertyType',
        'app:homes:filter_bedsMin'          => 'beds[0]',
        'app:homes:filter_bedsMax'          => 'beds[1]',
        'app:homes:filter_bathsMin'         => 'baths[0]',
        'app:homes:filter_bathsMax'         => 'baths[1]',
        'entity_selected'                   => 'id',
        'app:homes:filter_listingPriceMin'  => 'listPrice[0]',
        'app:homes:filter_listingPriceMax'  => 'listPrice[1]',
        'app:homes:filter_leasePriceMin'    => 'listPrice[0]',
        'app:homes:filter_leasePriceMax'    => 'listPrice[1]',
        'app:homes:filter_homeSizeMin'      => 'size[0]',
        'app:homes:filter_homeSizeMax'      => 'size[1]',
        'app:homes:filter_lotSizeMin'       => 'lotSize[0]',
        'app:homes:filter_lotSizeMax'       => 'lotSize[1]',
        'app:homes:filter_yearBuiltMin'     => 'yearBuilt[0]',
        'app:homes:filter_yearBuiltMax'     => 'yearBuilt[1]',
        'app:homes:filter_affliction'       => 'distressed',
        'app:homes:filter_keywords'         => 'keyword',

        'agent_id'             => 'agentId',
        'list_office_id'       => 'officeId',
        'city'                 => 'city',
        'state_province'       => 'state',
        'county'               => 'county',
        'school_district'      => 'schoolDistrict',
        'school_elementary'    => 'elementarySchool',
        'school_high'          => 'highSchool',
        'school_middle_junior' => 'middleSchool',
        'school'               => 'school',
        'status'               => 'status',
        'postal_code'          => 'zip',
        'property_description' => 'description',
        'state_province'       => 'state',
        'subdivision'          => 'subdivision',
        'area'                 => 'area',
        'dom'                  => 'daysOnMarket',
        'open_house_date'      => 'openHouse',
        'sortby'               => 'sortField',
        'order'                => 'sortOrder',
        'limit'                => 'pageSize',

    );


    public function __construct(IdxApp $idxApp, Settings $settings, IdxSearchModel $idxSearchModel)
    {
        $this->idxApp               = $idxApp;
        $this->settingsController   = $settings;
        $this->idxSearchModel       = $idxSearchModel;

        $this->registerActions();
    }


    function registerActions()
    {
        add_action('wp', array($this, 'applySpatialMatchSubstitutions'));
    }


    /**
     * Parses SM query string and returns rIDX-compatible search params
     *
     * @since 3.0.0
     * @return array
     */
    function parseSMQuery()
    {
        if (isset($_SERVER['QUERY_STRING']) && !empty($_SERVER['QUERY_STRING']))
        {
            parse_str($_SERVER['QUERY_STRING'], $smParams);

            $params = self::mapFilters($smParams);

            $params['listingType'] = self::geListingType($smParams);

            // Check if listing IDs are passed

            if (isset($params['id']))
            {
                $params['id'] = str_replace(':listings', '', $params['id']);
            }

            // Check if map center is set

            if (isset($smParams['map_center']) && !empty($smParams['map_center']))
            {
                $latLng = explode(',', $smParams['map_center']);
                $params['circle'] = "{$latLng[0]}:{$latLng[1]}:50";
            }
            // Check if any coordinates are passed at all
            else if (isset($smParams['map_extents']) && !empty($smParams['map_extents']))
            {
                // map_extens passes a string like this: "lat,lat,lng,lng"
                // we just grab first lat and lng for market determnination.

                $latLng = explode(',', $smParams['map_extents']);
                $params['circle'] = "{$latLng[0]}:{$latLng[2]}:50";
            }

            // If $params not empty - do the search

            if (!empty($params) && $market = self::getMarket($params))
            {
                $params['market'] = $market;
                $params['idxs_do']  = true;
                $params['search_widget'] = true;
                $params['action']   = 'searchListings';

                return $params;
            }
        }
    }


    function applySpatialMatchSubstitutions()
    {
        // Only on mobile devices

        if (!wp_is_mobile())
        {
            return;
        }

        // Swap SM shortcodes for IDX search widgets

        add_action('the_content', array($this, 'substituteSpatialMatchMapShortcode'), 1);

        // Swap SM sidebar widgets for IDX search widgets

        add_filter('dynamic_sidebar_params', array($this, 'substituteSpatialMatchWidgets'));
    }


    /**
     * Substitutes Spatial Match Map shortcodes inside page content
     * with Quick Search Widget
     *
     * @param $content
     * @return mixed
     */
    function substituteSpatialMatchMapShortcode($content)
    {
        $maps   = (array)$this->shortcodeExists('spatialmatch_map', $content);
        $popups = (array)$this->shortcodeExists('spatialmatch_popup', $content);

        $shortcodes = array_merge($maps, $popups);

        if (!$shortcodes)
        {
            return $content;
        }

        remove_filter('the_content', 'wpautop');

        foreach ($shortcodes as $shortcode)
        {
            if (!$this->_qswExists($content))
            {
                // Set listings from alert link as if search was already initiated

                if ($params = $this->parseSMQuery())
                {
                    $params['search_widget_preset'] = true;

                    $idxSearchModel = new IdxSearchModel();
                    $idxSearchModel->SetSearchParams($params);

                    $substitution = $this->idxApp->renderSearchResultsView($idxSearchModel);
                }
                else
                {
                    $substitution = $this->idxApp->getSearchWidgetHTML(array('mls' => self::getMarket(), 'layout' => 'horizontal'));
                }
            }
            else
            {
                $substitution = '';
            }

            $content = str_replace($shortcode, $substitution, $content);
        }

        return $content;
    }


    function shortcodeExists($shortcode, $context)
    {
        if (!function_exists('get_shortcode_regex'))
        {
            // http://codex.wordpress.org/Function_Reference/get_shortcode_regex
            trigger_error('get_shortcode_regex() doesn\'t exist. Make sure it\'s called on "wp" hook or later.');
        }

        $pattern = get_shortcode_regex();

        if (preg_match_all( '/'. $pattern .'/s', $context, $matches )
            && array_key_exists( 2, $matches )
            && in_array($shortcode, $matches[2]))
        {
            $shortcodes = array();

            foreach ($matches[2] as $k => $v)
            {
                if ($shortcode == $v)
                {
                    $shortcodes[] = $matches[0][$k];
                }
            }

            return $shortcodes;
        }
    }


    function parseShortcode($name, $shortcode)
    {
        $pattern = get_shortcode_regex();

        if (preg_match_all( '/'. $pattern .'/s', $shortcode, $matches )
            && array_key_exists( 2, $matches )
            && in_array($name, $matches[2]))
        {
            $key = array_search($name, $matches[2]);

            if ($key !== false)
            {
                return shortcode_parse_atts($matches[3][$key]);
            }

        }
    }


    private function _qswExists($content)
    {
        // Including [listings], since any pre-set searches will be overwritten by new
        // results triggered by new QSW substitution over SM widget.

        $lookfor = array('[idx_search_widget', 'listings', 'idx-search-widget', 'sm-quick-search');

        foreach($lookfor as $str)
        {
            if(stristr($content, $str))
            {
                return true;
            }
        }
    }


    /**
     * Replaces SM Widgets with IDX search widget
     *
     * @param $dynamic_sidebar_params
     * @return mixed
     */
    function substituteSpatialMatchWidgets($dynamic_sidebar_params)
    {
        global $wp_registered_widgets;

        // Is this a spatial match widget?

        if (isset($dynamic_sidebar_params[0]['widget_id']))
        {
            // Swap its callback with our custom one that returns IDX search widget

            if (stristr($dynamic_sidebar_params[0]['widget_id'], 'spatialmatch-widget-map')
                || stristr($dynamic_sidebar_params[0]['widget_id'],'spatialmatch-widget-popup')
                || stristr($dynamic_sidebar_params[0]['widget_id'],'spatialmatch-widget-home-search'))
            {
                $wp_registered_widgets[$dynamic_sidebar_params[0]['widget_id']]['old_callback'] = $wp_registered_widgets[$dynamic_sidebar_params[0]['widget_id']]['callback'];
                $wp_registered_widgets[$dynamic_sidebar_params[0]['widget_id']]['callback'] = '\hji\ResponsiveIDX\models\SpatialMatchModel::doSearchWidgetShortcode';
            }
        }

        return $dynamic_sidebar_params;
    }


    static function doSearchWidgetShortcode($sidebar_widget_params, $widget_number)
    {
        $atts = self::_processSpatialMatchSubstitutionAtts($sidebar_widget_params, $widget_number);

        echo IdxApp::getInstance()->getSearchWidgetHTML($atts);
    }


    private static function _processSpatialMatchSubstitutionAtts($sidebar_widget_params, $widget_number)
    {
        global $wp_registered_widgets;

        $sm_widet_obj = $wp_registered_widgets[$sidebar_widget_params['widget_id']]['old_callback'][0];
        $sm_widget_opts = get_option($sm_widet_obj->option_name);
        $sm_widget_opt = $sm_widget_opts[$sm_widet_obj->number];

        $atts['mls'] = self::getMarket();

        if (isset($sm_widget_opt['listingType']))
        {
            $atts['property_type'] = ($sm_widget_opt['listingType'] == 'listings') ? 'residential' : $sm_widget_opt['listingType'];
        }

        if (isset($sm_widget_opt['orientation']) && $sm_widget_opt['orientation'] == 'horizontal')
        {
            $atts['horizontal'] = true;
        }

        // Overwrite our default orientation with SM widget's settings if any

        if (isset($atts['horizontal']))
        {
            $atts['horizontal'] = true;
        }
        else
        {
            $atts['horizontal'] = false;
        }

        return $atts;
    }


    /**
     * Maps SM parameters to rIDX filters
     *
     * @since 3.0.0
     * @param $params array Assoc array of SM parameters with their corresponding values
     * @return array
     */
    private static function mapFilters(array $params)
    {
        $filters = array();
        $result  = array();

        foreach ($params as $k => $v)
        {
            if (isset(self::$hashMap[$k]))
            {
                $filterName = self::$hashMap[$k];

                preg_match('/(?P<param>\\w+)\\[(?P<key>\\d+)/', $filterName, $matches);

                if (isset($matches['param']) && isset($matches['key']))
                {
                    $filters[$matches['param']][$matches['key']] = $v;
                }
                else
                {
                    $filters[$filterName] = $v;
                }
            }
        }

        // Sort each param that is array by key

        foreach ($filters as $k => $v)
        {
            if (is_array($v))
            {
                ksort($v);
            }

            $result[$k] = $v;
        }

        return $result;
    }


    /**
     * Converts SM property type into rIDX, if it is passed via query string
     *
     * @since 3.0.0
     * @param array $smParams SM search parameters
     * @return false|string property type
     */
    private static function geListingType(array $smParams)
    {
        $types = array(
            'layer:listings'      => 'residential',
            'layer:land'          => 'land',
            'layer:multifamily'   => 'multifamily',
            'layer:rentals'       => 'rental',
            'layer:commercial'    => 'commercial',
        );

        $smPropertiesString = implode(' ', array_keys($smParams));

        foreach ($types as $k => $v)
        {
            if (strpos($smPropertiesString, $k))
            {
                return $v;
            }
        }
    }


    /**
     * Returns targeted market
     * - either because there is just 1 licensed market
     * - or based on map.center parameter in the SM query
     *
     * @since 3.0.0
     * @param array $params
     * @return false|string Market ID
     */
    private static function getMarket(array $params = array())
    {
        $market = false;

        // Get client's markets

        $markets = Membership::getInstance()->getMarkets();

        // If more than 1 market and we have center of the map parameter
        // identify market id with an API call

        if (count($markets) > 1 && isset($params['circle']))
        {
            $idxSearchModel = new IdxSearchModel();
            $result = $idxSearchModel->searchMarkets(array('circle' => $params['circle']));

            if ($result->result && $result->result->markets)
            {
                // Make sure we pick licensed market

                foreach ($result->result->markets as $mls)
                {
                    if (in_array($mls->id, $markets))
                    {
                        $market = $mls->id;
                        break;
                    }
                }

                // Return first market if none are licensed, for debugging purposes

                if (!$market)
                {
                    $market = $result->result->markets[0]->id;
                }

            }
        }
        else
        {
            $market = $markets[0];
        }

        return $market;
    }
}

Namespaces

Classes

Interfaces

Functions