XpressEngine Core  1.11.2
 All Classes Namespaces Files Functions Variables Pages
Public Member Functions | Public Attributes | List of all members
memberModel Class Reference

Model class of the member module. More...

Inheritance diagram for memberModel:
member ModuleObject BaseObject

Public Member Functions

 init ()
 Initialization. More...
 
 getMemberConfig ()
 Return member's configuration. More...
 
 _getAgreement ()
 
 getMemberMenu ()
 Display menus of the member. More...
 
 isLogged ()
 Check if logged-in. More...
 
 getLoggedInfo ()
 Return session information of the logged-in user. More...
 
 getMemberInfoByUserID ($user_id, $columnList=array())
 Return member information with user_id. More...
 
 getMemberInfoByEmailAddress ($email_address)
 Return member information with email_address. More...
 
 getMemberInfoByMemberSrl ($member_srl, $site_srl=0, $columnList=array())
 Return member information with member_srl. More...
 
 arrangeMemberInfo ($info, $site_srl=0)
 Add member info from extra_vars and other information. More...
 
 getMemberSrlByUserID ($user_id)
 Get member_srl corresponding to userid. More...
 
 getMemberSrlByEmailAddress ($email_address)
 Get member_srl corresponding to EmailAddress. More...
 
 getMemberSrlByNickName ($nick_name)
 Get member_srl corresponding to nickname. More...
 
 getLoggedMemberSrl ()
 Return member_srl of the current logged-in user. More...
 
 getLoggedUserID ()
 Return user_id of the current logged-in user. More...
 
 getMemberGroups ($member_srl, $site_srl=0, $force_reload=false)
 Get a list of groups which the member_srl belongs to. More...
 
 getMembersGroups ($member_srls, $site_srl=0)
 Get a list of groups which member_srls belong to. More...
 
 getDefaultGroup ($site_srl=0, $columnList=array())
 Get a default group. More...
 
 getAdminGroup ($columnList=array())
 Get an admin group. More...
 
 getGroup ($group_srl, $columnList=array())
 Get group info corresponding to group_srl. More...
 
 getGroups ($site_srl=0)
 Get a list of groups. More...
 
 getApiGroups ()
 
 getJoinFormList ($filter_response=false)
 Get a list of member join forms. More...
 
 getUsedJoinFormList ()
 
 getCombineJoinForm ($member_info)
 Combine extend join form and member information (used to modify member information) More...
 
 getJoinForm ($member_join_form_srl)
 Get a join form. More...
 
 getDeniedIDList ()
 Get a list of denied IDs. More...
 
 getDeniedIDs ()
 
 getDeniedNickNames ()
 
 isDeniedID ($user_id)
 Verify if ID is denied. More...
 
 isDeniedNickName ($nickName)
 Verify if nick name is denied. More...
 
 getProfileImage ($member_srl)
 Get information of the profile image. More...
 
 getImageName ($member_srl)
 Get the image name. More...
 
 getImageMark ($member_srl)
 Get the image mark. More...
 
 getGroupImageMark ($member_srl, $site_srl=0)
 Get the image mark of the group. More...
 
 getSignature ($member_srl)
 Get user's signature. More...
 
 isValidPassword ($hashed_password, $password_text, $member_srl=null)
 Compare plain text password to the password saved in DB. More...
 
 hashPassword ($password_text, $algorithm=null)
 Create a hash of plain text password. More...
 
 checkPasswordStrength ($password, $strength)
 
 getAdminGroupSrl ($site_srl=0)
 
- Public Member Functions inherited from member
 __construct ()
 
 moduleInstall ()
 
 checkUpdate ()
 
 moduleUpdate ()
 
 recompileCache ()
 
 recordLoginError ($error=0, $message= 'success')
 Record login error and return the error, about IPaddress. More...
 
 recordMemberLoginError ($error=0, $message= 'success', $args=NULL)
 Record login error and return the error, about MemberSrl. More...
 
