Skip to content

Commit 11f1564

Browse files
committed
minor #6245 [Cookbook][Console] change API doc class name (xabbuh)
This PR was merged into the 2.7 branch. Discussion ---------- [Cookbook][Console] change API doc class name The article describes the methods of the `SymfonyStyle` class and not the `StyleInterface` (new methods can only be added to the class but not to the interface before Symfony 4.0). Commits ------- c2a0f39 [Cookbook][Console] change API doc class name
2 parents 3d7838b + c2a0f39 commit 11f1564

File tree

1 file changed

+18
-18
lines changed

1 file changed

+18
-18
lines changed

cookbook/console/style.rst

Lines changed: 18 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -83,14 +83,14 @@ helper methods that cover the most common interactions performed by console comm
8383
Titling Methods
8484
~~~~~~~~~~~~~~~
8585

86-
:method:`Symfony\\Component\\Console\\Style\\StyleInterface::title`
86+
:method:`Symfony\\Component\\Console\\Style\\SymfonyStyle::title`
8787
It displays the given string as the command title. This method is meant to
8888
be used only once in a given command, but nothing prevents you to use it
8989
repeatedly::
9090

9191
$io->title('Lorem ipsum dolor sit amet');
9292

93-
:method:`Symfony\\Component\\Console\\Style\\StyleInterface::section`
93+
:method:`Symfony\\Component\\Console\\Style\\SymfonyStyle::section`
9494
It displays the given string as the title of some command section. This is
9595
only needed in complex commands which want to better separate their contents::
9696

@@ -105,7 +105,7 @@ Titling Methods
105105
Content Methods
106106
~~~~~~~~~~~~~~~
107107

108-
:method:`Symfony\\Component\\Console\\Style\\StyleInterface::text`
108+
:method:`Symfony\\Component\\Console\\Style\\SymfonyStyle::text`
109109
It displays the given string or array of strings as regular text. This is
110110
useful to render help messages and instructions for the user running the
111111
command::
@@ -122,7 +122,7 @@ Content Methods
122122
'Aenean sit amet arcu vitae sem faucibus porta',
123123
));
124124

125-
:method:`Symfony\\Component\\Console\\Style\\StyleInterface::listing`
125+
:method:`Symfony\\Component\\Console\\Style\\SymfonyStyle::listing`
126126
It displays an unordered list of elements passed as an array::
127127

128128
$io->listing(array(
@@ -131,7 +131,7 @@ Content Methods
131131
'Element #3 Lorem ipsum dolor sit amet',
132132
));
133133

134-
:method:`Symfony\\Component\\Console\\Style\\StyleInterface::table`
134+
:method:`Symfony\\Component\\Console\\Style\\SymfonyStyle::table`
135135
It displays the given array of headers and rows as a compact table::
136136

137137
$io->table(
@@ -143,7 +143,7 @@ Content Methods
143143
)
144144
);
145145

146-
:method:`Symfony\\Component\\Console\\Style\\StyleInterface::newLine`
146+
:method:`Symfony\\Component\\Console\\Style\\SymfonyStyle::newLine`
147147
It displays a blank line in the command output. Although it may seem useful,
148148
most of the times you won't need it at all. The reason is that every helper
149149
already adds their own blank lines, so you don't have to care about the
@@ -158,7 +158,7 @@ Content Methods
158158
Admonition Methods
159159
~~~~~~~~~~~~~~~~~~
160160

161-
:method:`Symfony\\Component\\Console\\Style\\StyleInterface::note`
161+
:method:`Symfony\\Component\\Console\\Style\\SymfonyStyle::note`
162162
It displays the given string or array of strings as a highlighted admonition.
163163
Use this helper sparingly to avoid cluttering command's output::
164164

@@ -174,7 +174,7 @@ Admonition Methods
174174
'Aenean sit amet arcu vitae sem faucibus porta',
175175
));
176176

177-
:method:`Symfony\\Component\\Console\\Style\\StyleInterface::caution`
177+
:method:`Symfony\\Component\\Console\\Style\\SymfonyStyle::caution`
178178
Similar to the ``note()`` helper, but the contents are more prominently
179179
highlighted. The resulting contents resemble an error message, so you should
180180
avoid using this helper unless strictly necessary::
@@ -194,7 +194,7 @@ Admonition Methods
194194
Progress Bar Methods
195195
~~~~~~~~~~~~~~~~~~~~
196196

