ordered use statements in code examples

Author: OskarStark

best_practices/business-logic.rst

@@ -229,8 +229,8 @@ looking for mapping information::
 
     namespace AppBundle\Entity;
 
-    use Doctrine\ORM\Mapping as ORM;
     use Doctrine\Common\Collections\ArrayCollection;
+    use Doctrine\ORM\Mapping as ORM;
 
     /**
      * @ORM\Entity

best_practices/configuration.rst

@@ -137,8 +137,8 @@ whereas they cannot access the container parameters::
 
     namespace AppBundle\Repository;
 
-    use Doctrine\ORM\EntityRepository;
     use AppBundle\Entity\Post;
+    use Doctrine\ORM\EntityRepository;
 
     class PostRepository extends EntityRepository
     {

best_practices/forms.rst

@@ -21,11 +21,11 @@ form in its own PHP class::
 
     use AppBundle\Entity\Post;
     use Symfony\Component\Form\AbstractType;
+    use Symfony\Component\Form\Extension\Core\Type\DateTimeType;
+    use Symfony\Component\Form\Extension\Core\Type\EmailType;
+    use Symfony\Component\Form\Extension\Core\Type\TextareaType;
     use Symfony\Component\Form\FormBuilderInterface;
     use Symfony\Component\OptionsResolver\OptionsResolver;
-    use Symfony\Component\Form\Extension\Core\Type\TextareaType;
-    use Symfony\Component\Form\Extension\Core\Type\EmailType;
-    use Symfony\Component\Form\Extension\Core\Type\DateTimeType;
 
     class PostType extends AbstractType
     {
@@ -109,11 +109,11 @@ some developers configure form buttons in the controller::
 
     namespace AppBundle\Controller\Admin;
 
-    use Symfony\Component\HttpFoundation\Request;
-    use Symfony\Bundle\FrameworkBundle\Controller\Controller;
-    use Symfony\Component\Form\Extension\Core\Type\SubmitType;
     use AppBundle\Entity\Post;
     use AppBundle\Form\PostType;
+    use Symfony\Bundle\FrameworkBundle\Controller\Controller;
+    use Symfony\Component\Form\Extension\Core\Type\SubmitType;
+    use Symfony\Component\HttpFoundation\Request;
 
     class PostController extends Controller
     {

best_practices/security.rst

@@ -259,11 +259,11 @@ the same ``getAuthorEmail()`` logic you used above::
 
     namespace AppBundle\Security;
 
+    use AppBundle\Entity\Post;
     use Symfony\Component\Security\Core\Authentication\Token\TokenInterface;
     use Symfony\Component\Security\Core\Authorization\AccessDecisionManagerInterface;
     use Symfony\Component\Security\Core\Authorization\Voter\Voter;
     use Symfony\Component\Security\Core\User\UserInterface;
-    use AppBundle\Entity\Post;
 
     class PostVoter extends Voter
     {

bundles/configuration.rst

@@ -263,8 +263,8 @@ In your extension, you can load this and dynamically set its arguments::
     // src/Acme/SocialBundle/DependencyInjection/AcmeSocialExtension.php
     // ...
 
-    use Symfony\Component\DependencyInjection\Loader\XmlFileLoader;
     use Symfony\Component\Config\FileLocator;
+    use Symfony\Component\DependencyInjection\Loader\XmlFileLoader;
 
     public function load(array $configs, ContainerBuilder $container)
     {

bundles/extension.rst

@@ -93,8 +93,8 @@ the extension!
 For instance, assume you have a file called ``services.xml`` in the
 ``Resources/config`` directory of your bundle, your ``load()`` method looks like::
 
-    use Symfony\Component\DependencyInjection\Loader\XmlFileLoader;
     use Symfony\Component\Config\FileLocator;
+    use Symfony\Component\DependencyInjection\Loader\XmlFileLoader;
 
     // ...
     public function load(array $configs, ContainerBuilder $container)

bundles/prepend_extension.rst

@@ -28,9 +28,9 @@ To give an Extension the power to do this, it needs to implement
     // src/Acme/HelloBundle/DependencyInjection/AcmeHelloExtension.php
     namespace Acme\HelloBundle\DependencyInjection;
 
-    use Symfony\Component\HttpKernel\DependencyInjection\Extension;
-    use Symfony\Component\DependencyInjection\Extension\PrependExtensionInterface;
     use Symfony\Component\DependencyInjection\ContainerBuilder;
+    use Symfony\Component\DependencyInjection\Extension\PrependExtensionInterface;
+    use Symfony\Component\HttpKernel\DependencyInjection\Extension;
 
     class AcmeHelloExtension extends Extension implements PrependExtensionInterface
     {

components/asset.rst

@@ -225,8 +225,8 @@ If you are also using the :doc:`HttpFoundation </components/http_foundation>`
 component in your project (for instance, in a Symfony application), the ``PathPackage``
 class can take into account the context of the current request::
 
-    use Symfony\Component\Asset\PathPackage;
     use Symfony\Component\Asset\Context\RequestStackContext;
+    use Symfony\Component\Asset\PathPackage;
     // ...
 
     $pathPackage = new PathPackage(
@@ -315,8 +315,8 @@ account the context of the current request. In this case, only the request
 scheme is considered, in order to select the appropriate base URL (HTTPs or
 protocol-relative URLs for HTTPs requests, any base URL for HTTP requests)::
 
-    use Symfony\Component\Asset\UrlPackage;
     use Symfony\Component\Asset\Context\RequestStackContext;
+    use Symfony\Component\Asset\UrlPackage;
     // ...
 
     $urlPackage = new UrlPackage(
@@ -341,9 +341,9 @@ In the following example, all packages use the same versioning strategy, but
 they all have different base paths::
 
     use Symfony\Component\Asset\Package;
+    use Symfony\Component\Asset\Packages;
     use Symfony\Component\Asset\PathPackage;
     use Symfony\Component\Asset\UrlPackage;
-    use Symfony\Component\Asset\Packages;
     // ...
 
     $versionStrategy = new StaticVersionStrategy('v1');

components/console/events.rst

@@ -33,8 +33,8 @@ Just before executing any command, the ``ConsoleEvents::COMMAND`` event is
 dispatched. Listeners receive a
 :class:`Symfony\\Component\\Console\\Event\\ConsoleCommandEvent` event::
 
-    use Symfony\Component\Console\Event\ConsoleCommandEvent;
     use Symfony\Component\Console\ConsoleEvents;
+    use Symfony\Component\Console\Event\ConsoleCommandEvent;
 
     $dispatcher->addListener(ConsoleEvents::COMMAND, function (ConsoleCommandEvent $event) {
         // gets the input instance
@@ -64,8 +64,8 @@ will then *not* execute the command, but instead will return the code ``113``
 of the `reserved exit codes`_ for console commands that conform with the
 C/C++ standard::
 
-    use Symfony\Component\Console\Event\ConsoleCommandEvent;
     use Symfony\Component\Console\ConsoleEvents;
+    use Symfony\Component\Console\Event\ConsoleCommandEvent;
 
     $dispatcher->addListener(ConsoleEvents::COMMAND, function (ConsoleCommandEvent $event) {
         // gets the command to be executed
@@ -112,8 +112,8 @@ thrown by the application.
 Listeners receive a
 :class:`Symfony\\Component\\Console\\Event\\ConsoleErrorEvent` event::
 
-    use Symfony\Component\Console\Event\ConsoleErrorEvent;
     use Symfony\Component\Console\ConsoleEvents;
+    use Symfony\Component\Console\Event\ConsoleErrorEvent;
 
     $dispatcher->addListener(ConsoleEvents::ERROR, function (ConsoleErrorEvent $event) {
         $output = $event->getOutput();
@@ -146,8 +146,8 @@ listener (like sending logs, closing a database connection, sending emails,
 Listeners receive a
 :class:`Symfony\\Component\\Console\\Event\\ConsoleTerminateEvent` event::
 
-    use Symfony\Component\Console\Event\ConsoleTerminateEvent;
     use Symfony\Component\Console\ConsoleEvents;
+    use Symfony\Component\Console\Event\ConsoleTerminateEvent;
 
     $dispatcher->addListener(ConsoleEvents::TERMINATE, function (ConsoleTerminateEvent $event) {
         // gets the output

components/console/helpers/questionhelper.rst

@@ -344,8 +344,8 @@ Testing a Command that Expects Input
 If you want to write a unit test for a command which expects some kind of input
 from the command line, you need to set the inputs that the command expects::
 
-    use Symfony\Component\Console\Helper\QuestionHelper;
     use Symfony\Component\Console\Helper\HelperSet;
+    use Symfony\Component\Console\Helper\QuestionHelper;
     use Symfony\Component\Console\Tester\CommandTester;
 
     // ...

components/console/helpers/table.rst

@@ -192,8 +192,8 @@ Spanning Multiple Columns and Rows
 To make a table cell that spans multiple columns you can use a :class:`Symfony\\Component\\Console\\Helper\\TableCell`::
 
     use Symfony\Component\Console\Helper\Table;
-    use Symfony\Component\Console\Helper\TableSeparator;
     use Symfony\Component\Console\Helper\TableCell;
+    use Symfony\Component\Console\Helper\TableSeparator;
 
     $table = new Table($output);
     $table

components/console/logger.rst

@@ -39,8 +39,8 @@ You can rely on the logger to use this dependency inside a command::
     use Acme\MyDependency;
     use Symfony\Component\Console\Command\Command;
     use Symfony\Component\Console\Input\InputInterface;
-    use Symfony\Component\Console\Output\OutputInterface;
     use Symfony\Component\Console\Logger\ConsoleLogger;
+    use Symfony\Component\Console\Output\OutputInterface;
 
     class MyCommand extends Command
     {

components/dependency_injection.rst

@@ -200,8 +200,8 @@ files. To do this you also need to install
 
 Loading an XML config file::
 
-    use Symfony\Component\DependencyInjection\ContainerBuilder;
     use Symfony\Component\Config\FileLocator;
+    use Symfony\Component\DependencyInjection\ContainerBuilder;
     use Symfony\Component\DependencyInjection\Loader\XmlFileLoader;
 
     $containerBuilder = new ContainerBuilder();
@@ -210,8 +210,8 @@ Loading an XML config file::
 
 Loading a YAML config file::
 
-    use Symfony\Component\DependencyInjection\ContainerBuilder;
     use Symfony\Component\Config\FileLocator;
+    use Symfony\Component\DependencyInjection\ContainerBuilder;
     use Symfony\Component\DependencyInjection\Loader\YamlFileLoader;
 
     $containerBuilder = new ContainerBuilder();
@@ -235,8 +235,8 @@ Loading a YAML config file::
 If you *do* want to use PHP to create the services then you can move this
 into a separate config file and load it in a similar way::
 
-    use Symfony\Component\DependencyInjection\ContainerBuilder;
     use Symfony\Component\Config\FileLocator;
+    use Symfony\Component\DependencyInjection\ContainerBuilder;
     use Symfony\Component\DependencyInjection\Loader\PhpFileLoader;
 
     $containerBuilder = new ContainerBuilder();

components/dependency_injection/compilation.rst

@@ -57,10 +57,10 @@ added but are processed when the container's ``compile()`` method is called.
 
 A very simple extension may just load configuration files into the container::
 
+    use Symfony\Component\Config\FileLocator;
     use Symfony\Component\DependencyInjection\ContainerBuilder;
-    use Symfony\Component\DependencyInjection\Loader\XmlFileLoader;
     use Symfony\Component\DependencyInjection\Extension\ExtensionInterface;
-    use Symfony\Component\Config\FileLocator;
+    use Symfony\Component\DependencyInjection\Loader\XmlFileLoader;
 
     class AcmeDemoExtension implements ExtensionInterface
     {
@@ -113,8 +113,8 @@ If this file is loaded into the configuration then the values in it are
 only processed when the container is compiled at which point the Extensions
 are loaded::
 
-    use Symfony\Component\DependencyInjection\ContainerBuilder;
     use Symfony\Component\Config\FileLocator;
+    use Symfony\Component\DependencyInjection\ContainerBuilder;
     use Symfony\Component\DependencyInjection\Loader\YamlFileLoader;
 
     $containerBuilder = new ContainerBuilder();

components/event_dispatcher.rst

@@ -254,8 +254,8 @@ order. Start by creating this custom event class and documenting it::
 
     namespace Acme\Store\Event;
 
-    use Symfony\Component\EventDispatcher\Event;
     use Acme\Store\Order;
+    use Symfony\Component\EventDispatcher\Event;
 
     /**
      * The order.placed event is dispatched each time an order is created
@@ -297,8 +297,8 @@ method notifies all listeners of the given event. It takes two arguments:
 the name of the event to dispatch and the ``Event`` instance to pass to
 each listener of that event::
 
-    use Acme\Store\Order;
     use Acme\Store\Event\OrderPlacedEvent;
+    use Acme\Store\Order;
 
     // the order is somehow created or retrieved
     $order = new Order();
@@ -335,10 +335,10 @@ Take the following example of a subscriber that subscribes to the
 
     namespace Acme\Store\Event;
 
+    use Acme\Store\Event\OrderPlacedEvent;
     use Symfony\Component\EventDispatcher\EventSubscriberInterface;
     use Symfony\Component\HttpKernel\Event\FilterResponseEvent;
     use Symfony\Component\HttpKernel\KernelEvents;
-    use Acme\Store\Event\OrderPlacedEvent;
 
     class StoreSubscriber implements EventSubscriberInterface
     {

components/expression_language/caching.rst

@@ -31,8 +31,8 @@ uses an :class:`Symfony\\Component\\Cache\\Adapter\\ArrayAdapter`). You can
 customize this by creating a custom cache pool or using one of the available
 ones and injecting this using the constructor::
 
-    use Symfony\Component\ExpressionLanguage\ExpressionLanguage;
     use Symfony\Component\Cache\Adapter\RedisAdapter;
+    use Symfony\Component\ExpressionLanguage\ExpressionLanguage;
 
     $cache = new RedisAdapter(...);
     $expressionLanguage = new ExpressionLanguage($cache);

components/form.rst

@@ -90,8 +90,8 @@ object to read data off of the correct PHP superglobals (i.e. ``$_POST`` or
     :class:`Symfony\\Component\\Form\\Extension\\HttpFoundation\\HttpFoundationExtension`
     to your form factory::
 
-        use Symfony\Component\Form\Forms;
         use Symfony\Component\Form\Extension\HttpFoundation\HttpFoundationExtension;
+        use Symfony\Component\Form\Forms;
 
         $formFactory = Forms::createFormFactoryBuilder()
             ->addExtension(new HttpFoundationExtension())
@@ -120,12 +120,12 @@ use the built-in support, first install the Security CSRF component:
 
 The following snippet adds CSRF protection to the form factory::
 
+    use Symfony\Component\Form\Extension\Csrf\CsrfExtension;
     use Symfony\Component\Form\Forms;
     use Symfony\Component\HttpFoundation\Session\Session;
-    use Symfony\Component\Form\Extension\Csrf\CsrfExtension;
-    use Symfony\Component\Security\Csrf\TokenStorage\SessionTokenStorage;
-    use Symfony\Component\Security\Csrf\TokenGenerator\UriSafeTokenGenerator;
     use Symfony\Component\Security\Csrf\CsrfTokenManager;
+    use Symfony\Component\Security\Csrf\TokenGenerator\UriSafeTokenGenerator;
+    use Symfony\Component\Security\Csrf\TokenStorage\SessionTokenStorage;
 
     // creates a Session object from the HttpFoundation component
     $session = new Session();
@@ -181,10 +181,11 @@ that help you render the HTML widget, label and error for each field
 (as well as a few other things). To configure the integration, you'll need
 to bootstrap or access Twig and add the :class:`Symfony\\Bridge\\Twig\\Extension\\FormExtension`::
 
-    use Symfony\Component\Form\Forms;
+
     use Symfony\Bridge\Twig\Extension\FormExtension;
-    use Symfony\Component\Form\FormRenderer;
     use Symfony\Bridge\Twig\Form\TwigRendererEngine;
+    use Symfony\Component\Form\FormRenderer;
+    use Symfony\Component\Form\Forms;
     use Twig\Environment;
     use Twig\Loader\FilesystemLoader;
     use Twig\RuntimeLoader\FactoryRuntimeLoader;
@@ -266,10 +267,10 @@ installed:
 Next, add the :class:`Symfony\\Bridge\\Twig\\Extension\\TranslationExtension`
 to your ``Twig\\Environment`` instance::
 
+    use Symfony\Bridge\Twig\Extension\TranslationExtension;
     use Symfony\Component\Form\Forms;
-    use Symfony\Component\Translation\Translator;
     use Symfony\Component\Translation\Loader\XliffFileLoader;
-    use Symfony\Bridge\Twig\Extension\TranslationExtension;
+    use Symfony\Component\Translation\Translator;
 
     // creates the Translator
     $translator = new Translator('en');
@@ -316,8 +317,8 @@ errors are then mapped to the correct field and rendered.
 
 Your integration with the Validation component will look something like this::
 
-    use Symfony\Component\Form\Forms;
     use Symfony\Component\Form\Extension\Validator\ValidatorExtension;
+    use Symfony\Component\Form\Forms;
     use Symfony\Component\Validator\Validation;
 
     $vendorDirectory = realpath(__DIR__.'/../vendor');

components/http_foundation/session_configuration.rst

@@ -42,8 +42,8 @@ Symfony provides drivers for the following native save handler as an example:
 Example usage::
 
     use Symfony\Component\HttpFoundation\Session\Session;
-    use Symfony\Component\HttpFoundation\Session\Storage\NativeSessionStorage;
     use Symfony\Component\HttpFoundation\Session\Storage\Handler\NativeFileSessionHandler;
+    use Symfony\Component\HttpFoundation\Session\Storage\NativeSessionStorage;
 
     $sessionStorage = new NativeSessionStorage([], new NativeFileSessionHandler());
     $session = new Session($sessionStorage);
@@ -80,8 +80,8 @@ easily serve as examples if you wish to write your own.
 Example usage::
 
     use Symfony\Component\HttpFoundation\Session\Session;
-    use Symfony\Component\HttpFoundation\Session\Storage\NativeSessionStorage;
     use Symfony\Component\HttpFoundation\Session\Storage\Handler\PdoSessionHandler;
+    use Symfony\Component\HttpFoundation\Session\Storage\NativeSessionStorage;
 
     $pdo = new \PDO(...);
     $sessionStorage = new NativeSessionStorage([], new PdoSessionHandler($pdo));

components/http_foundation/session_testing.rst

@@ -40,9 +40,9 @@ For unit testing where it is not necessary to persist the session, you should
 simply swap out the default storage engine with
 :class:`Symfony\\Component\\HttpFoundation\\Session\\Storage\\MockArraySessionStorage`::
 
-    use Symfony\Component\HttpFoundation\Session\Storage\MockArraySessionStorage;
     use Symfony\Component\HttpFoundation\Session\Session;
-
+    use Symfony\Component\HttpFoundation\Session\Storage\MockArraySessionStorage;
+s
     $session = new Session(new MockArraySessionStorage());
 
 Functional Testing

components/ldap.rst

@@ -119,8 +119,8 @@ Creating or Updating Entries
 The Ldap component provides means to create new LDAP entries, update or even
 delete existing ones::
 
-    use Symfony\Component\Ldap\Ldap;
     use Symfony\Component\Ldap\Entry;
+    use Symfony\Component\Ldap\Ldap;
     // ...
 
     $entry = new Entry('cn=Fabien Potencier,dc=symfony,dc=com', [