File classes/models/ComplianceViewModel.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

<?php
namespace hji\ResponsiveIDX\models;


use hji\common\utils\Views;
use hji\ResponsiveIDX\entities\ListingEntity;
use hji\ResponsiveIDX\ResponsiveIDX;


class ComplianceViewModel
{
    private static $instance;

    // Array of compliance rules objects that are ready to be rendered,
    // injected via SearchResultsViewModel when result views are being prepared.

    private static $rulesCollection = array();

    private $compliance; // Compliance object
    public $market;     // Current market

    private static $hooksSet = false; // Flag to determine if hooks were set.

    // Default placement hooks for all markets
    // context => wp hook

    private static $defaultPlacement = array(
        'page'      => 'wp_footer',
        'courtesy'  => 'ridx_listing_details_after_main_info',
        'footnotes' => 'ridx_listing_details_after_listing',
    );

    // Market-specific placement hooks - add new markets here per MLS request

    private static $compliancePlacement = array(
        'sandicor'  => array(
            'courtesy'  => 'ridx_listing_details_before_maps'
        ),
    );


    private function __construct($market)
    {
        $this->market = $market;
        $this->compliance = new ComplianceModel($this->market);

        // Add rules for the current market into rulesCollection,
        // so they can be rendered later

        if (!isset(self::$rulesCollection[$this->market]))
        {
            self::$rulesCollection[$this->market] = $this->compliance->getRules();
        }

        // Renders compliance rules via WP hooks
        // since we need to set hooks only once,
        // check if they haven't been already set.

        if (!self::$hooksSet)
        {
            $this->setRenderingHooks();
            self::$hooksSet = true;
        }
    }


    public function setListing(\hji\ResponsiveIDX\entities\ListingEntity $listing)
    {
        $this->compliance->setListing($listing);
    }


    /**
     * This is a singleton model that collects compliance rules
     * from all searches on the page and therefore can be
     * instantiated only once.
     *
     * @param $market
     * @return ComplianceViewModel
     */
    static function getInstance($market)
    {
        if (!self::$instance || self::$instance->market != $market)
        {
            self::$instance = new ComplianceViewModel($market);
        }

        return self::$instance;
    }


    /**
     * Returns compliance rules object
     *
     * @return \stdClass
     */
    function getRules()
    {
        return $this->compliance->getRules();
    }


    /**
     * Sets hooks for each type of compliance context to be rendered
     */
    function setRenderingHooks()
    {
        // Render summary context compliance

        $this->_setSummaryHooks();

        // Render details context compliance

        $this->_setDetailsHooks();

        // Render page context compliance

        $this->_setPageHooks();
    }


    private function _setSummaryHooks()
    {
        // We only use courtesy notice (listing office name) for this context type
        // in the search results snippet. Listing office name is a default field in the
        // mainDetailsHashmap.

        // Set filter to remove listingOffice_name from the mainDetailsHashmap

        add_filter('ridx_results_snippet_hashmap', array($this, 'removeListingOfficeFromSummary'), 1, 3);

        // ..same for the agentName

        add_filter('ridx_results_snippet_hashmap', array($this, 'removeListingAgentFromSummary'), 1, 3);
    }


    private function _setPageHooks()
    {
        // Page rules are aggregated based on all IDX searches generated on the page
        // and collected in self::$rulesCollection

        add_action('wp_footer', array($this, 'renderPageCompliance'));

        // Footer hook in listing details print template

        add_action('ridx_footer_print', array($this, 'renderPageCompliance'));
    }


    private function _setDetailsHooks()
    {
        // MLSes sometimes require to place courtesy notice in different places on the page.
        // Courtesy compliance is listing-specific and is set in ListingEntity object

        foreach (self::$rulesCollection as $market => $rules)
        {
            // Check if courtesy rule exists

            if (isset($rules->details->attribution) && $rules->details->attribution->getLexicon())
            {
                add_action($this->_getHook('courtesy', $market), array($this, 'renderCourtesy'));
            }

            if (isset($rules->details->footnotes) && $rules->details->footnotes->getLexicon())
            {
                add_action($this->_getHook('footnotes', $market), array($this, 'renderFootnotes'));
            }
        }
    }


    /**
     * Page context compliance
     */
    public function renderPageCompliance()
    {
        global $post;

        $compliance = false;

        // Concatenate all rules to pass content to the view

        foreach (self::$rulesCollection as $market => $rules)
        {
            if ($post && isset($post->listing))
            {
                $this->compliance->setListing($post->listing);
                $rules = $this->compliance->getRules();
            }

            if (isset($rules->page))
            {
                foreach($rules->page as $rule)
                {
                    if ($rule->getHtml())
                    {
                        $compliance .= $rule->getHtml();
                    }
                }
            }
        }

        if ($compliance)
        {
            $view = new Views(ResponsiveIDX::$views);
            echo $view->render('footer-compliance', array('compliance' => $compliance));
        }
    }


    /**
     * @param $listing - ListingEntity object passed through listing-details related hooks
     */
    public function renderCourtesy($listing)
    {
        echo $listing->getDetailsCourtesy();
    }


    public function renderFootnotes($listing)
    {
        if (!$listing)
        {
            global $post;

            if (isset($post->listing) && ($post->listing instanceof ListingEntity))
            {
                echo $post->listing->getDetailsFootnotes();
            }

        }
        else
        {
            echo $listing->getDetailsFootnotes();
        }
    }


    /**
     * Unset listingOffice_name form the SearchResultsViewModel::$mainDetaisHashmap()
     * if it's not required by MLS compliance rules
     */
    function removeListingOfficeFromSummary($mainDetailsHashmap, $listingType, $market)
    {
        // If summary attribution for given market is not required,
        // remove the listingOffice_name

        if (!isset(self::$rulesCollection[$market]->summary->attribution))
        {
            if ($k = array_search('listingOffice_name', $mainDetailsHashmap))
            {
                unset($mainDetailsHashmap[$k]);
            }
        }

        return $mainDetailsHashmap;
    }


    function removeListingAgentFromSummary($mainDetailsHashmap, $listingType, $market)
    {
        // If summary attribution for given market is not required,
        // remove the listingOffice_name

        if (!isset(self::$rulesCollection[$market]->summary->attribution))
        {
            if ($k = array_search('listingAgent_name', $mainDetailsHashmap))
            {
                unset($mainDetailsHashmap[$k]);
            }
        }

        return $mainDetailsHashmap;
    }


    /**
     * Helper method to return corresponding hook name
     *
     * @param $context
     * @param $market
     * @return mixed
     */
    private function _getHook($context, $market)
    {
        if (isset(self::$compliancePlacement[$market][$context]))
        {
            return self::$compliancePlacement[$market][$context];
        }
        else
        {
            return self::$defaultPlacement[$context];
        }
    }

}

Namespaces

Classes

Interfaces

Functions