Skip to content

Commit

Permalink
Merge branch '2.4' into 2.5
Browse files Browse the repository at this point in the history
* 2.4:
  $this->request replaced by $request
  Security] [Custom Provider] Use properties on WebserviceUser
  Use getters on WebserviceUser
  removed one space
  Update submit.rst
  Also apply it for .rst.inc files
  Fixed a minor syntax error
  Added editorconfig
  apply headline guidelines to the cookbook articles
  link to the deployment index
  remove "..." from XML element tags
  quote YAML strings starting with % or @ characters
  • Loading branch information
weaverryan committed Jul 29, 2014
2 parents ffa4360 + 7c98ac7 commit 1c948c8
Show file tree
Hide file tree
Showing 109 changed files with 261 additions and 250 deletions.
8 changes: 8 additions & 0 deletions .editorconfig
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
root = true

[*.{rst,rst.inc}]
indent_style = space
indent_size = 2
charset = utf-8
trim_trailing_whitespace = true
insert_final_newline = true
2 changes: 1 addition & 1 deletion book/forms.rst
Original file line number Diff line number Diff line change
Expand Up @@ -1675,7 +1675,7 @@ file:
xsi:schemaLocation="http://symfony.com/schema/dic/services http://symfony.com/schema/dic/services/services-1.0.xsd
http://symfony.com/schema/dic/symfony http://symfony.com/schema/dic/symfony/symfony-1.0.xsd">
<framework:config ...>
<framework:config>
<framework:templating>
<framework:form>
<framework:resource>AcmeTaskBundle:Form</framework:resource>
Expand Down
6 changes: 3 additions & 3 deletions book/http_cache.rst
Original file line number Diff line number Diff line change
Expand Up @@ -862,13 +862,13 @@ First, to use ESI, be sure to enable it in your application configuration:
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns:framework="http://symfony.com/schema/dic/symfony"
xsi:schemaLocation="http://symfony.com/schema/dic/services http://symfony.com/schema/dic/services/services-1.0.xsd
http://symfony.com/schema/dic/symfony http://symfony.com/schema/dic/symfony/symfony-1.0.xsd">
http://symfony.com/schema/dic/symfony
http://symfony.com/schema/dic/symfony/symfony-1.0.xsd">
<framework:config ...>
<framework:config>
<!-- ... -->
<framework:esi enabled="true" />
</framework:config>
</container>
.. code-block:: php
Expand Down
2 changes: 1 addition & 1 deletion book/internals.rst
Original file line number Diff line number Diff line change
Expand Up @@ -644,7 +644,7 @@ If you enable the web profiler, you also need to mount the profiler routes:
.. code-block:: yaml
_profiler:
resource: @WebProfilerBundle/Resources/config/routing/profiler.xml
resource: "@WebProfilerBundle/Resources/config/routing/profiler.xml"
prefix: /_profiler
.. code-block:: xml
Expand Down
6 changes: 3 additions & 3 deletions book/service_container.rst
Original file line number Diff line number Diff line change
Expand Up @@ -588,7 +588,7 @@ the service container gives you a much more appealing option:
</parameters>
<services>
<service id="my_mailer" ...>
<service id="my_mailer">
<!-- ... -->
</service>
<service id="newsletter_manager" class="%newsletter_manager.class%">
Expand Down Expand Up @@ -794,7 +794,7 @@ Injecting the dependency by the setter method just needs a change of syntax:
</parameters>
<services>
<service id="my_mailer" ...>
<service id="my_mailer">
<!-- ... -->
</service>
<service id="newsletter_manager" class="%newsletter_manager.class%">
Expand Down Expand Up @@ -960,7 +960,7 @@ it exists and do nothing if it doesn't:
xsi:schemaLocation="http://symfony.com/schema/dic/services http://symfony.com/schema/dic/services/services-1.0.xsd">
<services>
<service id="my_mailer" ...>
<service id="my_mailer">
<!-- ... -->
</service>
<service id="newsletter_manager" class="%newsletter_manager.class%">
Expand Down
2 changes: 1 addition & 1 deletion components/dependency_injection/configurators.rst
Original file line number Diff line number Diff line change
Expand Up @@ -156,7 +156,7 @@ The service config for the above classes would look something like this:
.. code-block:: xml
<services>
<service id="my_mailer" ...>
<service id="my_mailer">
<!-- ... -->
</service>
<service id="email_formatter_manager" class="EmailFormatterManager">
Expand Down
11 changes: 5 additions & 6 deletions contributing/documentation/standards.rst
Original file line number Diff line number Diff line change
Expand Up @@ -146,12 +146,11 @@ Language Standards
point of view: use the second instead);
* When referencing a hypothetical person, such as "a user with a session cookie", gender-neutral
pronouns (they/their/them) should be used. For example, instead of:

