File classes/controllers/Shortcodes.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

<?php
namespace hji\homevalue\controllers;

use hji\homevalue\core\Controller;
use hji\homevalue\models\Settings as M_Settings;


class Shortcodes extends Controller
{
    private $licenseKey;
    private $settings;

    function __construct($licenseKey)
    {
        $this->licenseKey = $licenseKey;
        $this->settings = new M_Settings();

//        add_shortcode('home_value', array($this, 'getHomeValueShortcode'));
        add_shortcode('home_value_form', array($this, 'getHomeValueFormShortcode'));

        // Make text widget support shortcodes

        add_filter('widget_text', 'do_shortcode');

        add_filter('the_content', array($this, 'renderHomeValueResults'));

        add_filter('hji_user_registration_statement', array($this, 'registrationDialogMessage'));
    }


    // TODO: Remove or add a shortcode to render home value for specified address
//    function getHomeValueShortcode($atts)
//    {
//        // Street is required
//
//        if (!isset($atts['street']) || empty($atts['street']))
//        {
//            return;
//        }
//
//        // Zip or City + State required
//
//        if (!isset($atts['zip']) || empty($atts['zip']))
//        {
//            if ((!isset($atts['city']) || empty($atts['city']))
//                && (!isset($atts['state']) || empty($atts['state'])))
//            {
//                return;
//            }
//        }
//
//        $this->api = $this->membership->apiController->api;
//    }


    /**
     * Home Value Form Shortcode
     *
     * Renders home value form. After submission a home value report is rendered.
     *
     * Supported params:
     * button - custom label for the form submit button. By default, button label is: "Get Home Value"
     *
     * Example 1:
     * [home_value_form]
     *
     * Example 2:
     * [home_value_form button="Get Property Value"]
     *
     * @param $atts
     * @return mixed
     */
    function getHomeValueFormShortcode($atts)
    {
        extract(shortcode_atts(
            array(
                'button'        => 'Get Home Value',
                'hide'          => false,
            ), $atts));

        $templatesPath = \hji\homevalue\HomeValue::$dir . '/classes/views';

        $view = $this->membershipServices()->getView($templatesPath);

        $vars['button']     = $button;
        $vars['hide']       = $hide;
        $vars['settings']   = $this->settings;

        return $view->render('home-value-form', $vars);
    }


    /**
     * Renders Home Value Results page view
     *
     * @param $content
     * @return bool|string
     */
    function renderHomeValueResults($content)
    {
        global $post;

        $params = self::isHomeValueQuery($_GET);

        if (isset($post->ID) &&
            $params &&
            ((int)$this->settings->results_page_id == $post->ID))
        {
            $membershipServices = $this->membershipServices();

            $membershipServices->getDispatcher()->dispatchUserAction('Home Value: Property Valuation', $params);

            if ($savedData = $this->getData($params))
            {
                $params = $savedData;
            }
            else
            {
                $params['data'] = $this->getAvmData($params);
            }

            $params['settings'] = $this->settings;

            $view = new \hji\common\utils\Views(\hji\homevalue\HomeValue::$dir . '/classes/views/');

            return $view->render('home-value-page', $params);
        }

        return $content;
    }


    /**
     * Checks if GET parameters are a query for the Home Value
     *
     * @param $params
     * @return bool
     */
    static function isHomeValueQuery($params)
    {
        if ((isset($params['street']) && !empty($params['street'])) &&
            ((
                (isset($params['city']) && !empty($params['city'])) &&
                (isset($params['state']) && !empty($params['state']))) ||
                (isset($params['zip']) && !empty($params['zip']))
            )
        )
        {
            $result = array();

            foreach ($params as $k => $v)
            {
                $result[$k] = trim($v);
            }

            return $result;
        }
    }


    /**
     * Caches AVM data for 10 minutes,
     * so it can be immediately retrieved
     * upon user registration, after the AVM teaser was displayed.
     *
     * @param $query
     * @param $data
     */
    function saveData($query, $data)
    {
        unset($query['action']);
        unset($query['hjdebug']);

        $_SESSION['hv-query']['query'] = $query;
        $_SESSION['hv-query']['data']  = $data;
        $_SESSION['hv-query']['expires']  = time() + 60*10; // 10 minutes
    }


    /**
     * Returns cached data.
     */
    function getData($query)
    {
        unset($query['action']);
        unset($query['hjdebug']);
        unset($query['hv-redirect']);

        $time = time();

        if (isset($_SESSION['hv-query']['query']) && $_SESSION['hv-query']['query'] == $query)
        {
            $result = @$_SESSION['hv-query']['data'];

            if ($_SESSION['hv-query']['expires'] < $time)
            {
                unset($_SESSION['hv-query']);
            }

            return $result;
        }
    }


    /**
     * Return AVM data from API
     *
     * @param $params
     * @return bool
     */
    function getAvmData($params)
    {
        // Prepare parameters before passing the to the API

        $atts['street'] = $params['street'];
        $atts['city']   = $params['city'];
        $atts['state']  = $params['state'];
        $atts['zip']    = $params['zip'];

        if (isset($params['beds']) && !empty($params['beds']))
        {
            $atts['beds'] = trim($params['beds']);
        }

        if (isset($params['baths']) && !empty($params['baths']))
        {
            $atts['baths'] = trim($params['baths']);
        }

        if (isset($params['size']) && !empty($params['size']))
        {
            $atts['size'] = trim($params['size']);
        }

        if (isset($params['lotSize']) && !empty($params['lotSize']))
        {
            $atts['lotSize'] = trim($params['lotSize']);
        }

        if (isset($params['yearBuilt']) && !empty($params['yearBuilt']))
        {
            $atts['yearBuilt'] = trim($params['yearBuilt']);
        }


        // Send AVM API request and return result

        $avm  = $params;
        $avm['data'] = $this->membershipServices()->getApiClient()->getAVM($atts);

        $this->saveData($params, $avm);

        return $avm['data'];
    }


    function registrationDialogMessage($content)
    {
        global $post;

        if (isset($post) && $post->ID == $this->settings->results_page_id && $params = self::isHomeValueQuery($_GET))
        {
            $result = $this->getData($params);

            if (isset($result['data']['address']) && !empty($result['data']['address']))
            {
                $address = '<strong>' . implode(' ', $result['data']['address']) . '</strong>';
            }
            else
            {
                $address = 'this property';
            }

            $content = "Please login to view detailed home valuation for {$address}.";
            $content = apply_filters('hji_home_value_registration_statement', $content);
        }

        return $content;
    }


    static function getGravityForm($formTitle)
    {
        _deprecated_function(__FUNCTION__, '1.0.1');
    }
}

Namespaces

Classes

Interfaces

Functions