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 User

Class Component to use for extending components, controllers and models in other plugins

hji\membership\services\DependencyInjector
Extended by hji\membership\abstracts\Component
Extended by hji\membership\extension\abstracts\Component implements hji\membership\extension\interfaces\ExtensionInterface
Extended by hji\users\core\abstracts\Component
Extended by hji\users\core\Controller
Extended by hji\users\controllers\User
Namespace: hji\users\controllers
Package: hji\membership\extension\abstracts
Codecoverageignore
Located at classes/controllers/User.php

Methods summary

public
# dump_user_object( )
public static hjiUser
# getInstance( )

Instance of the User Object

Instance of the User Object

Returns

hjiUser
public
# init( )
protected
# createUserModel( )
public
# initUser( )

Initializing logged in user object

Initializing logged in user object

public
# initSocialAuth( )
public mixed
# getUser( )

Returns User Object

Returns User Object

Returns

mixed
public boolean
# isLoggedIn( )

Checks if current user logged in.

Checks if current user logged in.

Returns

boolean
public
# setWPActions( )
public
# initUserPanel( )
public
# queryVars( $queryVars )
public static
# addRewriteRules( )
public
# userObjectJS( $js )
public
# ajaxAddFavorite( )
public
# ajaxRemoveFavorite( )
public
# ajaxAddSearch( )
public
# ajaxRemoveSearch( )
public
# ajaxUpdateSearch( )
public
# userAccountView( $posts )
public array
# userAccountFavoritesView( )

Returns HTML View for User Page

Returns HTML View for User Page

Returns

array
public boolean|string
# userAccountSearchesView( )

Returns HTML content with user saved searches

Returns HTML content with user saved searches

Returns

boolean|string
public boolean|string
# userAccountSectionsView( )

Returns HTML links to user account sections.

Returns HTML links to user account sections.

Returns

boolean|string
public boolean|string
# userAccountPersonalInfoView( )

Returns HTML for User Info + Edit Form

Returns HTML for User Info + Edit Form

Returns

boolean|string
public
# userRegistrationConfirmationView( $query )

Registration confirmation page view

Registration confirmation page view

public
# _confirmationContent( $duplicate = false )
public
# FirstTimeConfirmationView( )
public
# DuplicateConfirmationView( )
public
# _makePostsObj( $title, $content, $url )
public
# renderLoginLogout( )

Renders Login and Logout Forms

Renders Login and Logout Forms

public
# renderAddSearchModalForm( )

Renders Save Search modal form

Renders Save Search modal form

public
# renderLoginLogoutModalForms( )

Renders login and logout modal forms

Renders login and logout modal forms

public boolean|string
# getLogoutForm( )

Returns HTML for logout form

Returns HTML for logout form

Returns

boolean|string
public string
# getUserUrl( $id )

Returns User Account URL

Returns User Account URL

Parameters

$id

Returns

string
public
# getRegistrationConfirmationUrl( $email )
public
# ajaxRegister( )

Processes User Registration dada passed via Ajax

Processes User Registration dada passed via Ajax

TODO: refactor this method. Make sure registration happens via the same method no matter how user registers. See loginRegister() method.

public
# ajaxLogin( )

Processes User Login dada passed via Ajax

Processes User Login dada passed via Ajax

public
# processPostData( )
public boolean
# isRegistrationConfirmation( )

Checks if current request is for registration confirmation If true - returns email address

Checks if current request is for registration confirmation If true - returns email address

Returns

boolean
public
# dispatchConfirmationEmail( $user )

Sends a registration confirmation email.

Sends a registration confirmation email.

Parameters

$user
object
public
# notifyAdminOfNewRegistration( $user )
public
# dispatchAdminNotification( hji\users\entities\User $user )

Sends a registration notification email to the admin.

Sends a registration notification email to the admin.

Parameters

$user
object
public string
# set_html_content_type( )

Sets email content type

Sets email content type

Returns

string
public
# use_template( $template )
public
# login( $data )
public
# loginRegister( $userData )

Attempts to register user, if user exists, logs user in

Attempts to register user, if user exists, logs user in

public
# updateUserProfile( )
public
# logout( )
public
# requireRegistrationShortcode( )
public
# renderSignInWidget( )

Methods inherited from hji\membership\extension\abstracts\Component

getMembershipServices(), getProjectRoute(), getServices(), membershipServices(), services()

Methods inherited from hji\membership\abstracts\Component

getServiceContainer()

Methods inherited from hji\membership\services\DependencyInjector

di()

Properties summary

protected $user
#
protected $registrationPrompter
#
HJI WP Membership Code Reference API documentation generated by ApiGen