Account Suspended
Account Suspended
This Account has been suspended.
Contact your hosting provider for more information.
 All Data Structures Functions Variables Pages
SequentialProcess.php
1 <?php
2  /*********************************************************************************
3  * Zurmo is a customer relationship management program developed by
4  * Zurmo, Inc. Copyright (C) 2017 Zurmo Inc.
5  *
6  * Zurmo 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 ZURMO, ZURMO DISCLAIMS THE WARRANTY
11  * OF NON INFRINGEMENT OF THIRD PARTY RIGHTS.
12  *
13  * Zurmo 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 Zurmo, Inc. with a mailing address at 27 North Wacker Drive
24  * Suite 370 Chicago, IL 60606. or at email address contact@zurmo.com.
25  *
26  * The interactive user interfaces in original and modified 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 Zurmo
32  * logo and Zurmo copyright notice. If the display of the logo is not reasonably
33  * feasible for technical reasons, the Appropriate Legal Notices must display the words
34  * "Copyright Zurmo Inc. 2017. All rights reserved".
35  ********************************************************************************/
36 
42  abstract class SequentialProcess extends CComponent
43  {
48  abstract public function getAllStepsMessage();
49 
53  abstract protected function steps();
54 
59  abstract protected function stepMessages();
60 
64  protected $complete = false;
65 
70  protected $nextStep;
71 
76  protected $nextParams;
77 
82  protected $nextMessage;
83 
88  protected $completionPercentage;
89 
95  protected $subSequenceCompletionPercentage = 0;
96 
97  public function __construct()
98  {
99  assert('count($this->steps()) > 0');
100  assert('count($this->stepMessages()) > 0');
101  $stepMessagesCount = count($this->stepMessages());
102  $stepsCount = count($this->steps());
103  assert('$stepMessagesCount == $stepsCount');
104  }
105 
111  public function run($step, $params)
112  {
113  assert('$step == null || is_string($step)');
114  assert('$params == null || is_array($params)');
115  if ($step == null)
116  {
117  $steps = $this->steps();
118  $this->nextStep = array_shift($steps);
119  $this->setNextMessageByStep($this->nextStep);
120  return;
121  }
122  $this->nextParams = $this->{$step}($params);
123  $this->resolveNextInformationByCurrentStep($step);
124  }
125 
126  protected function resolveNextInformationByCurrentStep($step)
127  {
128  assert('is_string($step)');
129  $steps = $this->steps();
130  $currentKey = array_search($step, $steps);
131  $nextKey = $currentKey + 1;
132  if (count($steps) == 1)
133  {
134  $this->completionPercentage = $this->subSequenceCompletionPercentage;
135  }
136  else
137  {
138  $extraPercentage = ($this->subSequenceCompletionPercentage / 100) * (100 / count($steps));
139  $this->completionPercentage = ((($currentKey + 1) / count($steps)) * 100) + $extraPercentage;
140  }
141  }
142 
143  protected function setNextMessageByStep($step)
144  {
145  assert('is_string($step)');
146  $stepMessages = $this->stepMessages();
147  $this->nextMessage = $stepMessages[$step];
148  }
149 
150  public function isComplete()
151  {
152  return $this->complete;
153  }
154 
155  public function getNextStep()
156  {
157  return $this->nextStep;
158  }
159 
160  public function getNextParams()
161  {
162  return $this->nextParams;
163  }
164 
165  public function getNextMessage()
166  {
167  return $this->nextMessage;
168  }
169 
170  public function getCompletionPercentage()
171  {
172  return $this->completionPercentage;
173  }
174 
175  public function getViewClassNameByStep($step)
176  {
177  return 'SequentialProcessView';
178  }
179  }
180 ?>
run($step, $params)
Generated on Fri Sep 25 2020 07:10:26
Account Suspended
Account Suspended
This Account has been suspended.
Contact your hosting provider for more information.