* he or she, use they
* him or her, use them
* his or her, use their
* his or hers, use theirs
* himself or herself, use themselves
* he or she, use they
* him or her, use them
* his or her, use their
* his or hers, use theirs
* himself or herself, use themselves

.. _`the Sphinx documentation`: http://sphinx-doc.org/rest.html#source-code
.. _`Twig Coding Standards`: http://twig.sensiolabs.org/doc/coding_standards.html
Expand Down
10 changes: 5 additions & 5 deletions cookbook/assetic/apply_to_option.rst
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
.. index::
single: Assetic; Apply filters

How to Apply an Assetic Filter to a Specific File Extension
How to Apply an Assetic Filter to a specific File Extension
===========================================================

Assetic filters can be applied to individual files, groups of files or even,
Expand Down Expand Up @@ -49,7 +49,7 @@ An example configuration might look like this:
),
));
Filter a Single File
Filter a single File
--------------------

You can now serve up a single CoffeeScript file as JavaScript from within your
Expand All @@ -75,7 +75,7 @@ templates:
This is all that's needed to compile this CoffeeScript file and serve it
as the compiled JavaScript.

Filter Multiple Files
Filter multiple Files
---------------------

You can also combine multiple CoffeeScript files into a single output file:
Expand Down Expand Up @@ -107,7 +107,7 @@ JavaScript.

.. _cookbook-assetic-apply-to:

Filtering based on a File Extension
Filtering Based on a File Extension
-----------------------------------

One of the great advantages of using Assetic is reducing the number of asset
Expand Down Expand Up @@ -146,7 +146,7 @@ applied to all ``.coffee`` files:
apply_to="\.coffee$" />
<assetic:node-paths>/usr/lib/node_modules/</assetic:node-path>
</assetic:config>
.. code-block:: php
// app/config/config.php
Expand Down
8 changes: 4 additions & 4 deletions cookbook/assetic/asset_management.rst
Original file line number Diff line number Diff line change
Expand Up @@ -159,7 +159,7 @@ the :ref:`cssrewrite <cookbook-assetic-cssrewrite>` filter.

.. _cookbook-assetic-including-image:

Including images
Including Images
~~~~~~~~~~~~~~~~

To include an image you can use the ``image`` tag.
Expand Down Expand Up @@ -422,7 +422,7 @@ into your template:
A more detailed guide about configuring and using Assetic filters as well as
details of Assetic's debug mode can be found in :doc:`/cookbook/assetic/uglifyjs`.

Controlling the URL used
Controlling the URL Used
------------------------

If you wish to, you can control the URLs that Assetic produces. This is
Expand Down Expand Up @@ -471,7 +471,7 @@ it might be downright frustrating.
Fortunately, Assetic provides a way to dump your assets to real files, instead
of being generated dynamically.

Dumping Asset Files in the ``prod`` environment
Dumping Asset Files in the ``prod`` Environment
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

In the ``prod`` environment, your JS and CSS files are represented by a single
Expand Down Expand Up @@ -500,7 +500,7 @@ This will physically generate and write each file that you need (e.g. ``/js/abcd
If you update any of your assets, you'll need to run this again to regenerate
the file.

Dumping Asset Files in the ``dev`` environment
Dumping Asset Files in the ``dev`` Environment
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

By default, each asset path generated in the ``dev`` environment is handled
Expand Down
6 changes: 3 additions & 3 deletions cookbook/assetic/jpeg_optimize.rst
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
.. index::
single: Assetic; Image optimization

How to Use Assetic For Image Optimization with Twig Functions
How to Use Assetic for Image Optimization with Twig Functions
=============================================================

Amongst its many filters, Assetic has four filters which can be used for on-the-fly
Expand Down Expand Up @@ -111,7 +111,7 @@ remove these by using the ``strip_all`` option:
),
));
Lowering Maximum Quality
Lowering maximum Quality
~~~~~~~~~~~~~~~~~~~~~~~~

The quality level of the JPEG is not affected by default. You can gain
Expand Down Expand Up @@ -152,7 +152,7 @@ image quality:
),
));
Shorter syntax: Twig Function
Shorter Syntax: Twig Function
-----------------------------

If you're using Twig, it's possible to achieve all of this with a shorter
Expand Down
4 changes: 2 additions & 2 deletions cookbook/assetic/uglifyjs.rst
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
.. index::
single: Assetic; UglifyJS

How to Minify CSS/JS Files (using UglifyJS and UglifyCSS)
How to Minify CSS/JS Files (Using UglifyJS and UglifyCSS)
=========================================================

`UglifyJS`_ is a JavaScript parser/compressor/beautifier toolkit. It can be used
Expand Down Expand Up @@ -183,7 +183,7 @@ and :ref:`dump your assetic assets <cookbook-asetic-dump-prod>`.
rather than the common config file. For details on applying filters by
file extension, see :ref:`cookbook-assetic-apply-to`.

Install, configure and use UglifyCSS
Install, Configure and Use UglifyCSS
------------------------------------

The usage of UglifyCSS works the same way as UglifyJS. First, make sure
Expand Down
2 changes: 1 addition & 1 deletion cookbook/bundles/best_practices.rst
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
.. index::
single: Bundle; Best practices

How to use Best Practices for Structuring Bundles
How to Use best Practices for Structuring Bundles
=================================================

A bundle is a directory that has a well-defined structure and can host anything
Expand Down
6 changes: 3 additions & 3 deletions cookbook/bundles/extension.rst
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
single: Configuration; Semantic
single: Bundle; Extension configuration

How to expose a Semantic Configuration for a Bundle
How to Expose a semantic Configuration for a Bundle
===================================================

If you open your application configuration file (usually ``app/config/config.yml``),
Expand Down Expand Up @@ -330,7 +330,7 @@ information loaded from other bundles). The goal of the ``load()`` method
is to manipulate the container, adding and configuring any methods or services
needed by your bundle.

Loading External Configuration Resources
Loading external Configuration Resources
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

One common thing to do is to load an external configuration file that may
Expand Down Expand Up @@ -549,7 +549,7 @@ normalization and advanced merging. You can read more about this in
You can also see it in action by checking out some of the core Configuration classes,
such as the one from the `FrameworkBundle Configuration`_ or the `TwigBundle Configuration`_.

Modifying the configuration of another Bundle
Modifying the Configuration of another Bundle
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

If you have multiple bundles that depend on each other, it may be useful
Expand Down
2 changes: 1 addition & 1 deletion cookbook/bundles/inheritance.rst
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
.. index::
single: Bundle; Inheritance

How to use Bundle Inheritance to Override parts of a Bundle
How to Use Bundle Inheritance to Override Parts of a Bundle
===========================================================

When working with third-party bundles, you'll probably come across a situation
Expand Down
2 changes: 1 addition & 1 deletion cookbook/bundles/installation.rst
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
.. index::
single: Bundle; Installation

How to install 3rd party Bundles
How to Install 3rd Party Bundles
================================

