File classes/controllers/GravityForms.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 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511

<?php

namespace hji\users\controllers;

/**
 * Gravity Forms Handler Controller
 */

use \hji\users\entities\GFEntry;
use \hji\users\entities\User as UserEntity;
use \hji\users\models\User as UserModel;
use \hji\users\Users;
use \hji\users\utils\GravityFormsHelper as GFHelper;


class GravityForms
{
    /**
     * @var Logged in user entity object
     */
    protected $user;

    /**
     * @var User model
     */
    protected $userModel;

    protected $userController;

    protected $dynamicParameters = array();

    // Dynamic tags prefixes i.e. hjiUser.name = $this->user->name.

    public static $idxObjName  = 'hjiRidx';
    public static $userObjName = 'hjiUser';


    function __construct(UserEntity $user = null, UserModel $userModel)
    {
        $this->user      = $user;
        $this->userModel = $userModel;

        $this->setDynamicParameters();
        $this->registerPublicActions();
    }


    /**
     * Register WP Action Hooks implementations
     */
    function registerPublicActions()
    {
        // Modify fields properties to accept HJI data
        // http://www.gravityhelp.com/documentation/page/Gform_pre_render

        add_action('gform_pre_render', array($this, 'modifyFieldsProperties'));

        // Inject logged-in HJI user data into form field values

        add_filter('gform_field_value', array($this, 'populateUserFields'), 10, 3);


        // Validate form
        add_action('gform_validation', array($this, 'validateForm'));


        // http://gravityhelp.com/documentation/page/Gform_after_submission

        add_action('gform_after_submission', array($this, 'afterFormSubmission'), 10, 2);

        add_action('wp_head', array($this, 'renderHeaderScripts'));

    }


    function setDynamicParameters()
    {
        $defaultParameters = array(
            'hjiUser.name',
            'hjiUser.email',
            'hjiUser.phone',
        );

        $this->dynamicParameters = apply_filters('hji_gform_dynamic_parameters', $defaultParameters);
    }


    function getDynamicParameters($tagName = false)
    {
        if ($tagName)
        {
            return (isset($this->dynamicParameters[$tagName])) ? $this->dynamicParameters[$tagName] : '';
        }

        return $this->dynamicParameters;
    }


    /**
     * Injects current user information
     * if {hjiUser.} dynamic parameter is set
     *
     * Action hook [gform_field_value] implementation
     * http://www.gravityhelp.com/documentation/page/Gform_field_value_$parameter_name
     *
     * @param $value
     * @param $field
     * @return string
     */
    function populateUserFields($value, $field, $name)
    {
        if ($field['type'] == 'name' || !$this->user || (!$fieldName = GFHelper::isUserField($field)))
        {
            return $value;
        }

        return ($this->user->$fieldName != '') ? $this->user->$fieldName : '';
    }


    /**
     * Returns gform_hidden CSS class for a user field
     * if value already exists (for logged in users).
     * Basically hides user identity fields since they are
     * automatically pre-entered.
     *
     * Action hook [gform_field_css_class] implementation
     * http://www.gravityhelp.com/documentation/page/Gform_field_css_class
     *
     * @param $classes
     * @param $field
     * @param $form
     * @return string
     */
    function hideUserFields($classes, $field, $form)
    {
        if (!$this->user || !$fieldName = GFHelper::isUserField($field))
        {
            return $classes;
        }

        $classes = ($classes != '') ? $classes . ' ' : '';

        return ($this->user->$fieldName != '') ? $classes . 'hji_hidden' : $classes;
    }


