Files
EasySoft-ZenTaoPMS/module/story/zen.php
T

1277 lines
52 KiB
PHP

<?php
declare(strict_types=1);
/**
* The zen file of story module of ZenTaoPMS.
*
* @copyright Copyright 2009-2023 禅道软件(青岛)有限公司(ZenTao Software (Qingdao) Co., Ltd. www.zentao.net)
* @license ZPL(https://zpl.pub/page/zplv12.html) or AGPL(https://www.gnu.org/licenses/agpl-3.0.en.html)
* @author Wang Yidong<yidong@easycorp.ltd>
* @package story
* @link http://www.zentao.net
*/
class storyZen extends story
{
/**
* 设置创建需求页面的导航。
* Set menu for create story.
*
* @param int $productID
* @param int $objectID
* @access protected
* @return int[]
*/
protected function setMenuForCreate(int $productID, int $objectID): array
{
/* Get product id according to the project id when lite vision todo transfer story */
if($this->config->vision == 'lite' && $productID == 0)
{
$products = $this->product->getProductPairsByProject($objectID);
if(!empty($products)) $productID = key($products);
}
/* Get objectID by tab. */
if(empty($objectID))
{
if($this->app->tab == 'project') $objectID = (int)$this->session->project;
if($this->app->tab == 'execution') $objectID = (int)$this->session->execution;
}
/* Set menu by tab. */
if($this->app->tab == 'product') $this->product->setMenu($productID);
if($this->app->tab == 'execution') $this->execution->setMenu($objectID);
if($this->app->tab == 'project')
{
$projectID = $objectID;
if(!$this->session->multiple)
{
$projectID = $this->session->project;
$objectID = $this->execution->getNoMultipleID($projectID);
}
$projects = $this->project->getPairsByProgram();
$projectID = $this->project->checkAccess($projectID, $projects);
$this->project->setMenu($projectID);
}
return array($productID, $objectID);
}
/**
* 为批量创建需求页面设置导航。
* Set menu for batch create.
*
* @param int $productID
* @param string $branch
* @param int $executionID
* @param string $extra
* @access protected
* @return void
*/
protected function setMenuForBatchCreate(int $productID, string $branch = '', int $executionID = 0, string $extra = ''): void
{
$this->view->hiddenProduct = false;
$this->view->hiddenPlan = false;
/* Set menu. */
if($this->app->tab == 'project' and $this->config->vision == 'lite')
{
$this->project->setMenu($this->session->project);
return;
}
if(empty($executionID))
{
$this->product->setMenu($productID, $branch);
return;
}
$execution = $this->dao->findById((int)$executionID)->from(TABLE_EXECUTION)->fetch();
$this->view->execution = $execution;
if($execution->type == 'project')
{
$this->project->setMenu($executionID);
$this->lang->navGroup->story = 'project';
$model = $execution->model == 'waterfallplus' ? 'waterfall' : $execution->model;
if($execution->model == 'agileplus') $model = 'scrum';
$this->lang->product->menu = $this->lang->{$model}->menu;
}
else
{
$this->execution->setMenu($executionID);
$this->lang->navGroup->story = 'execution';
if($execution->type == 'kanban')
{
$this->loadModel('kanban');
$output = $this->story->parseExtra($extra);
$regionPairs = $this->kanban->getRegionPairs($executionID, 0, 'execution');
$regionID = !empty($output['regionID']) ? $output['regionID'] : key($regionPairs);
$lanePairs = $this->kanban->getLanePairsByRegion($regionID, 'story');
$laneID = !empty($output['laneID']) ? $output['laneID'] : key($lanePairs);
$this->view->regionID = $regionID;
$this->view->laneID = $laneID;
$this->view->regionPairs = $regionPairs;
$this->view->lanePairs = $lanePairs;
}
}
if($this->app->tab != 'project' && $this->app->tab != 'execution') return;
/* Hidden some fields of projects without products. */
$project = $this->dao->findById($executionID)->from(TABLE_PROJECT)->fetch();
if($project->project) $project = $this->dao->findById((int)$project->project)->from(TABLE_PROJECT)->fetch();
if($project->hasProduct) return;
$this->view->hiddenProduct = true;
if($project->model !== 'scrum') $this->view->hiddenPlan = true;
if(!$project->multiple) $this->view->hiddenPlan = true;
}
/**
* 为批量编辑页面设置导航。
* Set menu for batch edit page.
*
* @param int $productID
* @param string $branch
* @param int $executionID
* @param string $from
* @access protected
* @return void
*/
protected function setMenuForBatchEdit(int $productID, string $branch = '', int $executionID = 0, string $from = ''): void
{
$this->view->hiddenPlan = false;
if($this->app->tab == 'product')
{
$this->product->setMenu($productID);
return;
}
if($this->app->tab == 'execution')
{
$this->execution->setMenu($executionID);
return;
}
if($this->app->tab == 'qa')
{
$this->loadModel('qa')->setMenu($productID);
return;
}
if($this->app->tab == 'my')
{
$this->loadModel('my');
if($from == 'work') $this->lang->my->menu->work['subModule'] = 'story';
if($from == 'contribute') $this->lang->my->menu->contribute['subModule'] = 'story';
return;
}
if($this->app->tab == 'project')
{
$project = $this->dao->findByID($executionID)->from(TABLE_PROJECT)->fetch();
if($project->type == 'project')
{
if(!($project->model == 'scrum' and !$project->hasProduct and $project->multiple)) $this->view->hiddenPlan = true;
$this->project->setMenu($executionID);
}
else
{
if(!$project->hasProduct and !$project->multiple) $this->view->hiddenPlan = true;
$this->execution->setMenu($executionID);
}
}
}
/**
* 设置批量关闭需求页面的导航。
* Set menu for batch close.
*
* @param int $productID
* @param int $executionID
* @param string $from work|contribute
* @param string $storyType story|requirement
* @access protected
* @return void
*/
protected function setMenuForBatchClose(int $productID, int $executionID = 0, string $from = '', string $storyType = 'story')
{
/* The stories of a product. */
if($this->app->tab == 'product' and !empty($productID))
{
$this->product->setMenu($productID);
$product = $this->product->getByID($productID);
$this->view->title = $product->name . $this->lang->colon . $this->lang->story->batchClose;
$this->session->set('storyList', $this->createLink('product', 'browse', "productID={$productID}"), $this->app->tab);
}
/* The stories of a execution. */
elseif($executionID)
{
$this->lang->story->menu = $this->lang->execution->menu;
$this->lang->story->menuOrder = $this->lang->execution->menuOrder;
$this->execution->setMenu($executionID);
$execution = $this->execution->getByID($executionID);
$this->view->title = $execution->name . $this->lang->colon . $this->lang->story->batchClose;
$this->session->set('storyList', $this->createLink('execution', 'story', "executionID={$executionID}"), $this->app->tab);
}
else
{
if($this->app->tab == 'project')
{
$this->project->setMenu(!empty($this->session->project) ? $this->session->project : $executionID);
$this->view->title = $this->lang->story->batchClose;
$this->session->set('storyList', $this->createLink('projectstory', 'story', "projectID={$executionID}"), $this->app->tab);
}
else
{
$this->lang->story->menu = $this->lang->my->menu;
$this->lang->story->menuOrder = $this->lang->my->menuOrder;
if($from == 'work') $this->lang->my->menu->work['subModule'] = 'story';
if($from == 'contribute') $this->lang->my->menu->contribute['subModule'] = 'story';
$this->view->title = $this->lang->story->batchClose;
if(!empty($form)) $this->session->set('storyList', $this->createLink('my', $from, "mode=$storyType"), $this->app->tab);
}
}
}
/**
* 如果是看板执行,设置界面中要用到关于看板的视图变量。
* Set view vars for kanban.
*
* @param int $objectID
* @param array $kanbanSetting
* @access protected
* @return void
*/
protected function setViewVarsForKanban(int $objectID, array $kanbanSetting): void
{
if($this->app->tab != 'execution') return;
if(empty($objectID)) return;
$execution = $this->dao->findById($objectID)->from(TABLE_EXECUTION)->fetch();
if($execution->type != 'kanban') return ;
/* 如果是看板执行,设置看板的view变量。 */
$regionPairs = $this->loadModel('kanban')->getRegionPairs($execution->id, 0, 'execution');
$regionID = !empty($kanbanSetting['regionID']) ? $kanbanSetting['regionID'] : key($regionPairs);
$lanePairs = $this->kanban->getLanePairsByRegion($regionID, 'story');
$laneID = !empty($kanbanSetting['laneID']) ? $kanbanSetting['laneID'] : key($lanePairs);
$this->view->executionType = 'kanban';
$this->config->story->form->create['region']['options'] = $regionPairs;
$this->config->story->form->create['region']['default'] = $regionID;
$this->config->story->form->create['region']['title'] = $this->lang->kanbancard->region;
$this->config->story->form->create['lane']['options'] = $lanePairs;
$this->config->story->form->create['lane']['default'] = $laneID;
$this->config->story->form->create['lane']['title'] = $this->lang->kanbancard->lane;
}
/**
* 初始化创建需求的一些字段的数据。
* Init story for create.
*
* @param int $planID
* @param int $storyID
* @param int $bugID
* @param int $todoID
* @access protected
* @return object
*/
protected function initStoryForCreate(int $planID, int $storyID, int $bugID, int $todoID): object
{
$initStory = new stdclass();
$initStory->source = '';
$initStory->sourceNote = '';
$initStory->pri = 3;
$initStory->estimate = '';
$initStory->title = '';
$initStory->spec = '';
$initStory->verify = '';
$initStory->keywords = '';
$initStory->mailto = '';
$initStory->color = '';
$initStory->plan = $planID;
if($storyID > 0) $initStory = $this->getInitStoryByStory($storyID, $initStory);
if($bugID > 0) $initStory = $this->getInitStoryByBug($bugID, $initStory);
if($todoID > 0) $initStory = $this->getInitStoryByTodo($todoID, $initStory);
return $initStory;
}
/**
* 根据复制的需求,初始化创建需求的一些字段数据。
* Get init story by copied story.
*
* @param int $storyID
* @param object $initStory
* @access protected
* @return object
*/
protected function getInitStoryByStory(int $storyID, object $initStory): object
{
if(empty($storyID)) return $initStory;
$story = $this->story->getByID($storyID);
$initStory->product = $story->product;
$initStory->plan = $story->plan;
$initStory->module = $story->module;
$initStory->source = $story->source;
$initStory->sourceNote = $story->sourceNote;
$initStory->color = $story->color;
$initStory->pri = $story->pri;
$initStory->estimate = $story->estimate;
$initStory->title = $story->title;
$initStory->spec = htmlSpecialString($story->spec);
$initStory->verify = htmlSpecialString($story->verify);
$initStory->keywords = $story->keywords;
$initStory->mailto = $story->mailto;
$initStory->category = $story->category;
$initStory->feedbackBy = $story->feedbackBy;
$initStory->notifyEmail = $story->notifyEmail;
return $initStory;
}
/**
* 根据来源Bug,初始化创建需求的一些字段数据。
* Get init story by bug.
*
* @param int $bugID
* @param object $initStory
* @access protected
* @return object
*/
protected function getInitStoryByBug(int $bugID, object $initStory): object
{
if(empty($bugID)) return $initStory;
$bug = $this->loadModel('bug')->getByID($bugID);
$initStory->product = $bug->product;
$initStory->source = 'bug';
$initStory->title = $bug->title;
$initStory->keywords = $bug->keywords;
$initStory->spec = $bug->steps;
$initStory->pri = !empty($bug->pri) ? $bug->pri : '3';
$initStory->mailto = $bug->mailto;
if($bug->mailto and !str_contains($bug->mailto, $bug->openedBy)) $initStory->mailto = $bug->mailto . $bug->openedBy . ',';
return $initStory;
}
/**
* 根据来源待办,初始化创建产品的一些字段数据。
* Get init story by todo.
*
* @param int $todoID
* @param object $initStory
* @access protected
* @return object
*/
protected function getInitStoryByTodo(int $todoID, object $initStory): object
{
if(empty($todoID)) return $initStory;
$todo = $this->loadModel('todo')->getByID($todoID);
$initStory->source = 'todo';
$initStory->title = $todo->name;
$initStory->spec = $todo->desc;
$initStory->pri = $todo->pri;
return $initStory;
}
/**
* 获取产品和分支列表。
* Get products and branches for create.
*
* @param int $productID
* @param int $objectID
* @access protected
* @return array
*/
protected function getProductsAndBranchesForCreate(int $productID, int $objectID): array
{
$products = array();
$branches = array();
if($objectID != 0)
{
$onlyNoClosed = empty($this->config->CRProduct) ? 'noclosed' : '';
$products = $this->product->getProductPairsByProject($objectID, $onlyNoClosed);
$productID = (!empty($productID) && isset($products[$productID])) ? $productID : key($products);
$product = $this->product->getById($productID);
if($product->type != 'normal')
{
$productBranches = $this->loadModel('execution')->getBranchByProduct(array($productID), $objectID, 'noclosed|withMain');
if(isset($productBranches[$productID])) $branches = $productBranches[$productID];
}
}
else
{
$productList = $this->product->getOrderedProducts('noclosed');
foreach($productList as $product) $products[$product->id] = $product->name;
$product = $this->product->getById($productID);
if(!isset($products[$product->id])) $products[$product->id] = $product->name;
if($product->type != 'normal') $branches = $this->loadModel('branch')->getPairs($productID, 'active');
}
return array($products, $branches);
}
/**
* 获取创建需求的表单字段。
* Get form fields for create
*
* @param int $productID
* @param string $branch
* @param int $objectID
* @param object $initStory
* @access protected
* @return array
*/
protected function getFormFieldsForCreate(int $productID, string $branch, int $objectID, object $initStory): array
{
$account = $this->app->user->account;
$fields = $this->config->story->form->create;
/* 准备数据。*/
list($products, $branches) = $this->getProductsAndBranchesForCreate($productID, $objectID);
if($objectID)
{
$branch = is_array($branches) && !empty($branches) ? key($branches) : $branch;
$productID = (!empty($productID) && isset($products[$productID])) ? $productID : key($products);
}
$branch = str_contains($branch, ',') ? current(explode(',', $branch)) : $branch;
$product = $this->product->getByID($productID);
$users = $this->user->getPairs('pdfirst|noclosed|nodeleted');
$stories = $this->story->getParentStoryPairs($productID);
$plans = $this->loadModel('productplan')->getPairs($productID, $branch == 0 ? '' : $branch, 'unexpired|noclosed', true);
$plans = array_map(function($planName){return str_replace(FUTURE_TIME, $this->lang->story->undetermined, $planName);}, $plans);
$forceReview = $this->story->checkForceReview();
$needReview = ($account == $product->PO || $objectID > 0 || $this->config->story->needReview == 0 || !$forceReview);
$reviewers = $this->story->getProductReviewers($productID);
/* 追加字段的name、title属性,展开user数据。 */
foreach($fields as $field => $attr)
{
if(isset($attr['options']) and $attr['options'] == 'users') $fields[$field]['options'] = $users;
if(!isset($fields[$field]['name'])) $fields[$field]['name'] = $field;
if(!isset($fields[$field]['title'])) $fields[$field]['title'] = zget($this->lang->story, $field);
}
/* 设置下拉菜单内容。 */
$fields['product']['options'] = $products;
$fields['branch']['options'] = $branches;
$fields['branches']['options'] = $branches;
$fields['plan']['options'] = $plans;
$fields['plans']['options'] = $plans;
$fields['reviewer']['options'] = $reviewers;
$fields['parent']['options'] = array_filter($stories);
/* 设置默认值。 */
foreach($initStory as $field => $defaultValue)
{
if(isset($fields[$field])) $fields[$field]['default'] = $defaultValue;
}
if(empty($fields['product']['default'])) $fields['product']['default'] = $productID;
if(empty($fields['branch']['default'])) $fields['branch']['default'] = $branch;
if(empty($fields['branches']['default'])) $fields['branches']['default'] = $branch;
if(empty($fields['plans']['default'])) $fields['plans']['default'] = zget($initStory, 'plan', 0);
if(empty($needReview)) $fields['reviewer']['default'] = $product->PO;
if($forceReview) $fields['reviewer']['required'] = true;
/* 删除不需要的字段。 */
if(empty($branches)) unset($fields['branch'], $fields['branches'], $fields['modules'], $fields['plans']);
$this->view->productID = $productID;
$this->view->product = $product;
$this->view->branch = $branch;
$this->view->branches = $branches;
$this->view->objectID = $objectID;
$this->view->forceReview = $forceReview;
$this->view->needReview = $needReview;
return $fields;
}
/**
* 获取批量创建需求的表单字段。
* Get form fields for batch create.
*
* @param int $productID
* @param string $branch
* @param int $executionID
* @access protected
* @return array
*/
protected function getFormFieldsForBatchCreate(int $productID, string $branch, int $executionID = 0, string $storyType = ''): array
{
$product = $this->loadModel('product')->getByID($productID);
$fields = $this->config->story->form->batchCreate;
if($executionID)
{
$productBranches = $product->type != 'normal' ? $this->loadModel('execution')->getBranchByProduct(array($productID), $executionID, 'noclosed|withMain') : array();
$branches = isset($productBranches[$productID]) ? $productBranches[$productID] : array();
$branch = empty($branches) ? '' : key($branches);
if($this->view->execution->type == 'kanban')
{
$fields['region']['options'] = zget($this->view, 'regionPairs', array());
$fields['lane']['options'] = zget($this->view, 'lanePairs', array());
$fields['region']['default'] = zget($this->view, 'regionID', 0);
$fields['lane']['default'] = zget($this->view, 'laneID', 0);
}
}
else
{
$branches = $product->type != 'normal' ? $this->loadModel('branch')->getPairs($productID, 'active') : array();
}
$branch = current(explode(',', $branch));
$modules = $this->tree->getOptionMenu($productID, 'story', 0, $branch === 'all' ? 0 : $branch);
$plans = $this->loadModel('productplan')->getPairs($productID, ($branch === 'all' or empty($branch)) ? '' : $branch, 'unexpired|noclosed', true);
$reviewers = $this->story->getProductReviewers($productID);
$users = $this->user->getPairs('pdfirst|noclosed|nodeleted');
$stories = $this->story->getParentStoryPairs($productID);
$URS = $storyType != 'story' ? array() : $this->story->getProductStoryPairs($productID, $branch, 0, 'changing,active,reviewing', 'id_desc', 0, '', 'requirement');
/* 设置下拉菜单内容。 */
$fields['branch']['options'] = $branches;
switch ($product->type)
{
case 'normal':
unset($fields['branch']);
break;
case 'platform':
$fieldPlatform = array('platform' => $fields['branch']);
unset($fields['branch']);
$fields = array_merge($fieldPlatform, $fields);
break;
}
$fields['module']['options'] = $modules;
$fields['plan']['options'] = $plans;
$fields['reviewer']['options'] = $reviewers;
$fields['assignedTo']['options'] = $users;
$fields['mailto']['options'] = $users;
$fields['parent']['options'] = array_filter($stories);
$fields['URS']['options'] = $URS;
if($this->story->checkForceReview()) $fields['reviewer']['required'] = true;
if(empty($branches)) unset($fields['branch']);
if($this->view->hiddenPlan) unset($fields['plan']);
$this->view->branchID = $branch;
return $fields;
}
/**
* 获取变更需求的表单字段。
* Get form fields for change story.
*
* @param int $storyID
* @access protected
* @return array
*/
protected function getFormFieldsForChange(int $storyID): array
{
$story = $this->view->story;
$fields = $this->config->story->form->change;
foreach(array_keys($fields) as $field)
{
if(!isset($fields[$field]['name'])) $fields[$field]['name'] = $field;
if(!isset($fields[$field]['title'])) $fields[$field]['title'] = zget($this->lang->story, $field);
}
$reviewerAndResultPairs = $this->story->getReviewerPairs($storyID, $story->version);
$reviewer = array_keys($reviewerAndResultPairs);
$fields['reviewer']['options'] = $this->story->getProductReviewers($story->product, $reviewer);
$fields['reviewer']['default'] = $reviewer;
$fields['title']['default'] = $story->title;
$fields['color']['default'] = $story->color;
$fields['spec']['default'] = $story->spec;
$fields['verify']['default'] = $story->verify;
$fields['status']['default'] = $story->status;
$forceReview = $this->story->checkForceReview();
if($forceReview) $fields['reviewer']['required'] = true;
$this->view->forceReview = $forceReview;
$this->view->needReview = ($this->app->user->account == $this->view->product->PO || $this->config->story->needReview == 0 || !$forceReview) && empty($reviewer);
$fields['comment'] = array('type' => 'string', 'control' => 'editor', 'required' => false, 'default' => '', 'name' => 'comment', 'title' => $this->lang->comment);
return $fields;
}
/**
* 获取评审需求的表单字段。
* Get form fields for review story.
*
* @param int $storyID
* @access protected
* @return array
*/
protected function getFormFieldsForReview(int $storyID): array
{
$story = $this->view->story;
$fields = $this->config->story->form->review;
$users = $this->loadModel('user')->getPairs('nodeleted|noclosed', "$story->lastEditedBy,$story->openedBy");
$resultList = $this->lang->story->reviewResultList;
if($story->status == 'reviewing')
{
if($story->version == 1) unset($resultList['revert']);
if($story->version > 1) unset($resultList['reject']);
}
foreach($fields as $field => $attr)
{
if(isset($attr['options']) and $attr['options'] == 'users') $fields[$field]['options'] = $users;
if(!isset($fields[$field]['name'])) $fields[$field]['name'] = $field;
if(!isset($fields[$field]['title'])) $fields[$field]['title'] = zget($this->lang->story, $field);
}
$fields['result']['options'] = $resultList;
$fields['reviewedDate']['default'] = helper::now();
$fields['assignedTo']['default'] = $story->assignedTo;
$fields['pri']['default'] = $story->pri;
$fields['estimate']['default'] = $story->estimate;
$fields['status']['default'] = $story->status;
$fields['closedReason']['required'] = true;
$fields['duplicateStory']['required'] = true;
$fields['comment'] = array('type' => 'string', 'control' => 'editor', 'required' => false, 'default' => '', 'name' => 'comment', 'title' => $this->lang->comment, 'width' => 'full');
$this->view->users = $users;
return $fields;
}
/**
* 设置模块字段的表单字段。
* Set module form field.
*
* @param array $fields
* @param int $moduleID
* @access protected
* @return array
*/
protected function setModuleField(array $fields, int $moduleID): array
{
$productID = $this->view->productID;
$branch = $this->view->branch;
$optionMenu = $this->tree->getOptionMenu($productID, 'story', 0, $branch === 'all' ? 0 : $branch);
$moduleID = $moduleID ? $moduleID : (int)$this->cookie->lastStoryModule;
$moduleID = isset($optionMenu[$moduleID]) ? $moduleID : 0;
$fields['module']['options'] = $optionMenu;
$fields['module']['default'] = $moduleID;
$fields['modules']['options'] = $optionMenu;
$fields['modules']['default'] = $moduleID;
$this->view->moduleID = $moduleID;
return $fields;
}
/**
* 根据配置,删除非必要的表单字段配置。
* Remove form fields for create.
*
* @param array $fields
* @param string $storyType
* @access protected
* @return array
*/
protected function removeFormFieldsForCreate(array $fields, string $storyType = 'story'): array
{
$productID = $this->view->productID;
$branch = $this->view->branch;
$objectID = $this->view->objectID;
/* Hidden some fields of projects without products. */
$hiddenProduct = $hiddenParent = $hiddenPlan = $hiddenURS = false;
$teamUsers = $URS = array();
$showFeedback = in_array($fields['source']['default'], $this->config->story->feedbackSource);
if($storyType == 'story')
{
$moduleIdList = $this->tree->getAllChildId($this->view->moduleID);
$URS = $this->story->getProductStoryPairs($productID, $branch, $moduleIdList, 'changing,active,reviewing', 'id_desc', 0, '', 'requirement');
}
$fields['URS']['options'] = $URS;
if($this->app->tab === 'project' || $this->app->tab === 'execution')
{
$project = $this->dao->findById((int)$objectID)->from(TABLE_PROJECT)->fetch();
if(!empty($project->project)) $project = $this->dao->findById((int)$project->project)->from(TABLE_PROJECT)->fetch();
if(empty($project->hasProduct))
{
$teamUsers = $this->project->getTeamMemberPairs($project->id);
$hiddenProduct = $hiddenParent = true;
if($project->model !== 'scrum' or !$project->multiple) $hiddenPlan = true;
if($project->model === 'kanban') $hiddenURS = true;
}
}
if($storyType != 'story') unset($fields['region'], $fields['lane'], $fields['branches'], $fields['modules'], $fields['plans']);
if($storyType != 'story' || !$this->config->URSR || $hiddenURS) unset($fields['URS']);
if($hiddenProduct)
{
$fields['product']['control'] = 'hidden';
$fields['reviewer']['options'] = $teamUsers;
$fields['assignedTo']['options'] = $teamUsers;
}
$this->view->hiddenParent = $hiddenParent;
return $fields;
}
/**
* 根据配置,删除非必要的表单字段配置。
* Remove form fields for batch create.
*
* @param int $productID
* @param array $fields
* @param string $productType
* @param string $storyType
* @access protected
* @return array
*/
protected function removeFormFieldsForBatchCreate(array $fields, bool $hiddenPlan, string $executionType): array
{
if($hiddenPlan) unset($fields['plan']);
if($executionType != 'kanban')
{
unset($fields['region']);
unset($fields['lane']);
}
return $fields;
}
/**
* 获取指派给我的Block编号。
* Get assign me block id.
*
* @access protected
* @return int
*/
protected function getAssignMeBlockID(): int
{
if(!isonlybody()) return 0;
return (int)$this->dao->select('id')->from(TABLE_BLOCK)->where('block')->eq('assigntome')
->andWhere('module')->eq('my')
->andWhere('account')->eq($this->app->user->account)
->orderBy('order_desc')
->limit(1)
->fetch('id');
}
/**
* 构建创建需求数据。
* Build story for create
*
* @param int $executionID
* @param int $bugID
* @access protected
* @return object|false
*/
protected function buildStoryForCreate(int $executionID, int $bugID): object|false
{
$fields = $this->config->story->form->create;
$editorFields = array_keys(array_filter(array_map(function($config){return $config['control'] == 'editor';}, $fields)));
foreach(explode(',', trim($this->config->story->create->requiredFields, ',')) as $field) $fields[$field]['required'] = true;
if($this->post->type == 'requirement') $fields['plan']['required'] = false;
$storyData = form::data($fields)
->setIF($this->post->assignedTo, 'assignedDate', helper::now())
->setIF($this->post->plan > 0, 'stage', 'planned')
->setIF(!in_array($this->post->source, $this->config->story->feedbackSource), 'feedbackBy', '')
->setIF(!in_array($this->post->source, $this->config->story->feedbackSource), 'notifyEmail', '')
->setIF($executionID > 0, 'stage', 'projected')
->setIF($bugID > 0, 'fromBug', $bugID)
->get();
if(isset($_POST['reviewer'])) $_POST['reviewer'] = array_filter($_POST['reviewer']);
if(!$this->post->needNotReview and empty($_POST['reviewer']))
{
dao::$errors['reviewer'] = sprintf($this->lang->error->notempty, $this->lang->story->reviewedBy);
return false;
}
if($storyData->status != 'draft' and $this->story->checkForceReview()) $storyData->status = 'reviewing';
return $this->loadModel('file')->processImgURL($storyData, $editorFields, $this->post->uid);
}
/**
* 构建评审需求数据。
* Build story for review
*
* @param int $storyID
* @access protected
* @return object|false
*/
protected function buildStoryForReview(int $storyID): object|false
{
$now = helper::now();
$fields = $this->config->story->form->review;
foreach(explode(',', trim($this->config->story->create->requiredFields, ',')) as $field)
{
if($field == 'comment' && !$this->post->comment)
{
dao::$errors[] = sprintf($this->lang->error->notempty, $this->lang->comment);
return false;
}
if(isset($fields[$field])) $fields[$field]['required'] = true;
}
if($this->post->result == false)
{
dao::$errors['result'][] = $this->lang->story->mustChooseResult;
return false;
}
$editorFields = array_keys(array_filter(array_map(function($config){return $config['control'] == 'editor';}, $fields)));
$result = $this->post->result;
$closedReason = $this->post->closedReason;
$oldStory = $this->dao->findById($storyID)->from(TABLE_STORY)->fetch();
$storyData = form::data($fields)
->setDefault('lastEditedBy', $this->app->user->account)
->setDefault('lastEditedDate', $now)
->removeIF($result != 'reject', 'closedReason,duplicateStory,childStories')
->removeIF($result == 'reject' && $closedReason != 'duplicate', 'duplicateStory')
->removeIF($result == 'reject' && $closedReason != 'subdivided', 'childStories')
->get();
if($oldStory->assignedTo != $storyData->assignedTo) $storyData->assignedDate = $now;
$storyData->reviewedBy = implode(',', array_unique(explode(',', $oldStory->reviewedBy . ',' . $this->app->user->account)));
if($result == 'reject' && empty($closedReason)) dao::$errors[] = sprintf($this->lang->error->notempty, $this->lang->story->rejectedReason);
if($result == 'reject' && $closedReason == 'duplicate' && empty($storyData->duplicateStory)) dao::$errors[] = sprintf($this->lang->error->notempty, $this->lang->story->duplicateStory);
if(dao::isError()) return false;
return $this->loadModel('file')->processImgURL($storyData, $editorFields, $this->post->uid);
}
/**
* 构建批量创建需求数据。
* Build stories for batch create.
*
* @param int $productID
* @param string $storyType
* @access protected
* @return array
*/
protected function buildStoriesForBatchCreate(int $productID, string $storyType): array
{
$forceReview = $this->story->checkForceReview();
$fields = $this->config->story->form->batchCreate;
$account = $this->app->user->account;
$now = helper::now();
$saveDraft = $this->post->status == 'draft';
if($forceReview) $fields['reviewer']['required'] = true;
$stories = form::batchData($fields)->get();
foreach($stories as $i => $story)
{
$story->type = $storyType;
$story->status = (empty($story->reviewer) && !$forceReview) ? 'active' : 'reviewing';
$story->status = $saveDraft ? 'draft' : $story->status;
$story->stage = ($this->app->tab == 'project' || $this->app->tab == 'execution') ? 'projected' : 'wait';
$story->product = $productID;
$story->openedBy = $account;
$story->vision = $this->config->vision;
$story->openedDate = $now;
$story->version = 1;
$story->mailto = is_array($story->mailto) ? implode(',', $story->mailto) : '';
!empty($story->assignedTo) && $story->assignedDate = $now;
if($this->post->uploadImage && $this->post->uploadImage[$i]) $story->uploadImage = $this->post->uploadImage[$i];
}
return $stories;
}
/**
* 构建批量编辑需求数据。
* Build stories for batch edit page.
*
* @access protected
* @return array
*/
protected function buildStoriesForBatchEdit(): array
{
$fields = $this->config->story->form->batchEdit;
$account = $this->app->user->account;
$now = helper::now();
$fields['duplicateStory'] = array('type' => 'int', 'required' => false, 'default' => 0);
$fields['childStories'] = array('type' => 'string', 'required' => false, 'default' => '', 'filter' => 'trim');
$stories = form::batchData($fields)->get();
$oldStories = $this->story->getByList(array_keys($stories));
foreach($stories as $storyID => $story)
{
$oldStory = $oldStories[$storyID];
$story->lastEditedBy = $this->app->user->account;
$story->lastEditedDate = $now;
if($oldStory->assignedTo != $story->assignedTo) $story->assignedDate = $now;
if($oldStory->parent < 0) $story->plan = '';
if($story->stage != $oldStory->stage) $story->stagedBy = (str_contains('|tested|verified|released|closed|', "|{$story->stage}|")) ? $account : '';
if($story->closedBy && helper::isZeroDate($oldStory->closedDate)) $story->closedDate = $now;
if($story->closedReason && helper::isZeroDate($oldStory->closedDate)) $story->closedDate = $now;
if($story->closedBy || $story->closedReason) $story->status = 'closed';
if($story->closedReason && empty($story->closedBy)) $story->closedBy = $account;
if($story->closedBy && empty($story->closedReason)) dao::$errors['closedReason'] = sprintf($this->lang->error->notempty, $this->lang->story->closedReason);
if($story->closedReason == 'done' && empty($story->stage)) dao::$errors['stage'] = sprintf($this->lang->error->notempty, $this->lang->story->stage);
if($story->closedReason == 'duplicate' && empty($story->duplicateStory)) dao::$errors['duplicateStory'] = sprintf($this->lang->error->notempty, $this->lang->story->duplicateStory);
}
return $stories;
}
/**
* 构建批量关闭需求数据,跳过有子需求的父需求以及已经关闭了的需求。
* Build stories for batch close.
*
* @access protected
* @return array
*/
protected function buildStoriesForBatchClose(): array
{
$fields = $this->config->story->form->batchClose;
$account = $this->app->user->account;
$now = helper::now();
$fields['duplicateStory'] = array('type' => 'int', 'required' => false, 'default' => 0);
$data = form::batchData($fields)->get();
$oldStories = $this->story->getByList(array_keys($data));
$stories = array();
foreach($data as $storyID => $story)
{
$oldStory = $oldStories[$storyID];
if($oldStory->parent == -1) continue; /* Skip the story which has any child story. */
if($oldStory->status == 'closed') continue; /* Skip the story which has been closed. */
$story->lastEditedBy = $account;
$story->lastEditedDate = $now;
$story->closedBy = $account;
$story->closedDate = $now;
$story->assignedTo = 'closed';
$story->assignedDate = $now;
$story->status = 'closed';
$story->stage = 'closed';
if($story->closedReason != 'done') $story->plan = '';
if($story->closedReason == 'duplicate' && empty($story->duplicateStory)) dao::$errors['duplicateStory'] = sprintf($this->lang->error->notempty, $this->lang->story->duplicateStory);
$stories[$storyID] = $story;
}
return $stories;
}
/**
* 检查需求是否重复。
* Check repeat story.
*
* @param object $story
* @param int $objectID
* @param string $storyType
* @access protected
* @return array
*/
protected function checkRepeatStory(object $story, int $objectID, string $storyType = 'story'): array
{
/* Check repeat story. */
$result = $this->loadModel('common')->removeDuplicate('story', $story, "product={$story->product}");
if(empty($result['stop'])) return array();
$response['result'] = 'success';
$response['message'] = sprintf($this->lang->duplicate, $this->lang->story->common);
$response['locate'] = $this->createLink('story', 'view', "storyID={$result['duplicate']}&version=0&param=0&storyType=$storyType");
if($objectID)
{
$execution = $this->dao->findById((int)$objectID)->from(TABLE_EXECUTION)->fetch();
$moduleName = $execution->type == 'project' ? 'projectstory' : 'execution';
$param = $execution->type == 'project' ? "projectID=$objectID&productID={$story->product}" : "executionID=$objectID";
$response['locate'] = $this->createLink($moduleName, 'story', $param);
}
return $response;
}
/**
* 如果是在弹窗中创建需求,获取创建后的跳转地址。
* Get response when after create story in modal.
*
* @param string $message
* @param int $executionID
* @access protected
* @return array|false
*/
protected function responseAfterCreateInModal(string $message, int $executionID = 0): array|false
{
if(!isonlybody()) return false;
if($this->app->tab != 'execution') return array('result' => 'success', 'message' => $message, 'load' => true, 'closeModal' => true);
$executionID = $executionID ? $executionID : $this->session->execution;
$execution = $this->execution->getByID($executionID);
$executionLaneType = $this->session->executionLaneType ? $this->session->executionLaneType : 'all';
$executionGroupBy = $this->session->executionGroupBy ? $this->session->executionGroupBy : 'default';
if($execution->type == 'kanban')
{
$rdSearchValue = $this->session->rdSearchValue ? $this->session->rdSearchValue : '';
$kanbanData = $this->loadModel('kanban')->getRDKanban($executionID, $executionLaneType, 'id_desc', 0, $executionGroupBy, $rdSearchValue);
$kanbanData = json_encode($kanbanData);
return array('result' => 'success', 'message' => $message, 'closeModal' => true, 'callback' => "updateKanban($kanbanData, 0)");
}
$taskSearchValue = $this->session->taskSearchValue ? $this->session->taskSearchValue : '';
$kanbanData = $this->loadModel('kanban')->getExecutionKanban($execution->id, $executionLaneType, $executionGroupBy, $taskSearchValue);
$kanbanType = $executionLaneType == 'all' ? 'story' : key($kanbanData);
$kanbanData = $kanbanData[$kanbanType];
$kanbanData = json_encode($kanbanData);
return array('result' => 'success', 'message' => $message, 'closeModal' => true, 'callback' => "updateKanban(\"story\", $kanbanData)");
}
/**
* 获取创建需求后的跳转地址。
* Get location when after create story.
*
* @param int $productID
* @param string $branch
* @param int $objectID
* @param int $storyID
* @param string $storyType
* @access protected
* @return string
*/
protected function getAfterCreateLocation(int $productID, string $branch, int $objectID, int $storyID, string $storyType): string
{
if($this->app->getViewType() == 'xhtml') return $this->createLink('story', 'view', "storyID=$storyID", 'html');
if($objectID)
{
helper::setcookie('storyModuleParam', '0', 0);
return $this->session->storyList;
}
helper::setcookie('storyModule', '0', 0);
$branchID = $this->post->branch ? $this->post->branch : $branch;
if(!$this->session->storyList) return $this->createLink('product', 'browse', "productID=$productID&branch=$branchID&browseType=&param=0&storyType=$storyType&orderBy=id_desc");
if(!empty($_POST['branches']) and count($_POST['branches']) > 1) return preg_replace('/branch=(\d+|[A-Za-z]+)/', 'branch=all', $this->session->storyList);
return $this->session->storyList;
}
/**
* 获取批量创建需求后的跳转地址。
* Get after batch create location.
*
* @param int $productID
* @param string $branch
* @param int $executionID
* @param int $storyID
* @param string $storyType
* @access protected
* @return string
*/
protected function getAfterBatchCreateLocation(int $productID, string $branch, int $executionID, int $storyID, string $storyType): string
{
if($storyID)
{
$locateLink = $this->session->storyList ? $this->session->storyList : $this->createLink('projectstory', 'view', "storyID=$storyID");
if($this->app->tab == 'product') $locateLink = $this->inlink('view', "storyID=$storyID&version=0&param=0&storyType=$storyType");
return $locateLink;
}
if($executionID)
{
helper::setcookie('storyModuleParam', '0', 0);
return $this->session->storyList;
}
helper::setcookie('storyModule', '0', 0);
if($this->session->storyList) return $this->session->storyList;
return $this->createLink('product', 'browse', "productID=$productID&branch=$branch&browseType=unclosed&queryID=0&storyType=$storyType");
}
/**
* 获取变更需求后的跳转地址。
* Get after change story location.
*
* @param int $storyID
* @param string $storyType
* @access protected
* @return string
*/
protected function getAfterChangeLocation(int $storyID, string $storyType = 'story'): string
{
if($this->app->tab == 'execution') return helper::createLink('execution', 'storyView', "storyID=$storyID");
if($this->app->tab != 'project') return helper::createLink('story', 'view', "storyID=$storyID&version=0&param=0&storyType=$storyType");
if($this->app->tab == 'project')
{
$module = 'projectstory';
$method = 'view';
$params = "storyID=$storyID";
if(!$this->session->multiple)
{
$module = 'story';
$params .= "&version=0&param={$this->session->project}&storyType=$storyType";
}
return helper::createLink($module, $module, $params);
}
}
/**
* 获取评审需求后的跳转地址。
* Get after review location.
*
* @param int $storyID
* @param string $storyType
* @param string $from
* @access protected
* @return string
*/
protected function getAfterReviewLocation(int $storyID, string $storyType = 'story', string $from = ''): string
{
if($from == 'project') return helper::createLink('projectstory', 'view', "storyID={$storyID}");
if($from != 'execution') return helper::createLink('story', 'view', "storyID={$storyID}&version=0&param=0&storyType={$storyType}");
$execution = $this->execution->getByID($this->session->execution);
$module = 'story';
$method = 'view';
$params = "storyID=$storyID&version=0&param={$this->session->execution}&storyType=$storyType";
if($execution->multiple)
{
$module = 'execution';
$method = 'storyView';
$params = "storyID=$storyID";
}
return helper::createLink($module, $method, $params);
}
/**
* 根据上传图片,批量创建需求时,获取初始化需求数据。
* Get data from upload images.
*
* @param int $productID
* @param int $moduleID
* @param int $planID
* @access protected
* @return array
*/
protected function getDataFromUploadImages(int $productID, int $moduleID = 0, int $planID = 0): array
{
/* Clear title when switching products and set the session for the current product. */
if($productID != $this->cookie->preProductID) unset($_SESSION['storyImagesFile']);
helper::setcookie('preProductID', (string)$productID);
$defaultStory = array('title' => '', 'spec' => '', 'module' => $moduleID, 'plan' => $planID, 'pri' => 3, 'estimate' => 0, 'branch' => $this->view->branchID);
$batchStories = array();
$count = $this->config->story->batchCreate;
for($batchIndex = 0; $batchIndex < $count; $batchIndex++) $batchStories[] = $defaultStory;
if(empty($_SESSION['storyImagesFile'])) return $batchStories;
$files = $this->session->storyImagesFile;
$batchStories = array();
foreach($files as $fileName => $file)
{
$defaultStory['title'] = $file['title'];
$defaultStory['uploadImage'] = $fileName;
$batchStories[] = $defaultStory;
}
return $batchStories;
}
/**
* Get custom fields list.
*
* @param object $config
* @param string $storyType
* @param bool $hiddenPlan
* @param object $product
* @access protected
* @return array
*/
protected function getCustomFields(object &$config, string $storyType, bool $hiddenPlan, object $product): array
{
$customFields = array();
/* Attach multi-branch or multi-platform field. */
if($product->type != 'normal') $customFields[$product->type] = $this->lang->product->branchName[$product->type];
foreach(explode(',', $config->story->list->customBatchCreateFields) as $field)
{
$customFields[$field] = $this->lang->story->$field;
}
if($hiddenPlan) unset($customFields['plan']);
if($product->type != 'normal')
{
$config->story->custom->batchCreateFields = sprintf($config->story->custom->batchCreateFields, $product->type);
}
else
{
$config->story->custom->batchCreateFields = trim(sprintf($config->story->custom->batchCreateFields, ''), ',');
}
/* User requirement without plan field. */
if($storyType == 'requirement') unset($customFields['plan']);
return $customFields;
}
/**
* Get show fields list.
*
* @param string $fieldListStr
* @param bool $hiddenPlan
* @param object $product
* @access protected
* @return array
*/
protected function getShowFields(string $fieldListStr, string $storyType, object $product): string
{
$showFields = $fieldListStr;
if($product->type == 'normal')
{
$showFields = str_replace(array(0 => ",branch,", 1 => ",platform,"), '', ",$showFields,");
$showFields = trim($showFields, ',');
}
if($storyType == 'requirement') $showFields = str_replace('plan', '', $showFields);
return $showFields;
}
/**
* Build story post data for activating the story.
*
* @return object
*/
protected function buildStoryForActivate(): object
{
$postData = form::data($this->config->story->form->activate)->get();
$story = $this->loadModel('file')->processImgURL($postData, $this->config->story->editor->activate['id'], $this->post->uid);
return $story;
}
}