- Public Member Functions inherited from ModuleObject
 setModule ($module)
 
 setModulePath ($path)
 
 setRedirectUrl ($url= './', $output=NULL)
 
 getRedirectUrl ()
 
 setMessage ($message= 'success', $type=NULL)
 
 setMessageType ($type)
 
 getMessageType ()
 
 setRefreshPage ()
 
 setAct ($act)
 
 setModuleInfo ($module_info, $xml_info)
 
 stop ($msg_code)
 
 setTemplateFile ($filename)
 
 getTemplateFile ()
 
 setTemplatePath ($path)
 
 getTemplatePath ()
 
 setEditedLayoutFile ($filename)
 
 getEditedLayoutFile ()
 
 setLayoutFile ($filename)
 
 getLayoutFile ()
 
 setLayoutPath ($path)
 
 getLayoutPath ($layout_name="", $layout_type="P")
 
 proc ()
 
- Public Member Functions inherited from BaseObject
 __construct ($error=0, $message= 'success')
 
 setError ($error=0)
 
 getError ()
 
 setHttpStatusCode ($code= '200')
 
 getHttpStatusCode ()
 
 setMessage ($message= 'success', $type=NULL)
 
 getMessage ()
 
 add ($key, $val)
 
 adds ($object)
 
 get ($key)
 
 gets ()
 
 getVariables ()
 
 getObjectVars ()
 
 toBool ()
 
 toBoolean ()
 

Public Attributes

 $join_form_list = NULL
 Keep data internally which may be frequently called ... More...
 
- Public Attributes inherited from member
 $useSha1 = false
 
- Public Attributes inherited from ModuleObject
 $mid = NULL
 string to represent run-time instance of Module (XE Module) More...
 
 $module = NULL
 Class name of Xe Module that is identified by mid. More...
 
 $module_srl = NULL
 integer value to represent a run-time instance of Module (XE Module) More...
 
 $module_info = NULL
 an object containing the module information More...
 
 $origin_module_info = NULL
 
 $xml_info = NULL
 an object containing the module description extracted from XML file More...
 
 $module_path = NULL
 a path to directory where module source code resides More...
 
 $act = NULL
 a string value to contain the action name More...
 
 $template_path = NULL
 a path of directory where template files reside More...
 
 $template_file = NULL
 name of template file More...
 
 $layout_path = ''
 a path of directory where layout files reside More...
 
 $layout_file = ''
 name of layout file More...
 
 $edited_layout_file = ''
 name of temporary layout files that is modified in an admin mode More...
 
 $stop_proc = FALSE
 a flag to indicating whether to stop the execution of code. More...
 
 $module_config = NULL
 
 $ajaxRequestMethod = array('XMLRPC', 'JSON')
 
 $gzhandler_enable = TRUE
 
- Public Attributes inherited from BaseObject
 $error = 0
 
 $message = 'success'
 
 $variables = array()
 
 $httpStatusCode = NULL
 

Detailed Description

Model class of the member module.

Author
NAVER (devel.nosp@m.oper.nosp@m.s@xpr.nosp@m.esse.nosp@m.ngine.nosp@m..com)

Definition at line 8 of file member.model.php.

Member Function Documentation

memberModel::_getAgreement ( )

Definition at line 85 of file member.model.php.

memberModel::arrangeMemberInfo (   $info,
  $site_srl = 0 
)

Add member info from extra_vars and other information.

Definition at line 356 of file member.model.php.

memberModel::checkPasswordStrength (   $password,
  $strength 
)

Definition at line 1089 of file member.model.php.

memberModel::getAdminGroup (   $columnList = array())

Get an admin group.

Definition at line 574 of file member.model.php.

memberModel::getAdminGroupSrl (   $site_srl = 0)

Definition at line 1119 of file member.model.php.

memberModel::getApiGroups ( )

Definition at line 642 of file member.model.php.

memberModel::getCombineJoinForm (   $member_info)

Combine extend join form and member information (used to modify member information)

Definition at line 760 of file member.model.php.

memberModel::getDefaultGroup (   $site_srl = 0,
  $columnList = array() 
)

Get a default group.

Definition at line 544 of file member.model.php.

memberModel::getDeniedIDList ( )

Get a list of denied IDs.

Definition at line 824 of file member.model.php.

memberModel::getDeniedIDs ( )

Definition at line 839 of file member.model.php.

memberModel::getDeniedNickNames ( )

Definition at line 846 of file member.model.php.

memberModel::getGroup (   $group_srl,
  $columnList = array() 
)

Get group info corresponding to group_srl.

Definition at line 583 of file member.model.php.

memberModel::getGroupImageMark (   $member_srl,
  $site_srl = 0 
)

Get the image mark of the group.