    /**
     * Substitutes GF rIDX merge tags in a string with respective rIDX field values
     *
     * @since 1.0
     *
     * @param $value string - content of a field
     * @return mixed string
     */
    function applyIdxMergeTags($value)
    {
        // Check if current page has a listing object

        if (!$listingObj = ridx_get_listing())
        {
            return $value;
        }

        // Check if IDX tags existing within the given value

        if (!strstr($value, '{'. self::$idxObjName . '.'))
        {
            return $value;
        }

        $listingFields = GFHelper::getIDXFields();

        foreach ($listingFields as $field)
        {
            // Skip array values in the listing object

            if (!$listingObj->$field['name'] || !is_string($listingObj->$field['name']))
            {
                continue;
            }

            // Construct possible tag

            $tag = '{'. self::$idxObjName . '.' . $field['name'] . '}';

            // Replace tags with listing values

            $value = str_ireplace($tag, $listingObj->$field['name'], $value);

            // Check if IDX tags existing within the given value

            if (!strstr($value, '{'. self::$idxObjName . '.'))
            {
                return $value;
            }
        }

        return $value;
    }


    /**
     * Substitutes GF hjiUSer merge tags in a string with respective logged-in user values
     *
     * @since 1.0
     *
     * @param $value string - content of a field
     * @return mixed string
     */
    function applyUserMergeTags($value)
    {
        if (!$this->user)
        {
            return $value;
        }

        foreach ($this->getDynamicParameters() as $tagName)
        {
            $fieldName = GFHelper::tagToField($tagName);

            $tagVal = (isset($this->user->$fieldName) && $this->user->$fieldName != '') ? $this->user->$fieldName : '';

            $value = str_ireplace('{' . $tagName . '}', $tagVal, $value);
        }

        return $value;
    }


    /**
     * Runs after gfoms is being submitted:
     * registers and/or logs user in if not logged in and/or records form submission as action
     *
     * action hook [gform_after_submission] implementation
     * http://www.gravityhelp.com/documentation/page/Gform_after_submission
     *
     * @param $entry
     * @param $form
     */
    function afterFormSubmission($entry, $form)
    {
        $formEntry = new GFEntry($entry, $form);
        $tags = array();

        // If user is logged in or registration/login from form entry is successful
        // record web form submission as action

        if ($this->user || $this->_registerLogin($formEntry))
        {
            if (isset($form['id']))
            {
                $tags['form_id'] = $form['id'];
            }

            if (isset($form['title']))
            {
                $tags['title'] = $form['title'];
            }

            if (isset($form['hji_form_key']))
            {
                $tags['hji_form_key'] = $form['hji_form_key'];
            }

            $this->user->logFormEntry($formEntry->getData(), $tags);
        }
    }


    /**
     * Registers and/or logs user in based on form entry
     * TODO: REFACTOR - move registerLogin at once to UserModel (Controller?) - we should just pass data.
     *
     * @param $formEntry
     *
     * @return bool|\hji\users\controllers\Logged|\hji\users\entities\User|mixed
     */
    function _registerLogin($formEntry)
    {
        if ($userData  = $this->getUserDataFromFormEntry($formEntry))
        {
            $this->user = User::getInstance()->loginRegister($userData);
            return $this->user;
        }
    }


    function renderHeaderScripts()
    {
        ?>
        <style type="text/css">
            .hji_hidden { display: none; }
            .gfield_error.hji_hidden { display: block; }
        </style>
        <?php
    }


    /**
     * Modify fields properties to accept HJI data
     *
     * @since 1.0
     *
     * Action hook [gform_pre_render] implementation
     * @url http://www.gravityhelp.com/documentation/page/Gform_pre_render
     *
     * @param $form GF form array
     * @return array GF form array
     */
    function modifyFieldsProperties($form)
    {
        if (!empty($form['fields']))
        {
            foreach ($form['fields'] as &$field)
            {
                // Modify common fields to accept HJI values

                $field = $this->hjifyCommonField($field);

                // Apply merge tags

                $field = $this->applyMergeTags($field);

                // If advanced name field - set default name

                if ($field['type'] == 'name' && $this->user)
                {
                    $name = GFHelper::getFirstLastName($this->user->name);
                    $this->populateNameField($field, $name);
                }
            }
        }

        return $form;
    }


