zentao/module/program/zen.php

<?php
/**
 * The zen file of program 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      dingguodong <dingguodong@easycorp.ltd>
 * @link        https://www.zentao.net
 */

class programZen extends program
{
    /**
     * 追加额外的数据到提交的表单数据。
     * Append extras data to post data.
     *
     * @param  object     $postData
     * @access protected
     * @return object
     */
    protected function prepareStartExtras($postData)
    {
        return $postData->add('status', 'doing')
            ->add('lastEditedBy', $this->app->user->account)
            ->add('lastEditedDate', helper::now())
            ->get();
    }

    /**
     * 获取创建项目集的数据。
     * Build program data for create.
     *
     * @access protected
     * @return object
     */
    protected function buildProgramForCreate()
    {
        $fields = $this->config->program->form->create;
        if($this->post->longTime) $fields['end']['skipRequired'] = true;

        foreach(explode(',', trim($this->config->program->create->requiredFields, ',')) as $field)
        {
            if($field == 'end') continue;
            $fields[$field]['required'] = true;
        }

        $this->app->loadConfig('project');
        $program = form::data($fields)
            ->setDefault('openedBy', $this->app->user->account)
            ->setDefault('openedDate', helper::now())
            ->setDefault('code', '')
            ->setIF($this->post->longTime, 'end', LONG_TIME)
            ->setIF($this->post->acl == 'open', 'whitelist', '')
            ->add('type', 'program')
            ->join('whitelist', ',')
            ->get();

        return $this->loadModel('file')->processImgURL($program, $this->config->program->editor->create['id'], $this->post->uid);
    }

    /**
     * 获取编辑项目集的数据。
     * Build program for edit.
     *
     * @param  int       $programID
     * @access protected
     * @return object
     */
    protected function buildProgramForEdit($programID)
    {
        $oldProgram = $this->program->fetchByID($programID);
        $fields     = $this->config->program->form->edit;
        if($this->post->longTime) $fields['end']['skipRequired'] = true;

        foreach(explode(',', trim($this->config->program->edit->requiredFields, ',')) as $field)
        {
            if($field == 'end') continue;
            $fields[$field]['required'] = true;
        }

        $this->app->loadConfig('project');
        $program = form::data($fields, $programID)
            ->setDefault('id', $programID)
            ->setDefault('lastEditedBy', $this->app->user->account)
            ->setDefault('lastEditedDate', helper::now())
            ->setIF(helper::isZeroDate($this->post->begin), 'begin', '')
            ->setIF(helper::isZeroDate($this->post->end), 'end', '')
            ->setIF($this->post->realBegan != '' and $oldProgram->status == 'wait', 'status', 'doing')
            ->setIF(!isset($_POST['budgetUnit']), 'budgetUnit', $oldProgram->budgetUnit)
            ->setIF($this->post->longTime, 'end', LONG_TIME)
            ->setIF($this->post->acl == 'open', 'whitelist', '')
            ->join('whitelist', ',')
            ->get();

        return $this->loadModel('file')->processImgURL($program, $this->config->program->editor->edit['id'], $this->post->uid);
    }

    /**
     * @param mixed[] $parents
     * @param int $programID
     */
    protected function removeSubjectToCurrent($parents, $programID)
    {
        $children = $this->dao->select('*')->from(TABLE_PROGRAM)->where('path')->like("%,$programID,%")->fetchPairs('id', 'id');
        foreach($children as $childID) unset($parents[$childID]);

        return $parents;
    }

    /**
     * 根据条件获取项目集。
     * Get programs by type.
     *
     * @param  string      $status
     * @param  string      $orderBy
     * @param  int         $param
     * @param  object|null $pager
     * @access protected
     * @return array
     */
    protected function getProgramsByType($status, $orderBy, $param = 0, $pager = null)
    {
        $status = strtolower($status);
        $this->view->summary = '';

        if(strpos($orderBy, 'order') !== false) $orderBy = "grade,{$orderBy}";
        if(strtolower($status) == 'bysearch')
        {
            $programs = $this->program->getListBySearch($orderBy, $param, false, $pager);
        }
        else
        {
            /* Get top programs and projects. */
            $topObjects = $this->program->getList($status == 'unclosed' ? 'doing,suspended,wait' : $status, $orderBy, 'top', array(), $pager);
            if(!$topObjects) $topObjects = array(0);

            $programs = $this->program->getList($status, $orderBy, 'child', array_keys($topObjects));
        }

        /* Get summary. */
        $topCount = $indCount = 0;
        foreach($programs as $program)
        {
            if($program->type == 'program' and $program->parent == 0) $topCount ++;
            if($program->type == 'project' and $program->parent == 0) $indCount ++;
        }
        $this->view->summary = sprintf($this->lang->program->summary, $topCount, $indCount);

        return $programs;
    }

