Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly
Appearance settings

Commit 2881fb6

Browse filesBrowse files
wouterjwouterj
committed
Merge branch '2.3' into 2.7
Conflicts: reference/forms/types/entity.rst reference/twig_reference.rst
2 parents 88052f7 + cb91d7d commit 2881fb6
Copy full SHA for 2881fb6

File tree

Expand file treeCollapse file tree

9 files changed

+307
-19
lines changed
Filter options
Expand file treeCollapse file tree

9 files changed

+307
-19
lines changed

‎book/forms.rst

Copy file name to clipboardExpand all lines: book/forms.rst
+3-9Lines changed: 3 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -260,21 +260,15 @@ possible paths:
260260
#. When initially loading the page in a browser, the form is simply created and
261261
rendered. :method:`Symfony\\Component\\Form\\FormInterface::handleRequest`
262262
recognizes that the form was not submitted and does nothing.
263-
:method:`Symfony\\Component\\Form\\FormInterface::isValid` returns ``false``
263+
:method:`Symfony\\Component\\Form\\FormInterface::isSubmitted` returns ``false``
264264
if the form was not submitted.
265265

266266
#. When the user submits the form, :method:`Symfony\\Component\\Form\\FormInterface::handleRequest`
267267
recognizes this and immediately writes the submitted data back into the
268268
``task`` and ``dueDate`` properties of the ``$task`` object. Then this object
269269
is validated. If it is invalid (validation is covered in the next section),
270-
:method:`Symfony\\Component\\Form\\FormInterface::isValid` returns ``false``
271-
again, so the form is rendered together with all validation errors;
272-
273-
.. note::
274-
275-
You can use the method :method:`Symfony\\Component\\Form\\FormInterface::isSubmitted`
276-
to check whether a form was submitted, regardless of whether or not the
277-
submitted data is actually valid.
270+
:method:`Symfony\\Component\\Form\\FormInterface::isValid` returns
271+
``false``, so the form is rendered together with all validation errors;
278272

279273
#. When the user submits the form with valid data, the submitted data is again
280274
written into the form, but this time :method:`Symfony\\Component\\Form\\FormInterface::isValid`

‎components/dependency_injection/factories.rst

Copy file name to clipboardExpand all lines: components/dependency_injection/factories.rst
+1-1Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -57,7 +57,7 @@ configure the service container to use the
5757
<factory class="NewsletterManagerFactory" method="createNewsletterManager" />
5858
</service>
5959
</services>
60-
</services>
60+
</container>
6161
6262
.. code-block:: php
6363

‎cookbook/console/logging.rst

Copy file name to clipboardExpand all lines: cookbook/console/logging.rst
+2-4Lines changed: 2 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -86,8 +86,7 @@ First configure a listener for console exception events in the service container
8686
services:
8787
kernel.listener.command_dispatch:
8888
class: AppBundle\EventListener\ConsoleExceptionListener
89-
arguments:
90-
logger: '@logger'
89+
arguments: ['@logger']
9190
tags:
9291
- { name: kernel.event_listener, event: console.exception }
9392
@@ -184,8 +183,7 @@ First configure a listener for console terminate events in the service container
184183
services:
185184
kernel.listener.command_dispatch:
186185
class: AppBundle\EventListener\ErrorLoggerListener
187-
arguments:
188-
logger: '@logger'
186+
arguments: ['@logger']
189187
tags:
190188
- { name: kernel.event_listener, event: console.terminate }
191189

‎cookbook/deployment/fortrabbit.rst