    /**
     * Applies HJI merge tags to defaultValue of the field.
     *
     * @param $field GF field array with field properties
     * @return array
     */
    function applyMergeTags($field)
    {
        if (isset($field['defaultValue']) && !empty($field['defaultValue']))
        {
            $field['defaultValue'] = $this->applyIdxMergeTags($field['defaultValue']);

            $field['defaultValue'] = $this->applyUserMergeTags($field['defaultValue']);
        }

        return $field;
    }


    /**
     * Detects common filed and modifies it to accept HJI values
     *
     * @since 1.0
     *
     * @param $field array GF field array
     * @return array GF field array
     */
    function hjifyCommonField($field)
    {
        switch($field['type'])
        {
            case 'name':
                $field['inputName']         = '{hjiUser.name}';
                $field['allowsPrepopulate'] = true;
                break;

            case 'email':
                $field['inputName']         = '{hjiUser.email}';
                $field['allowsPrepopulate'] = true;
                break;

            case 'phone':
                $field['inputName']         = '{hjiUser.phone}';
                $field['allowsPrepopulate'] = true;
                break;
        }

        return $field;
    }


    /**
     *
     *
     * [gform_validation] hook implementation
     * @url http://www.gravityhelp.com/documentation/page/Gform_validation
     *
     * @since 1.0
     *
     * @param $validation_result
     * @return mixed
     */
    function validateForm($validation_result)
    {
        return $validation_result;
    }


    /**
     * Returns array of user data from form entry
     * TODO: refactor original form names so they are plain
     * - no reg/login - just email, name, phone.
     *
     * @since 1.0
     * @param $formEntry GFEntry entity object
     * @return array|bool user data or false
     */
    function getUserDataFromFormEntry(GFEntry $formEntry)
    {
        $data = array();

        // Loop through all fields and search for field type email

        if ($email = $formEntry->getEmail())
        {
            $email = is_array($email) ? implode(' ', $email) : $email;

            if (filter_var($email, FILTER_VALIDATE_EMAIL))
            {
                $data['regemail'] = $email;
            }
        }

        if ($name = $formEntry->getName())
        {
            $fullName = GFHelper::getFirstLastName($name);

            $data['regfname'] = $fullName['first'];
            $data['reglname'] = $fullName['last'];
        }

        if ($phone = $formEntry->getPhone())
        {
            $data['regphone'] = is_array($phone) ? implode(' ', $phone) : $phone;
        }

        return (!empty($data) && isset($data['regemail'])) ? $data : false;
    }


    /**
     * Populate a Gravity Forms Name field.
     *
     * @url http://www.eugenoprea.com/code-snippets/gravity-forms-populate-name-field/
     *
     * @param array        $field  Gravity Forms field object
     * @param string|array $name   Name components, pass either a string or array when the
     *                             nameFormat is 'simple' or an array in all other cases
     */
    function populateNameField(&$field, $name = array())
    {
        if (!(is_array($field) && ('name' == rgar($field, 'type')) && !empty($name)))
        {
            return;
        }

        $field_id = $field['id'];
        $format = rgar($field, 'nameFormat');

        if (is_array($name))
        {
            $first = sanitize_text_field(rgar($name, 'first'));
            $last  = sanitize_text_field(rgar($name, 'last'));
        }

        switch ($format)
        {
            case 'simple':
                $default_value = isset($first, $last) ? ($first . ' ' . $last) : $name;
                $default_value = sanitize_text_field($default_value);
                break;

            case 'extended':
                $prefix = sanitize_text_field(rgar($name, 'prefix'));
                $suffix = sanitize_text_field(rgar($name, 'suffix'));

                $default_value = array_filter(array
                (
                    (strval($field_id . '.2')) => $prefix,
                    (strval($field_id . '.3')) => $first,
                    (strval($field_id . '.6')) => $last,
                    (strval($field_id . '.8')) => $suffix,
                ));

                break;

            case 'normal':
            default:
                $default_value = array_filter(array
                (
                    (strval($field_id . '.3')) => $first,
                    (strval($field_id . '.6')) => $last,
                ));
                break;
        }

        if (!empty($default_value))
        {
            $field['defaultValue'] = $default_value;
        }
    }

}

Namespaces

Classes

Interfaces

Functions