    /**
     * 根据项目集，获取产品经理列表。
     * Get PM list by programs.
     *
     * @param  array     $programs
     * @access protected
     * @return array
     */
    protected function getPMListByPrograms($programs)
    {
        $accounts   = array();
        $hasProject = false;
        foreach($programs as $program)
        {
            if(!empty($program->PM) and !in_array($program->PM, $accounts)) $accounts[] = $program->PM;
            if($hasProject === false and $program->type != 'program')       $hasProject = true;
        }
        $this->view->hasProject = $hasProject;

        return $this->loadModel('user')->getListByAccounts($accounts, 'account');
    }

    /**
     * 获取项目集看板。
     * Get kanban list for product.
     *
     * @param  string    $browseType
     * @access protected
     * @return array
     */
    protected function getKanbanList($browseType = 'my')
    {
        $kanbanList = array();

        $programPairs = array(0 => $this->lang->project->noProgram) + $this->program->getPairs(true, 'order_asc');
        $programList  = $this->getProgramList4Kanban($browseType);

        foreach($programList as $programID => $productList)
        {
            $region = array();

            $heading = new stdclass();
            $heading->title = zget($programPairs, $programID, $programID);

            $region['key']     = $programID;
            $region['id']      = $programID;
            $region['heading'] = $heading;

            $lanes       = array();
            $items       = array();
            $columnCards = array();
            foreach($productList as $laneKey => $laneData)
            {
                $lanes[] = array('name' => $laneKey, 'title' => $laneData->name);
                $columns = array();

                foreach(array('unexpiredPlans', 'waitingProjects', 'doing', 'doingProjects', 'doingExecutions', 'normalReleases') as $columnKey)
                {
                    $colTitle = $columnKey == 'doing' ? $this->lang->program->statusList['doing'] : $this->lang->program->kanban->{$columnKey};
                    $column = array('name' => $columnKey, 'title' => $colTitle);
                    if($columnKey == 'doingExecutions' || $columnKey == 'doingProjects') $column['parentName'] = 'doing';
                    $columns[] = $column;

                    $cardList = !empty($laneData->{$columnKey}) ? $laneData->{$columnKey} : array();
                    foreach($cardList as $card)
                    {
                        $items[$laneKey][$columnKey][] = array('id' => $card->id, 'name' => $card->id, 'title' => isset($card->name) ? $card->name : $card->title, 'status' => isset($card->status) ? $card->status : '', 'cardType' => $columnKey, 'delay' => !empty($card->delay) ? $card->delay : 0, 'progress' => isset($card->progress) ? $card->progress : 0, 'marker' => isset($card->marker) ? $card->marker : 0);

                        if(!isset($columnCards[$columnKey])) $columnCards[$columnKey] = 0;
                        $columnCards[$columnKey] ++;

                        if($columnKey == 'doingProjects')
                        {
                            if(!empty($latestExecutions[$card->id]))
                            {
                                $execution = $latestExecutions[$card->id];
                                $items[$laneKey]['doingExecutions'][] = array('id' => $execution->id, 'name' => $execution->id, 'title' => $execution->name, 'status' => $execution->status, 'cardType' => 'doingExecution', 'delay' => !empty($execution->delay) ? $execution->delay : 0, 'progress' => $execution->progress);

                                if(!isset($columnCards['doingExecutions'])) $columnCards['doingExecutions'] = 0;
                                $columnCards['doingExecutions'] ++;
                            }
                        }
                    }
                }
            }

            foreach($columns as $key => $column) $columns[$key]['cards'] = !empty($columnCards[$column['name']]) ? $columnCards[$column['name']] : 0;
            $groupData['key']           = $programID;
            $groupData['data']['lanes'] = $lanes;
            $groupData['data']['cols']  = $columns;
            $groupData['data']['items'] = $items;

            $region['items'] = array($groupData);
            $kanbanList[] = $region;
        }

        return $kanbanList;
    }

    /**
     * 获取项目集看板的数据。
     * Get kanban list data for product.
     *
     * @param  string    $browseType
     * @access protected
     * @return array
     */
    protected function getProgramList4Kanban($browseType = 'my')
    {
        $programs = $this->program->getTopPairs('noclosed');
        $involvedPrograms = $this->program->getInvolvedPrograms($this->app->user->account);
        foreach($programs as $programID => $programName)
        {
            if($browseType == 'my')
            {
                if(!in_array($programID, $involvedPrograms)) unset($programs[$programID]);
            }
            else
            {
                if(in_array($programID, $involvedPrograms)) unset($programs[$programID]);
            }
        }

        list($productGroup, $planGroup, $releaseGroup, $projectGroup, $doingExecutions) = $this->program->getKanbanStatisticData(array(0 => '') + $programs);

        $programList = array();
        $today       = helper::today();
        foreach($productGroup as $programID => $productList)
        {
            foreach($productList as $product)
            {
                $product->unexpiredPlans = isset($planGroup[$product->id]) ? $planGroup[$product->id] : array();

                if(isset($projectGroup[$product->id]))
                {
                    foreach($projectGroup[$product->id] as $project)
                    {
                        if(helper::diffDate($today, $project->end) > 0) $project->delay = helper::diffDate($today, $project->end);
                        if($project->status == 'wait')
                        {
                            $product->waitingProjects[$project->id] = $project;
                        }
                        elseif($project->status == 'doing')
                        {
                            $product->doingProjects[$project->id] = $project;
                            if(isset($doingExecutions[$project->id]))
                            {
                                $doingExecution = $doingExecutions[$project->id];
                                if(helper::diffDate($today, $doingExecution->end) > 0) $doingExecution->delay = helper::diffDate($today, $doingExecution->end);
                                $product->doingExecutions[$doingExecution->id] = $doingExecution;
                            }
                        }
                    }
                }

                $product->normalReleases = isset($releaseGroup[$product->id]) ? $releaseGroup[$product->id] : array();
                $programList[$programID][$product->id] = $product;
            }
        }

        return $programList;
    }

    /**
     * 构造1.5级导航的数据。
     * Build the data of 1.5 level navigation.
     *
     * 当列表中缺少上级项目集时，将仍挂在该上级下的子项目集作为根节点展示，避免仅含子项目集时树为空。
     * When parent programs are missing from the list, child programs whose parent is absent are shown as roots.
     *
     * @param  array     $programs
     * @param  int       $parentID
     * @access protected
     * @return array
     */
    protected function buildTree($programs, $parentID = 0)
    {
        $programList = array();
        foreach($programs as $program)
        {
            if($program->type != 'program') continue;
            $programList[] = $program;
        }

        if(empty($programList)) return array();

        $ids = array();
        foreach($programList as $program) $ids[$program->id] = true;

        $names     = array_column($programList, 'name');
        $pinyinMap = common::convert2Pinyin($names);

        return $this->buildTreeNodes($programList, $parentID, $ids, $pinyinMap);
    }

    /**
     * 递归构造项目集树节点。
     * Build program tree nodes recursively.
     *
     * @param  array     $programs
     * @param  int       $parentID
     * @param  array     $ids      program id => true
     * @param  array     $pinyinMap name => pinyin (from batch convert2Pinyin)
     * @access protected
     * @return array
     */
    protected function buildTreeNodes($programs, $parentID, $ids, $pinyinMap)
    {
        $result = array();
        foreach($programs as $program)
        {
            if($parentID === 0)
            {
                $match = ($program->parent == $parentID) || !isset($ids[$program->parent]);
            }
            else
            {
                $match = ($program->parent == $parentID);
            }

            if(!$match) continue;

            $itemArray = array
            (
                'id'    => $program->id,
                'text'  => $program->name,
                'label' => false,
                'keys'  => zget($pinyinMap, $program->name, ''),
                'items' => $this->buildTreeNodes($programs, $program->id, $ids, $pinyinMap)
            );

            if(empty($itemArray['items'])) unset($itemArray['items']);
            $result[] = $itemArray;
        }
        return $result;
    }

    /**
     * 获取下拉树菜单的链接。
     * Get link for drop tree menu.
     *
     * @param  string    $moduleName
     * @param  string    $methodName
     * @param string $programID
     * @param  string    $vars
     * @param  string    $from
     * @access protected
     * @return string
     */
    protected function getLink($moduleName, $methodName, $programID, $vars = '', $from = 'program')
    {
        if($from != 'program') return helper::createLink('product', 'all', "programID={$programID}" . $vars);

        if($this->config->edition != 'open')
        {
            $flow = $this->loadModel('workflow')->getByModule($moduleName);
            if($flow && in_array($flow->app, array('scrum', 'waterfall', 'kanbanProject'))) $flow->app = 'project';
            if(!empty($flow) && $flow->buildin == '0') return helper::createLink('flow', 'ajaxSwitchBelong', "objectID=$programID&moduleName=$moduleName") . "#app=$flow->app";
        }
        if($moduleName == 'project')
        {
            $moduleName = 'program';
            $methodName = 'project';
        }
        if($moduleName == 'product')
        {
            $moduleName = 'program';
            $methodName = 'product';
        }

        return helper::createLink($moduleName, $methodName, "programID={$programID}");
    }

    /**
     * 在产品视角查看项目时通过浏览类型获取产品列表。
     * Get products by browse type of the program for product view in program list.
     *
     * @param  string $browseType
     * @param  array  $products
     * @return array
     */
    protected function getProductsByBrowseType($browseType, $products)
    {
        /* Filter the program by browse type. */
        foreach($products as $index => $product)
        {
            $programID = $product->program;
            /* The product associated with the program. */
            if(!empty($programID))
            {
                $program = $this->program->getByID($programID);
                if(!empty($program) && in_array($browseType, array('all', 'unclosed', 'wait', 'doing', 'suspended', 'closed')))
                {
                    if($browseType == 'unclosed' && $program->status == 'closed')
                        unset($products[$index]);
                    elseif($browseType != 'unclosed' && $browseType != 'all' && $program->status != $browseType)
                        unset($products[$index]);
                }
            }
            else
            {
                /* The product without program only can be viewed when browse type is all and not closed. */
                if($browseType != 'all' and $browseType != 'unclosed') unset($products[$index]);
            }
        }
        return $products;
    }
}