Remove unnecessary use of BaseObject

- 트리거 등 반환값이 필요하지 않은 곳에서 new BaseObject()를 반환하는 것 삭제
- 모듈 설치, 업데이트 후 무의미한 new BaseObject()를 반환하는 것 삭제
- 사용자에게 에러 메시지를 돌려주는 용도로 new BaseObject(-1, '에러메시지')를
  사용하는 경우는 대부분 $this->setError()로 변경함. 언어 변환과 sprintf()
  처리까지 한 번에 이루어지므로 이쪽이 더 편리함.
This commit is contained in:
Kijin Sung 2017-12-01 00:54:51 +09:00
parent 03d74a984f
commit 84e5542d77
103 changed files with 692 additions and 862 deletions

View file

@ -557,7 +557,7 @@ class documentAdminController extends document
$eid = Context::get('eid');
$obj = new stdClass();
if(!$module_srl || !$name || !$eid) return new BaseObject(-1,'msg_invalid_request');
if(!$module_srl || !$name || !$eid) return $this->setError('msg_invalid_request');
// set the max value if idx is not specified
if(!$var_idx)
{
@ -573,7 +573,7 @@ class documentAdminController extends document
$output = executeQuery('document.isExistsExtraKey', $obj);
if(!$output->toBool() || $output->data->count)
{
return new BaseObject(-1, 'msg_extra_name_exists');
return $this->setError('msg_extra_name_exists');
}
// insert or update
@ -595,7 +595,7 @@ class documentAdminController extends document
{
$module_srl = Context::get('module_srl');
$var_idx = Context::get('var_idx');
if(!$module_srl || !$var_idx) return new BaseObject(-1,'msg_invalid_request');
if(!$module_srl || !$var_idx) return $this->setError('msg_invalid_request');
$oDocumentController = getController('document');
$output = $oDocumentController->deleteDocumentExtraKeys($module_srl, $var_idx);
@ -614,26 +614,26 @@ class documentAdminController extends document
$module_srl = Context::get('module_srl');
$var_idx = Context::get('var_idx');
if(!$type || !$module_srl || !$var_idx) return new BaseObject(-1,'msg_invalid_request');
if(!$type || !$module_srl || !$var_idx) return $this->setError('msg_invalid_request');
$oModuleModel = getModel('module');
$module_info = $oModuleModel->getModuleInfoByModuleSrl($module_srl);
if(!$module_info->module_srl) return new BaseObject(-1,'msg_invalid_request');
if(!$module_info->module_srl) return $this->setError('msg_invalid_request');
$oDocumentModel = getModel('document');
$extra_keys = $oDocumentModel->getExtraKeys($module_srl);
if(!$extra_keys[$var_idx]) return new BaseObject(-1,'msg_invalid_request');
if(!$extra_keys[$var_idx]) return $this->setError('msg_invalid_request');
if($type == 'up') $new_idx = $var_idx-1;
else $new_idx = $var_idx+1;
if($new_idx<1) return new BaseObject(-1,'msg_invalid_request');
if($new_idx<1) return $this->setError('msg_invalid_request');
$args = new stdClass();
$args->module_srl = $module_srl;
$args->var_idx = $new_idx;
$output = executeQuery('document.getDocumentExtraKeys', $args);
if (!$output->toBool()) return $output;
if (!$output->data) return new BaseObject(-1, 'msg_invalid_request');
if (!$output->data) return $this->setError('msg_invalid_request');
unset($args);
// update immediately if there is no idx to change
@ -737,7 +737,7 @@ class documentAdminController extends document
$member_info = $oMemberModel->getMemberInfoByMemberSrl($oDocument->get('member_srl'));
if($member_info->is_admin == 'Y' && $logged_info->is_admin != 'Y')
{
return new BaseObject(-1, 'msg_admin_document_no_move_to_trash');
return $this->setError('msg_admin_document_no_move_to_trash');
}
$oModuleModel = getModel('module');
@ -882,7 +882,7 @@ class documentAdminController extends document
//DB restore
$output = $oDocumentController->insertDocument($originObject, false, true, false);
if(!$output->toBool()) return new BaseObject(-1, $output->getMessage());
if(!$output->toBool()) return $this->setError($output->getMessage());
//FILE restore
$oDocument = $oDocumentModel->getDocument($originObject->document_srl);

View file

@ -47,8 +47,6 @@ class document extends ModuleObject
// 2009. 01. 29 Added a trigger for additional setup
$oModuleController->insertTrigger('module.dispAdditionSetup', 'document', 'view', 'triggerDispDocumentAdditionSetup', 'before');
return new BaseObject();
}
/**
@ -341,8 +339,6 @@ class document extends ModuleObject
$oDB->addColumn('document_update_log', 'is_admin', 'varchar', 1);
$oDB->addIndex('document_update_log', 'idx_is_admin', array('is_admin'));
}
return new BaseObject(0,'success_updated');
}
/**

View file

@ -28,21 +28,21 @@ class documentController extends document
{
if(!Context::get('is_logged'))
{
return new BaseObject(-1, 'msg_invalid_request');
return $this->setError('msg_invalid_request');
}
}
$document_srl = Context::get('target_srl');
if(!$document_srl) return new BaseObject(-1, 'msg_invalid_request');
if(!$document_srl) return $this->setError('msg_invalid_request');
$oDocumentModel = getModel('document');
$oDocument = $oDocumentModel->getDocument($document_srl, false, false);
$module_srl = $oDocument->get('module_srl');
if(!$module_srl) return new BaseObject(-1, 'msg_invalid_request');
if(!$module_srl) return $this->setError('msg_invalid_request');
$oModuleModel = getModel('module');
$document_config = $oModuleModel->getModulePartConfig('document',$module_srl);
if($document_config->use_vote_up=='N') return new BaseObject(-1, 'msg_invalid_request');
if($document_config->use_vote_up=='N') return $this->setError('msg_invalid_request');
$point = 1;
$output = $this->updateVotedCount($document_srl, $point);
@ -60,18 +60,18 @@ class documentController extends document
{
if(!Context::get('is_logged'))
{
return new BaseObject(-1, 'msg_invalid_request');
return $this->setError('msg_invalid_request');
}
}
$document_srl = Context::get('target_srl');
if(!$document_srl) return new BaseObject(-1, 'msg_invalid_request');
if(!$document_srl) return $this->setError('msg_invalid_request');
$oDocumentModel = getModel('document');
$oDocument = $oDocumentModel->getDocument($document_srl, false, false);
if($oDocument->get('voted_count') <= 0)
{
return new BaseObject(-1, 'msg_document_voted_cancel_not');
return $this->setError('msg_document_voted_cancel_not');
}
$point = 1;
$output = $this->updateVotedCountCancel($document_srl, $oDocument, $point);
@ -114,21 +114,21 @@ class documentController extends document
{
if(!Context::get('is_logged'))
{
return new BaseObject(-1, 'msg_invalid_request');
return $this->setError('msg_invalid_request');
}
}
$document_srl = Context::get('target_srl');
if(!$document_srl) return new BaseObject(-1, 'msg_invalid_request');
if(!$document_srl) return $this->setError('msg_invalid_request');
$oDocumentModel = getModel('document');
$oDocument = $oDocumentModel->getDocument($document_srl, false, false);
$module_srl = $oDocument->get('module_srl');
if(!$module_srl) return new BaseObject(-1, 'msg_invalid_request');
if(!$module_srl) return $this->setError('msg_invalid_request');
$oModuleModel = getModel('module');
$document_config = $oModuleModel->getModulePartConfig('document',$module_srl);
if($document_config->use_vote_down=='N') return new BaseObject(-1, 'msg_invalid_request');
if($document_config->use_vote_down=='N') return $this->setError('msg_invalid_request');
$point = -1;
$output = $this->updateVotedCount($document_srl, $point);
@ -146,18 +146,18 @@ class documentController extends document
{
if(!Context::get('is_logged'))
{
return new BaseObject(-1, 'msg_invalid_request');
return $this->setError('msg_invalid_request');
}
}
$document_srl = Context::get('target_srl');
if(!$document_srl) return new BaseObject(-1, 'msg_invalid_request');
if(!$document_srl) return $this->setError('msg_invalid_request');
$oDocumentModel = getModel('document');
$oDocument = $oDocumentModel->getDocument($document_srl, false, false);
if($oDocument->get('blamed_count') >= 0)
{
return new BaseObject(-1, 'msg_document_voted_cancel_not');
return $this->setError('msg_document_voted_cancel_not');
}
$point = -1;
$output = $this->updateVotedCountCancel($document_srl, $oDocument, $point);
@ -229,13 +229,13 @@ class documentController extends document
{
if(!Context::get('is_logged'))
{
return new BaseObject(-1, 'msg_not_logged');
return $this->setError('msg_not_logged');
}
$document_srl = intval(Context::get('target_srl'));
if(!$document_srl)
{
return new BaseObject(-1, 'msg_invalid_request');
return $this->setError('msg_invalid_request');
}
// if an user select message from options, message would be the option.
@ -302,7 +302,7 @@ class documentController extends document
function triggerDeleteModuleDocuments(&$obj)
{
$module_srl = $obj->module_srl;
if(!$module_srl) return new BaseObject();
if(!$module_srl) return;
// Delete the document
$oDocumentAdminController = getAdminController('document');
$output = $oDocumentAdminController->deleteModuleDocument($module_srl);
@ -319,8 +319,6 @@ class documentController extends document
// remove histories
$this->deleteDocumentHistory(null, null, $module_srl);
return new BaseObject();
}
/**
@ -490,7 +488,7 @@ class documentController extends document
if($logged_info->is_admin != 'Y') $obj->content = removeHackTag($obj->content);
// An error appears if both log-in info and user name don't exist.
if(!$logged_info->member_srl && !$obj->nick_name) return new BaseObject(-1,'msg_invalid_request');
if(!$logged_info->member_srl && !$obj->nick_name) return new BaseObject(-1, 'msg_invalid_request');
// Fix encoding of non-BMP UTF-8 characters.
$obj->title = utf8_mbencode($obj->title);
@ -581,7 +579,7 @@ class documentController extends document
return new BaseObject(-1, 'msg_invalid_request');
}
if(!$source_obj->document_srl || !$obj->document_srl) return new BaseObject(-1,'msg_invalied_request');
if(!$source_obj->document_srl || !$obj->document_srl) return new BaseObject(-1, 'msg_invalied_request');
// Default Status
if($obj->status)
@ -1245,7 +1243,7 @@ class documentController extends document
*/
function insertDocumentExtraKey($module_srl, $var_idx, $var_name, $var_type, $var_is_required = 'N', $var_search = 'N', $var_default = '', $var_desc = '', $eid)
{
if(!$module_srl || !$var_idx || !$var_name || !$var_type || !$eid) return new BaseObject(-1,'msg_invalid_request');
if(!$module_srl || !$var_idx || !$var_name || !$var_type || !$eid) return new BaseObject(-1, 'msg_invalid_request');
$obj = new stdClass();
$obj->module_srl = $module_srl;
@ -1282,7 +1280,7 @@ class documentController extends document
*/
function deleteDocumentExtraKeys($module_srl, $var_idx = null)
{
if(!$module_srl) return new BaseObject(-1,'msg_invalid_request');
if(!$module_srl) return new BaseObject(-1, 'msg_invalid_request');
$obj = new stdClass();
$obj->module_srl = $module_srl;
if(!is_null($var_idx)) $obj->var_idx = $var_idx;
@ -1342,7 +1340,7 @@ class documentController extends document
*/
function insertDocumentExtraVar($module_srl, $document_srl, $var_idx, $value, $eid = null, $lang_code = '')
{
if(!$module_srl || !$document_srl || !$var_idx || !isset($value)) return new BaseObject(-1,'msg_invalid_request');
if(!$module_srl || !$document_srl || !$var_idx || !isset($value)) return new BaseObject(-1, 'msg_invalid_request');
if(!$lang_code) $lang_code = Context::getLangType();
$obj = new stdClass;
@ -1843,9 +1841,9 @@ class documentController extends document
$prev_category = $val;
}
// Return if the previous category doesn't exist
if(!$prev_category) return new BaseObject(-1,lang('msg_category_not_moved'));
if(!$prev_category) return new BaseObject(-1, 'msg_category_not_moved');
// Return if the selected category is the top level
if($category_srl_list[0]==$category_srl) return new BaseObject(-1,lang('msg_category_not_moved'));
if($category_srl_list[0]==$category_srl) return new BaseObject(-1, 'msg_category_not_moved');
// Information of the selected category
$cur_args = new stdClass;
$cur_args->category_srl = $category_srl;
@ -1889,7 +1887,7 @@ class documentController extends document
}
$next_category_srl = $category_srl_list[$i+1];
if(!$category_list[$next_category_srl]) return new BaseObject(-1,lang('msg_category_not_moved'));
if(!$category_list[$next_category_srl]) return new BaseObject(-1, 'msg_category_not_moved');
$next_category = $category_list[$next_category_srl];
// Information of the selected category
$cur_args = new stdClass;
@ -1969,7 +1967,7 @@ class documentController extends document
$columnList = array('module_srl', 'module');
$module_info = $oModuleModel->getModuleInfoByModuleSrl($args->module_srl, $columnList);
$grant = $oModuleModel->getGrant($module_info, Context::get('logged_info'));
if(!$grant->manager) return new BaseObject(-1,'msg_not_permitted');
if(!$grant->manager) return new BaseObject(-1, 'msg_not_permitted');
if($args->expand !="Y") $args->expand = "N";
if(!is_array($args->group_srls)) $args->group_srls = str_replace('|@|',',',$args->group_srls);
@ -2039,7 +2037,7 @@ class documentController extends document
$columnList = array('module_srl', 'module');
$module_info = $oModuleModel->getModuleInfoByModuleSrl($source_category->module_srl, $columnList);
$grant = $oModuleModel->getGrant($module_info, Context::get('logged_info'));
if(!$grant->manager) return new BaseObject(-1,'msg_not_permitted');
if(!$grant->manager) return new BaseObject(-1, 'msg_not_permitted');
// First child of the parent_category_srl
$source_args = new stdClass;
@ -2100,7 +2098,7 @@ class documentController extends document
$columnList = array('module_srl', 'module');
$module_info = $oModuleModel->getModuleInfoByModuleSrl($args->module_srl, $columnList);
$grant = $oModuleModel->getGrant($module_info, Context::get('logged_info'));
if(!$grant->manager) return new BaseObject(-1,'msg_not_permitted');
if(!$grant->manager) return new BaseObject(-1, 'msg_not_permitted');
$oDocumentModel = getModel('document');
// Get original information
@ -2141,7 +2139,7 @@ class documentController extends document
$columnList = array('module_srl', 'module');
$module_info = $oModuleModel->getModuleInfoByModuleSrl($module_srl, $columnList);
$grant = $oModuleModel->getGrant($module_info, Context::get('logged_info'));
if(!$grant->manager) return new BaseObject(-1,'msg_not_permitted');
if(!$grant->manager) return new BaseObject(-1, 'msg_not_permitted');
$xml_file = $this->makeCategoryFile($module_srl);
// Set return value
@ -2466,7 +2464,7 @@ class documentController extends document
*/
function procDocumentAddCart()
{
if(!Context::get('is_logged')) return new BaseObject(-1, 'msg_not_permitted');
if(!Context::get('is_logged')) return $this->setError('msg_not_permitted');
// Get document_srl
$srls = explode(',',Context::get('srls'));
@ -2540,7 +2538,7 @@ class documentController extends document
function procDocumentManageCheckedDocument()
{
@set_time_limit(0);
if(!Context::get('is_logged')) return new BaseObject(-1,'msg_not_permitted');
if(!Context::get('is_logged')) return $this->setError('msg_not_permitted');
$logged_info = Context::get('logged_info');
// Get request parameters.
@ -2596,13 +2594,13 @@ class documentController extends document
$module_info = $oModuleModel->getModuleInfoByModuleSrl($module_srl);
if (!$module_info->module_srl)
{
return new BaseObject(-1, 'msg_invalid_request');
return $this->setError('msg_invalid_request');
}
$module_grant = $oModuleModel->getGrant($module_info, $logged_info);
if (!$module_grant->manager)
{
return new BaseObject(-1, 'msg_not_permitted');
return $this->setError('msg_not_permitted');
}
}
@ -2612,22 +2610,22 @@ class documentController extends document
if($type == 'move')
{
if(!$target_module_srl) return new BaseObject(-1, 'fail_to_move');
if(!$target_module_srl) return $this->setError('fail_to_move');
$oDocumentAdminController = getAdminController('document');
$output = $oDocumentAdminController->moveDocumentModule($document_srl_list, $target_module_srl, $target_category_srl);
if(!$output->toBool()) return new BaseObject(-1, 'fail_to_move');
if(!$output->toBool()) return $this->setError('fail_to_move');
$msg_code = 'success_moved';
}
else if($type == 'copy')
{
if(!$target_module_srl) return new BaseObject(-1, 'fail_to_move');
if(!$target_module_srl) return $this->setError('fail_to_move');
$oDocumentAdminController = getAdminController('document');
$output = $oDocumentAdminController->copyDocumentModule($document_srl_list, $target_module_srl, $target_category_srl);
if(!$output->toBool()) return new BaseObject(-1, 'fail_to_move');
if(!$output->toBool()) return $this->setError('fail_to_move');
$msg_code = 'success_copied';
}
@ -2638,7 +2636,7 @@ class documentController extends document
foreach ($document_srl_list as $document_srl)
{
$output = $this->deleteDocument($document_srl, true);
if(!$output->toBool()) return new BaseObject(-1, 'fail_to_delete');
if(!$output->toBool()) return $this->setError('fail_to_delete');
}
$oDB->commit();
$msg_code = 'success_deleted';
@ -2654,7 +2652,7 @@ class documentController extends document
{
$args->document_srl = $document_srl;
$output = $this->moveDocumentToTrash($args);
if(!$output || !$output->toBool()) return new BaseObject(-1, 'fail_to_trash');
if(!$output || !$output->toBool()) return $this->setError('fail_to_trash');
}
$oDB->commit();
$msg_code = 'success_trashed';
@ -2712,13 +2710,13 @@ class documentController extends document
$module_info = $oModuleModel->getModuleInfoByModuleSrl($srl);
if (!$module_info->module_srl)
{
return new BaseObject(-1, 'msg_invalid_request');
return $this->setError('msg_invalid_request');
}
$module_grant = $oModuleModel->getGrant($module_info, $logged_info);
if (!$module_grant->manager)
{
return new BaseObject(-1, 'msg_not_permitted');
return $this->setError('msg_not_permitted');
}
$module_srl[] = $srl;
@ -2757,7 +2755,7 @@ class documentController extends document
{
if(!$this->module_srl)
{
return new BaseObject(-1, 'msg_invalid_request');
return $this->setError('msg_invalid_request');
}
$obj = Context::getRequestVars();
@ -2780,12 +2778,12 @@ class documentController extends document
{
if(!$oDocument->isGranted())
{
return new BaseObject(-1, 'msg_invalid_request');
return $this->setError('msg_invalid_request');
}
if($oDocument->get('status') != $this->getConfigStatus('temp'))
{
return new BaseObject(-1, 'msg_invalid_request');
return $this->setError('msg_invalid_request');
}
$output = $this->updateDocument($oDocument, $obj);
@ -2817,7 +2815,7 @@ class documentController extends document
*/
function procDocumentGetList()
{
if(!Context::get('is_logged')) return new BaseObject(-1,'msg_not_permitted');
if(!Context::get('is_logged')) return $this->setError('msg_not_permitted');
$documentSrls = Context::get('document_srls');
if($documentSrls) $documentSrlList = explode(',', $documentSrls);

View file

@ -39,7 +39,7 @@ class documentModel extends document
{
if(!is_array($documentSrls) || count($documentSrls) == 0)
{
return new BaseObject(-1, 'msg_invalid_request');
return $this->setError('msg_invalid_request');
}
$args = new stdClass();
@ -508,7 +508,7 @@ class documentModel extends document
$oDocument = $oDocumentModel->getDocument($document_srl, false, false, $columnList);
$module_srl = $oDocument->get('module_srl');
$member_srl = $oDocument->get('member_srl');
if(!$module_srl) return new BaseObject(-1, 'msg_invalid_request');
if(!$module_srl) return $this->setError('msg_invalid_request');
$oModuleModel = getModel('module');
$document_config = $oModuleModel->getModulePartConfig('document',$module_srl);
@ -915,7 +915,7 @@ class documentModel extends document
*/
function getDocumentCategories()
{
if(!Context::get('is_logged')) return new BaseObject(-1,'msg_not_permitted');
if(!Context::get('is_logged')) return $this->setError('msg_not_permitted');
$module_srl = Context::get('module_srl');
$categories= $this->getCategoryList($module_srl);
$lang = Context::get('lang');
@ -1010,13 +1010,13 @@ class documentModel extends document
$module_info = $oModuleModel->getModuleInfoByModuleSrl($module_srl);
// Check permissions
$grant = $oModuleModel->getGrant($module_info, Context::get('logged_info'));
if(!$grant->manager) return new BaseObject(-1,'msg_not_permitted');
if(!$grant->manager) return $this->setError('msg_not_permitted');
$category_srl = Context::get('category_srl');
$category_info = $this->getCategory($category_srl);
if(!$category_info)
{
return new BaseObject(-1, 'msg_invalid_request');
return $this->setError('msg_invalid_request');
}
$this->add('category_info', $category_info);
@ -1198,7 +1198,7 @@ class documentModel extends document
{
$args = new stdClass;
$document_srl = Context::get('document_srl');
if(!$document_srl) return new BaseObject(-1,'msg_invalid_request');
if(!$document_srl) return $this->setError('msg_invalid_request');
$point = Context::get('point');
if($point != -1) $point = 1;
@ -1207,18 +1207,18 @@ class documentModel extends document
$columnList = array('document_srl', 'module_srl');
$oDocument = $oDocumentModel->getDocument($document_srl, false, false, $columnList);
$module_srl = $oDocument->get('module_srl');
if(!$module_srl) return new BaseObject(-1, 'msg_invalid_request');
if(!$module_srl) return $this->setError('msg_invalid_request');
$oModuleModel = getModel('module');
$document_config = $oModuleModel->getModulePartConfig('document',$module_srl);
if($point == -1)
{
if($document_config->use_vote_down!='S') return new BaseObject(-1, 'msg_invalid_request');
if($document_config->use_vote_down!='S') return $this->setError('msg_invalid_request');
$args->below_point = 0;
}
else
{
if($document_config->use_vote_up!='S') return new BaseObject(-1, 'msg_invalid_request');
if($document_config->use_vote_up!='S') return $this->setError('msg_invalid_request');
$args->more_point = 0;
}

View file

@ -36,9 +36,9 @@ class documentView extends document
$oDocumentModel = getModel('document');
// Creates an object for displaying the selected document
$oDocument = $oDocumentModel->getDocument($document_srl, $this->grant->manager);
if(!$oDocument->isExists()) return new BaseObject(-1,'msg_invalid_request');
if(!$oDocument->isExists()) return $this->setError('msg_invalid_request');
// Check permissions
if(!$oDocument->isAccessible()) return new BaseObject(-1,'msg_not_permitted');
if(!$oDocument->isAccessible()) return $this->setError('msg_not_permitted');
// Information setting module
//Context::set('module_info', $module_info); //module_info not use in UI
// Browser title settings
@ -58,7 +58,7 @@ class documentView extends document
{
if(!checkCSRF())
{
return new BaseObject(-1, 'msg_invalid_request');
return $this->setError('msg_invalid_request');
}
$content = Context::get('content');
@ -87,7 +87,7 @@ class documentView extends document
*/
function dispDocumentManageDocument()
{
if(!Context::get('is_logged')) return new BaseObject(-1,'msg_not_permitted');
if(!Context::get('is_logged')) return $this->setError('msg_not_permitted');
// Taken from a list of selected sessions
$flag_list = $_SESSION['document_management'];
if(count($flag_list))
@ -215,12 +215,12 @@ class documentView extends document
$oDocument = $oDocumentModel->getDocument($document_srl, $this->grant->manager, FALSE);
if(!$oDocument->isExists())
{
return new BaseObject(-1,'msg_invalid_request');
return $this->setError('msg_invalid_request');
}
// Check permissions
if(!$oDocument->isAccessible())
{
return new BaseObject(-1,'msg_not_permitted');
return $this->setError('msg_not_permitted');
}
// Browser title settings