Merge branch '2.5' into 2.6

weaverryan · weaverryan · commit 564640c95b99 · 2014-12-07T09:41:59.000-05:00
* 2.5: [#4050] Backporting some additions to 2.3 Missing attribute 'original' Fixes concat operator typo Incorporates @wouterj 's suggestion for more realistic usage of bang Changes operator spacing language Adds missing space before return statement Fixes spelling and formatting errors Fixes wrong bullet character Adds bullet addressing bang placement Reverses statement about bang spacing and corresponding examples [RFC] Clarification on formatting for bangs (!) remove first person as per feedback capitalize section title as per feedback instructions for setting SYMFONY_ENV on Heroku for smooth deploys Change: ConsoleTerminateListener => ErrorLoggerListener Removed parameters from service Fix typos in code Conflicts: reference/configuration/framework.rst
diff --git a/best_practices/i18n.rst b/best_practices/i18n.rst
@@ -83,7 +83,7 @@ English in the application would be:
     <!-- app/Resources/translations/messages.en.xliff -->
     <?xml version="1.0"?>
     <xliff version="1.2" xmlns="urn:oasis:names:tc:xliff:document:1.2">
-        <file source-language="en" target-language="en" datatype="plaintext">
+        <file source-language="en" target-language="en" datatype="plaintext" original="file.ext">
             <body>
                 <trans-unit id="1">
                     <source>title.post_list</source>
diff --git a/contributing/code/standards.rst b/contributing/code/standards.rst
@@ -79,14 +79,26 @@ example containing most features described below:
 
             throw new \RuntimeException(sprintf('Unrecognized dummy option "%s"', $dummy));
         }
+        
+        private function reverseBoolean($value = null, $theSwitch = false)
+        {
+            if (!$theSwitch) {
+                return;
+            }
+
+            return !$value;
+        }
     }
 
 Structure
 ---------
 
 * Add a single space after each comma delimiter;
 
-* Add a single space around operators (``==``, ``&&``, ...);
+* Add a single space around binary operators (``==``, ``&&``, ...), with 
+  the exception of the concatenation (``.``) operator;
+
+* Place unary operators (``!``, ``--``, ...) adjacent to the affected variable;
 
 * Add a comma after each array item in a multi-line array, even after the
   last one;
diff --git a/cookbook/console/logging.rst b/cookbook/console/logging.rst
@@ -190,7 +190,7 @@ First configure a listener for console terminate events in the service container
         # app/config/services.yml
         services:
             kernel.listener.command_dispatch:
-                class: Acme\DemoBundle\EventListener\ConsoleTerminateListener
+                class: Acme\DemoBundle\EventListener\ErrorLoggerListener
                 arguments:
                     logger: "@logger"
                 tags:
@@ -204,12 +204,8 @@ First configure a listener for console terminate events in the service container
                    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
                    xsi:schemaLocation="http://symfony.com/schema/dic/services http://symfony.com/schema/dic/services/services-1.0.xsd">
 
-            <parameters>
-                <parameter key="console_exception_listener.class">Acme\DemoBundle\EventListener\ConsoleExceptionListener</parameter>
-            </parameters>
-
             <services>
-                <service id="kernel.listener.command_dispatch" class="%console_exception_listener.class%">
+                <service id="kernel.listener.command_dispatch" class="Acme\DemoBundle\EventListener\ErrorLoggerListener">
                     <argument type="service" id="logger"/>
                     <tag name="kernel.event_listener" event="console.terminate" />
                 </service>
@@ -222,32 +218,28 @@ First configure a listener for console terminate events in the service container
         use Symfony\Component\DependencyInjection\Definition;
         use Symfony\Component\DependencyInjection\Reference;
 
-        $container->setParameter(
-            'console_exception_listener.class',
-            'Acme\DemoBundle\EventListener\ConsoleExceptionListener'
-        );
-        $definitionConsoleExceptionListener = new Definition(
-            '%console_exception_listener.class%',
+        $definitionErrorLoggerListener = new Definition(
+            'Acme\DemoBundle\EventListener\ErrorLoggerListener',
             array(new Reference('logger'))
         );
-        $definitionConsoleExceptionListener->addTag(
+        $definitionErrorLoggerListener->addTag(
             'kernel.event_listener',
             array('event' => 'console.terminate')
         );
         $container->setDefinition(
             'kernel.listener.command_dispatch',
-            $definitionConsoleExceptionListener
+            $definitionErrorLoggerListener
         );
 
 Then implement the actual listener::
 
-    // src/Acme/DemoBundle/EventListener/ConsoleExceptionListener.php
+    // src/Acme/DemoBundle/EventListener/ErrorLoggerListener.php
     namespace Acme\DemoBundle\EventListener;
 
     use Symfony\Component\Console\Event\ConsoleTerminateEvent;
     use Psr\Log\LoggerInterface;
 
-    class ConsoleExceptionListener
+    class ErrorLoggerListener
     {
         private $logger;
 
diff --git a/cookbook/deployment/heroku.rst b/cookbook/deployment/heroku.rst
@@ -71,8 +71,9 @@ Deploying your Application on Heroku
 
 To deploy your application to Heroku, you must first create a ``Procfile``,
 which tells Heroku what command to use to launch the web server with the
-correct settings. After you've done that, you can simply ``git push`` and
-you're done!
+correct document root. After that, you will ensure that your Symfony application
+runs the ``prod`` environment, and then you'll be ready to ``git push`` to
+Heroku for your first deploy!
 
 Creating a Procfile
 ~~~~~~~~~~~~~~~~~~~
@@ -110,6 +111,27 @@ create the ``Procfile`` file and to add it to the repository:
     [master 35075db] Procfile for Apache and PHP
      1 file changed, 1 insertion(+)
 
+Setting the ``prod`` Environment
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+During a deploy, Heroku runs ``composer install --no-dev`` to install all of the
+dependencies your application requires. However, typical `post-install-commands`_
+in ``composer.json``, e.g. to install assets or clear (or pre-warm) caches, run
+using Symfony's ``dev`` environment by default.
+
+This is clearly not what you want - the app runs in "production" (even if you
+use it just for an experiment, or as a staging environment), and so any build
+steps should use the same ``prod`` environment as well.
+
+Thankfully, the solution to this problem is very simple: Symfony will pick up an
+environment variable named ``SYMFONY_ENV`` and use that environment if nothing
+else is explicitly set. As Heroku exposes all `config vars`_ as environment
+variables, you can issue a single command to prepare your app for a deployment:
+
+.. code-block:: bash
+
+    $ heroku config:set SYMFONY_ENV=prod
+
 Pushing to Heroku
 ~~~~~~~~~~~~~~~~~
 
@@ -193,3 +215,5 @@ You should be seeing your Symfony application in your browser.
 .. _`ephemeral file system`: https://devcenter.heroku.com/articles/dynos#ephemeral-filesystem
 .. _`Logplex`: https://devcenter.heroku.com/articles/logplex
 .. _`verified that the RSA key fingerprint is correct`: https://devcenter.heroku.com/articles/git-repository-ssh-fingerprints
+.. _`post-install-commands`: https://getcomposer.org/doc/articles/scripts.md
+.. _`config vars`: https://devcenter.heroku.com/articles/config-vars