Most bundles provide their own installation instructions. However, the
Expand Down
4 changes: 2 additions & 2 deletions cookbook/bundles/override.rst
Original file line number Diff line number Diff line change
Expand Up @@ -93,7 +93,7 @@ See :doc:`/cookbook/service_container/compiler_passes` for information on how to
compiler passes. If you want to do something beyond just overriding the class -
like adding a method call - you can only use the compiler pass method.

Entities & Entity mapping
Entities & Entity Mapping
-------------------------

Due to the way Doctrine works, it is not possible to override entity mapping
Expand All @@ -119,7 +119,7 @@ rather than::

.. _override-validation:

Validation metadata
Validation Metadata
-------------------

Symfony loads all validation configuration files from every bundle and
Expand Down
2 changes: 1 addition & 1 deletion cookbook/bundles/prepend_extension.rst
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
single: Configuration; Semantic
single: Bundle; Extension configuration

How to simplify configuration of multiple Bundles
How to Simplify Configuration of multiple Bundles
=================================================

When building reusable and extensible applications, developers are often
Expand Down
14 changes: 7 additions & 7 deletions cookbook/bundles/remove.rst
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
.. index::
single: Bundle; Removing AcmeDemoBundle

How to remove the AcmeDemoBundle
How to Remove the AcmeDemoBundle
================================

The Symfony2 Standard Edition comes with a complete demo that lives inside a
Expand All @@ -13,7 +13,7 @@ starting a project, but you'll probably want to eventually remove it.
This article uses the AcmeDemoBundle as an example, but you can use
these steps to remove any bundle.

1. Unregister the bundle in the ``AppKernel``
1. Unregister the Bundle in the ``AppKernel``
---------------------------------------------

To disconnect the bundle from the framework, you should remove the bundle from
Expand All @@ -38,20 +38,20 @@ development environment and you can find it inside the if statement below::
}
}

2. Remove bundle configuration
2. Remove Bundle Configuration
------------------------------

Now that Symfony doesn't know about the bundle, you need to remove any
configuration and routing configuration inside the ``app/config`` directory
that refers to the bundle.

2.1 Remove bundle routing
2.1 Remove Bundle Routing
~~~~~~~~~~~~~~~~~~~~~~~~~

The routing for the AcmeDemoBundle can be found in ``app/config/routing_dev.yml``.
Remove the ``_acme_demo`` entry at the bottom of this file.

2.2 Remove bundle configuration
2.2 Remove Bundle Configuration
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

Some bundles contain configuration in one of the ``app/config/config*.yml``
Expand All @@ -65,7 +65,7 @@ used in the configuration for the ``app/config/security.yml`` file. You can
use it as a boilerplate for your own security, but you **can** also remove
everything: it doesn't matter to Symfony if you remove it or not.

3. Remove the bundle from the Filesystem
3. Remove the Bundle from the Filesystem
----------------------------------------

Now you have removed every reference to the bundle in your application, you
Expand All @@ -81,7 +81,7 @@ can remove the ``Acme`` directory as well.

echo $this->container->get('kernel')->getBundle('AcmeDemoBundle')->getPath();

4. Remove integration in other bundles
4. Remove Integration in other Bundles
--------------------------------------

.. note::
Expand Down
4 changes: 2 additions & 2 deletions cookbook/cache/varnish.rst
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
.. index::
single: Cache; Varnish

How to use Varnish to speed up my Website
How to Use Varnish to Speed up my Website
=========================================

Because Symfony2's cache uses the standard HTTP cache headers, the
Expand Down Expand Up @@ -62,7 +62,7 @@ Symfony2 adds automatically:
// For Varnish < 3.0
// esi;
}
/* By default Varnish ignores Cache-Control: nocache
/* By default Varnish ignores Cache-Control: nocache
(https://www.varnish-cache.org/docs/3.0/tutorial/increasing_your_hitrate.html#cache-control),
so in order avoid caching it has to be done explicitly */
if (beresp.http.Pragma ~ "no-cache" ||
Expand Down
Loading

0 comments on commit 1c948c8

Please sign in to comment.