197-
:method:`Symfony\\Component\\Console\\Style\\StyleInterface::progressStart`
197+
:method:`Symfony\\Component\\Console\\Style\\SymfonyStyle::progressStart`
198198
It displays a progress bar with a number of steps equal to the argument passed
199199
to the method (don't pass any value if the length of the progress bar is
200200
unknown)::
@@ -205,7 +205,7 @@ Progress Bar Methods
205205
// displays a 100-step length progress bar
206206
$io->progressStart(100);
207207

208-
:method:`Symfony\\Component\\Console\\Style\\StyleInterface::progressAdvance`
208+
:method:`Symfony\\Component\\Console\\Style\\SymfonyStyle::progressAdvance`
209209
It makes the progress bar advance the given number of steps (or ``1`` step
210210
if no argument is passed)::
211211

@@ -215,7 +215,7 @@ Progress Bar Methods
215215
// advances the progress bar 10 steps
216216
$io->progressAdvance(10);
217217

218-
:method:`Symfony\\Component\\Console\\Style\\StyleInterface::progressFinish`
218+
:method:`Symfony\\Component\\Console\\Style\\SymfonyStyle::progressFinish`
219219
It finishes the progress bar (filling up all the remaining steps when its
220220
length is known)::
221221

@@ -224,7 +224,7 @@ Progress Bar Methods
224224
User Input Methods
225225
~~~~~~~~~~~~~~~~~~
226226

227-
:method:`Symfony\\Component\\Console\\Style\\StyleInterface::ask`
227+
:method:`Symfony\\Component\\Console\\Style\\SymfonyStyle::ask`
228228
It asks the user to provide some value::
229229

230230
$io->ask('What is your name?');
@@ -245,7 +245,7 @@ User Input Methods
245245
return $number;
246246
});
247247

248-
:method:`Symfony\\Component\\Console\\Style\\StyleInterface::askHidden`
248+
:method:`Symfony\\Component\\Console\\Style\\SymfonyStyle::askHidden`
249249
It's very similar to the ``ask()`` method but the user's input will be hidden
250250
and it cannot define a default value. Use it when asking for sensitive information::
251251

@@ -260,7 +260,7 @@ User Input Methods
260260
return $password;
261261
});
262262

263-
:method:`Symfony\\Component\\Console\\Style\\StyleInterface::confirm`
263+
:method:`Symfony\\Component\\Console\\Style\\SymfonyStyle::confirm`
264264
It asks a Yes/No question to the user and it only returns ``true`` or ``false``::
265265

266266
$io->confirm('Restart the web server?');
@@ -270,7 +270,7 @@ User Input Methods
270270

271271
$io->confirm('Restart the web server?', true);
272272

273-
:method:`Symfony\\Component\\Console\\Style\\StyleInterface::choice`
273+
:method:`Symfony\\Component\\Console\\Style\\SymfonyStyle::choice`
274274
It asks a question whose answer is constrained to the given list of valid
275275
answers::
276276

@@ -284,7 +284,7 @@ User Input Methods
284284
Result Methods
285285
~~~~~~~~~~~~~~
286286

287-
:method:`Symfony\\Component\\Console\\Style\\StyleInterface::success`
287+
:method:`Symfony\\Component\\Console\\Style\\SymfonyStyle::success`
288288
It displays the given string or array of strings highlighted as a successful
289289
message (with a green background and the ``[OK]`` label). It's meant to be
290290
used once to display the final result of executing the given command, but you
@@ -301,7 +301,7 @@ Result Methods
301301
'Consectetur adipiscing elit',
302302
));
303303

304-
:method:`Symfony\\Component\\Console\\Style\\StyleInterface::warning`
304+
:method:`Symfony\\Component\\Console\\Style\\SymfonyStyle::warning`
305305
It displays the given string or array of strings highlighted as a warning
306306
message (with a read background and the ``[WARNING]`` label). It's meant to be
307307
used once to display the final result of executing the given command, but you
@@ -318,7 +318,7 @@ Result Methods
318318
'Consectetur adipiscing elit',
319319
));
320320

321-
:method:`Symfony\\Component\\Console\\Style\\StyleInterface::error`
321+
:method:`Symfony\\Component\\Console\\Style\\SymfonyStyle::error`
322322
It displays the given string or array of strings highlighted as an error
323323
message (with a read background and the ``[ERROR]`` label). It's meant to be
324324
used once to display the final result of executing the given command, but you

0 commit comments

Comments
 (0)