Skip to content

Commit 93be6df

Browse files
committed
minor #11277 ordered use statements in code examples (OskarStark)
This PR was merged into the 3.4 branch. Discussion ---------- ordered use statements in code examples I know, that this could lead to massive merge conflicts, but if we would not merge it up, I could create a shiny new PullRequest against `4.2` and I am willing to merge it up and fix the conflicts, too! Or does any thoughts about **not** to order the use statements exist, which I doesn't know? There are a lot more todo, but before finishing this PR, I'd like to receive some feedback Commits ------- 3506a7e ordered use statements in code examples
2 parents b1c5ac1 + 3506a7e commit 93be6df

File tree

182 files changed

+387
-382
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

182 files changed

+387
-382
lines changed

best_practices/business-logic.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -238,8 +238,8 @@ looking for mapping information::
238238

239239
namespace AppBundle\Entity;
240240

241-
use Doctrine\ORM\Mapping as ORM;
242241
use Doctrine\Common\Collections\ArrayCollection;
242+
use Doctrine\ORM\Mapping as ORM;
243243

244244
/**
245245
* @ORM\Entity

best_practices/configuration.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -137,8 +137,8 @@ whereas they cannot access the container parameters::
137137

138138
namespace AppBundle\Repository;
139139

140-
use Doctrine\ORM\EntityRepository;
141140
use AppBundle\Entity\Post;
141+
use Doctrine\ORM\EntityRepository;
142142

143143
class PostRepository extends EntityRepository
144144
{

best_practices/forms.rst

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -21,11 +21,11 @@ form in its own PHP class::
2121

2222
use AppBundle\Entity\Post;
2323
use Symfony\Component\Form\AbstractType;
24+
use Symfony\Component\Form\Extension\Core\Type\DateTimeType;
25+
use Symfony\Component\Form\Extension\Core\Type\EmailType;
26+
use Symfony\Component\Form\Extension\Core\Type\TextareaType;
2427
use Symfony\Component\Form\FormBuilderInterface;
2528
use Symfony\Component\OptionsResolver\OptionsResolver;
26-
use Symfony\Component\Form\Extension\Core\Type\TextareaType;
27-
use Symfony\Component\Form\Extension\Core\Type\EmailType;
28-
use Symfony\Component\Form\Extension\Core\Type\DateTimeType;
2929

3030
class PostType extends AbstractType
3131
{
@@ -109,11 +109,11 @@ some developers configure form buttons in the controller::
109109

110110
namespace AppBundle\Controller\Admin;
111111

112-
use Symfony\Component\HttpFoundation\Request;
113-
use Symfony\Bundle\FrameworkBundle\Controller\Controller;
114-
use Symfony\Component\Form\Extension\Core\Type\SubmitType;
115112
use AppBundle\Entity\Post;
116113
use AppBundle\Form\PostType;
114+
use Symfony\Bundle\FrameworkBundle\Controller\Controller;
115+
use Symfony\Component\Form\Extension\Core\Type\SubmitType;
116+
use Symfony\Component\HttpFoundation\Request;
117117

118118
class PostController extends Controller
119119
{

best_practices/security.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -259,11 +259,11 @@ the same ``getAuthorEmail()`` logic you used above::
259259

260260
namespace AppBundle\Security;
261261

262+
use AppBundle\Entity\Post;
262263
use Symfony\Component\Security\Core\Authentication\Token\TokenInterface;
263264
use Symfony\Component\Security\Core\Authorization\AccessDecisionManagerInterface;
264265
use Symfony\Component\Security\Core\Authorization\Voter\Voter;
265266
use Symfony\Component\Security\Core\User\UserInterface;
266-
use AppBundle\Entity\Post;
267267

268268
class PostVoter extends Voter
269269
{

bundles/configuration.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -262,8 +262,8 @@ In your extension, you can load this and dynamically set its arguments::
262262
// src/Acme/SocialBundle/DependencyInjection/AcmeSocialExtension.php
263263
// ...
264264

265-
use Symfony\Component\DependencyInjection\Loader\XmlFileLoader;
266265
use Symfony\Component\Config\FileLocator;
266+
use Symfony\Component\DependencyInjection\Loader\XmlFileLoader;
267267

268268
public function load(array $configs, ContainerBuilder $container)
269269
{

bundles/extension.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -93,8 +93,8 @@ the extension!
9393
For instance, assume you have a file called ``services.xml`` in the
9494
``Resources/config`` directory of your bundle, your ``load()`` method looks like::
9595

96-
use Symfony\Component\DependencyInjection\Loader\XmlFileLoader;
9796
use Symfony\Component\Config\FileLocator;
97+
use Symfony\Component\DependencyInjection\Loader\XmlFileLoader;
9898

9999
// ...
100100
public function load(array $configs, ContainerBuilder $container)

bundles/prepend_extension.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -28,9 +28,9 @@ To give an Extension the power to do this, it needs to implement
2828
// src/Acme/HelloBundle/DependencyInjection/AcmeHelloExtension.php
2929
namespace Acme\HelloBundle\DependencyInjection;
3030

31-
use Symfony\Component\HttpKernel\DependencyInjection\Extension;
32-
use Symfony\Component\DependencyInjection\Extension\PrependExtensionInterface;
3331
use Symfony\Component\DependencyInjection\ContainerBuilder;
32+
use Symfony\Component\DependencyInjection\Extension\PrependExtensionInterface;
33+
use Symfony\Component\HttpKernel\DependencyInjection\Extension;
3434

3535
class AcmeHelloExtension extends Extension implements PrependExtensionInterface
3636
{

components/asset.rst

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -223,8 +223,8 @@ If you are also using the :doc:`HttpFoundation </components/http_foundation>`
223223
component in your project (for instance, in a Symfony application), the ``PathPackage``
224224
class can take into account the context of the current request::
225225

226-
use Symfony\Component\Asset\PathPackage;
227226
use Symfony\Component\Asset\Context\RequestStackContext;
227+
use Symfony\Component\Asset\PathPackage;
228228
// ...
229229

230230
$pathPackage = new PathPackage(
@@ -313,8 +313,8 @@ account the context of the current request. In this case, only the request
313313
scheme is considered, in order to select the appropriate base URL (HTTPs or
314314
protocol-relative URLs for HTTPs requests, any base URL for HTTP requests)::
315315

316-
use Symfony\Component\Asset\UrlPackage;
317316
use Symfony\Component\Asset\Context\RequestStackContext;
317+
use Symfony\Component\Asset\UrlPackage;
318318
// ...
319319

320320
$urlPackage = new UrlPackage(
@@ -339,9 +339,9 @@ In the following example, all packages use the same versioning strategy, but
339339
they all have different base paths::
340340

341341
use Symfony\Component\Asset\Package;
342+
use Symfony\Component\Asset\Packages;
342343
use Symfony\Component\Asset\PathPackage;
343344
use Symfony\Component\Asset\UrlPackage;
344-
use Symfony\Component\Asset\Packages;
345345
// ...
346346

347347
$versionStrategy = new StaticVersionStrategy('v1');

components/cache/adapters/php_array_cache_adapter.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,8 +8,8 @@ Php Array Cache Adapter
88
This adapter is a high performance cache for static data (e.g. application configuration)
99
that is optimized and preloaded into OPcache memory storage::
1010

11-
use Symfony\Component\Cache\Adapter\PhpArrayAdapter;
1211
use Symfony\Component\Cache\Adapter\FilesystemAdapter;
12+
use Symfony\Component\Cache\Adapter\PhpArrayAdapter;
1313

1414
// somehow, decide it's time to warm up the cache!
1515
if ($needsWarmup) {

components/cache/cache_invalidation.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -73,9 +73,9 @@ in the same place. By using two adapters, you can e.g. store some big cached ite
7373
on the filesystem or in the database and keep tags in a Redis database to sync all
7474
your fronts and have very fast invalidation checks::
7575

76-
use Symfony\Component\Cache\Adapter\TagAwareAdapter;
7776
use Symfony\Component\Cache\Adapter\FilesystemAdapter;
7877
use Symfony\Component\Cache\Adapter\RedisAdapter;
78+
use Symfony\Component\Cache\Adapter\TagAwareAdapter;
7979

8080
$cache = new TagAwareAdapter(
8181
// Adapter for cached items

components/cache/psr6_psr16_adapters.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -36,8 +36,8 @@ instead. No problem! The Cache component provides the
3636
:class:`Symfony\\Component\\Cache\\Adapter\\SimpleCacheAdapter` class for exactly
3737
this use-case::
3838

39-
use Symfony\Component\Cache\Simple\FilesystemCache;
4039
use Symfony\Component\Cache\Adapter\SimpleCacheAdapter;
40+
use Symfony\Component\Cache\Simple\FilesystemCache;
4141

4242
// the PSR-16 cache object that you want to use
4343
$psr16Cache = new FilesystemCache();

components/config/definition.rst

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -52,8 +52,8 @@ implements the :class:`Symfony\\Component\\Config\\Definition\\ConfigurationInte
5252

5353
namespace Acme\DatabaseConfiguration;
5454

55-
use Symfony\Component\Config\Definition\ConfigurationInterface;
5655
use Symfony\Component\Config\Definition\Builder\TreeBuilder;
56+
use Symfony\Component\Config\Definition\ConfigurationInterface;
5757

5858
class DatabaseConfiguration implements ConfigurationInterface
5959
{
@@ -809,9 +809,9 @@ any value is not of the expected type, is mandatory and yet undefined, or
809809
could not be validated in some other way, an exception will be thrown.
810810
Otherwise the result is a clean array of configuration values::
811811

812-
use Symfony\Component\Yaml\Yaml;
813-
use Symfony\Component\Config\Definition\Processor;
814812
use Acme\DatabaseConfiguration;
813+
use Symfony\Component\Config\Definition\Processor;
814+
use Symfony\Component\Yaml\Yaml;
815815

816816
$config = Yaml::parse(
817817
file_get_contents(__DIR__.'/src/Matthias/config/config.yml')

components/console/events.rst

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -33,8 +33,8 @@ Just before executing any command, the ``ConsoleEvents::COMMAND`` event is
3333
dispatched. Listeners receive a
3434
:class:`Symfony\\Component\\Console\\Event\\ConsoleCommandEvent` event::
3535

36-
use Symfony\Component\Console\Event\ConsoleCommandEvent;
3736
use Symfony\Component\Console\ConsoleEvents;
37+
use Symfony\Component\Console\Event\ConsoleCommandEvent;
3838

3939
$dispatcher->addListener(ConsoleEvents::COMMAND, function (ConsoleCommandEvent $event) {
4040
// gets the input instance
@@ -64,8 +64,8 @@ will then *not* execute the command, but instead will return the code ``113``
6464
of the `reserved exit codes`_ for console commands that conform with the
6565
C/C++ standard::
6666

67-
use Symfony\Component\Console\Event\ConsoleCommandEvent;
6867
use Symfony\Component\Console\ConsoleEvents;
68+
use Symfony\Component\Console\Event\ConsoleCommandEvent;
6969

7070
$dispatcher->addListener(ConsoleEvents::COMMAND, function (ConsoleCommandEvent $event) {
7171
// gets the command to be executed
@@ -112,8 +112,8 @@ thrown by the application.
112112
Listeners receive a
113113
:class:`Symfony\\Component\\Console\\Event\\ConsoleErrorEvent` event::
114114

115-
use Symfony\Component\Console\Event\ConsoleErrorEvent;
116115
use Symfony\Component\Console\ConsoleEvents;
116+
use Symfony\Component\Console\Event\ConsoleErrorEvent;
117117

118118
$dispatcher->addListener(ConsoleEvents::ERROR, function (ConsoleErrorEvent $event) {
119119
$output = $event->getOutput();
@@ -146,8 +146,8 @@ listener (like sending logs, closing a database connection, sending emails,
146146
Listeners receive a
147147
:class:`Symfony\\Component\\Console\\Event\\ConsoleTerminateEvent` event::
148148

149-
use Symfony\Component\Console\Event\ConsoleTerminateEvent;
150149
use Symfony\Component\Console\ConsoleEvents;
150+
use Symfony\Component\Console\Event\ConsoleTerminateEvent;
151151

152152
$dispatcher->addListener(ConsoleEvents::TERMINATE, function (ConsoleTerminateEvent $event) {
153153
// gets the output

components/console/helpers/questionhelper.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -344,8 +344,8 @@ Testing a Command that Expects Input
344344
If you want to write a unit test for a command which expects some kind of input
345345
from the command line, you need to set the inputs that the command expects::
346346

347-
use Symfony\Component\Console\Helper\QuestionHelper;
348347
use Symfony\Component\Console\Helper\HelperSet;
348+
use Symfony\Component\Console\Helper\QuestionHelper;
349349
use Symfony\Component\Console\Tester\CommandTester;
350350

351351
// ...

components/console/helpers/table.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -192,8 +192,8 @@ Spanning Multiple Columns and Rows
192192
To make a table cell that spans multiple columns you can use a :class:`Symfony\\Component\\Console\\Helper\\TableCell`::
193193

194194
use Symfony\Component\Console\Helper\Table;
195-
use Symfony\Component\Console\Helper\TableSeparator;
196195
use Symfony\Component\Console\Helper\TableCell;
196+
use Symfony\Component\Console\Helper\TableSeparator;
197197

198198
$table = new Table($output);
199199
$table

components/console/logger.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -39,8 +39,8 @@ You can rely on the logger to use this dependency inside a command::
3939
use Acme\MyDependency;
4040
use Symfony\Component\Console\Command\Command;
4141
use Symfony\Component\Console\Input\InputInterface;
42-
use Symfony\Component\Console\Output\OutputInterface;
4342
use Symfony\Component\Console\Logger\ConsoleLogger;
43+
use Symfony\Component\Console\Output\OutputInterface;
4444

4545
class MyCommand extends Command
4646
{

components/dependency_injection.rst

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -198,8 +198,8 @@ files. To do this you also need to install
198198

199199
Loading an XML config file::
200200

201-
use Symfony\Component\DependencyInjection\ContainerBuilder;
202201
use Symfony\Component\Config\FileLocator;
202+
use Symfony\Component\DependencyInjection\ContainerBuilder;
203203
use Symfony\Component\DependencyInjection\Loader\XmlFileLoader;
204204

205205
$containerBuilder = new ContainerBuilder();
@@ -208,8 +208,8 @@ Loading an XML config file::
208208

209209
Loading a YAML config file::
210210

211-
use Symfony\Component\DependencyInjection\ContainerBuilder;
212211
use Symfony\Component\Config\FileLocator;
212+
use Symfony\Component\DependencyInjection\ContainerBuilder;
213213
use Symfony\Component\DependencyInjection\Loader\YamlFileLoader;
214214

215215
$containerBuilder = new ContainerBuilder();
@@ -233,8 +233,8 @@ Loading a YAML config file::
233233
If you *do* want to use PHP to create the services then you can move this
234234
into a separate config file and load it in a similar way::
235235

236-
use Symfony\Component\DependencyInjection\ContainerBuilder;
237236
use Symfony\Component\Config\FileLocator;
237+
use Symfony\Component\DependencyInjection\ContainerBuilder;
238238
use Symfony\Component\DependencyInjection\Loader\PhpFileLoader;
239239

240240
$containerBuilder = new ContainerBuilder();

components/dependency_injection/compilation.rst

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -57,10 +57,10 @@ added but are processed when the container's ``compile()`` method is called.
5757

5858
A very simple extension may just load configuration files into the container::
5959

60+
use Symfony\Component\Config\FileLocator;
6061
use Symfony\Component\DependencyInjection\ContainerBuilder;
61-
use Symfony\Component\DependencyInjection\Loader\XmlFileLoader;
6262
use Symfony\Component\DependencyInjection\Extension\ExtensionInterface;
63-
use Symfony\Component\Config\FileLocator;
63+
use Symfony\Component\DependencyInjection\Loader\XmlFileLoader;
6464

6565
class AcmeDemoExtension implements ExtensionInterface
6666
{
@@ -113,8 +113,8 @@ If this file is loaded into the configuration then the values in it are
113113
only processed when the container is compiled at which point the Extensions
114114
are loaded::
115115

116-
use Symfony\Component\DependencyInjection\ContainerBuilder;
117116
use Symfony\Component\Config\FileLocator;
117+
use Symfony\Component\DependencyInjection\ContainerBuilder;
118118
use Symfony\Component\DependencyInjection\Loader\YamlFileLoader;
119119

120120
$containerBuilder = new ContainerBuilder();

components/event_dispatcher.rst

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -200,8 +200,8 @@ determine which instance is passed.
200200
use Symfony\Component\DependencyInjection\ContainerBuilder;
201201
use Symfony\Component\DependencyInjection\ParameterBag\ParameterBag;
202202
use Symfony\Component\DependencyInjection\Reference;
203-
use Symfony\Component\EventDispatcher\EventDispatcher;
204203
use Symfony\Component\EventDispatcher\DependencyInjection\RegisterListenersPass;
204+
use Symfony\Component\EventDispatcher\EventDispatcher;
205205

206206
$containerBuilder = new ContainerBuilder(new ParameterBag());
207207
// register the compiler pass that handles the 'kernel.event_listener'
@@ -252,8 +252,8 @@ order. Start by creating this custom event class and documenting it::
252252

253253
namespace Acme\Store\Event;
254254

255-
use Symfony\Component\EventDispatcher\Event;
256255
use Acme\Store\Order;
256+
use Symfony\Component\EventDispatcher\Event;
257257

258258
/**
259259
* The order.placed event is dispatched each time an order is created
@@ -295,8 +295,8 @@ method notifies all listeners of the given event. It takes two arguments:
295295
the name of the event to dispatch and the ``Event`` instance to pass to
296296
each listener of that event::
297297

298-
use Acme\Store\Order;
299298
use Acme\Store\Event\OrderPlacedEvent;
299+
use Acme\Store\Order;
300300

301301
// the order is somehow created or retrieved
302302
$order = new Order();
@@ -333,10 +333,10 @@ Take the following example of a subscriber that subscribes to the
333333

334334
namespace Acme\Store\Event;
335335

336+
use Acme\Store\Event\OrderPlacedEvent;
336337
use Symfony\Component\EventDispatcher\EventSubscriberInterface;
337338
use Symfony\Component\HttpKernel\Event\FilterResponseEvent;
338339
use Symfony\Component\HttpKernel\KernelEvents;
339-
use Acme\Store\Event\OrderPlacedEvent;
340340

341341
class StoreSubscriber implements EventSubscriberInterface
342342
{

components/expression_language/caching.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -31,8 +31,8 @@ uses an :class:`Symfony\\Component\\Cache\\Adapter\\ArrayAdapter`). You can
3131
customize this by creating a custom cache pool or using one of the available
3232
ones and injecting this using the constructor::
3333

34-
use Symfony\Component\ExpressionLanguage\ExpressionLanguage;
3534
use Symfony\Component\Cache\Adapter\RedisAdapter;
35+
use Symfony\Component\ExpressionLanguage\ExpressionLanguage;
3636

3737
$cache = new RedisAdapter(...);
3838
$expressionLanguage = new ExpressionLanguage($cache);

components/filesystem.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -21,8 +21,8 @@ Usage
2121
The :class:`Symfony\\Component\\Filesystem\\Filesystem` class is the unique
2222
endpoint for filesystem operations::
2323

24-
use Symfony\Component\Filesystem\Filesystem;
2524
use Symfony\Component\Filesystem\Exception\IOExceptionInterface;
25+
use Symfony\Component\Filesystem\Filesystem;
2626

2727
$filesystem = new Filesystem();
2828

0 commit comments

Comments
 (0)