mirror of
https://github.com/Lastorder-DC/rhymix.git
synced 2026-04-30 15:52:17 +09:00
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
parent
a0a824166d
commit
634b6b78ea
6 changed files with 431 additions and 111 deletions
|
|
@ -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;
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue