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

  • ActionsSearchFilters
  • ActionsWebServiceOptions
  • FavoritesViewModel
  • FrontEndNotices
  • RegistrationNotificationViewModel
  • Request
  • Settings
  • SettingsTab
  • User
  • UserActionsModel
  • UserFactory
  • UsersSearchModel

Class User

Namespace: hji\users\models
Located at classes/models/User.php

Methods summary

public
# __construct( hji\users\utils\UserAuth $auth, hji\users\models\UsersSearchModel $searchModel )
public boolean
# getUser( boolean $email = false, boolean $forceUserRequest = false, boolean $forceApiAuth = false )

Returns currently logged in user data or data looked up by provided email address

Returns currently logged in user data or data looked up by provided email address

Parameters

$email
$forceUserRequest
$forceApiAuth

Returns

boolean
public
# setError( array $error )

Adds error to the array of errors

Adds error to the array of errors

Parameters

$error
public boolean|array
# getErrors( )

Returns errors

Returns errors

Returns

boolean|array
  • array of errors or false
public mixed
# login( $data )

Log user in

Log user in

Parameters

$data
posted data array via login form

Returns

mixed
public
# updateAuthData( $data, $reAuthenticate = false )
public mixed
# createUser( $data )

Register new user account

Register new user account

Parameters

$data
posted data array via registration form

Returns

mixed
public
# updateUser( $userId, array $params )
public
# logout( )

Log user out

Log user out

public
# processRegistrationData( $data )
public
# processLoginData( $data )
public
# logAction( $action, array $tags, array $parameters, $userId )

Properties summary

public $auth
#
protected $searchModel
#
protected hji\users\models\UserFactory $userFactory

Delegates creation of user objects

Delegates creation of user objects

#
HJI WP Membership Code Reference API documentation generated by ApiGen