-
Notifications
You must be signed in to change notification settings - Fork 117
/
FormFlowInterface.php
176 lines (143 loc) · 3.71 KB
/
FormFlowInterface.php
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
<?php
namespace Craue\FormFlowBundle\Form;
use Craue\FormFlowBundle\Exception\InvalidTypeException;
use Craue\FormFlowBundle\Storage\StorageInterface;
use Symfony\Component\EventDispatcher\EventDispatcherInterface;
use Symfony\Component\Form\FormFactoryInterface;
use Symfony\Component\Form\FormInterface;
use Symfony\Component\HttpFoundation\Request;
/**
* @author Christian Raue <christian.raue@gmail.com>
* @copyright 2011-2014 Christian Raue
* @license http://opensource.org/licenses/mit-license.php MIT License
*/
interface FormFlowInterface {
/**
* @return string
*/
function getName();
/**
* @param FormFactoryInterface $formFactory
*/
function setFormFactory(FormFactoryInterface $formFactory);
/**
* @param Request|null $request
*/
function setRequest(Request $request = null);
/**
* @param StorageInterface $storage
*/
function setStorage(StorageInterface $storage);
/**
* @return StorageInterface
*/
function getStorage();
/**
* @param EventDispatcherInterface $eventDispatcher
*/
function setEventDispatcher(EventDispatcherInterface $eventDispatcher);
/**
* @return boolean
*/
function isRevalidatePreviousSteps();
/**
* @return boolean
*/
function isAllowDynamicStepNavigation();
/**
* @return boolean If file uploads should be handled by serializing them into the storage.
*/
function isHandleFileUploads();
/**
* @return string|null Directory for storing temporary files while handling uploads. If {@code null}, the system's default will be used.
*/
function getHandleFileUploadsTempDir();
/**
* @return boolean
*/
function isAllowRedirectAfterSubmit();
/**
* @return string
*/
function getId();
/**
* Restores previously saved form data of all steps and determines the current step.
* @param mixed $formData
*/
function bind($formData);
/**
* @return mixed
*/
function getFormData();
/**
* Creates the form for the current step.
* @return FormInterface
*/
function createForm();
/**
* @param integer $stepNumber
* @return boolean
*/
function isStepDone($stepNumber);
/**
* @param integer $stepNumber
* @return boolean
*/
function isStepSkipped($stepNumber);
/**
* @param FormInterface $form
* @return boolean Whether the form is valid.
*/
function isValid(FormInterface $form);
/**
* Saves the form data of the current step.
* @param FormInterface $form
*/
function saveCurrentStepData(FormInterface $form);
/**
* Proceeds to the next step.
* @return boolean Whether the next step can be prepared. If not, the flow is finished.
*/
function nextStep();
/**
* Resets the flow and clears its underlying storage.
*/
function reset();
/**
* @return integer First visible step, which may be greater than 1 if steps are skipped.
*/
function getFirstStepNumber();
/**
* @return integer Last visible step, which may be less than {@code getStepCount()} if steps are skipped.
*/
function getLastStepNumber();
/**
* @return integer
* @throws \RuntimeException If the current step is not yet known.
*/
function getCurrentStepNumber();
/**
* @return string|null The label for the current step.
*/
function getCurrentStepLabel();
/**
* Get labels for all steps used to render the step list.
* @return string[]|null[] Value with index 0 is the label for step 1.
*/
function getStepLabels();
/**
* @param integer $stepNumber
* @return StepInterface
* @throws InvalidTypeException If {@code $stepNumber} is not an integer.
* @throws \OutOfBoundsException If step {@code $stepNumber} doesn't exist.
*/
function getStep($stepNumber);
/**
* @return StepInterface[] Value with index 0 is step 1.
*/
function getSteps();
/**
* @return integer
*/
function getStepCount();
}