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 [email protected].
 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 starts a workflow stage
 39:  * 
 40:  * @package application.components.x2flow.actions
 41:  */
 42: abstract class BaseX2FlowWorkflowStageAction extends X2FlowAction {
 43:     public $title;
 44:     public $info;
 45:     
 46:     public function paramRules() {
 47:         $workflows = Workflow::getList(false);  // no "none" options
 48:         $workflowIds = array_keys($workflows);
 49:         $stages = count($workflowIds)? Workflow::getStagesByNumber($workflowIds[0]) : array('---');
 50: 
 51:         return array_merge (parent::paramRules (), array (
 52:             'title'=>$this->title,
 53:             'modelClass'=>'modelClass',
 54:             'modelRequired' => 1,
 55:             'options' => array(
 56:                 array(
 57:                     'name'=>'workflowId',
 58:                     'label'=>'Process',
 59:                     'type'=>'dropdown',
 60:                     'options'=>$workflows
 61:                 ),
 62:                 array(
 63:                     'name'=>'stageNumber',
 64:                     'label'=>'Stage',
 65:                     'type'=>'dependentDropdown',
 66:                     'dependency' => 'workflowId',
 67:                     'options'=>$stages,
 68:                     'optionsSource' => Yii::app()->createUrl ('/workflow/workflow/getStageNames')
 69:                 ),
 70:             )
 71:         ));
 72:     }
 73: 
 74:     /**
 75:      * Validates type of model that triggered the flow
 76:      */
 77:     public function validate (&$params=array (), $flowId=null) {
 78:         if(!isset($params['model'])){
 79:             return array (
 80:                 false, 
 81:                 Yii::t('studio', "Workflow stage actions must have an associated model.")
 82:             );
 83:         }
 84:         $model = $params['model'];
 85:         $modelName = get_class ($model);
 86: 
 87:         // ensure that model can be associated with workflows
 88:         if (!$model instanceof X2Model) { 
 89:             return array (
 90:                 false, 
 91:                 Yii::t('studio', "Processes are not associated with records of this type")
 92:             );
 93:         } elseif (!$model->supportsWorkflow) {
 94:             return array (
 95:                 false, 
 96:                 Yii::t('studio', "{recordName} are not associated with processes", 
 97:                 array ('{recordName}' => ucfirst (X2Model::getRecordName ($modelName))))
 98:             );
 99:         }
100:         return parent::validate ($params, $flowId);
101:     }
102: 
103: }
104: