HJI WP Membership Code Reference
  • Namespace
  • Class
  • Tree
  • Deprecated
  • Todo
  • Hook Reference
  • Slipstream API Docs

Namespaces

  • hji
    • AgentRoster
      • controllers
      • models
      • utils
    • common
      • factories
      • interfaces
      • models
      • utils
    • construction
      • admin
        • controllers
        • models
      • core
      • front
        • controllers
      • interfaces
      • models
        • listings
        • subdivisions
      • views
    • geofarms
      • common
      • controllers
      • models
      • widgets
    • homevalue
      • controllers
      • core
        • abstracts
      • models
    • lifestylefinder
    • listingstoblog
      • controllers
    • membership
      • abstracts
      • controllers
      • entities
      • extension
        • abstracts
        • interfaces
      • factories
      • includes
      • interfaces
      • models
        • data
        • webservice
          • abstracts
          • actions
          • interfaces
      • observers
      • services
    • recentsales
      • controllers
      • tinymce
      • widgets
    • ResponsiveIDX
      • abstracts
      • adapters
      • controllers
      • core
        • abstracts
      • entities
      • models
      • services
      • tinymce
      • utils
      • widgets
    • schools
      • controllers
      • tinymce
      • widgets
    • users
      • abstracts
      • admin
        • controllers
        • models
      • controllers
      • core
        • abstracts
      • entities
      • models
      • utils
  • None
  • REL
    • controllers
    • Models
    • Taxonomies
    • Utils
      • Convert
    • widgets

Classes

  • GravityForms
  • GravityFormsAdmin
  • RegistrationPrompter
  • Settings
  • SocialAuth
  • User
  • UserPanel

Class GravityForms

Namespace: hji\users\controllers
Located at classes/controllers/GravityForms.php

Methods summary

public
# __construct( hji\users\entities\User $user, hji\users\models\User $userModel )
public
# registerPublicActions( )

Register WP Action Hooks implementations

Register WP Action Hooks implementations

public
# setDynamicParameters( )
public
# getDynamicParameters( $tagName = false )
public string
# populateUserFields( $value, $field, $name )

Injects current user information if {hjiUser.} dynamic parameter is set

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

Parameters

$value
$field
$name

Returns

string
public string
# hideUserFields( $classes, $field, $form )

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.

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

Parameters

$classes
$field
$form

Returns

string
public mixed
# applyIdxMergeTags( $value )

Substitutes GF rIDX merge tags in a string with respective rIDX field values

Substitutes GF rIDX merge tags in a string with respective rIDX field values

Parameters

$value
  • content of a field

Returns

mixed
string

Since

1.0
public mixed
# applyUserMergeTags( $value )

Substitutes GF hjiUSer merge tags in a string with respective logged-in user values

Substitutes GF hjiUSer merge tags in a string with respective logged-in user values

Parameters

$value
  • content of a field

Returns

mixed
string

Since

1.0
public
# afterFormSubmission( $entry, $form )

Runs after gfoms is being submitted: registers and/or logs user in if not logged in and/or records form submission as action

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

Parameters

$entry
$form
public boolean|hji\users\controllers\Logged|hji\users\entities\User|mixed
# _registerLogin( $formEntry )

Registers and/or logs user in based on form entry TODO: REFACTOR - move registerLogin at once to UserModel (Controller?) - we should just pass data.

Registers and/or logs user in based on form entry TODO: REFACTOR - move registerLogin at once to UserModel (Controller?) - we should just pass data.

Parameters

$formEntry

Returns

boolean|hji\users\controllers\Logged|hji\users\entities\User|mixed
public
# renderHeaderScripts( )
public array
# modifyFieldsProperties( $form )

Modify fields properties to accept HJI data

Modify fields properties to accept HJI data

Parameters

$form
form array

Returns

array
GF form array

Since

1.0

Action hook [gform_pre_render] implementation


Url

http://www.gravityhelp.com/documentation/page/Gform_pre_render
public array
# applyMergeTags( $field )

Applies HJI merge tags to defaultValue of the field.

Applies HJI merge tags to defaultValue of the field.

Parameters

$field
field array with field properties

Returns

array
public array
# hjifyCommonField( $field )

Detects common filed and modifies it to accept HJI values

Detects common filed and modifies it to accept HJI values

Parameters

$field
GF field array

Returns

array
GF field array

Since

1.0
public mixed
# validateForm( $validation_result )

[gform_validation] hook implementation

Parameters

$validation_result

Returns

mixed

Since

1.0

Url

http://www.gravityhelp.com/documentation/page/Gform_validation
public array|boolean
# getUserDataFromFormEntry( hji\users\entities\GFEntry $formEntry )

Returns array of user data from form entry TODO: refactor original form names so they are plain - no reg/login - just email, name, phone.

Returns array of user data from form entry TODO: refactor original form names so they are plain - no reg/login - just email, name, phone.

Parameters

$formEntry
entity object

Returns

array|boolean
user data or false

Since

1.0
public
# populateNameField( array & $field, string|array $name = array() )

Populate a Gravity Forms Name field.

Populate a Gravity Forms Name field.

Parameters

$field
Gravity Forms field object
$name

Name components, pass either a string or array when the nameFormat is 'simple' or an array in all other cases

Url

http://www.eugenoprea.com/code-snippets/gravity-forms-populate-name-field/

Properties summary

protected Logged $user

in user entity object

in user entity object

#
protected hji\users\controllers\User $userModel

model

model

#
protected $userController
#
protected array $dynamicParameters
# array()
public static string $idxObjName
# 'hjiRidx'
public static string $userObjName
# 'hjiUser'
HJI WP Membership Code Reference API documentation generated by ApiGen