Copy file name to clipboard
+285Lines changed: 285 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,285 @@
1+
.. index::
2+
single: Deployment; Deploying to fortrabbit.com
3+
4+
Deploying to fortrabbit
5+
=======================
6+
7+
This step-by-step cookbook describes how to deploy a Symfony web application to
8+
`fortrabbit`_. You can read more about using Symfony with fortrabbit on the
9+
official fortrabbit `Symfony install guide`_.
10+
11+
Setting up fortrabbit
12+
---------------------
13+
14+
Before getting started, you should have done a few things on the fortrabbit side:
15+
16+
* `Sign up`_;
17+
* Add an SSH key to your Account (to deploy via Git);
18+
* Create an App.
19+
20+
Preparing your Application
21+
--------------------------
22+
23+
You don't need to change any code to deploy a Symfony application to fortrabbit.
24+
But it requires some minor tweaks to its configuration.
25+
26+
Configure Logging
27+
~~~~~~~~~~~~~~~~~
28+
29+
Per default Symfony logs to a file. Modify the ``app/config/config_prod.yml`` file
30+
to redirect it to :phpfunction:`error_log`:
31+
32+
.. configuration-block::
33+
34+
.. code-block:: yaml
35+
36+
# app/config/config_prod.yml
37+
monolog:
38+
# ...
39+
handlers:
40+
nested:
41+
type: error_log
42+
43+
.. code-block:: xml
44+
45+
<!-- app/config/config_prod.xml -->
46+
<?xml version="1.0" encoding="UTF-8" ?>
47+
<container xmlns="http://symfony.com/schema/dic/services"
48+
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
49+
xmlns:monolog="http://symfony.com/schema/dic/monolog"
50+
xsi:schemaLocation="http://symfony.com/schema/dic/services
51+
http://symfony.com/schema/dic/services/services-1.0.xsd
52+
http://symfony.com/schema/dic/monolog
53+
http://symfony.com/schema/dic/monolog/monolog-1.0.xsd">
54+
55+
<monolog:config>
56+
<!-- ... -->
57+
<monolog:handler name="nested" type="error_log" />
58+
</monolog:config>
59+
</container>
60+
61+
.. code-block:: php
62+
63+
// app/config/config_prod.php
64+
$container->loadFromExtension('monolog', array(
65+
// ...
66+
'handlers' => array(
67+
'nested' => array(
68+
'type' => 'error_log',
69+
),
70+
),
71+
));
72+
73+
Configuring Database Access & Session Handler
74+
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
75+
76+
You can use the fortrabbit App Secrets to attain your database credentials.
77+
Create the file ``app/config/config_prod_secrets.php`` with the following
78+
contents::
79+
80+
// get the path to the secrects.json file
81+
$secrets = getenv("APP_SECRETS")
82+
if (!$secrets) {
83+
return;
84+
}
85+
86+
// read the file and decode json to an array
87+
$secrets = json_decode(file_get_contents($secrets), true);
88+
89+
// set database parameters to the container
90+
if (isset($secrets['MYSQL'])) {
91+
$container->setParameter('database_driver', 'pdo_mysql');
92+
$container->setParameter('database_host', $secrets['MYSQL']['HOST']);
93+
$container->setParameter('database_name', $secrets['MYSQL']['DATABASE']);
94+
$container->setParameter('database_user', $secrets['MYSQL']['USER']);
95+
$container->setParameter('database_password', $secrets['MYSQL']['PASSWORD']);
96+
}
97+
98+
// check if the Memcache component is present
99+
if (isset($secrets['MEMCACHE'])) {
100+
$memcache = $secrets['MEMCACHE'];
101+
$handlers = [];
102+
103+
foreach (range(1, $memcache['COUNT']) as $num) {
104+
$handlers[] = $memcache['HOST'.$num].':'.$memcache['PORT'.$num];
105+
}
106+
107+
// apply ini settings
108+
ini_set('session.save_handler', 'memcached');
109+
ini_set('session.save_path', implode(',', $handlers));
110+
111+
if ("2" === $memcache['COUNT']) {
112+
ini_set('memcached.sess_number_of_replicas', 1);
113+
ini_set('memcached.sess_consistent_hash', 1);
114+
ini_set('memcached.sess_binary', 1);
115+
}
116+
}
117+
118+
Make sure this file is imported into the main config file:
119+
120+
.. configuration-block::
121+
122+
.. code-block:: yaml
123+
124+
# app/config/config_prod.yml
125+
imports:
126+
- { resource: config.yml }
127+
- { resource: config_prod_secrets.php }
128+
129+
# ..
130+
framework:
131+
session:
132+
# set handler_id to null to use default session handler from php.ini (memcached)
133+
handler_id: ~
134+
# ..
135+
136+
.. code-block:: xml
137+
138+
<!-- app/config/config_prod.xml -->
139+
<?xml version="1.0" encoding="UTF-8"?>
140+
<container xmlns="http://symfony.com/schema/dic/services"
141+
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
142+
xmlns:framework="http://symfony.com/schema/dic/symfony"
143+
xsi:schemaLocation="http://symfony.com/schema/dic/services http://symfony.com/schema/dic/services/services-1.0.xsd
144+
http://symfony.com/schema/dic/symfony http://symfony.com/schema/dic/symfony/symfony-1.0.xsd">
145+
146+
<imports>
147+
<import resource="config.xml" />
148+
<import resource="config_prod_secrets.php" />
149+
</imports>
150+
151+
<!-- .. -->
152+
<framework:config>
153+
<!-- .. -->
154+
<framework:session save_path="null" />
155+
</framework:config>
156+
</container>
157+
158+
.. code-block:: php
159+
160+
// app/config/config_prod.php
161+
$loader->import('config/config.php');
162+
$loader->import('config_prod_secrets.php');
163+
164+
$container->loadFromExtension('framework', array(
165+
'session' => array(
166+
'handler_id' => null,
167+
),
168+
));
169+
170+
// ...
171+
172+
Configuring the Environment in the Dashboard
173+
--------------------------------------------
174+
175+
PHP Settings
176+
~~~~~~~~~~~~
177+
178+
The PHP version and enabled extensions are configuable under the PHP settings
179+
of your App within the fortrabbit Dashboard.
180+
181+
Environment Variables
182+
~~~~~~~~~~~~~~~~~~~~~
183+
184+
Set the ``SYMFONY_ENV`` environment variable to ``prod`` to make sure the right
185+
config files get loaded. ENV vars are configuable in fortrabbit Dashboard as well.
186+
187+
Document Root
188+
~~~~~~~~~~~~~
189+
190+
The document root is configuable for every custom domain you setup for your App.
191+
The default is ``/htdocs``, but for Symfony you probably want to change it to
192+
``/htdocs/web``. You also do so in the fortrabbit Dashboard under ``Domain`` settings.
193+
194+
Deploying to fortrabbit
195+
-----------------------
196+
197+
It is assumed that your codebase is under version-control with Git and dependencies
198+
are managed with Composer (locally).
199+
200+
Every time you push to fortrabbit composer install runs before your code gets
201+
deployed. To finetune the deployment behavior put a `fortrabbit.yml`_. deployment
202+
file (optional) in the project root.
203+
204+
Add fortrabbit as a (additional) Git remote and add your configuration changes:
205+
206+
.. code-block:: bash
207+
208+
$ git remote add fortrabbit git@deploy.eu2.frbit.com:<your-app>.git
209+
$ git add composer.json composer.lock
210+
$ git add app/config/config_prod_secrets.php
211+
212+
Commit and push
213+
214+
.. code-block:: bash
215+
216+
$ git commit -m 'fortrabbit config'
217+
$ git push fortrabbit master -u
218+
219+
.. note::
220+
221+
Replace ``<your-app>`` with the name of your fortrabbit App.
222+
223+
.. code-block:: bash
224+
225+
Commit received, starting build of branch master
226+
227+
––––––––––––––––––––––– ∙ƒ –––––––––––––––––––––––
228+
229+
B U I L D
230+
231+
Checksum:
232+
def1bb29911a62de26b1ddac6ef97fc76a5c647b
233+
234+
Deployment file:
235+
fortrabbit.yml
236+
237+
Pre-script:
238+
not found
239+
0ms
240+
241+
Composer:
242+
- - -
243+
Loading composer repositories with package information
244+
Installing dependencies (including require-dev) from lock file
245+
Nothing to install or update
246+
Generating autoload files
247+
248+
- - -
249+
172ms
250+
251+
Post-script:
252+
not found
253+
0ms
254+
255+
R E L E A S E
256+
257+
Packaging:
258+
930ms
259+
260+
Revision:
261+
1455788127289043421.def1bb29911a62de26b1ddac6ef97fc76a5c647b
262+
263+
Size:
264+
9.7MB
265+
266+
Uploading:
267+
500ms
268+
269+
Build & release done in 1625ms, now queued for final distribution.
270+
271+
272+
.. note::
273+
274+
The first ``git push`` takes much longer as all composer dependencies get
275+
downloaded. All subsequent deploys are done within seconds.
276+
277+
That's it! Your application is being deployed on fortrabbit. More information
278+
about `database migrations and tunneling`_ can be found in the fortrabbit
279+
documentation.
280+
281+
.. _`fortrabbit`: https://www.fortrabbit.com
282+
.. _`Symfony install guide`: https://help.fortrabbit.com/install-symfony
283+
.. _`fortrabbit.yml`: https://help.fortrabbit.com/deployment-file-v2
284+
.. _`database migrations and tunneling`: https://help.fortrabbit.com/install-symfony-2#toc-migrate-amp-other-database-commands
285+
.. _`Sign up`: https://dashboard.fortrabbit.com

