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');