1: <?php
 2: /*****************************************************************************************
 3:  * X2Engine Open Source Edition is a customer relationship management program developed by
 4:  * X2Engine, Inc. Copyright (C) 2011-2016 X2Engine Inc.
 5:  * 
 6:  * This program is free software; you can redistribute it and/or modify it under
 7:  * the terms of the GNU Affero General Public License version 3 as published by the
 8:  * Free Software Foundation with the addition of the following permission added
 9:  * to Section 15 as permitted in Section 7(a): FOR ANY PART OF THE COVERED WORK
10:  * IN WHICH THE COPYRIGHT IS OWNED BY X2ENGINE, X2ENGINE DISCLAIMS THE WARRANTY
11:  * OF NON INFRINGEMENT OF THIRD PARTY RIGHTS.
12:  * 
13:  * This program is distributed in the hope that it will be useful, but WITHOUT
14:  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
15:  * FOR A PARTICULAR PURPOSE.  See the GNU Affero General Public License for more
16:  * details.
17:  * 
18:  * You should have received a copy of the GNU Affero General Public License along with
19:  * this program; if not, see http://www.gnu.org/licenses or write to the Free
20:  * Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
21:  * 02110-1301 USA.
22:  * 
23:  * You can contact X2Engine, Inc. P.O. Box 66752, Scotts Valley,
24:  * California 95067, USA. or at email address contact@x2engine.com.
25:  * 
26:  * The interactive user interfaces in modified source and object code versions
27:  * of this program must display Appropriate Legal Notices, as required under
28:  * Section 5 of the GNU Affero General Public License version 3.
29:  * 
30:  * In accordance with Section 7(b) of the GNU Affero General Public License version 3,
31:  * these Appropriate Legal Notices must retain the display of the "Powered by
32:  * X2Engine" logo. If the display of the logo is not reasonably feasible for
33:  * technical reasons, the Appropriate Legal Notices must display the words
34:  * "Powered by X2Engine".
35:  *****************************************************************************************/
36: 
37: /**
38:  * X2FlowAction that completes a workflow stage
39:  * 
40:  * @package application.components.x2flow.actions
41:  */
42: class X2FlowWorkflowCompleteStage extends BaseX2FlowWorkflowStageAction {
43:     public $title = 'Complete Process Stage';
44:     public $info = '';
45:     
46:     public function paramRules() {
47:         $paramRules = parent::paramRules ();
48:         $paramRules['options'][] = array(
49:             'name'=>'stageComment',
50:             'label'=>Yii::t('studio','Stage Comment'),
51:             'optional'=>1,
52:             'type'=>'richtext'
53:         );
54:         return $paramRules;
55:     }
56: 
57:     public function execute(&$params) {
58:         $workflowId = $this->parseOption ('workflowId', $params);
59:         $stageNumber = $this->parseOption ('stageNumber', $params);
60:         $stageComment = $this->parseOption ('stageComment', $params);
61: 
62:         $model = $params['model'];
63:         $type = lcfirst (X2Model::getModuleName (get_class ($model)));
64:         $modelId = $model->id;
65: 
66:         $workflowStatus = Workflow::getWorkflowStatus($workflowId,$modelId,$type);
67:         $message = '';
68: 
69:         if (Workflow::validateAction (
70:             'complete', $workflowStatus, $stageNumber, $stageComment, $message)) {
71: 
72:             list ($started, $workflowStatus) = 
73:                 Workflow::completeStage (
74:                     $workflowId, $stageNumber, $model, $stageComment, false, $workflowStatus);
75:             assert ($started);
76:             return array (true, Yii::t('studio', 'Stage "{stageName}" completed for {recordName}', 
77:                 array (
78:                     '{stageName}' => $workflowStatus['stages'][$stageNumber]['name'],
79:                     '{recordName}' => $model->getLink (),
80:                 )
81:             ));
82:         } else {
83:             return array (false, $message);
84:         }
85:         
86:     }
87: }
88: