File classes/widgets/QuickSearch.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

<?php
namespace hji\ResponsiveIDX\widgets;

use \hji\common\models\Alerts;
use \hji\common\utils\Cookies;
use \hji\common\utils\Views;
use \hji\ResponsiveIDX\controllers\Settings;
use \hji\membership\Membership;
use \hji\ResponsiveIDX\models\IdxSearchModel;
use \hji\ResponsiveIDX\models\QuickSearchViewModel;
use \hji\ResponsiveIDX\ResponsiveIDX;

/**
 * Quick Home Search Widget
 */
class QuickSearch_Widget extends \WP_Widget
{
    /**
     * @since 3.0.4
     */
    protected $screen;
    protected $targetScreens = array(
        'widgets',
        'customize'
    );

    /**
     * All available options for the widget
     * with their default values.
     * Has to be re-used in shortcodes.
     *
     * @since 3.0
     * @var array
     */
    private static $defaultOptions = array(
        'title'                     => null,
        'market'                    => false,
        'listingType'               => false,
        'listingTypeSelector'       => 'select',
        'expand_advanced_opt'       => false,
        'layout'                    => 'vertical',
        'sortField'                 => false,
        'sortOrder'                 => false,
        'search_widget_prepopulate' => false,
        'mobileOff'                 => false
    );

    /**
     * Hashmap for deprecated option names
     *
     * @since 3.0
     * @var array
     */
    private static $deprecatedOptions = array(
        'mls'                       => 'market',
        'property_type'             => 'listingType',
        'property_types_radios'     => 'listingTypeSelector',
        'horizontal'                => 'layout'
    );

    private static $listingTypeSelectors = array(
        'radio'     => 'Radios',
        'select'    => 'Selection List'
    );


    /**
     * Container for $_GET['idxs_do'] params
     */
    private $searchParams = array();

    public $idxSearchModel;


    public function __construct()
    {
        parent::__construct(
            'sm_quicksearch_widget', // Base ID
            'HJI rIDX: Quick Home Search', // Name
            array( 'description' => __( 'Quick Home Search widget by Responsive IDX.', 'pl_text_domain' ), ) // Args
        );

        $this->settingsController   = Settings::getInstance();

        // Process $_GET params if the search was initiated
        // TODO: actions, especially for scripts need to be moved into the widget controller
        add_action('parse_request', array($this, 'preprocessQueryParams'));

        add_action('current_screen', array($this, 'setScreen'));

        add_action('admin_print_scripts', array($this, 'load_header_scripts'));
        add_action('in_admin_footer', array($this, 'load_footer_scripts'));
    }


    /**
     * Sets ID of the current Admin Screen
     *
     * @since 3.0.4
     */
    function setScreen()
    {
        if ($currentScreen = get_current_screen())
        {
            $this->screen = $currentScreen->id;
        }
    }


    /**
     * @since 3.0.4
     *
     * @return bool
     */
    protected function isTargetScreen()
    {
        return in_array($this->screen, $this->targetScreens);
    }


    public function load_header_scripts()
    {
        if (!$this->isTargetScreen())
        {
            return;
        }
        ?>
        <script>
            // This is a container array for mls property types objects
            // needs to be initialized only once, so other instances can push into it.
            // Each widget instance pushes array of property types mls_pts.push() into it.

            var mls_pts = [];
        </script>
        <?php
    }


    public function load_footer_scripts()
    {
        if (!$this->isTargetScreen())
        {
            return;
        }
        ?>
        <script>
            jQuery(document).ready(
                function()
                {
                    jQuery('div[id*="sm_quicksearch_widget"].widget').ManageQuickSearchWidgets();
                }
            );
        </script>
        <?php
    }


    /**
     * Preserves search params from the $_GET variable,
     * so they can pre-populate search model if needed
     *
     * @since 3.0
     */
    function preprocessQueryParams()
    {
        // Running this on parse_request makes $vars WP object

        // Preserve raw search parameters if search was initiated by user.

        if (isset($_GET['idxs_do']))
        {
            $this->searchParams = $_GET;
        }
    }


    /**
     * Returns IdxSearchModel object to the widget
     *
     * @param $instance widget instance
     * @return \hji\ResponsiveIDX\models\IdxSearchModel
     */
    function getSearchModel($instance)
    {
        // Was search model passed to the widget directly?
        // Always overrides it
        if (isset($instance['search_widget_prepopulate']) &&
            (bool)$instance['search_widget_prepopulate'] &&
            isset($instance['idxSearchModel']))
        {
            return $instance['idxSearchModel'];
        }

        $idxSearchModel = new IdxSearchModel();

        // Was a search triggered by user and we have search parameters?
        if (!empty($this->searchParams))
        {
            $idxSearchModel->SetSearchParams($this->searchParams);
            return $idxSearchModel;
        }

        // Return empty/default search model
        return $idxSearchModel;
    }


