10000 Merge branch '4.1' · symfony/symfony-docs@16c0ee7 · GitHub
[go: up one dir, main page]
Skip to content

Commit 16c0ee7

Browse files
javiereguiluzjaviereguiluz
committed
Merge branch '4.1'
* 4.1: Fixed Encore dir paths Change the public folder to web for 3.4 Updated KnpUniversity links to SymfonyCasts correct a typo in a namespace loading There is no public folder in 3.4 Fixed the link to Functional Tests Update templating.rst Update doctrine.rst Shorten Twig ternary expression [Serializer] Cache the normalizer to use when possible
2 parents e08cac0 + 088e659 commit 16c0ee7

15 files changed

+57
-25
lines changed

‎bundles/extension.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -32,8 +32,8 @@ This is how the extension of an AcmeHelloBundle should look like::
3232
// src/Acme/HelloBundle/DependencyInjection/AcmeHelloExtension.php
3333
namespace Acme\HelloBundle\DependencyInjection;
3434

35-
use Symfony\Component\HttpKernel\DependencyInjection\Extension;
3635
use Symfony\Component\DependencyInjection\ContainerBuilder;
36+
use Symfony\Component\DependencyInjection\Extension\Extension;
3737

3838
class AcmeHelloExtension extends Extension
3939
{

‎components/serializer.rst

Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1317,6 +1317,32 @@ can use this simpler configuration:
13171317
</class>
13181318
</serializer>
13191319
1320+
Performance
1321+
-----------
1322+
1323+
To figure which normalizer (or denormalizer) must be used to handle an object,
1324+
the :class:`Symfony\\Component\\Serializer\\Serializer` class will call the
1325+
:method:`Symfony\\Component\\Serializer\\Normalizer\\NormalizerInterface::supportsNormalization`
1326+
(or :method:`Symfony\\Component\\Serializer\\Normalizer\\DenormalizerInterface::supportsDenormalization`)
1327+
of all registered normalizers (or denormalizers) in a loop.
1328+
1329+
The result of these methods can vary depending on the object to serialize, the
1330+
format and the context. That's why the result **is not cached** by default and
1331+
can result in a significant performance bottleneck.
1332+
1333+
However, most normalizers (and denormalizers) always return the same result when
1334+
the object's type and the format are the same, so the result can be cached. To
1335+
do so, make those normalizers (and denormalizers) implement the
1336+
:class:`Symfony\\Component\\Serializer\\Normalizer\\CacheableSupportsMethodInterface`
1337+
and return ``true`` when
1338+
:method:`Symfony\\Component\\Serializer\\Normalizer\\CacheableSupportsMethodInterface::hasCacheableSupportsMethod`
1339+
is called.
1340+
1341+
.. note::
1342+
1343+
All built-in :ref:`normalizers and denormalizers <component-serializer-normalizers>`
1344+
as well the ones included in `API Platform`_ natively implement this interface.
1345+
13201346
Learn more
13211347
----------
13221348

@@ -1326,6 +1352,11 @@ Learn more
13261352

13271353
/serializer
13281354

1355+
.. seealso::
1356+
1357+
Normalizers for the Symfony Serializer Component supporting popular web API formats
1358+
(JSON-LD, GraphQL, HAL and JSONAPI) are available as part of the `API Platform`_ project.
1359+
13291360
.. seealso::
13301361

13311362
A popular alternative to the Symfony Serializer Component is the third-party
@@ -1342,3 +1373,4 @@ Learn more
13421373
.. _CSV: https://tools.ietf.org/html/rfc4180
13431374
.. _`RFC 7807`: https://tools.ietf.org/html/rfc7807
13441375
.. _`Value Objects`: https://en.wikipedia.org/wiki/Value_object
1376+
.. _`API Platform`: https://api-platform.com

‎doctrine.rst

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -162,10 +162,11 @@ Woh! You now have a new ``src/Entity/Product.php`` file::
162162

163163
.. caution::
164164

165-
MySQL sets a `limit of 767 bytes for the index key prefix`_. When using
166-
``utf8mb4``, string columns with 255 character length surpass that limit.
167-
This means that any column of type ``string`` and ``unique=true`` must
168-
set its maximum ``length`` to ``190``. Otherwise, you'll see this error:
165+
There is a `limit of 767 bytes for the index key prefix`_ when using
166+
InnoDB tables in MySQL 5.6 and earlier versions. String columns with 255
167+
character length and ``utf8mb4`` encoding surpass that limit. This means
168+
that any column of type ``string`` and ``unique=true`` must set its
169+
maximum ``length`` to ``190``. Otherwise, you'll see this error:
169170
*"[PDOException] SQLSTATE[42000]: Syntax error or access violation:
170171
1071 Specified key was too long; max key length is 767 bytes"*.
171172

@@ -756,4 +757,4 @@ Learn more
756757
.. _`SensioFrameworkExtraBundle`: http://symfony.com/doc/current/bundles/SensioFrameworkExtraBundle/index.html
757758
.. _`ParamConverter`: http://symfony.com/doc/current/bundles/SensioFrameworkExtraBundle/annotations/converters.html
758759
.. _`limit of 767 bytes for the index key prefix`: https://dev.mysql.com/doc/refman/5.6/en/innodb-restrictions.html
759-
.. _`Doctrine screencast series`: https://knpuniversity.com/screencast/symfony-doctrine
760+
.. _`Doctrine screencast series`: https://symfonycasts.com/screencast/symfony-doctrine

‎doctrine/associations.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -594,4 +594,4 @@ Doctrine's `Association Mapping Documentation`_.
594594

595595
.. _`Association Mapping Documentation`: http://docs.doctrine-project.org/projects/doctrine-orm/en/latest/reference/association-mapping.html
596596
.. _`orphanRemoval`: http://docs.doctrine-project.org/projects/doctrine-orm/en/latest/reference/working-with-associations.html#orphan-removal
597-
.. _`Mastering Doctrine Relations`: https://knpuniversity.com/screencast/doctrine-relations
597+
.. _`Mastering Doctrine Relations`: https://symfonycasts.com/screencast/doctrine-relations

‎forms.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -719,4 +719,4 @@ Learn more
719719

720720
.. _`Symfony Form component`: https://github.com/symfony/form
721721
.. _`DateTime`: https://php.net/manual/en/class.datetime.php
722-
.. _`Symfony Forms screencast series`: https://knpuniversity.com/screencast/symfony-forms
722+
.. _`Symfony Forms screencast series`: https://symfonycasts.com/screencast/symfony-forms

‎frontend.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -106,4 +106,4 @@ Other Front-End Articles
106106
.. _`Mix`: https://laravel.com/docs/mix
107107
.. _`Symfony`: http://symfony.com/
108108
.. _`Full API`: https://github.com/symfony/webpack-encore/blob/master/index.js
109-
.. _`Webpack Encore screencast series`: https://knpuniversity.com/screencast/webpack-encore
109+
.. _`Webpack Encore screencast series`: https://symfonycasts.com/screencast/webpack-encore

‎frontend/encore/installation-no-flex.rst

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ Install Encore into your project via Yarn:
1717
1818
.. note::
1919

20-
If you prefer to use `npm`_, no problem! Run ``npm install @symfony/webpack-encore --save-dev``.
20+
If you prefer to use `npm`_, no problem! Run ``npm install @symfony/webpack-encore --save-dev``.
2121

2222
This command creates (or modifies) a ``package.json`` file and downloads dependencies
2323
into a ``node_modules/`` directory. Yarn also creates/updates a ``yarn.lock``
@@ -81,9 +81,9 @@ import some JavaScript:
8181
.. code-block:: javascript
8282
8383
// assets/js/app.js
84-
84+
8585
require('../css/app.css');
86-
86+
8787
console.log('Hello Webpack Encore');
8888
8989
And the new ``assets/css/app.css`` file:

‎frontend/encore/server-data.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,7 @@ method that returns an array, you could do the following:
3535

3636
.. code-block:: twig
3737
38-
<div data-user-profile="{{ app.user ? app.user.profileData|json_encode|e('html_attr') : '' }}">
38+
<div data-user-profile="{{ app.user ? app.user.profileData|json_encode|e('html_attr') }}">
3939
<!-- ... -->
4040
</div>
4141

‎frontend/encore/simple-example.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -158,8 +158,8 @@ To import values, use ``import``:
158158
// assets/js/app.js
159159
- var $ = require('jquery');
160160
+ import $ from 'jquery';
161-
162-
- require('../css/app.css');
161+
162+
- require('../css/app.css');
163163
+ import '../css/app.css';
164164
165165
.. _multiple-javascript-entries:

‎page_creation.rst

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -196,8 +196,8 @@ One of Symfony's *killer* features is the Web Debug Toolbar: a bar that displays
196196
a *huge* amount of debugging information along the bottom of your page while developing. This is all
197197
included out of the box using a package called ``symfony/profiler-pack``.
198198

199-
You will see a black bar along the bottom of the page. You'll learn more about all the information it holds
200-
along the way, but feel free to experiment: hover over and click
199+
You will see a black bar along the bottom of the page. You'll learn more about all the information it holds
200+
along the way, but feel free to experiment: hover over and click
201201
the different icons to get information about routing, performance, logging and more.
202202

203203
Rendering a Template
@@ -342,5 +342,5 @@ Go Deeper with HTTP & Framework Fundamentals
342342

343343
.. _`Twig`: https://twig.symfony.com
344344
.. _`Composer`: https://getcomposer.org
345-
.. _`Stellar Development with Symfony`: https://knpuniversity.com/screencast/symfony/setup
345+
.. _`Stellar Development with Symfony`: https://symfonycasts.com/screencast/symfony/setup
346346
.. _`Flex recipes`: https://flex.symfony.com

‎security.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1348,4 +1348,4 @@ Other Security Related Topics
13481348
.. _`frameworkextrabundle documentation`: https://symfony.com/doc/current/bundles/SensioFrameworkExtraBundle/index.html
13491349
.. _`HWIOAuthBundle`: https://github.com/hwi/HWIOAuthBundle
13501350
.. _`Symfony ACL bundle`: https://github.com/symfony/acl-bundle
1351-
.. _`Symfony Security screencast series`: https://knpuniversity.com/screencast/symfony-security
1351+
.. _`Symfony Security screencast series`: https://symfonycasts.com/screencast/symfony-security

‎service_container.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1069,4 +1069,4 @@ Learn more
10691069
.. _`service-oriented architecture`: https://en.wikipedia.org/wiki/Service-oriented_architecture
10701070
.. _`Symfony Standard Edition (version 3.3) services.yaml`: https://github.com/symfony/symfony-standard/blob/3.3/app/config/services.yml
10711071
.. _`glob pattern`: https://en.wikipedia.org/wiki/Glob_(programming)
1072-
.. _`Symfony Fundamentals screencast series`: https://knpuniversity.com/screencast/symfony-fundamentals
1072+
.. _`Symfony Fundamentals screencast series`: https://symfonycasts.com/screencast/symfony-fundamentals

‎setup.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -159,7 +159,7 @@ Go Deeper with Setup
159159
setup/composer
160160
setup/*
161161

162-
.. _`Stellar Development with Symfony`: http://knpuniversity.com/screencast/symfony
162+
.. _`Stellar Development with Symfony`: http://symfonycasts.com/screencast/symfony
163163
.. _`Composer`: https://getcomposer.org/
164164
.. _`technical requirements`: https://symfony.com/doc/current/reference/requirements.html
165165
.. _`The Symfony Demo application`: https://github.com/symfony/symfony-demo

‎templating.rst

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -404,9 +404,8 @@ ease the work of the template designer. In PHP, the templating system provides
404404
an extensible *helper* system that provides useful features in a template
405405
context.
406406

407-
You've already seen a few built-in Twig tags (``{% block %}`` & ``{% extends %}``)
408-
as well as an example of a PHP helper (``$view['slots']``). Here you will learn a
409-
few more.
407+
You've already seen a few built-in Twig tags like ``{% block %}`` and
408+
``{% extends %}``. Here you will learn a few more.
410409

411410
.. index::
412411
single: Templating; Including other templates

‎testing.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -47,7 +47,7 @@ Unit Tests
4747

4848
A unit test is a test against a single PHP class, also called a *unit*. If you
4949
want to test the overall behavior of your application, see the section about
50-
`Functional Tests`_.
50+
:ref:`Functional Tests <functional-tests>`.
5151

5252
Writing Symfony unit tests is no different from writing standard PHPUnit
5353
unit tests. Suppose, for example, that you have an *incredibly* simple class

0 commit comments

Comments
 (0)
0