Definition at line 963 of file member.model.php.

memberModel::getGroups (   $site_srl = 0)

Get a list of groups.

Definition at line 594 of file member.model.php.

memberModel::getImageMark (   $member_srl)

Get the image mark.

Definition at line 939 of file member.model.php.

memberModel::getImageName (   $member_srl)

Get the image name.

Definition at line 916 of file member.model.php.

memberModel::getJoinForm (   $member_join_form_srl)

Get a join form.

Definition at line 799 of file member.model.php.

memberModel::getJoinFormList (   $filter_response = false)

Get a list of member join forms.

This method works as an extend filter of modules/member/tpl/filter/insert.xml. To use as extend_filter, the argument should be boolean. When the argument is true, it returns object result in type of filter.

Definition at line 657 of file member.model.php.

memberModel::getLoggedInfo ( )

Return session information of the logged-in user.

Definition at line 229 of file member.model.php.

memberModel::getLoggedMemberSrl ( )

Return member_srl of the current logged-in user.

Definition at line 466 of file member.model.php.

memberModel::getLoggedUserID ( )

Return user_id of the current logged-in user.

Definition at line 475 of file member.model.php.

memberModel::getMemberConfig ( )

Return member's configuration.

Definition at line 25 of file member.model.php.

memberModel::getMemberGroups (   $member_srl,
  $site_srl = 0,
  $force_reload = false 
)

Get a list of groups which the member_srl belongs to.

Definition at line 485 of file member.model.php.

memberModel::getMemberInfoByEmailAddress (   $email_address)

Return member information with email_address.

Definition at line 287 of file member.model.php.

memberModel::getMemberInfoByMemberSrl (   $member_srl,
  $site_srl = 0,
  $columnList = array() 
)

Return member information with member_srl.

Definition at line 315 of file member.model.php.

memberModel::getMemberInfoByUserID (   $user_id,
  $columnList = array() 
)

Return member information with user_id.

Definition at line 269 of file member.model.php.

memberModel::getMemberMenu ( )

Display menus of the member.

Definition at line 116 of file member.model.php.

memberModel::getMembersGroups (   $member_srls,
  $site_srl = 0 
)

Get a list of groups which member_srls belong to.

Definition at line 525 of file member.model.php.

memberModel::getMemberSrlByEmailAddress (   $email_address)

Get member_srl corresponding to EmailAddress.

Definition at line 444 of file member.model.php.

memberModel::getMemberSrlByNickName (   $nick_name)

Get member_srl corresponding to nickname.

Definition at line 455 of file member.model.php.

memberModel::getMemberSrlByUserID (   $user_id)

Get member_srl corresponding to userid.

Definition at line 433 of file member.model.php.

memberModel::getProfileImage (   $member_srl)

Get information of the profile image.

Definition at line 887 of file member.model.php.

memberModel::getSignature (   $member_srl)

Get user's signature.

Definition at line 1005 of file member.model.php.

memberModel::getUsedJoinFormList ( )

get used join form list.

Returns
array $joinFormList

Definition at line 732 of file member.model.php.

memberModel::hashPassword (   $password_text,
  $algorithm = null 
)

Create a hash of plain text password.

Parameters
string$password_textThe password to hash
string$algorithmThe algorithm to use (optional, only set this when you want to use a non-default algorithm)
Returns
string

Definition at line 1083 of file member.model.php.

memberModel::init ( )

Initialization.

Definition at line 18 of file member.model.php.

memberModel::isDeniedID (   $user_id)

Verify if ID is denied.

Definition at line 860 of file member.model.php.

memberModel::isDeniedNickName (   $nickName)

Verify if nick name is denied.

Definition at line 872 of file member.model.php.

memberModel::isLogged ( )

Check if logged-in.

Definition at line 197 of file member.model.php.

memberModel::isValidPassword (   $hashed_password,
  $password_text,
  $member_srl = null 
)

Compare plain text password to the password saved in DB.

Parameters
string$hashed_passwordThe hash that was saved in DB
string$password_textThe password to check
int$member_srlSet this to member_srl when comparing a member's password (optional)
Returns
bool

Definition at line 1028 of file member.model.php.

Member Data Documentation

memberModel::$join_form_list = NULL

Keep data internally which may be frequently called ...

Definition at line 13 of file member.model.php.


The documentation for this class was generated from the following file: