34 |
35 | As you can see, the status *step1* is associated with a Yii2 model that contains attributes the user must select, and a Yii2 view name that represent the form to display to the user.
36 |
37 | Defining the wokflow definition for this wizflow is easy : [check this out](https://github.com/raoul2000/yii2-wizflow/blob/master/example/models/Wizflow.php).
38 |
39 | Read more about [Workflow Definition](http://raoul2000.github.io/yii2-workflow/workflow-creation/).
40 |
41 | ### The Wizflow Manager
42 |
43 | Now last thing is a component able to navigate through this wizflow, based on user inputs and the current step (i.e. status). This component is the **WizflowManager**. The one provided with this extension is also responsible for path persistence, that is keep track of all successive steps the user has performed through the wizflow (a very basic session storage persistence is implemented).
44 |
45 | If you take a look to the *[WizflowManager](https://github.com/raoul2000/yii2-wizflow/blob/master/src/WizflowManager.php)* code, you will see that the **getNextStep** method is in charge of providing the next status the user will reach when the button *NEXT* is pushed. To define what is the next step, the *WizflowManager* invokes the `SimpleWorkflowBehavior.getNextStatuses(true,true)` method which includes model validation. If more than one next step (next status) is available, the first one is used: **it is the developper responsability to make sure that validation rules and transitions only allow one next step**.
46 |
47 | In the example included in the *yii-wizflow* extension the workflow above is configured. This workflow includes a branching between *step1* and the *blue* or *green* status. Depending on the user input, the validation rules must be exclusive in order to only select on possible destination :
48 |
49 | - if the user select "blue" as favorite color, the next step is "blue"
50 | - if the user select "green" as favorite color, the next step is "green"
51 |
52 | That's the way branching in handled : validation rules applied at a given step should be configured in order to select **only one destination** as the *next step*. Again, this is developer responsability to ensure this is done correctly.
53 |
54 | Read more about the [Workflow Driven Attribute validation](http://raoul2000.github.io/yii2-workflow/concept-validation/).
55 |
56 | # Install Examples
57 |
58 | The *yii2-wizflow* extension comes with a set of Yii2 models, controller and views dedicated to override the **basic Yii2 application template** and demonstrate yii-wizflow in action.
59 |
60 | Here is a summary of commands to run to install the example Wizflow application. You'll find a detailed description below.
61 |
62 | ```
63 | composer global require "fxp/composer-asset-plugin:~1.1.1"
64 | composer create-project yiisoft/yii2-app-basic wizflow 2.0.9
65 | cd wizflow
66 | composer require raoul2000/yii2-wizflow:@dev
67 | cp vendor/raoul2000/yii2-wizflow/example/* .
68 | ```
69 |
70 | To install this demo app you must :
71 |
72 | - create a new yii2 application based on the **basic** template. To do so, follow [Yii2 installation guide](http://www.yiiframework.com/download/)
73 | - install the *yii2-wizflow* extension
74 | - override all folders at the root of your yii2 app with the ones provided in `vendor/raoul2000/yii2-wizflow/example`
75 |
76 | If you already have a running Yii2 application based on the *basic* template, here are the steps you can perform manually:
77 |
78 | - declare the **WizflowManager** component in `APP_FOLDER/conf/web.php`. This component implements all the logic between the workflow definition and model/view. It also handle the persistence layer by saving user entries into the current session.
79 |
80 | ```php
81 | 'components' => [
82 | 'wizflowManager' => [
83 | 'class' => '\raoul2000\wizflow\wizflowManager'
84 | ],
85 | // etc ...
86 | ```
87 |
88 | - declare the **workflowSource** component in `APP_FOLDER/conf/web.php`. This is the standard yii2-wizflow source component.
89 |
90 | ```php
91 | 'components' => [
92 | 'workflowSource' => [
93 | // use default settings : workflow definition is stored in an object and can be
94 | // retrieved with the getDefinition() method
95 | 'class' => '\raoul2000\workflow\source\file\WorkflowFileSource'
96 | ],
97 | // etc ...
98 | ```
99 | - add a new action in `APP_FOLDER/controllers/SiteController.php`. This action is used during wizard navigation.
100 |
101 | ```php
102 | public function actions()
103 | {
104 | return [
105 | // other actions ...
106 | 'wizflow' => [
107 | 'class' => '\raoul2000\wizflow\WizardPlayAction'
108 | ],
109 | ];
110 | }
111 | ```
112 | - add the *finish* action in `APP_FOLDER/controllers/SiteController.php`. This action is invoked at the end of the wizard, to display a summary of choices made by the user.
113 |
114 | ```php
115 | public function actionFinish()
116 | {
117 | return $this->render('finish',[
118 | 'path' => Yii::$app->wizflowManager->getPath()
119 | ]);
120 | }
121 | ```
122 |
123 | - navigate to [http://hostname/index.php?r=site/wizflow](http://host/index.php?r=site/wizflow)
124 | - enjoy
125 |
--------------------------------------------------------------------------------
/composer.json:
--------------------------------------------------------------------------------
1 | {
2 | "name" : "raoul2000/yii2-wizflow",
3 | "description" : "The wizard UI pattern implemented using yii2-workfl",
4 | "keywords": ["yii2","extension","workflow"," wizard"],
5 | "homepage" : "http://raoul2000.github.io/yii2-wizflow/guide-README.html",
6 | "type" : "yii2-extension",
7 | "license" : "BSD-3-Clause",
8 | "support" : {
9 | "issues" : "https://github.com/raoul2000/yii2-wizflow/issues",
10 | "source" : "https://github.com/raoul2000/yii2-wizflow",
11 | "email" : "raoul.boulard@gmail.com"
12 | },
13 | "minimum-stability" : "stable",
14 | "require" : {
15 | "php" : ">=5.4.0",
16 | "yiisoft/yii2" : "*",
17 | "raoul2000/yii2-workflow" : "*"
18 | },
19 | "config" : {
20 | "process-timeout" : 1800
21 | },
22 | "autoload" : {
23 | "psr-4" : {
24 | "raoul2000\\wizflow\\" : "src/"
25 | }
26 | },
27 | "authors" : [{
28 | "name" : "Raoul",
29 | "email" : "raoul.boulard@gmail.com",
30 | "homepage" : "https://github.com/raoul2000/yii2-wizflow"
31 | }
32 | ]
33 | }
34 |
--------------------------------------------------------------------------------
/example/config/web.php:
--------------------------------------------------------------------------------
1 | 'basic',
7 | 'basePath' => dirname(__DIR__),
8 | 'bootstrap' => ['log'],
9 | 'components' => [
10 | 'workflowSource' => [
11 | 'class' => 'raoul2000\workflow\source\file\WorkflowFileSource'
12 | ],
13 | 'wizflowManager' => [
14 | 'class' => '\raoul2000\wizflow\WizflowManager',
15 | 'workflowSourceName' => 'workflowSource'
16 | ],
17 | 'request' => [
18 | // !!! insert a secret key in the following (if it is empty) - this is required by cookie validation
19 | 'cookieValidationKey' => '3GufHzdPMW2Fv8ZnM7Eq6X3iTLvvB5v0',
20 | ],
21 | 'cache' => [
22 | 'class' => 'yii\caching\FileCache',
23 | ],
24 | 'user' => [
25 | 'identityClass' => 'app\models\User',
26 | 'enableAutoLogin' => true,
27 | ],
28 | 'errorHandler' => [
29 | 'errorAction' => 'site/error',
30 | ],
31 | 'log' => [
32 | 'traceLevel' => YII_DEBUG ? 3 : 0,
33 | 'targets' => [
34 | [
35 | 'class' => 'yii\log\FileTarget',
36 | 'levels' => ['error', 'warning'],
37 | ],
38 | ],
39 | ],
40 | ]
41 | ];
42 |
43 | if (YII_ENV_DEV) {
44 | // configuration adjustments for 'dev' environment
45 | $config['bootstrap'][] = 'debug';
46 | $config['modules']['debug'] = [
47 | 'class' => 'yii\debug\Module',
48 | ];
49 |
50 | $config['bootstrap'][] = 'gii';
51 | $config['modules']['gii'] = [
52 | 'class' => 'yii\gii\Module',
53 | ];
54 | }
55 |
56 | return $config;
57 |
--------------------------------------------------------------------------------
/example/controllers/SiteController.php:
--------------------------------------------------------------------------------
1 | [
14 | 'class' => 'yii\web\ErrorAction',
15 | ],
16 | 'wizflow' => [
17 | 'class' => '\raoul2000\wizflow\WizardPlayAction'
18 | ]
19 | ];
20 | }
21 |
22 | public function actionFinish()
23 | {
24 | return $this->render('finish',[
25 | 'path' => Yii::$app->wizflowManager->getPath()
26 | ]);
27 | }
28 |
29 | public function actionIndex()
30 | {
31 | return $this->render('index');
32 | }
33 | }
34 |
--------------------------------------------------------------------------------
/example/models/BlueForm.php:
--------------------------------------------------------------------------------
1 | blueStuff);
30 | }
31 | /**
32 | * @return array customized attribute labels
33 | */
34 | public function attributeLabels()
35 | {
36 | return [
37 | 'greenStuff' => 'name somthing blue',
38 | ];
39 | }
40 |
41 | }
42 |
--------------------------------------------------------------------------------
/example/models/FinalForm.php:
--------------------------------------------------------------------------------
1 | rate;
29 | }
30 | /**
31 | * @return array customized attribute labels
32 | */
33 | public function attributeLabels()
34 | {
35 | return [
36 | 'rate' => 'Did you like your wizflow experience ?',
37 | ];
38 | }
39 |
40 | }
41 |
--------------------------------------------------------------------------------
/example/models/GreenForm.php:
--------------------------------------------------------------------------------
1 | greenStuff);
30 | }
31 | /**
32 | * @return array customized attribute labels
33 | */
34 | public function attributeLabels()
35 | {
36 | return [
37 | 'greenStuff' => 'name somthing green',
38 | ];
39 | }
40 | }
41 |
--------------------------------------------------------------------------------
/example/models/Step1Form.php:
--------------------------------------------------------------------------------
1 | 'blue', 'operator' => '==',
27 | 'on' => WorkflowScenario::enterStatus('Wizflow/blue')],
28 |
29 | [['favoriteColor'], 'compare', 'compareValue' => 'green', 'operator' => '==',
30 | 'on' => WorkflowScenario::enterStatus('Wizflow/green')],
31 | ];
32 | }
33 | public function summary()
34 | {
35 | return 'your favorite color is '.$this->favoriteColor;
36 | }
37 |
38 | /**
39 | * @return array customized attribute labels
40 | */
41 | public function attributeLabels()
42 | {
43 | return [
44 | 'favoriteColor' => 'your favorite color',
45 | ];
46 | }
47 | }
48 |
--------------------------------------------------------------------------------
/example/models/WelcomeForm.php:
--------------------------------------------------------------------------------
1 | '. Html::encode($this->name) . '';
32 | }
33 | }
34 |
--------------------------------------------------------------------------------
/example/models/Wizflow.php:
--------------------------------------------------------------------------------
1 | 'welcome',
17 | 'status' => [
18 | 'welcome' => [
19 | 'transition' => ['step1'],
20 | 'metadata' => [
21 | 'model' => [
22 | 'class' => '\app\models\WelcomeForm'
23 | ],
24 | 'view' =>'step-welcome'
25 | ]
26 | ],
27 | 'step1' => [
28 | 'transition' => ['blue','green'],
29 | 'metadata' => [
30 | 'model' => [
31 | 'class' => '\app\models\Step1Form'
32 | ],
33 | 'view' =>'step-1'
34 | ]
35 | ],
36 | 'blue' => [
37 | 'transition' => ['final'],
38 | 'metadata' => [
39 | 'model' => [
40 | 'class' => '\app\models\BlueForm'
41 | ],
42 | 'view' =>'step-blue'
43 | ]
44 | ],
45 | 'green' => [
46 | 'transition' => ['final'],
47 | 'metadata' => [
48 | 'model' => [
49 | 'class' => '\app\models\GreenForm'
50 | ],
51 | 'view' =>'step-green'
52 | ]
53 | ],
54 | 'final' => [
55 | 'transition' => [],
56 | 'metadata' => [
57 | 'model' => [
58 | 'class' => '\app\models\FinalForm'
59 | ],
60 | 'view' =>'step-final'
61 | ]
62 | ]
63 | ]
64 | ];
65 | }
66 | }
67 |
--------------------------------------------------------------------------------
/example/views/layouts/main.php:
--------------------------------------------------------------------------------
1 |
14 | beginPage() ?>
15 |
16 |
17 |
18 |
19 |
20 |
21 |
28 | 'Wizflow Demo App',
31 | 'brandUrl' => Yii::$app->homeUrl,
32 | 'options' => [
33 | 'class' => 'navbar-inverse navbar-fixed-top',
34 | ],
35 | ]);
36 | echo Nav::widget([
37 | 'options' => ['class' => 'navbar-nav navbar-right']
38 | ]);
39 | NavBar::end();
40 | ?>
41 |
42 |
49 |
50 |
57 |
58 | endBody() ?>
59 |
60 |
61 | endPage() ?>
62 |
--------------------------------------------------------------------------------
/example/views/site/finish.php:
--------------------------------------------------------------------------------
1 |
8 |
43 | isset($this->params['breadcrumbs']) ? $this->params['breadcrumbs'] : [],
45 | ]) ?>
46 |
47 |
48 | We are done : Thanks !
9 |
10 |
23 |
--------------------------------------------------------------------------------
/example/views/site/index.php:
--------------------------------------------------------------------------------
1 | title = 'My Yii Application';
6 | ?>
7 |
11 |
13 |
22 | Let's summarize your replies :
12 |13 |
14 | summary().'
'; 17 | } 18 | ?> 19 |
20 | '; 17 | } 18 | ?> 19 |
'start']) ?>
21 |
8 |
9 |
17 |
--------------------------------------------------------------------------------
/example/views/site/step-1.php:
--------------------------------------------------------------------------------
1 |
10 |
10 |
16 | Congratulations!
11 | 12 |You have successfully created your Wizflow powered application.
13 | 14 | 15 |
11 |
12 |
47 |
--------------------------------------------------------------------------------
/example/views/site/step-blue.php:
--------------------------------------------------------------------------------
1 |
10 |
13 |
45 |
46 |
14 |
16 | summary().'
'; 19 | } 20 | ?> 21 |
22 | Summary
15 |16 | summary().'
'; 19 | } 20 | ?> 21 |
23 |
44 |
24 | To know more about you, I would like you tell me what is your favorite color.
25 |
26 |
27 | ['','nav'=>'next'],
29 | ]); ?>
30 |
31 | field($model, 'favoriteColor')->radioList([
32 | 'green'=> 'I like green',
33 | 'blue'=> 'I prefer blue'
34 | ]) ?>
35 |
36 |
37 |
38 | Prev',['','nav'=> 'prev'],['class'=> 'btn btn-primary', 'role'=> 'button'])?> 39 | ', ['class' => 'btn btn-primary']) ?> 40 |
41 |
42 |
43 | 38 | Prev',['','nav'=> 'prev'],['class'=> 'btn btn-primary', 'role'=> 'button'])?> 39 | ', ['class' => 'btn btn-primary']) ?> 40 |
11 |
12 |
43 |
--------------------------------------------------------------------------------
/example/views/site/step-final.php:
--------------------------------------------------------------------------------
1 |
10 |
13 |
41 |
42 |
14 |
16 | summary().'
'; 19 | } 20 | ?> 21 |
22 | Summary
15 |16 | summary().'
'; 19 | } 20 | ?> 21 |
23 |
40 |
24 | Yes, blue is a nice color. Can you name the most beautiful thing you have ever seen with a blue color in it ?
25 |
26 |
27 | ['','nav'=>'next']
29 | ]); ?>
30 |
31 | field($model, 'blueStuff') ?>
32 |
33 |
34 |
35 | Prev',['','nav'=> 'prev'],['class'=> 'btn btn-primary', 'role'=> 'button'])?> 36 | ', ['class' => 'btn btn-primary']) ?> 37 |
38 |
39 | 35 | Prev',['','nav'=> 'prev'],['class'=> 'btn btn-primary', 'role'=> 'button'])?> 36 | ', ['class' => 'btn btn-primary']) ?> 37 |
11 |
12 |
47 |
--------------------------------------------------------------------------------
/example/views/site/step-green.php:
--------------------------------------------------------------------------------
1 |
10 |
13 |
44 |
45 |
46 |
14 |
16 | summary().'
'; 19 | } 20 | ?> 21 |
22 | Summary
15 |16 | summary().'
'; 19 | } 20 | ?> 21 |
23 |
43 |
24 | That's intresting and we reached the end of the wizards steps. How did you like our little talk together ?
25 |
26 |
27 | ['', 'nav' => 'finish']
29 | ]); ?>
30 |
31 | field($model, 'rate')->radioList([
32 | 'cool' => 'Yes that was cool',
33 | 'supercool' => 'It was super cool man !',
34 | ]) ?>
35 |
36 |
37 |
38 | Prev',['','nav'=> 'prev'],['class'=> 'btn btn-primary', 'role'=> 'button'])?> 39 | 'btn btn-primary']) ?> 40 |
41 |
42 | 38 | Prev',['','nav'=> 'prev'],['class'=> 'btn btn-primary', 'role'=> 'button'])?> 39 | 'btn btn-primary']) ?> 40 |
11 |
12 |
44 |
--------------------------------------------------------------------------------
/example/views/site/step-welcome.php:
--------------------------------------------------------------------------------
1 |
10 |
13 |
41 |
42 |
43 |
14 |
16 | summary().'
'; 19 | } 20 | ?> 21 |
22 | Summary
15 |16 | summary().'
'; 19 | } 20 | ?> 21 |
23 |
40 |
24 | All right, green then. Do you have something green in mind ?
25 |
26 |
27 | ['','nav'=>'next']
29 | ]); ?>
30 |
31 | field($model, 'greenStuff') ?>
32 |
33 |
34 |
35 | Prev',['','nav'=> 'prev'],['class'=> 'btn btn-primary', 'role'=> 'button'])?> 36 | ', ['class' => 'btn btn-primary']) ?> 37 |
38 |
39 | 35 | Prev',['','nav'=> 'prev'],['class'=> 'btn btn-primary', 'role'=> 'button'])?> 36 | ', ['class' => 'btn btn-primary']) ?> 37 |
11 |
12 |
38 |
--------------------------------------------------------------------------------
/src/WizardPlayAction.php:
--------------------------------------------------------------------------------
1 | get($this->wizardManagerName);
15 |
16 | if( $nav == 'prev' ) {
17 | $model = $wizard->getPreviousStep();
18 | if( $model == null) {
19 | $this->controller->redirect(array_merge($this->url, ['nav'=>'start']));
20 | }
21 | } elseif($nav == 'start') {
22 | $model = $wizard->start();
23 | } else {
24 |
25 | $model = $wizard->getCurrentStep();
26 | if( $model == null) {
27 | $this->controller->redirect($this->urlFinish);
28 | } else {
29 |
30 | if( $model->load(Yii::$app->request->post()) && $model->validate()) {
31 | // current step has been completed : save it and get next step
32 | $wizard->updateCurrentStep($model);
33 | $model = $wizard->getNextStep();
34 | if( $model == null) {
35 | //we reached the last step : save it and go tp the finish page
36 | $wizard->save();
37 | $this->controller->redirect($this->urlFinish);
38 | }
39 | }
40 | }
41 | }
42 | if ($model != null ) {
43 | $viewname = $model->getWorkflowStatus()->getMetadata('view');
44 | $wizard->save();
45 | return $this->controller->render($viewname,[
46 | 'model' => $model,
47 | 'path' => $wizard->getPath()
48 | ]);
49 | }
50 | }
51 | }
52 |
--------------------------------------------------------------------------------
/src/WizflowManager.php:
--------------------------------------------------------------------------------
1 | '\raoul2000\workflow\base\SimpleWorkflowBehavior',
19 | 'defaultWorkflowId' => 'Wizflow'
20 | ];
21 | /**
22 | * @var string name of the workflow behavior that is attached to all wizards steps
23 | */
24 | public $workflowBehaviorName = 'wizflowBehavior';
25 | /**
26 | * @var string Name of the workflow source component to use
27 | */
28 | public $workflowSourceName = 'workflowSource';
29 | /**
30 | * @var IWorkflowSource the workflow source instance
31 | */
32 | private $_ws;
33 | /**
34 | * @var string session key name used to store steps
35 | */
36 | public $skeyName = '_wiz';
37 | /**
38 | * This array stores the wizards state :
39 | * - the current step (key = 'current')
40 | * - a list of all steps that have been performed so far (key = 'path')
41 | *
42 | * Example :
43 | *
13 |
36 |
37 |
14 |
16 |
17 | Summary
15 |16 |
18 |
35 |
19 | Let's start by introducing each other. I am wizflow, a mix between a wizard and a workflow. What about you ?
20 |
21 | ['','nav'=>'next']
23 | ]); ?>
24 |
25 | field($model, 'name') ?>
26 | field($model, 'email') ?>
27 |
28 |
29 |
30 | ', ['class' => 'btn btn-primary']) ?> 31 |
32 |
33 |
34 | 30 | ', ['class' => 'btn btn-primary']) ?> 31 |
44 | * [ 45 | * 'current' => [ 46 | * 'attrib1' => 'value1', 47 | * //... 48 | * 'status' => 'Wizflow/step', 49 | * ], 50 | * 'path' => [ 51 | * 'Wizflow/step' => [ 52 | * 'attrib1' => 'value1', 53 | * //... 54 | * 'status' => 'Wizflow/step', 55 | * ], 56 | * //etc ... 57 | * ] 58 | * ] 59 | *60 | */ 61 | private $_wiz = [ 62 | 'current' => null, 63 | 'path' => [] 64 | ]; 65 | /** 66 | * Loads existing wizard data if available. 67 | * 68 | * @see \yii\base\Object::init() 69 | */ 70 | public function init() 71 | { 72 | if( empty($this->skeyName) || ! is_string($this->skeyName)) { 73 | throw new InvalidConfigException('Parameter "skeyName" must be a non-empty string'); 74 | } 75 | 76 | if( empty($this->workflowSourceName) || ! is_string($this->workflowSourceName)) { 77 | throw new InvalidConfigException('Parameter "workflowSourceName" must be a non-empty string'); 78 | } 79 | 80 | $this->_ws = Yii::$app->get($this->getWorkflowSourceName()); 81 | 82 | $wiz = Yii::$app->session->get($this->skeyName,null); 83 | if($wiz !== null) { 84 | $this->_wiz = $wiz; 85 | } 86 | } 87 | /** 88 | * Returns the name workflow source component to use. 89 | * Note that the component must be available and registred in the Yii::$app container. 90 | * 91 | * @return string The name of the workflow source component 92 | */ 93 | public function getWorkflowSourceName() 94 | { 95 | return $this->workflowSourceName; 96 | } 97 | 98 | /** 99 | * Returns the workflow source component used by the manager 100 | * @return IWorkflowSource the workflow source component instance 101 | */ 102 | public function getWorkflowSource() 103 | { 104 | return $this->_ws; 105 | } 106 | /** 107 | * Creates and returns the form model instance for the status attribute. 108 | * Note that the attribute array passed as argument must include the status value. 109 | * 110 | * The instance is created using the 'model' metadata value associated with the 'status' 111 | * attribute value. The metadata 'model' must be an array suitable to invoke Yii::createObject(). 112 | * 113 | * Once created, the SimpleWorkflowBehavior is attached to the model. 114 | * 115 | * @param array $attributes list of attributes 116 | * @throws Exception 117 | * @return Model 118 | */ 119 | private function createInstance($attributes) 120 | { 121 | if( isset($attributes['status']) == false ) { 122 | throw new Exception('missing attribute "status"'); 123 | } 124 | 125 | $status = $this->workflowSource->getStatus($attributes['status']); 126 | $config = array_merge( 127 | $status->getMetadata('model'), 128 | $attributes 129 | ); 130 | $instance = Yii::createObject($config); 131 | $instance->attachBehavior( 132 | $this->workflowBehaviorName, 133 | $this->workflowBehavior 134 | ); 135 | 136 | return $instance; 137 | } 138 | /** 139 | * Save the wizard data into the current session 140 | */ 141 | public function save() 142 | { 143 | Yii::$app->session->set($this->skeyName,$this->_wiz); 144 | } 145 | /** 146 | * @return boolean TRUE if the wizard process as started (i.e. a current step is available) 147 | * FALSE otherwise. 148 | */ 149 | public function hasCurrentStep() 150 | { 151 | return $this->_wiz['current'] != null; 152 | } 153 | /** 154 | * Updates the current step with the model passed as argument. 155 | * 156 | * @param Model $model 157 | * @throws Exception 158 | */ 159 | public function updateCurrentStep($model) 160 | { 161 | if( $this->hasCurrentStep() == false ) { 162 | throw new Exception('wizard has no current step'); 163 | } 164 | $this->_wiz['current'] = $model->getAttributes(); 165 | } 166 | /** 167 | * Returns the model associated with the current wizard step. 168 | * 169 | * @return Model|null the current stemp model instance or NULL if no current step is defined. 170 | */ 171 | public function getCurrentStep() 172 | { 173 | $currentStep = null; 174 | if( $this->hasCurrentStep() ) { 175 | $currentStep = $this->createInstance($this->_wiz['current']); 176 | } 177 | return $currentStep; 178 | } 179 | 180 | /** 181 | * Returns an array containing all steps models that have been done until now. 182 | * The current step is not included in the returned array. 183 | * 184 | * @return array list of steps that have been performed until now 185 | */ 186 | public function getPath() 187 | { 188 | $path = []; 189 | foreach ($this->_wiz['path'] as $stepConfig) { 190 | $stepModel = $this->createInstance($stepConfig); 191 | $path[] = $stepModel; 192 | } 193 | return $path; 194 | } 195 | /** 196 | * Add the current step to the path and creates the next step form which becomes the new current step. 197 | * 198 | * @return Model the new current step 199 | */ 200 | public function getNextStep() 201 | { 202 | $nextStep = null; 203 | if ( $this->hasCurrentStep()) { 204 | // add current step to the path 205 | 206 | $currentStep = $this->getCurrentStep(); 207 | $this->_wiz['path'][$currentStep->getWorkflowStatus()->getId()] = $this->_wiz['current']; 208 | $this->_wiz['current'] = null; 209 | 210 | // find the next step 211 | 212 | $nextStatuses = $currentStep->getNextStatuses(true, true); 213 | $nextStep = null; 214 | if( count($nextStatuses) != 0) { 215 | foreach($nextStatuses as $info) { 216 | if( $info['isValid']) { 217 | // create the next step Form instance 218 | $nextStep = $this->createInstance(['status' => $info['status']->getId()]); 219 | 220 | // save it as the current step 221 | $this->_wiz['current'] = $nextStep->getAttributes(); 222 | 223 | break; 224 | } 225 | } 226 | } 227 | } 228 | return $nextStep; 229 | } 230 | /** 231 | * Replace the current step, with the last step of the path and returns it. 232 | * 233 | * @return Model the new current step 234 | */ 235 | public function getPreviousStep() 236 | { 237 | $prevStep = null; 238 | if( count($this->_wiz['path']) != 0) { 239 | 240 | $config = array_pop($this->_wiz['path']); 241 | 242 | // replace current step 243 | $this->_wiz['current'] = $config; 244 | 245 | // create instance 246 | $prevStep = $this->createInstance($config); 247 | } 248 | return $prevStep; 249 | } 250 | /** 251 | * Initiate the wizard. 252 | * This method reset the existing wizard path and returns the model for the first step. 253 | * 254 | * @return Model the model for the first step 255 | */ 256 | public function start() 257 | { 258 | $workflow = $this->workflowSource->getWorkflow($this->workflowBehavior['defaultWorkflowId']); 259 | 260 | $status = $workflow->getInitialStatus(); 261 | $config = $status->getMetadata('model'); 262 | $config['status'] = $status->getId(); 263 | 264 | $firstStep = $this->createInstance($config); 265 | 266 | $this->_wiz['current'] = $firstStep->getAttributes(); 267 | $this->_wiz['path'] = []; 268 | 269 | return $firstStep; 270 | } 271 | /** 272 | * Clean up session data that may have been stored by this wizard. 273 | */ 274 | public function destroy() 275 | { 276 | Yii::$app->session->remove($this->skeyName); 277 | } 278 | } 279 | -------------------------------------------------------------------------------- /src/WizflowModelInterface.php: -------------------------------------------------------------------------------- 1 | 2 |