ea4f98c66f
- Rename method cacheSearchParams() to cacheSearchFunc() in framework/model.class.php - Update parameter name from cacheSearchParams to cacheSearchFunc across execution and my modules - Update corresponding test files and documentation comments - Improve naming clarity to reflect that we're caching the function/method rather than just parameters
501 lines
18 KiB
PHP
501 lines
18 KiB
PHP
<?php declare(strict_types=1);
|
||
/**
|
||
* ZenTaoPHP的model类。
|
||
* The model class file of ZenTaoPHP framework.
|
||
*
|
||
* The author disclaims copyright to this source code. In place of
|
||
* a legal notice, here is a blessing:
|
||
*
|
||
* May you do good and not evil.
|
||
* May you find forgiveness for yourself and forgive others.
|
||
* May you share freely, never taking more than you give.
|
||
*/
|
||
|
||
/**
|
||
* model基类。
|
||
* The base class of model.
|
||
*
|
||
* @package framework
|
||
*/
|
||
include __DIR__ . '/base/model.class.php';
|
||
|
||
#[AllowDynamicProperties]
|
||
class model extends baseModel
|
||
{
|
||
/**
|
||
* 企业版部分功能是从然之合并过来的。ZDOO代码中调用loadModel方法时传递了一个非空的appName，在禅道中会导致错误。
|
||
* 调用父类的loadModel方法来避免这个错误。
|
||
* Some codes merged from ZDOO called the function loadModel with a non-empty appName which causes an error in zentao.
|
||
* Call the parent function with empty appName to avoid this error.
|
||
*
|
||
* @param string $moduleName 模块名，如果为空，使用当前模块。The module name, if empty, use current module's name.
|
||
* @param string $appName 应用名，如果为空，使用当前应用。The app name, if empty, use current app's name.
|
||
* @access public
|
||
* @return object|bool the model object or false if model file not exists.
|
||
*/
|
||
public function loadModel($moduleName, $appName = ''): object|bool
|
||
{
|
||
return parent::loadModel($moduleName);
|
||
}
|
||
|
||
/**
|
||
* 企业版部分功能是从然之合并过来的。ZDOO代码中调用loadTao方法时传递了一个非空的appName，在禅道中会导致错误。
|
||
* 调用父类的loadTao方法来避免这个错误。
|
||
* Some codes merged from ZDOO called the function loadTao with a non-empty appName which causes an error in zentao.
|
||
* Call the parent function with empty appName to avoid this error.
|
||
*
|
||
* @param string $moduleName 模块名，如果为空，使用当前模块。The module name, if empty, use current module's name.
|
||
* @param string $appName 应用名，如果为空，使用当前应用。The app name, if empty, use current app's name.
|
||
* @access public
|
||
* @return object|bool the model object or false if model file not exists.
|
||
*/
|
||
public function loadTao($moduleName, $appName = ''): object|bool
|
||
{
|
||
return parent::loadTao($moduleName);
|
||
}
|
||
|
||
/**
|
||
* Load dao of bi.
|
||
*
|
||
* @access public
|
||
* @return void
|
||
*/
|
||
public function loadBIDAO()
|
||
{
|
||
global $config, $biDAO;
|
||
if(is_object($biDAO)) return $this->dao = $biDAO;
|
||
|
||
if(!isset($config->biDB)) return;
|
||
|
||
$driver = $config->db->driver;
|
||
$biDAO = new $driver();
|
||
|
||
$biDAO->slaveDBH = $this->app->connectByPDO($config->biDB, 'BI');
|
||
|
||
$this->dao = $biDAO;
|
||
}
|
||
|
||
/**
|
||
* 通过对象ID获取对象信息。
|
||
* Get object information by ID.
|
||
*
|
||
* @param int $objectID
|
||
* @param string $moduleName
|
||
* @access public
|
||
* @return object|bool
|
||
*/
|
||
public function fetchByID(int $objectID, string $moduleName = ''): object|bool
|
||
{
|
||
if(empty($objectID)) return false;
|
||
if(empty($moduleName)) $moduleName = $this->getModuleName();
|
||
|
||
$table = zget($this->config->objectTables, $moduleName, '');
|
||
if(empty($table)) return false;
|
||
|
||
return $this->mao->findById($objectID)->from($table)->fetch();
|
||
}
|
||
|
||
/**
|
||
* 删除记录
|
||
* Delete one record.
|
||
*
|
||
* @param string $table the table name
|
||
* @param int $id the id value of the record to be deleted
|
||
* @access public
|
||
* @return bool
|
||
*/
|
||
public function delete(string $table, int $id)
|
||
{
|
||
if(empty($id)) return false;
|
||
|
||
$this->dao->update($table)->set('deleted')->eq(1)->where('id')->eq($id)->exec();
|
||
$objectType = preg_replace('/^' . preg_quote((string) $this->config->db->prefix) . '/', '', trim($table, '`'));
|
||
$this->loadModel('action')->create($objectType, $id, 'deleted', '', ACTIONMODEL::CAN_UNDELETED);
|
||
|
||
return true;
|
||
}
|
||
|
||
/**
|
||
* 回滚数据库操作。
|
||
* Rollback database operation.
|
||
*
|
||
* @access public
|
||
* @return false
|
||
*/
|
||
public function rollback(): bool
|
||
{
|
||
$this->dao->rollback();
|
||
return false;
|
||
}
|
||
|
||
/**
|
||
* Build menu of a module.
|
||
*
|
||
* @param string $moduleName
|
||
* @param string $methodName
|
||
* @param string $params
|
||
* @param object $data
|
||
* @param string $type
|
||
* @param string $icon
|
||
* @param string $target
|
||
* @param string $class
|
||
* @param bool $onlyBody
|
||
* @param string $misc
|
||
* @param string $title
|
||
* @param bool $returnHtml
|
||
* @access public
|
||
* @return string
|
||
*/
|
||
|
||
public function buildMenu($moduleName, $methodName, $params, $data, $type = 'view', $icon = '', $target = '', $class = '', $onlyBody = false, $misc = '' , $title = '', $returnHtml = true)
|
||
{
|
||
if(strpos($moduleName, '.') !== false) list($appName, $moduleName) = explode('.', $moduleName);
|
||
|
||
if(strpos($methodName, '_') !== false && strpos($methodName, '_') > 0) list($module, $method) = explode('_', $methodName);
|
||
|
||
if(empty($module)) $module = $moduleName;
|
||
if(empty($method)) $method = $methodName;
|
||
|
||
static $actions = array();
|
||
if(isset($this->config->bizVersion))
|
||
{
|
||
if(empty($actions[$moduleName]))
|
||
{
|
||
$actions[$moduleName] = $this->dao->select('*')->from(TABLE_WORKFLOWACTION)
|
||
->where('module')->eq($moduleName)
|
||
->andWhere('buildin')->eq('1')
|
||
->andWhere('status')->eq('enable')
|
||
->beginIF(!empty($this->config->vision))->andWhere('vision')->eq($this->config->vision)->fi()
|
||
->fetchAll('action', false);
|
||
}
|
||
}
|
||
|
||
$enabled = true;
|
||
if(!empty($actions) and isset($actions[$moduleName][$methodName]))
|
||
{
|
||
$action = $actions[$moduleName][$methodName];
|
||
|
||
if($action->extensionType == 'override') return $this->loadModel('flow')->buildActionMenu($moduleName, $action, $data, $type);
|
||
|
||
$conditions = json_decode($action->conditions);
|
||
if($conditions and $action->extensionType == 'extend')
|
||
{
|
||
if($icon != 'copy' and $methodName != 'create') $title = $action->name;
|
||
if($conditions) $enabled = $this->loadModel('flow')->checkConditions($conditions, $data);
|
||
}
|
||
else
|
||
{
|
||
if(method_exists($this, 'isClickable')) $enabled = $this->isClickable($data, $method, $module);
|
||
}
|
||
}
|
||
else
|
||
{
|
||
if(method_exists($this, 'isClickable')) $enabled = $this->isClickable($data, $method, $module);
|
||
}
|
||
|
||
if(!$returnHtml) return $enabled;
|
||
|
||
$html = '';
|
||
$type = $type == 'browse' ? 'list' : 'button';
|
||
$html = common::buildIconButton($module, $method, $params, $data, $type, $icon, $target, $class, $onlyBody, $misc, $title, '', $enabled);
|
||
return $html;
|
||
}
|
||
|
||
/**
|
||
* Build menu of actions created by workflow action.
|
||
*
|
||
* @param string $module
|
||
* @param int $data
|
||
* @param string $type browse | view
|
||
* @param string $show direct | dropdownlist
|
||
* @access public
|
||
* @return string
|
||
*/
|
||
public function buildFlowMenu($module, $data, $type = 'browse', $show = '')
|
||
{
|
||
if($this->config->edition == 'open') return '';
|
||
if(!empty($this->app->installing) || !empty($this->app->upgrading)) return '';
|
||
|
||
$moduleName = $module;
|
||
if(str_contains($module, '.')) [$appName, $moduleName] = explode('.', $module);
|
||
|
||
static $actions;
|
||
static $relations;
|
||
if(empty($actions))
|
||
{
|
||
$actions = $this->dao->select('*')->from(TABLE_WORKFLOWACTION)
|
||
->where('module')->eq($moduleName)
|
||
->andWhere('buildin')->eq('0')
|
||
->andWhere('status')->eq('enable')
|
||
->beginIF(!empty($this->config->vision))->andWhere('vision')->eq($this->config->vision)->fi()
|
||
->orderBy('order_asc')
|
||
->fetchAll('', false);
|
||
}
|
||
if(empty($relations)) $relations = $this->dao->select('next, actions')->from(TABLE_WORKFLOWRELATION)->where('prev')->eq($moduleName)->fetchPairs();
|
||
|
||
$this->loadModel('flow');
|
||
|
||
$approvalProgressMenu = '';
|
||
if($type == 'view' && !empty($this->config->openedApproval) && commonModel::hasPriv('approval', 'progress'))
|
||
{
|
||
$flow = $this->loadModel('workflow', 'flow')->getByModule($moduleName);
|
||
if($flow->approval == 'enabled' && !empty($data->approval))
|
||
{
|
||
$extraClass = str_contains(',testsuite,build,release,productplan,', ",{$moduleName},") ? 'btn-link' : '';
|
||
$approvalProgressMenu .= "<div class='divider'></div>";
|
||
$approvalProgressMenu .= baseHTML::a(helper::createLink('approval', 'progress', "approvalID={$data->approval}", '', true), $this->lang->flow->approvalProgress, "class='btn {$extraClass} iframe'");
|
||
}
|
||
}
|
||
|
||
$menu = '';
|
||
if($show)
|
||
{
|
||
foreach($actions as $action)
|
||
{
|
||
if(!str_contains((string) $action->position, $type) || $action->show != $show) continue;
|
||
|
||
$menu .= $this->flow->buildActionMenu($moduleName, $action, $data, $type, $relations);
|
||
}
|
||
|
||
if($approvalProgressMenu) $menu .= $approvalProgressMenu;
|
||
}
|
||
else
|
||
{
|
||
$dropdownMenu = '';
|
||
foreach($actions as $action)
|
||
{
|
||
if(!str_contains((string) $action->position, $type)) continue;
|
||
|
||
if($type == 'view' || $action->show == 'direct') $menu .= $this->flow->buildActionMenu($moduleName, $action, $data, $type, $relations);
|
||
if($type == 'browse' && $action->show == 'dropdownlist') $dropdownMenu .= $this->flow->buildActionMenu($moduleName, $action, $data, $type, $relations);
|
||
}
|
||
|
||
if($approvalProgressMenu) $menu .= $approvalProgressMenu;
|
||
|
||
if($type == 'browse' && $dropdownMenu)
|
||
{
|
||
$menu .= "<div class='dropdown'><a href='javascript:;' data-toggle='dropdown'>{$this->lang->more}<span class='caret'> </span></a>";
|
||
$menu .= "<ul class='dropdown-menu pull-right'>{$dropdownMenu}</ul></div>";
|
||
}
|
||
}
|
||
|
||
return $menu;
|
||
}
|
||
|
||
/**
|
||
* 缓存用于构造搜索参数的方法和参数。
|
||
* Cache the method and arguments used to build search parameters.
|
||
*
|
||
* @param string $module
|
||
* @param string $classMethod 构造搜索参数的类名和方法名，以::分隔。The class name and method name which builds the search params, separated by ::.
|
||
* @param array $methodArgs 调用构造搜索参数的方法时传入的参数列表（实参）。 The arguments passed to the method which builds the search params (actual parameters).
|
||
* @access public
|
||
* @return void
|
||
*/
|
||
public function cacheSearchFunc(string $module, string $classMethod, array $methodArgs)
|
||
{
|
||
list($className, $methodName) = explode('::', $classMethod);
|
||
|
||
$funcModel = str_replace(['ext', 'Model'], '', $className);
|
||
|
||
$key = 0;
|
||
$funcArgs = [];
|
||
$method = new ReflectionMethod($className, $methodName);
|
||
$params = $method->getParameters(); // 构造搜索参数的方法的参数列表（形参）。The parameters of the method which builds the search params (formal parameters).
|
||
foreach($params as $param)
|
||
{
|
||
if(isset($methodArgs[$key]))
|
||
{
|
||
$funcArgs[$param->getName()] = $methodArgs[$key];
|
||
}
|
||
elseif($param->isDefaultValueAvailable())
|
||
{
|
||
$funcArgs[$param->getName()] = $param->getDefaultValue();
|
||
}
|
||
$key++;
|
||
}
|
||
|
||
$this->session->set($module . 'SearchFunc', ['funcModel' => $funcModel, 'funcName' => $methodName, 'funcArgs' => $funcArgs]);
|
||
}
|
||
|
||
/**
|
||
* Process status of an object according to its subStatus.
|
||
*
|
||
* @param string $module product | release | story | project | task | bug | testcase | testtask | feedback
|
||
* @param object $record a record of above modules.
|
||
* @access public
|
||
* @return string
|
||
*/
|
||
public function processStatus($module, $record)
|
||
{
|
||
if($module == 'story') $module = $record->type;
|
||
if($this->config->edition == 'open' or empty($record->subStatus)) return zget($this->lang->$module->statusList, $record->status);
|
||
|
||
return $this->loadModel('workflowfield')->processSubStatus($module, $record);
|
||
}
|
||
|
||
/**
|
||
* Process workflow export data.
|
||
*
|
||
* @param object $data
|
||
* @access public
|
||
* @return object
|
||
*/
|
||
public function processExportData($data)
|
||
{
|
||
if($this->config->edition == 'open') return $data;
|
||
if(!empty($this->app->installing) || !empty($this->app->upgrading)) return $data;
|
||
|
||
return $this->loadModel('workflowfield')->processExportData($data);
|
||
}
|
||
|
||
/**
|
||
* Process workflow export options.
|
||
*
|
||
* @param object $data
|
||
* @access public
|
||
* @return object
|
||
*/
|
||
public function processExportOptions($data)
|
||
{
|
||
if($this->config->edition == 'open') return $data;
|
||
if(!empty($this->app->installing) || !empty($this->app->upgrading)) return $data;
|
||
|
||
return $this->loadModel('workflowfield')->processExportOptions($data);
|
||
}
|
||
|
||
/**
|
||
* Process workflow import data.
|
||
*
|
||
* @param object $data
|
||
* @access public
|
||
* @return object
|
||
*/
|
||
public function processImportData($data)
|
||
{
|
||
if($this->config->edition == 'open') return $data;
|
||
if(!empty($this->app->installing) || !empty($this->app->upgrading)) return $data;
|
||
|
||
return $this->loadModel('workflowfield')->processImportData($data);
|
||
}
|
||
|
||
/**
|
||
* Get flow extend fields.
|
||
*
|
||
* @param int $objectID
|
||
* @access public
|
||
* @return array
|
||
*/
|
||
public function getFlowExtendFields(int $objectID = 0): array
|
||
{
|
||
if($this->config->edition == 'open') return array();
|
||
if(!empty($this->app->installing) || !empty($this->app->upgrading)) return array();
|
||
|
||
return $this->loadModel('flow')->getExtendFields($this->app->getModuleName(), $this->app->getMethodName(), $objectID);
|
||
}
|
||
|
||
/**
|
||
* Set workflow export fields.
|
||
*
|
||
* @access public
|
||
* @return string
|
||
*/
|
||
public function getFlowExportFields()
|
||
{
|
||
if($this->config->edition == 'open') return array();
|
||
if(!empty($this->app->installing) || !empty($this->app->upgrading)) return array();
|
||
|
||
return $this->loadModel('workflowfield')->getExportFields($this->app->getModuleName());
|
||
}
|
||
|
||
/**
|
||
* Execute Hooks
|
||
*
|
||
* @param int $objectID
|
||
* @access public
|
||
* @return string
|
||
*/
|
||
public function executeHooks(int $objectID): string
|
||
{
|
||
if($this->config->edition == 'open') return '';
|
||
if(!empty($this->app->installing) || !empty($this->app->upgrading)) return '';
|
||
|
||
$moduleName = $this->app->getModuleName();
|
||
$methodName = $this->app->getMethodName();
|
||
|
||
$groupID = $this->loadModel('workflowgroup')->getGroupIDByDataID($moduleName, $objectID);
|
||
$action = $this->loadModel('workflowaction')->getByModuleAndAction($moduleName, $methodName, $groupID);
|
||
if(empty($action) or $action->extensionType == 'none') return '';
|
||
|
||
$this->loadModel('file');
|
||
if($this->post->uid) $this->file->updateObjectID($this->post->uid, $objectID, $moduleName);
|
||
$uiID = $this->loadModel('workflowlayout')->getUIByDataID($moduleName, $methodName, $objectID);
|
||
$fields = $this->workflowaction->getPageFields($moduleName, $action->action, '', null, $uiID, $groupID);
|
||
foreach($fields as $field)
|
||
{
|
||
if($field->control == 'file' && $field->show && !$field->readonly)
|
||
{
|
||
$this->file->saveUpload($moduleName, $objectID, $field->field, $field->field, $field->field);
|
||
}
|
||
}
|
||
|
||
$flow = $this->loadModel('workflow')->getByModule($moduleName, false, $groupID);
|
||
if($flow && $action) return $this->loadModel('workflowhook')->execute($flow, $action, $objectID);
|
||
}
|
||
|
||
/**
|
||
* Call the functions declared in the tao files.
|
||
*
|
||
* @param string $method
|
||
* @param array $arguments
|
||
* @access public
|
||
* @return mixed
|
||
*/
|
||
public function __call(string $method, array $arguments)
|
||
{
|
||
$moduleName = $this->getModuleName();
|
||
$taoClass = $moduleName . 'Tao';
|
||
|
||
if(isset($this->{$taoClass}) && is_callable(array($this->{$taoClass}, $method))) return call_user_func_array(array($this->{$taoClass}, $method), $arguments);
|
||
|
||
$this->app->triggerError("the module {$moduleName} has no {$method} method", __FILE__, __LINE__, true);
|
||
}
|
||
|
||
/**
|
||
* Call the static functions declared in the tao files.
|
||
*
|
||
* @param string $method
|
||
* @param array $arguments
|
||
* @access public
|
||
* @return mixed
|
||
*/
|
||
public static function __callStatic($method, $arguments)
|
||
{
|
||
global $app;
|
||
|
||
$moduleName = strtolower(static::class);
|
||
|
||
preg_match_all('/^(ext)?(\w+)model/', $moduleName, $matches);
|
||
if(isset($matches[2][0]))
|
||
{
|
||
$moduleName = $matches[2][0];
|
||
}
|
||
else
|
||
{
|
||
preg_match_all('/^(ext)?(\w+)tao/', $moduleName, $matches);
|
||
if(isset($matches[2][0])) $moduleName = $matches[2][0];
|
||
}
|
||
|
||
$modelClass = 'ext' . $moduleName . 'Model';
|
||
if(method_exists($modelClass, $method)) return call_user_func_array("{$modelClass}::{$method}", $arguments);
|
||
|
||
$taoClass = 'ext' . $moduleName . 'Tao';
|
||
if(method_exists($taoClass, $method)) return call_user_func_array("{$taoClass}::{$method}", $arguments);
|
||
|
||
$taoClass = $moduleName . 'Tao';
|
||
if(method_exists($taoClass, $method)) return call_user_func_array("{$taoClass}::{$method}", $arguments);
|
||
|
||
$app->triggerError("the module {$moduleName} has no {$method} method", __FILE__, __LINE__, true);
|
||
}
|
||
}
|