add phpDoc in member module

git-svn-id: http://xe-core.googlecode.com/svn/branches/1.5.0@10838 201d5d3c-b55e-5fd7-737f-ddc643e51545
This commit is contained in:
devjin 2012-07-06 04:49:27 +00:00
parent a0a824166d
commit 634b6b78ea
6 changed files with 431 additions and 111 deletions

View file

@ -2,19 +2,21 @@
/**
* @class memberAdminController
* @author NHN (developers@xpressengine.com)
* @brief member module of the admin controller class
* member module of the admin controller class
**/
class memberAdminController extends member {
/**
* @brief Initialization
* Initialization
* @return void
**/
function init() {
}
/**
* @brief Add a user (Administrator)
* Add a user (Administrator)
* @return void|Object (void : success, Object : fail)
**/
function procMemberAdminInsert() {
// if(Context::getRequestMethod() == "GET") return new Object(-1, "msg_invalid_request");
@ -109,7 +111,8 @@
}
/**
* @brief Delete a user (Administrator)
* Delete a user (Administrator)
* @return void|Object (void : success, Object : fail)
**/
function procMemberAdminDelete() {
// Separate all the values into DB entries and others
@ -123,6 +126,10 @@
$this->setMessage("success_deleted");
}
/**
* Set config of member
* @return void|Object (void : success, Object : fail)
**/
function procMemberAdminInsertConfig(){
$input_args = Context::gets(
'enable_join',
@ -234,6 +241,12 @@
$this->setRedirectUrl($returnUrl);
}
/**
* Create ruleset file of signup
* @param object $signupForm (user define signup form)
* @param string $agreement
* @return void
**/
function _createSignupRuleset($signupForm, $agreement = null){
$xml_file = './files/ruleset/insertMember.xml';
$buff = '<?xml version="1.0" encoding="utf-8"?>' . PHP_EOL
@ -281,6 +294,11 @@
$validator->getJsPath();
}
/**
* Create ruleset file of login
* @param string $identifier (login identifier)
* @return void
**/
function _createLoginRuleset($identifier){
$xml_file = './files/ruleset/login.xml';
$buff = '<?xml version="1.0" encoding="utf-8"?>'
@ -303,6 +321,11 @@
$validator->getJsPath();
}
/**
* Create ruleset file of find account
* @param string $identifier (login identifier)
* @return void
**/
function _createFindAccountByQuestion($identifier){
$xml_file = './files/ruleset/find_member_account_by_question.xml';
$buff = '<?xml version="1.0" encoding="utf-8"?>'
@ -329,7 +352,8 @@
}
/**
* @brief Add a user group
* Add a user group
* @return void|Object (void : success, Object : fail)
**/
function procMemberAdminInsertGroup() {
$args = Context::gets('title','description','is_default','image_mark');
@ -345,7 +369,8 @@
}
/**
* @brief Update user group information
* Update user group information
* @return void|Object (void : success, Object : fail)
**/
function procMemberAdminUpdateGroup() {
$group_srl = Context::get('group_srl');
@ -364,7 +389,8 @@
}
/**
* @brief Update user group information
* Update user group information
* @return void|Object (void : success, Object : fail)
**/
function procMemberAdminDeleteGroup() {
$group_srl = Context::get('group_srl');
@ -381,7 +407,8 @@
}
/**
* @brief Add a join form
* Add a join form
* @return void|Object (void : success, Object : fail)
**/
function procMemberAdminInsertJoinForm() {
$args->member_join_form_srl = Context::get('member_join_form_srl');
@ -442,6 +469,10 @@
$this->setRedirectUrl($returnUrl);
}
/**
* Delete a join form
* @return void
**/
function procMemberAdminDeleteJoinForm(){
$member_join_form_srl = Context::get('member_join_form_srl');
$this->deleteJoinForm($member_join_form_srl);
@ -460,7 +491,9 @@
}
/**
* @brief Move up/down the member join form and modify it
* Move up/down the member join form and modify it
* @deprecated
* @return void
**/
function procMemberAdminUpdateJoinForm() {
$member_join_form_srl = Context::get('member_join_form_srl');
@ -489,6 +522,7 @@
/**
* selected member manager layer in dispAdminList
* @return void|Object (void : success, Object : fail)
**/
function procMemberAdminSelectedMemberManage(){
$var = Context::getRequestVars();
@ -561,7 +595,8 @@
}
/**
* @brief Delete the selected members
* Delete the selected members
* @return void|Object (void : success, Object : fail)
*/
function procMemberAdminDeleteMembers() {
$target_member_srls = Context::get('target_member_srls');
@ -581,7 +616,8 @@
}
/**
* @brief Update a group of selected memebrs
* Update a group of selected memebrs
* @return void|Object (void : success, Object : fail)
**/
function procMemberAdminUpdateMembersGroup() {
$member_srl = Context::get('member_srl');
@ -638,7 +674,8 @@
}
/**
* @brief Add a denied ID
* Add a denied ID
* @return void
**/
function procMemberAdminInsertDeniedID() {
$user_ids = Context::get('user_id');
@ -658,7 +695,8 @@
}
/**
* @brief Update denied ID
* Update denied ID
* @return void|Object (void : success, Object : fail)
**/
function procMemberAdminUpdateDeniedID() {
$user_id = Context::get('user_id');
@ -677,7 +715,9 @@
}
/**
* @brief Add an administrator
* Add an administrator
* @param object $args
* @return object (info of added member)
**/
function insertAdmin($args) {
// Assign an administrator
@ -692,7 +732,10 @@
}
/**
* @brief Change the group values of member
* Change the group values of member
* @param int $source_group_srl
* @param int $target_group_srl
* @return Object
**/
function changeGroup($source_group_srl, $target_group_srl) {
$args->source_group_srl = $source_group_srl;
@ -702,7 +745,9 @@
}
/**
* @brief find_account_answerInsert a group
* find_account_answerInsert a group
* @param object $args
* @return Object
**/
function insertGroup($args) {
if(!$args->site_srl) $args->site_srl = 0;
@ -719,7 +764,9 @@
}
/**
* @brief Modify Group Information
* Modify Group Information
* @param object $args
* @return Object
**/
function updateGroup($args) {
// Check the value of is_default.
@ -736,6 +783,9 @@
/**
* Delete a Group
* @param int $group_srl
* @param int $site_srl
* @return Object
**/
function deleteGroup($group_srl, $site_srl = 0) {
// Create a member model object
@ -759,6 +809,7 @@
/**
* Set group config
* @return void
**/
function procMemberAdminGroupConfig() {
$vars = Context::getRequestVars();
@ -794,6 +845,10 @@
$this->setRedirectUrl($returnUrl);
}
/**
* Set group order
* @return void
**/
function procMemberAdminUpdateGroupOrder() {
$vars = Context::getRequestVars();
@ -807,7 +862,10 @@
}
/**
* @brief Register denied ID
* Register denied ID
* @param string $user_id
* @param string $description
* @return Object
**/
function insertDeniedID($user_id, $description = '') {
$args->user_id = $user_id;
@ -818,7 +876,9 @@
}
/**
* @brief Delete a denied ID
* Delete a denied ID
* @param string $user_id
* @return Object
**/
function deleteDeniedID($user_id) {
$args->user_id = $user_id;
@ -826,7 +886,9 @@
}
/**
* @brief Delete a join form
* Delete a join form
* @param int $member_join_form_srl
* @return Object
**/
function deleteJoinForm($member_join_form_srl) {
$args->member_join_form_srl = $member_join_form_srl;
@ -835,7 +897,10 @@
}
/**
* @brief Move up a join form
* Move up a join form
* @deprecated
* @param int $member_join_form_srl
* @return Object
**/
function moveJoinFormUp($member_join_form_srl) {
$oMemberModel = &getModel('member');
@ -874,7 +939,10 @@
}
/**
* @brief Move down a join form
* Move down a join form
* @deprecated
* @param int $member_join_form_srl
* @return Object
**/
function moveJoinFormDown($member_join_form_srl) {
$oMemberModel = &getModel('member');

View file

@ -2,26 +2,40 @@
/**
* @class memberAdminModel
* @author NHN (developers@xpressengine.com)
* @brief admin model class of member module
* admin model class of member module
**/
class memberAdminModel extends member {
/**
* @brief Keep data internally which may be frequently called.
* info of member
* @var object
**/
var $member_info = NULL;
/**
* info of member groups
* @var array
**/
var $member_groups = NULL;
/**
* info of sign up form
* @var array
**/
var $join_form_list = NULL;
/**
* @brief Initialization
* Initialization
* @return void
**/
function init() {
}
/**
* @brief Get a member list
* Get a member list
*
* @return object|array (object : when member count is 1, array : when member count is more than 1)
**/
function getMemberList() {
// Search option
@ -119,7 +133,12 @@
}
/**
* @brief Get a memebr list for each site
* Get a memebr list for each site
*
* @param int $site_srl
* @param int $page
*
* @return array
**/
function getSiteMemberList($site_srl, $page = 1) {
$args->site_srl = $site_srl;
@ -131,6 +150,11 @@
return $output;
}
/**
* Get member_srls lists about site admins
*
* @return array
**/
function getSiteAdminMemberSrls(){
$output = executeQueryArray('member.getSiteAdminMemberSrls');
if (!$output->toBool() || !$output->data) return array();
@ -144,7 +168,9 @@
}
/**
* @brief Return colorset list of a skin in the member module
* Return colorset list of a skin in the member module
*
* @return void
**/
function getMemberAdminColorset() {
$skin = Context::get('skin');
@ -167,7 +193,11 @@
}
/**
* @brief Return member count with date
* Return member count with date
*
* @param string $date
*
* @return int
**/
function getMemberCountByDate($date = '') {
if($date) $args->regDate = date('Ymd', strtotime($date));
@ -179,7 +209,11 @@
}
/**
* @brief Return site join member count with date
* Return site join member count with date
*
* @param string $date
*
* @return int
**/
function getMemberGroupMemberCountByDate($date = '') {
if($date) $args->regDate = date('Ymd', strtotime($date));
@ -191,7 +225,9 @@
}
/**
* @brief Return add join Form
* Return add join Form
*
* @return void
**/
function getMemberAdminInsertJoinForm() {
$member_join_form_srl = Context::get('member_join_form_srl');
@ -214,6 +250,13 @@
$this->add('tpl', str_replace("\n"," ",$tpl));
}
/**
* check allowed target ip address when login for admin.
*
* @return boolean (true : allowed, false : refuse)
**/
function getMemberAdminIPCheck() {
$db_info = Context::getDBInfo();

View file

@ -2,15 +2,29 @@
/**
* @class memberAdminView
* @author NHN (developers@xpressengine.com)
* @brief member module's admin view class
* member module's admin view class
**/
class memberAdminView extends member {
var $group_list = NULL; ///< group list
var $memberInfo = NULL; ///< selected member info
/**
* Group list
*
* @var array
**/
var $group_list = NULL;
/**
* Selected member info
*
* @var array
**/
var $memberInfo = NULL;
/**
* @brief initialization
* initialization
*
* @return void
**/
function init() {
$oMemberModel = &getModel('member');
@ -31,7 +45,9 @@
}
/**
* @brief display member list
* display member list
*
* @return void
**/
function dispMemberAdminList() {
$oMemberAdminModel = &getAdminModel('member');
@ -81,7 +97,9 @@
}
/**
* @brief default configuration for member management
* default configuration for member management
*
* @return void
**/
function dispMemberAdminConfig() {
global $lang; // retrieve configuration via module model instance
@ -124,7 +142,9 @@
}
/**
* @brief display member information
* display member information
*
* @return void
**/
function dispMemberAdminInfo() {
$oMemberModel = &getModel('member');
@ -148,7 +168,9 @@
}
/**
* @brief display member insert form
* display member insert form
*
* @return void
**/
function dispMemberAdminInsert() {
// retrieve extend form
@ -189,6 +211,14 @@
$this->setTemplateFile('insert_member');
}
/**
* Get tags by the member info type
*
* @param object $memberInfo
* @param boolean $isAdmin (true : admin, false : not admin)
*
* @return array
**/
function _getMemberInputTag($memberInfo, $isAdmin = false){
$oMemberModel = &getModel('member');
$extend_form_list = $oMemberModel->getCombineJoinForm($memberInfo);
@ -372,7 +402,9 @@ EOD;
}
/**
* @brief display member delete form
* display member delete form
*
* @return void
**/
function dispMemberAdminDeleteForm() {
if(!Context::get('member_srl')) return $this->dispMemberAdminList();
@ -380,7 +412,9 @@ EOD;
}
/**
* @brief display group list
* display group list
*
* @return void
**/
function dispMemberAdminGroupList() {
$oModuleModel = &getModel('module');
@ -401,7 +435,9 @@ EOD;
}
/**
* @brief Display a list of member join form
* Display a list of member join form
*
* @return void
**/
function dispMemberAdminJoinFormList() {
// Create a member model object
@ -416,7 +452,9 @@ EOD;
}
/**
* @brief Display an admin page for memebr join forms
* Display an admin page for memebr join forms
*
* @return void
**/
function dispMemberAdminInsertJoinForm() {
// Get the value of join_form
@ -437,7 +475,9 @@ EOD;
}
/**
* @brief Display denied ID list
* Display denied ID list
*
* @return void
**/
function dispMemberAdminDeniedIDList() {
// Create a member model object
@ -457,7 +497,9 @@ EOD;
}
/**
* @brief Update all the member groups
* Update all the member groups
*
* @return void
**/
function dispMemberAdminManageGroup() {
// Get a list of the selected member
@ -476,7 +518,9 @@ EOD;
}
/**
* @brief Delete all members
* Delete members
*
* @return void
**/
function dispMemberAdminDeleteMembers() {
// Get a list of the selected member

View file

@ -2,14 +2,17 @@
/**
* @class memberAPI
* @author NHN (developers@xpressengine.com)
* @brief API Processing of View Action in the member module
* API Processing of View Action in the member module
**/
class memberAPI extends member {
/**
* @brief Content List
* Content List
*
* @param Object $oModule
*
* @return void
**/
function dispSavedDocumentList(&$oModule) {
$document_list = $this->arrangeContentList(Context::get('document_list'));
@ -17,8 +20,13 @@
$oModule->add('page_navigation',Context::get('page_navigation'));
}
/**
* Arrange Contents
*
* @param array $content_list
*
* @return array
**/
function arrangeContentList($content_list) {
$output = array();
if(count($content_list)) {
@ -27,7 +35,13 @@
return $output;
}
/**
* Arrange Contents
*
* @param array $content_list
*
* @return array
**/
function arrangeContent($content) {
$output = null;
if($content){
@ -35,6 +49,5 @@
}
return $output;
}
}
?>

View file

@ -2,14 +2,21 @@
/**
* @class member
* @author NHN (developers@xpressengine.com)
* @brief high class of the member module
* high class of the member module
**/
class member extends ModuleObject {
/**
* Use sha1 encryption
*
* @var boolean
**/
var $useSha1 = false;
/**
* @brief constructor
* constructor
*
* @return void
**/
function member() {
if(!Context::isInstalled()) return;
@ -30,7 +37,9 @@
}
/**
* @brief Implement if additional tasks are necessary when installing
* Implement if additional tasks are necessary when installing
*
* @return Object
**/
function moduleInstall() {
// Register action forward (to use in administrator mode)
@ -150,7 +159,9 @@
}
/**
* @brief a method to check if successfully installed
* a method to check if successfully installed
*
* @return boolean
**/
function checkUpdate() {
$oDB = &DB::getInstance();
@ -195,7 +206,9 @@
}
/**
* @brief Execute update
* Execute update
*
* @return Object
**/
function moduleUpdate() {
$oDB = &DB::getInstance();
@ -329,7 +342,9 @@
}
/**
* @brief Re-generate the cache file
* Re-generate the cache file
*
* @return void
**/
function recompileCache() {
set_include_path(_XE_PATH_."modules/member/php-openid-1.2.3");

View file

@ -2,20 +2,34 @@
/**
* @class memberController
* @author NHN (developers@xpressengine.com)
* @brief Controller class of member module
* Controller class of member module
**/
class memberController extends member {
/**
* Info of selected member
*
* @var object
**/
var $memberInfo;
/**
* @brief Initialization
* Initialization
*
* @return void
**/
function init() {
}
/**
* @brief Log-in by checking user_id and password
* Log-in by checking user_id and password
*
* @param string $user_id
* @param string $password
* @param string $keep_signed
*
* @return void|Object (void : success, Object : fail)
**/
function procMemberLogin($user_id = null, $password = null, $keep_signed = null) {
if(!$user_id && !$password && Context::getRequestMethod() == 'GET')
@ -67,7 +81,13 @@
}
/**
* @brief Login by openid
* Login by openid
*
* @deprecated
*
* @param string $validator
*
* @return void|Object (void : success, Object : fail)
**/
function procMemberOpenIDLogin($validator = "procMemberOpenIDValidate") {
$oModuleModel = &getModel('module');
@ -109,6 +129,15 @@
$this->setRedirectUrl($redirect_url);
}
/**
* Legacy open id
*
* @deprecated
*
* @param string $openid_identity
*
* @return array
**/
function getLegacyUserIDsFromOpenID($openid_identity) {
// Issue 17515512: workaround
$result = array();
@ -151,7 +180,9 @@
}
/**
* @brief openid authentication check
* openid authentication check
*
* @return void|Object (void : success, Object : fail)
**/
function procMemberOpenIDValidate() {
set_include_path(_XE_PATH_."modules/member/php-openid-1.2.3");
@ -252,14 +283,18 @@
}
/**
* @brief Request member join by openID
* Request member join by openID
*
* @return Object
**/
function procMemberAddOpenIDToMember() {
return $this->procMemberOpenIDLogin("procMemberValidateAddOpenIDToMember");
}
/**
* @brief Validate openID processing
* Validate openID processing
*
* @return Object
**/
function procMemberValidateAddOpenIDToMember() {
set_include_path(_XE_PATH_."modules/member/php-openid-1.2.3");
@ -311,7 +346,9 @@
}
/**
* @brief Disconnect OpenID
* Disconnect OpenID
*
* @return void
**/
function procMemberDeleteOpenIDFromMember() {
$logged_info = Context::get('logged_info');
@ -343,7 +380,9 @@
/**
* @brief Log-out
* Log-out
*
* @return Object
**/
function procMemberLogout() {
// Call a trigger before log-out (before)
@ -367,7 +406,9 @@
}
/**
* @brief Scrap
* Scrap document
*
* @return void|Object (void : success, Object : fail)
**/
function procMemberScrapDocument() {
// Check login information
@ -400,7 +441,9 @@
}
/**
* @brief Delete a scrap
* Delete a scrap
*
* @return void|Object (void : success, Object : fail)
**/
function procMemberDeleteScrap() {
// Check login information
@ -416,15 +459,18 @@
}
/**
* @brief Save posts
* @Deprecated - instead Document Controller - procDocumentTempSave method use
* Save posts
* @deprecated - instead Document Controller - procDocumentTempSave method use
* @return Object
**/
function procMemberSaveDocument() {
return new Object(0, 'Deprecated method');
}
/**
* @brief Delete the post
* Delete the post
*
* @return void|Object (void : success, Object : fail)
**/
function procMemberDeleteSavedDocument() {
// Check login information
@ -439,7 +485,9 @@
}
/**
* @brief Check values when member joining
* Check values when member joining
*
* @return void|Object (void : success, Object : fail)
**/
function procMemberCheckValue() {
$name = Context::get('name');
@ -474,7 +522,9 @@
}
/**
* @brief Join Membership
* Join Membership
*
* @return void|Object (void : success, Object : fail)
**/
function procMemberInsert() {
if (Context::getRequestMethod () == "GET") return new Object (-1, "msg_invalid_request");
@ -606,7 +656,9 @@
}
/**
* @brief Edit member profile
* Edit member profile
*
* @return void|Object (void : success, Object : fail)
**/
function procMemberModifyInfo() {
if(!Context::get('is_logged')) return $this->stop('msg_not_logged');
@ -695,7 +747,9 @@
}
/**
* @brief Change the user password
* Change the user password
*
* @return void|Object (void : success, Object : fail)
**/
function procMemberModifyPassword() {
if(!Context::get('is_logged')) return $this->stop('msg_not_logged');
@ -730,7 +784,9 @@
}
/**
* @brief Membership withdrawal
* Membership withdrawal
*
* @return void|Object (void : success, Object : fail)
**/
function procMemberLeave() {
if(!Context::get('is_logged')) return $this->stop('msg_not_logged');
@ -763,7 +819,9 @@
}
/**
* @brief OpenID Withdrawal
* OpenID Withdrawal
*
* @return void|Object (void : success, Object : fail)
**/
function procMemberOpenIDLeave() {
// Return an error if in the non-login state
@ -783,7 +841,9 @@
}
/**
* @brief Add a profile image
* Add a profile image
*
* @return void|Object (void : success, Object : fail)
**/
function procMemberInsertProfileImage() {
// Check if the file is successfully uploaded
@ -808,6 +868,14 @@
$this->setRedirectUrl($returnUrl);
}
/**
* Insert a profile image
*
* @param int $member_srl
* @param object $target_file
*
* @return void
**/
function insertProfileImage($member_srl, $target_file) {
$oModuleModel = &getModel('module');
$config = $oModuleModel->getModuleConfig('member');
@ -832,7 +900,9 @@
}
/**
* @brief Add an image name
* Add an image name
*
* @return void|Object (void : success, Object : fail)
**/
function procMemberInsertImageName() {
// Check if the file is successfully uploaded
@ -857,6 +927,14 @@
$this->setRedirectUrl($returnUrl);
}
/**
* Insert a image name
*
* @param int $member_srl
* @param object $target_file
*
* @return void
**/
function insertImageName($member_srl, $target_file) {
$oModuleModel = &getModel('module');
$config = $oModuleModel->getModuleConfig('member');
@ -878,7 +956,9 @@
}
/**
* @brief Delete profile image
* Delete profile image
*
* @return Object
**/
function procMemberDeleteProfileImage() {
$member_srl = Context::get('member_srl');
@ -901,7 +981,9 @@
}
/**
* @brief Delete Image name
* Delete Image name
*
* @return void
**/
function procMemberDeleteImageName() {
$member_srl = Context::get('member_srl');
@ -924,7 +1006,9 @@
}
/**
* @brief Add an image to mark
* Add an image to mark
*
* @return void|Object (void : success, Object : fail)
**/
function procMemberInsertImageMark() {
// Check if the file is successfully uploaded
@ -949,6 +1033,14 @@
$this->setRedirectUrl($returnUrl);
}
/**
* Insert a image mark
*
* @param int $member_srl
* @param object $target_file
*
* @return void
**/
function insertImageMark($member_srl, $target_file) {
$oModuleModel = &getModel('module');
$config = $oModuleModel->getModuleConfig('member');
@ -967,11 +1059,12 @@
if($width > $max_width || $height > $max_height || $type!=1) FileHandler::createImageFile($target_file, $target_filename, $max_width, $max_height, 'gif');
else @copy($target_file, $target_filename);
}
/**
* @brief Delete Image Mark
* Delete Image Mark
*
* @return Object
**/
function procMemberDeleteImageMark() {
$member_srl = Context::get('member_srl');
@ -987,7 +1080,9 @@
}
/**
* @brief Find ID/Password
* Find ID/Password
*
* @return Object
**/
function procMemberFindAccount() {
$email_address = Context::get('email_address');
@ -1070,7 +1165,9 @@
/**
* @brief Generate a temp password by answering to the pre-determined question
* Generate a temp password by answering to the pre-determined question
*
* @return void|Object (void : success, Object : fail)
**/
function procMemberFindAccountByQuestion() {
$oMemberModel = &getModel('member');
@ -1119,8 +1216,10 @@
}
/**
* @brief Execute finding ID/Passoword
* Execute finding ID/Passoword
* When clicking the link in the verification email, a method is called to change the old password and to authenticate it
*
* @return void|Object (void : success, Object : fail)
**/
function procMemberAuthAccount() {
// Test user_id and authkey
@ -1154,8 +1253,10 @@
}
/**
* @brief Execute finding ID/Passoword
* Execute finding ID/Passoword
* When clicking the link in the verification email, a method is called to change the old password and to authenticate it
*
* @return Object
**/
function procMemberUpdateAuthMail() {
$member_srl = Context::get('member_srl');
@ -1215,7 +1316,9 @@
}
/**
* @brief Request to re-send the authentication mail
* Request to re-send the authentication mail
*
* @return void|Object (void : success, Object : fail)
**/
function procMemberResendAuthMail() {
// Get an email_address
@ -1276,7 +1379,9 @@
}
/**
* @brief Join a virtual site
* Join a virtual site
*
* @return void|Object (void : success, Object : fail)
**/
function procMemberSiteSignUp() {
$site_module_info = Context::get('site_module_info');
@ -1292,7 +1397,9 @@
}
/**
* @brief Leave the virtual site
* Leave the virtual site
*
* @return void|Object (void : success, Object : fail)
**/
function procMemberSiteLeave() {
$site_module_info = Context::get('site_module_info');
@ -1307,7 +1414,11 @@
}
/**
* @brief Save the member configurations
* Save the member configurations
*
* @param object $args
*
* @return void
**/
function setMemberConfig($args) {
if(!$args->skin) $args->skin = "default";
@ -1337,7 +1448,12 @@
}
/**
* @brief Save the signature as a file
* Save the signature as a file
*
* @param int $member_srl
* @param string $signature
*
* @return void
**/
function putSignature($member_srl, $signature) {
$signature = trim(removeHackTag($signature));
@ -1355,7 +1471,11 @@
}
/**
* @brief Delete the signature file
* Delete the signature file
*
* @param string $member_srl
*
* @return void
**/
function delSignature($member_srl) {
$filename = sprintf('files/member_extra_info/signature/%s%d.gif', getNumberingPath($member_srl), $member_srl);
@ -1363,7 +1483,13 @@
}
/**
* @brief Add group_srl to member_srl
* Add group_srl to member_srl
*
* @param int $member_srl
* @param int $group_srl
* @param int $site_srl
*
* @return Object
**/
function addMemberToGroup($member_srl,$group_srl,$site_srl=0) {
$args->member_srl = $member_srl;
@ -1388,8 +1514,12 @@
}
/**
* @brief Change a group of certain members
* Change a group of certain members
* Available only when a member has a single group
*
* @param object $args
*
* @return Object
**/
function replaceMemberGroup($args) {
$obj->site_srl = $args->site_srl;
@ -1426,7 +1556,9 @@
/**
* @brief Auto-login
* Auto-login
*
* @return void
**/
function doAutologin() {
// Get a key value of auto log-in
@ -1452,7 +1584,6 @@
$do_auto_login = false;
// Compare key values based on the information
$key = md5($user_id . $password . $_SERVER['HTTP_USER_AGENT']);
@ -1495,9 +1626,15 @@
}
}
/**
* @brief Log-in
**/
/**
* Log-in
*
* @param string $user_id
* @param string $password
* @param boolean $keep_signed
*
* @return Object
**/
function doLogin($user_id, $password = '', $keep_signed = false) {
$user_id = strtolower($user_id);
if(!$user_id) return new Object(-1, 'null_user_id');
@ -1625,7 +1762,7 @@
}
/**
* @brief Update or create session information
* Update or create session information
**/
function setSessionInfo() {
$oMemberModel = &getModel('member');
@ -1677,7 +1814,7 @@
}
/**
* @brief Logged method for providing a personalized menu
* Logged method for providing a personalized menu
* Login information is used in the output widget, or personalized page
**/
function addMemberMenu($act, $str) {
@ -1689,7 +1826,7 @@
}
/**
* @brief Nickname and click Log In to add a pop-up menu that appears when the method
* Nickname and click Log In to add a pop-up menu that appears when the method
**/
function addMemberPopupMenu($url, $str, $icon = '', $target = 'self') {
$member_popup_menu_list = Context::get('member_popup_menu_list');
@ -1705,7 +1842,7 @@
}
/**
* @brief Add users to the member table
* Add users to the member table
**/
function insertMember(&$args, $password_is_hashed = false) {
// Call a trigger (before)
@ -1874,7 +2011,7 @@
}
/**
* @brief Modify member information
* Modify member information
**/
function updateMember($args) {
// Call a trigger (before)
@ -1990,7 +2127,7 @@
}
/**
* @brief Modify member password
* Modify member password
**/
function updateMemberPassword($args) {
$output = executeQuery('member.updateChangePasswordDate', $args);
@ -2021,7 +2158,7 @@
}
/**
* @brief Delete User
* Delete User
**/
function deleteMember($member_srl) {
// Call a trigger (before)
@ -2089,7 +2226,7 @@
}
/**
* @brief Destroy all session information
* Destroy all session information
**/
function destroySessionInfo() {
if(!$_SESSION || !is_array($_SESSION)) return;