@@ -83,14 +83,14 @@ helper methods that cover the most common interactions performed by console comm
83
83
Titling Methods
84
84
~~~~~~~~~~~~~~~
85
85
86
- :method: `Symfony\\ Component\\ Console\\ Style\\ StyleInterface ::title `
86
+ :method: `Symfony\\ Component\\ Console\\ Style\\ SymfonyStyle ::title `
87
87
It displays the given string as the command title. This method is meant to
88
88
be used only once in a given command, but nothing prevents you to use it
89
89
repeatedly::
90
90
91
91
$io->title('Lorem ipsum dolor sit amet');
92
92
93
- :method: `Symfony\\ Component\\ Console\\ Style\\ StyleInterface ::section `
93
+ :method: `Symfony\\ Component\\ Console\\ Style\\ SymfonyStyle ::section `
94
94
It displays the given string as the title of some command section. This is
95
95
only needed in complex commands which want to better separate their contents::
96
96
@@ -105,7 +105,7 @@ Titling Methods
105
105
Content Methods
106
106
~~~~~~~~~~~~~~~
107
107
108
- :method: `Symfony\\ Component\\ Console\\ Style\\ StyleInterface ::text `
108
+ :method: `Symfony\\ Component\\ Console\\ Style\\ SymfonyStyle ::text `
109
109
It displays the given string or array of strings as regular text. This is
110
110
useful to render help messages and instructions for the user running the
111
111
command::
@@ -122,7 +122,7 @@ Content Methods
122
122
'Aenean sit amet arcu vitae sem faucibus porta',
123
123
));
124
124
125
- :method: `Symfony\\ Component\\ Console\\ Style\\ StyleInterface ::listing `
125
+ :method: `Symfony\\ Component\\ Console\\ Style\\ SymfonyStyle ::listing `
126
126
It displays an unordered list of elements passed as an array::
127
127
128
128
$io->listing(array(
@@ -131,7 +131,7 @@ Content Methods
131
131
'Element #3 Lorem ipsum dolor sit amet',
132
132
));
133
133
134
- :method: `Symfony\\ Component\\ Console\\ Style\\ StyleInterface ::table `
134
+ :method: `Symfony\\ Component\\ Console\\ Style\\ SymfonyStyle ::table `
135
135
It displays the given array of headers and rows as a compact table::
136
136
137
137
$io->table(
@@ -143,7 +143,7 @@ Content Methods
143
143
)
144
144
);
145
145
146
- :method: `Symfony\\ Component\\ Console\\ Style\\ StyleInterface ::newLine `
146
+ :method: `Symfony\\ Component\\ Console\\ Style\\ SymfonyStyle ::newLine `
147
147
It displays a blank line in the command output. Although it may seem useful,
148
148
most of the times you won't need it at all. The reason is that every helper
149
149
already adds their own blank lines, so you don't have to care about the
@@ -158,7 +158,7 @@ Content Methods
158
158
Admonition Methods
159
159
~~~~~~~~~~~~~~~~~~
160
160
161
- :method: `Symfony\\ Component\\ Console\\ Style\\ StyleInterface ::note `
161
+ :method: `Symfony\\ Component\\ Console\\ Style\\ SymfonyStyle ::note `
162
162
It displays the given string or array of strings as a highlighted admonition.
163
163
Use this helper sparingly to avoid cluttering command's output::
164
164
@@ -174,7 +174,7 @@ Admonition Methods
174
174
'Aenean sit amet arcu vitae sem faucibus porta',
175
175
));
176
176
177
- :method: `Symfony\\ Component\\ Console\\ Style\\ StyleInterface ::caution `
177
+ :method: `Symfony\\ Component\\ Console\\ Style\\ SymfonyStyle ::caution `
178
178
Similar to the ``note() `` helper, but the contents are more prominently
179
179
highlighted. The resulting contents resemble an error message, so you should
180
180
avoid using this helper unless strictly necessary::
@@ -194,7 +194,7 @@ Admonition Methods
194
194
Progress Bar Methods
195
195
~~~~~~~~~~~~~~~~~~~~
196
196
197
- :method: `Symfony\\ Component\\ Console\\ Style\\ StyleInterface ::progressStart `
197
+ :method: `Symfony\\ Component\\ Console\\ Style\\ SymfonyStyle ::progressStart `
198
198
It displays a progress bar with a number of steps equal to the argument passed
199
199
to the method (don't pass any value if the length of the progress bar is
200
200
unknown)::
@@ -205,7 +205,7 @@ Progress Bar Methods
205
205
// displays a 100-step length progress bar
206
206
$io->progressStart(100);
207
207
208
- :method: `Symfony\\ Component\\ Console\\ Style\\ StyleInterface ::progressAdvance `
208
+ :method: `Symfony\\ Component\\ Console\\ Style\\ SymfonyStyle ::progressAdvance `
209
209
It makes the progress bar advance the given number of steps (or ``1 `` step
210
210
if no argument is passed)::
211
211
@@ -215,7 +215,7 @@ Progress Bar Methods
215
215
// advances the progress bar 10 steps
216
216
$io->progressAdvance(10);
217
217
218
- :method: `Symfony\\ Component\\ Console\\ Style\\ StyleInterface ::progressFinish `
218
+ :method: `Symfony\\ Component\\ Console\\ Style\\ SymfonyStyle ::progressFinish `
219
219
It finishes the progress bar (filling up all the remaining steps when its
220
220
length is known)::
221
221
@@ -224,7 +224,7 @@ Progress Bar Methods
224
224
User Input Methods
225
225
~~~~~~~~~~~~~~~~~~
226
226
227
- :method: `Symfony\\ Component\\ Console\\ Style\\ StyleInterface ::ask `
227
+ :method: `Symfony\\ Component\\ Console\\ Style\\ SymfonyStyle ::ask `
228
228
It asks the user to provide some value::
229
229
230
230
$io->ask('What is your name?');
@@ -245,7 +245,7 @@ User Input Methods
245
245
return $number;
246
246
});
247
247
248
- :method: `Symfony\\ Component\\ Console\\ Style\\ StyleInterface ::askHidden `
248
+ :method: `Symfony\\ Component\\ Console\\ Style\\ SymfonyStyle ::askHidden `
249
249
It's very similar to the ``ask() `` method but the user's input will be hidden
250
250
and it cannot define a default value. Use it when asking for sensitive information::
251
251
@@ -260,7 +260,7 @@ User Input Methods
260
260
return $password;
261
261
});
262
262
263
- :method: `Symfony\\ Component\\ Console\\ Style\\ StyleInterface ::confirm `
263
+ :method: `Symfony\\ Component\\ Console\\ Style\\ SymfonyStyle ::confirm `
264
264
It asks a Yes/No question to the user and it only returns ``true `` or ``false ``::
265
265
266
266
$io->confirm('Restart the web server?');
@@ -270,7 +270,7 @@ User Input Methods
270
270
271
271
$io->confirm('Restart the web server?', true);
272
272
273
- :method: `Symfony\\ Component\\ Console\\ Style\\ StyleInterface ::choice `
273
+ :method: `Symfony\\ Component\\ Console\\ Style\\ SymfonyStyle ::choice `
274
274
It asks a question whose answer is constrained to the given list of valid
275
275
answers::
276
276
@@ -284,7 +284,7 @@ User Input Methods
284
284
Result Methods
285
285
~~~~~~~~~~~~~~
286
286
287
- :method: `Symfony\\ Component\\ Console\\ Style\\ StyleInterface ::success `
287
+ :method: `Symfony\\ Component\\ Console\\ Style\\ SymfonyStyle ::success `
288
288
It displays the given string or array of strings highlighted as a successful
289
289
message (with a green background and the ``[OK] `` label). It's meant to be
290
290
used once to display the final result of executing the given command, but you
@@ -301,7 +301,7 @@ Result Methods
301
301
'Consectetur adipiscing elit',
302
302
));
303
303
304
- :method: `Symfony\\ Component\\ Console\\ Style\\ StyleInterface ::warning `
304
+ :method: `Symfony\\ Component\\ Console\\ Style\\ SymfonyStyle ::warning `
305
305
It displays the given string or array of strings highlighted as a warning
306
306
message (with a read background and the ``[WARNING] `` label). It's meant to be
307
307
used once to display the final result of executing the given command, but you
@@ -318,7 +318,7 @@ Result Methods
318
318
'Consectetur adipiscing elit',
319
319
));
320
320
321
- :method: `Symfony\\ Component\\ Console\\ Style\\ StyleInterface ::error `
321
+ :method: `Symfony\\ Component\\ Console\\ Style\\ SymfonyStyle ::error `
322
322
It displays the given string or array of strings highlighted as an error
323
323
message (with a read background and the ``[ERROR] `` label). It's meant to be
324
324
used once to display the final result of executing the given command, but you
0 commit comments