    /**
     * Front-end display of widget.
     *
     * @see WP_Widget::widget()
     *
     * @param array $args     Widget arguments.
     * @param array $instance Saved values from database.
     */
    public function widget($args, $instance)
    {
        $instance = self::mergeOptions($instance);

        // If user expanded advanced options - keep them that way
        if (Cookies::getCookie('expand_advanced_opt') === "1")
        {
            $instance['expand_advanced_opt'] = true;
        }

        $instance = apply_filters('ridx_quick_search_widget_instance', $instance, $args);

        $this->idxSearchModel = $this->getSearchModel($instance);

        $this->viewModel            = new QuickSearchViewModel($this);

        // Check if search results page is set in the plugin's settings

        if (!$this->settingsController->getSearchPageSlug())
        {
            if (is_user_logged_in())
            {
                $alerts = new Alerts();
                $message = 'In order to display Search Widget, <i>Search Results Page</i> has to be selected in the <a href="' . admin_url('admin.php?page=hjpl_options') . '">Responsive IDX Settings</a>.';
                $alerts->addAlert($message, Alerts::WARNING);
                $view = new Views(Membership::$dir . '/common/views/');

                echo $view->render('alerts', array('alerts' => $alerts));
            }

            return;
        }

        if ($content = $this->viewModel->getWidgetContent($args, $instance))
        {
            $before_widget = $after_widget = $before_title = $after_title = null;

            extract($args);

            $instance['title'] = (isset($instance['title'])) ? $instance['title'] : null;

            $title = apply_filters('widget_title', $instance['title']);

            echo $before_widget;

                if (!empty($title))
                {
                    echo $before_title . $title . $after_title;
                }

                // Define widget wrapper classes

                $wrapperClasses = array(
                    'hjitb',
                    'quick-search-widget-wrapper'
                );

                if (isset($instance['layout']))
                {
                    $wrapperClasses[] = $instance['layout'];
                }
                else
                {
                    // Fallback to vertical layout

                    $wrapperClasses[] = 'vertical';
                }

                // On/Off mobile view while browsed on mobile device

                if (wp_is_mobile() && !$instance['mobileOff'])
                {
                    $wrapperClasses[] = 'is-mobile';
                }

                $wrapperClasses = apply_filters('quick-search-wrapper-classes', $wrapperClasses, $instance);

                if (is_array($wrapperClasses) && !empty($wrapperClasses))
                {
                    echo '<div class="' . implode($wrapperClasses, ' ') . '">';
                }
                else
                {
                    echo '<div>';
                }

                    echo $content;

                echo '</div>';

            echo $after_widget;
        }
    }


    /**
     * Sanitize widget form values as they are saved.
     *
     * @see WP_Widget::update()
     *
     * @param array $new_instance Values just sent to be saved.
     * @param array $old_instance Previously saved values from database.
     *
     * @return array Updated safe values to be saved.
     */
    public function update($new_instance, $old_instance)
    {
        $instance = array();

        foreach ($new_instance as $k => $v)
        {
            if (!is_array($v))
            {
                $instance[$k] = esc_attr($v);
            }
            else
            {
                $instance[$k] = $v;
            }
        }

        return $instance;
    }


    /**
     * Back-end widget form.
     *
     * @see WP_Widget::form()
     *
     * @param array $instance Previously saved values from database.
     * @return string|void
     */
    public function form($instance)
    {
        $instance = self::mergeOptions($instance);
        // Render widget form in admin dashboard
        // for managing widget's settings

        $viewModel            = new QuickSearchViewModel($this);
        $viewModel->widgetFormContent($instance);
    }


    public function getListingTypeSelectors()
    {
        return apply_filters('quick-search-listing-type-selectors', self::$listingTypeSelectors);
    }


    /**
     * Merges set options array with the default ones
     *
     * @param $options
     * @return array
     */
    public static function mergeOptions($options)
    {
        $options = self::convertDeprecatedOptions($options);

        return array_merge(self::$defaultOptions, $options);
    }


    /**
     * Merges shortcode attributes with the default widget options
     * via shortcode_atts() WP core method.
     *
     * @param $atts
     * @return array
     */
    public static function mergeShortcodeAtts($atts)
    {

        $atts = self::convertDeprecatedOptions((array) $atts);

        return shortcode_atts(self::$defaultOptions, $atts);
    }


    /**
     * Converts deprecated option names and their values to new ones
     *
     * @param $options
     * @return array
     */
    private static function convertDeprecatedOptions(array $options)
    {
        $result = $options;

        foreach ($options as $k => $v)
        {
            if (isset(self::$deprecatedOptions[$k]))
            {
                // Check if value conversion method exists
                $method = '_convert_' . $k;

                if (method_exists('\hji\ResponsiveIDX\widgets\QuickSearch_Widget', $method))
                {
                    $v = self::$method($v);
                }

                $newKey = self::$deprecatedOptions[$k];
                $result[$newKey] = $v;
                unset($result[$k]);
            }
        }

        return self::convertWrongCase((array)$result);
    }


    private static function convertWrongCase($options)
    {
        $defaultOptionsMap = array();

        // Create lower case options map to camelCase
        foreach (self::$defaultOptions as $k => $v)
        {
            $defaultOptionsMap[strtolower($k)] = $k;
        }

        // Convert current options to lower case, to make sure
        // set values overwrite the default ones

        $result = array();
        $_options = array();

        foreach ($options as $k => $v)
        {
            $_options[strtolower($k)] = $k;
        }

        foreach ($_options as $k => $K)
        {
            if (isset($defaultOptionsMap[$k]))
            {
                $result[$defaultOptionsMap[$k]] = $options[$K];
            }
            else
            {
                $result[$K] = $options[$K];
            }
        }

        return $result;
    }


    private static function _convert_horizontal($value)
    {
        return ($value == '1') ? 'horizontal' : 'vertical';
    }


    private static function _convert_property_types_radios($value)
    {
        return ($value == '1') ? 'radios' : 'select';
    }

}

Namespaces

Classes

Interfaces

Functions