‎cookbook/deployment/index.rst

Copy file name to clipboardExpand all lines: cookbook/deployment/index.rst
+1Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,3 +8,4 @@ Deployment
88
azure-website
99
heroku
1010
platformsh
11+
fortrabbit

‎cookbook/doctrine/reverse_engineering.rst

Copy file name to clipboardExpand all lines: cookbook/doctrine/reverse_engineering.rst
+4-3Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -99,10 +99,11 @@ The first command generates entity classes with annotation mappings. But
9999
if you want to use YAML or XML mapping instead of annotations, you should
100100
execute the second command only.
101101

102-
.. tip::
102+
.. caution::
103103

104-
If you want to use annotations, you can safely delete the XML (or YAML) files
105-
after running these two commands.
104+
If you want to use annotations, you must remove the XML (or YAML) files
105+
after running these two commands. This is necessary as
106+
:ref:`it is not possible to mix mapping configuration formats <book-doctrine-adding-mapping>`
106107

107108
For example, the newly created ``BlogComment`` entity class looks as follow::
108109

‎cookbook/map.rst.inc

Copy file name to clipboardExpand all lines: cookbook/map.rst.inc
+1Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -66,6 +66,7 @@
6666
* :doc:`/cookbook/deployment/azure-website`
6767
* :doc:`/cookbook/deployment/heroku`
6868
* :doc:`/cookbook/deployment/platformsh`
69+
* :doc:`/cookbook/deployment/fortrabbit`
6970

7071
* :doc:`/cookbook/doctrine/index`
7172

‎cookbook/security/form_login_setup.rst

Copy file name to clipboardExpand all lines: cookbook/security/form_login_setup.rst
+1-1Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -297,7 +297,7 @@ When setting up your login form, watch out for a few common pitfalls.
297297
~~~~~~~~~~~~~~~~~~~~~~~~~~~~
298298

299299
First, be sure that you've defined the ``/login`` route correctly and that
300-
it corresponds to the ``login_path`` and``check_path`` config values.
300+
it corresponds to the ``login_path`` and ``check_path`` config values.
301301
A misconfiguration here can mean that you're redirected to a 404 page instead
302302
of the login page, or that submitting the login form does nothing (you just see
303303
the login form over and over again).

0 commit comments

Comments
0 (0)
Morty Proxy This is a proxified and sanitized view of the page, visit original site.