Skip to content

Fix technology, vendor and bundle names to their official notation #3186

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 8 commits into from
Nov 18, 2013
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions book/doctrine.rst
Original file line number Diff line number Diff line change
Expand Up @@ -1485,7 +1485,7 @@ and ``nullable``. Take a few examples:
fields:
# A string field length 255 that cannot be null
# (reflecting the default values for the "length" and *nullable* options)
# type attribute is necessary in yaml definitions
# type attribute is necessary in YAML definitions
name:
type: string

Expand All @@ -1502,7 +1502,7 @@ and ``nullable``. Take a few examples:
<!--
A string field length 255 that cannot be null
(reflecting the default values for the "length" and *nullable* options)
type attribute is necessary in xml definitions
type attribute is necessary in XML definitions
-->
<field name="name" type="string" />
<field name="email"
Expand Down Expand Up @@ -1564,7 +1564,7 @@ Some notable or interesting tasks include:
.. note::

To be able to load data fixtures to your database, you will need to have
the ``DoctrineFixturesBundle`` bundle installed. To learn how to do it,
the DoctrineFixturesBundle bundle installed. To learn how to do it,
read the ":doc:`/bundles/DoctrineFixturesBundle/index`" entry of the
documentation.

Expand Down
2 changes: 1 addition & 1 deletion book/http_fundamentals.rst
Original file line number Diff line number Diff line change
Expand Up @@ -246,7 +246,7 @@ have all the request information at your fingertips::
As a bonus, the ``Request`` class does a lot of work in the background that
you'll never need to worry about. For example, the ``isSecure()`` method
checks the *three* different values in PHP that can indicate whether or not
the user is connecting via a secured connection (i.e. ``https``).
the user is connecting via a secured connection (i.e. HTTPS).

.. sidebar:: ParameterBags and Request attributes

Expand Down
6 changes: 3 additions & 3 deletions book/installation.rst
Original file line number Diff line number Diff line change
Expand Up @@ -180,7 +180,7 @@ Symfony itself - into the ``vendor/`` directory.
.. tip::

When running ``php composer.phar install`` or ``php composer.phar update``,
composer will execute post install/update commands to clear the cache
Composer will execute post install/update commands to clear the cache
and install assets. By default, the assets will be copied into your ``web``
directory.

Expand Down Expand Up @@ -321,11 +321,11 @@ Using Source Control

If you're using a version control system like ``Git`` or ``Subversion``, you
can setup your version control system and begin committing your project to
it as normal. The Symfony Standard edition *is* the starting point for your
it as normal. The Symfony Standard Edition *is* the starting point for your
new project.

For specific instructions on how best to setup your project to be stored
in git, see :doc:`/cookbook/workflow/new_project_git`.
in Git, see :doc:`/cookbook/workflow/new_project_git`.

Ignoring the ``vendor/`` Directory
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Expand Down
14 changes: 7 additions & 7 deletions book/internals.rst
Original file line number Diff line number Diff line change
Expand Up @@ -66,8 +66,8 @@ Dependency Injection component and a powerful plugin system (bundles).
:doc:`Dependency Injection </book/service_container>` and
:doc:`Bundles </cookbook/bundles/best_practices>`.

``FrameworkBundle`` Bundle
~~~~~~~~~~~~~~~~~~~~~~~~~~
FrameworkBundle
~~~~~~~~~~~~~~~

The :namespace:`Symfony\\Bundle\\FrameworkBundle` bundle is the bundle that
ties the main components and libraries together to make a lightweight and fast
Expand Down Expand Up @@ -254,7 +254,7 @@ or setup variables so that a Controller can be called after the event. Any
listener can return a ``Response`` object via the ``setResponse()`` method on
the event. In this case, all other listeners won't be called.

This event is used by ``FrameworkBundle`` to populate the ``_controller``
This event is used by the FrameworkBundle to populate the ``_controller``
``Request`` attribute, via the
:class:`Symfony\\Bundle\\FrameworkBundle\\EventListener\\RouterListener`. RequestListener
uses a :class:`Symfony\\Component\\Routing\\RouterInterface` object to match
Expand All @@ -273,7 +273,7 @@ the ``Request`` and determine the Controller name (stored in the

*Event Class*: :class:`Symfony\\Component\\HttpKernel\\Event\\FilterControllerEvent`

This event is not used by ``FrameworkBundle``, but can be an entry point used
This event is not used by the FrameworkBundle, but can be an entry point used
to modify the controller that should be executed::

use Symfony\Component\HttpKernel\Event\FilterControllerEvent;
Expand All @@ -299,7 +299,7 @@ to modify the controller that should be executed::

*Event Class*: :class:`Symfony\\Component\\HttpKernel\\Event\\GetResponseForControllerResultEvent`

This event is not used by ``FrameworkBundle``, but it can be used to implement
This event is not used by the FrameworkBundle, but it can be used to implement
a view sub-system. This event is called *only* if the Controller does *not*
return a ``Response`` object. The purpose of the event is to allow some other
return value to be converted into a ``Response``.
Expand Down Expand Up @@ -342,7 +342,7 @@ The purpose of this event is to allow other systems to modify or replace the
// ... modify the response object
}

The ``FrameworkBundle`` registers several listeners:
The FrameworkBundle registers several listeners:

* :class:`Symfony\\Component\\HttpKernel\\EventListener\\ProfilerListener`:
collects data for the current request;
Expand Down Expand Up @@ -387,7 +387,7 @@ was already served to the client.

*Event Class*: :class:`Symfony\\Component\\HttpKernel\\Event\\GetResponseForExceptionEvent`

``FrameworkBundle`` registers an
The FrameworkBundle registers an
:class:`Symfony\\Component\\HttpKernel\\EventListener\\ExceptionListener` that
forwards the ``Request`` to a given Controller (the value of the
``exception_listener.controller`` parameter -- must be in the
Expand Down
6 changes: 3 additions & 3 deletions book/page_creation.rst
Original file line number Diff line number Diff line change
Expand Up @@ -840,7 +840,7 @@ format you prefer:

Each top-level entry like ``framework`` or ``twig`` defines the configuration
for a particular bundle. For example, the ``framework`` key defines the configuration
for the core Symfony ``FrameworkBundle`` and includes configuration for the
for the core Symfony FrameworkBundle and includes configuration for the
routing, templating, and other core systems.

For now, don't worry about the specific configuration options in each section.
Expand All @@ -854,7 +854,7 @@ options of each feature.
three formats (YAML, XML and PHP). Each has its own advantages and
disadvantages. The choice of which to use is up to you:

* *YAML*: Simple, clean and readable (learn more about yaml in
* *YAML*: Simple, clean and readable (learn more about YAML in
":doc:`/components/yaml/yaml_format`");

* *XML*: More powerful than YAML at times and supports IDE autocompletion;
Expand All @@ -867,7 +867,7 @@ Default Configuration Dump
.. versionadded:: 2.1
The ``config:dump-reference`` command was added in Symfony 2.1

You can dump the default configuration for a bundle in yaml to the console using
You can dump the default configuration for a bundle in YAML to the console using
the ``config:dump-reference`` command. Here is an example of dumping the default
FrameworkBundle configuration:

Expand Down
2 changes: 1 addition & 1 deletion book/propel.rst
Original file line number Diff line number Diff line change
Expand Up @@ -126,7 +126,7 @@ After creating your ``schema.xml``, generate your model from it by running:
$ php app/console propel:model:build

This generates each model class to quickly develop your application in the
``Model/`` directory the ``AcmeStoreBundle`` bundle.
``Model/`` directory of the ``AcmeStoreBundle`` bundle.

Creating the Database Tables/Schema
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Expand Down
2 changes: 1 addition & 1 deletion book/routing.rst
Original file line number Diff line number Diff line change
Expand Up @@ -1175,7 +1175,7 @@ In an upcoming section, you'll learn how to generate URLs from inside templates.

.. tip::

If the frontend of your application uses AJAX requests, you might want
If the frontend of your application uses Ajax requests, you might want
to be able to generate URLs in JavaScript based on your routing configuration.
By using the `FOSJsRoutingBundle`_, you can do exactly that:

Expand Down
2 changes: 1 addition & 1 deletion book/security.rst
Original file line number Diff line number Diff line change
Expand Up @@ -1007,7 +1007,7 @@ authorization from inside a controller::

.. _book-security-securing-controller-annotations:

You can also choose to install and use the optional ``JMSSecurityExtraBundle``,
You can also choose to install and use the optional JMSSecurityExtraBundle,
which can secure your controller using annotations::

// ...
Expand Down
20 changes: 10 additions & 10 deletions book/service_container.rst
Original file line number Diff line number Diff line change
Expand Up @@ -255,8 +255,8 @@ looks up the value of each parameter and uses it in the service definition.
.. note::

If you want to use a string that starts with an ``@`` sign as a parameter
value (i.e. a very safe mailer password) in a yaml file, you need to escape
it by adding another ``@`` sign (This only applies to the YAML format):
value (i.e. a very safe mailer password) in a YAML file, you need to escape
it by adding another ``@`` sign (this only applies to the YAML format):

.. code-block:: yaml

Expand Down Expand Up @@ -464,9 +464,9 @@ In other words, a service container extension configures the services for
a bundle on your behalf. And as you'll see in a moment, the extension provides
a sensible, high-level interface for configuring the bundle.

Take the ``FrameworkBundle`` - the core Symfony2 framework bundle - as an
Take the FrameworkBundle - the core Symfony2 framework bundle - as an
example. The presence of the following code in your application configuration
invokes the service container extension inside the ``FrameworkBundle``:
invokes the service container extension inside the FrameworkBundle:

.. configuration-block::

Expand Down Expand Up @@ -514,21 +514,21 @@ invokes the service container extension inside the ``FrameworkBundle``:

When the configuration is parsed, the container looks for an extension that
can handle the ``framework`` configuration directive. The extension in question,
which lives in the ``FrameworkBundle``, is invoked and the service configuration
for the ``FrameworkBundle`` is loaded. If you remove the ``framework`` key
which lives in the FrameworkBundle, is invoked and the service configuration
for the FrameworkBundle is loaded. If you remove the ``framework`` key
from your application configuration file entirely, the core Symfony2 services
won't be loaded. The point is that you're in control: the Symfony2 framework
doesn't contain any magic or perform any actions that you don't have control
over.

Of course you can do much more than simply "activate" the service container
extension of the ``FrameworkBundle``. Each extension allows you to easily
extension of the FrameworkBundle. Each extension allows you to easily
customize the bundle, without worrying about how the internal services are
defined.

In this case, the extension allows you to customize the ``error_handler``,
``csrf_protection``, ``router`` configuration and much more. Internally,
the ``FrameworkBundle`` uses the options specified here to define and configure
the FrameworkBundle uses the options specified here to define and configure
the services specific to it. The bundle takes care of creating all the necessary
``parameters`` and ``services`` for the service container, while still allowing
much of the configuration to be easily customized. As an added bonus, most
Expand Down Expand Up @@ -934,7 +934,7 @@ the framework.
Be sure that the ``swiftmailer`` entry appears in your application
configuration. As was mentioned in :ref:`service-container-extension-configuration`,
the ``swiftmailer`` key invokes the service extension from the
``SwiftmailerBundle``, which registers the ``mailer`` service.
SwiftmailerBundle, which registers the ``mailer`` service.

.. _book-service-container-tags:

Expand Down Expand Up @@ -975,7 +975,7 @@ to be used for a specific purpose. Take the following example:
$definition->addTag('twig.extension');
$container->setDefinition('foo.twig.extension', $definition);

The ``twig.extension`` tag is a special tag that the ``TwigBundle`` uses
The ``twig.extension`` tag is a special tag that the TwigBundle uses
during configuration. By giving the service this ``twig.extension`` tag,
the bundle knows that the ``foo.twig.extension`` service should be registered
as a Twig extension with Twig. In other words, Twig finds all services tagged
Expand Down
4 changes: 2 additions & 2 deletions book/templating.rst
Original file line number Diff line number Diff line change
Expand Up @@ -1278,10 +1278,10 @@ Overriding Core Templates
~~~~~~~~~~~~~~~~~~~~~~~~~

Since the Symfony2 framework itself is just a bundle, core templates can be
overridden in the same way. For example, the core ``TwigBundle`` contains
overridden in the same way. For example, the core TwigBundle contains
a number of different "exception" and "error" templates that can be overridden
by copying each from the ``Resources/views/Exception`` directory of the
``TwigBundle`` to, you guessed it, the
TwigBundle to, you guessed it, the
``app/Resources/TwigBundle/views/Exception`` directory.

.. index::
Expand Down
14 changes: 7 additions & 7 deletions components/config/definition.rst
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ and their structure can be validated using the "Definition" part of the Config
Component. Configuration values are usually expected to show some kind of
hierarchy. Also, values should be of a certain type, be restricted in number
or be one of a given set of values. For example, the following configuration
(in Yaml) shows a clear hierarchy and some validation rules that should be
(in YAML) shows a clear hierarchy and some validation rules that should be
applied to it (like: "the value for ``auto_connect`` must be a boolean value"):

.. code-block:: yaml
Expand Down Expand Up @@ -396,19 +396,19 @@ Normalization
When the config files are processed they are first normalized, then merged
and finally the tree is used to validate the resulting array. The normalization
process is used to remove some of the differences that result from different
configuration formats, mainly the differences between Yaml and XML.
configuration formats, mainly the differences between YAML and XML.

The separator used in keys is typically ``_`` in Yaml and ``-`` in XML. For
example, ``auto_connect`` in Yaml and ``auto-connect``. The normalization would
The separator used in keys is typically ``_`` in YAML and ``-`` in XML. For
example, ``auto_connect`` in YAML and ``auto-connect``. The normalization would
make both of these ``auto_connect``.

.. caution::

The target key will not be altered if it's mixed like
``foo-bar_moo`` or if it already exists.

Another difference between Yaml and XML is in the way arrays of values may
be represented. In Yaml you may have:
Another difference between YAML and XML is in the way arrays of values may
be represented. In YAML you may have:

.. code-block:: yaml

Expand Down Expand Up @@ -447,7 +447,7 @@ a second argument::
->end()
;

As well as fixing this, ``fixXmlConfig`` ensures that single xml elements
As well as fixing this, ``fixXmlConfig`` ensures that single XML elements
are still turned into an array. So you may have:

.. code-block:: xml
Expand Down
2 changes: 1 addition & 1 deletion components/config/introduction.rst
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ Introduction

The Config Component provides several classes to help you find, load, combine,
autofill and validate configuration values of any kind, whatever their source
may be (Yaml, XML, INI files, or for instance a database).
may be (YAML, XML, INI files, or for instance a database).

Installation
------------
Expand Down
2 changes: 1 addition & 1 deletion components/config/resources.rst
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ all matches.
Resource loaders
----------------

For each type of resource (Yaml, XML, annotation, etc.) a loader must be defined.
For each type of resource (YAML, XML, annotation, etc.) a loader must be defined.
Each loader should implement :class:`Symfony\\Component\\Config\\Loader\\LoaderInterface`
or extend the abstract :class:`Symfony\\Component\\Config\\Loader\\FileLoader`
class, which allows for recursively importing other resources::
Expand Down
2 changes: 1 addition & 1 deletion components/dependency_injection/introduction.rst
Original file line number Diff line number Diff line change
Expand Up @@ -179,7 +179,7 @@ Setting Up the Container with Configuration Files
-------------------------------------------------

As well as setting up the services using PHP as above you can also use
configuration files. This allows you to use XML or Yaml to write the definitions
configuration files. This allows you to use XML or YAML to write the definitions
for the services rather than using PHP to define the services as in the above
examples. In anything but the smallest applications it make sense to organize
the service definitions by moving them into one or more configuration files.
Expand Down
10 changes: 5 additions & 5 deletions components/dependency_injection/parameters.rst
Original file line number Diff line number Diff line change
Expand Up @@ -275,7 +275,7 @@ key, and define the type as ``constant``.

.. note::

This does not work for Yaml configuration. If you're using Yaml, you can
This does not work for YAML configuration. If you're using YAML, you can
import an XML file to take advantage of this functionality:

.. configuration-block::
Expand Down Expand Up @@ -316,7 +316,7 @@ To disable this behavior, use the ``string`` type:

.. note::

This is not available for Yaml and PHP, because they already have built-in
This is not available for YAML and PHP, because they already have built-in
support for the PHP keywords.

Syntax for Referencing Services
Expand All @@ -327,10 +327,10 @@ each format. You can configure the behavior if the referenced service does
not exist. By default, an exception is thrown when a non-existent service
is referenced.

Yaml
YAML
~~~~

Start the string with ``@`` or ``@?`` to reference a service in Yaml.
Start the string with ``@`` or ``@?`` to reference a service in YAML.

* ``@mailer`` references the ``mailer`` service. If the service does not
exists, an exception will be thrown;
Expand All @@ -339,7 +339,7 @@ Start the string with ``@`` or ``@?`` to reference a service in Yaml.

.. tip::

Use ``@@`` to escape the ``@`` symbol in Yaml. ``@@mailer`` will be
Use ``@@`` to escape the ``@`` symbol in YAML. ``@@mailer`` will be
converted into the string ``"@mailer"`` instead of referencing the
``mailer`` service.

Expand Down
4 changes: 2 additions & 2 deletions components/http_kernel/introduction.rst
Original file line number Diff line number Diff line change
Expand Up @@ -386,7 +386,7 @@ to create a ``Response``.
This can be useful if you want to use a "view" layer: instead of returning
a ``Response`` from the controller, you return data that represents the page.
A listener to this event could then use this data to create a ``Response`` that
is in the correct format (e.g HTML, json, etc).
is in the correct format (e.g HTML, JSON, etc).

At this stage, if no listener sets a response on the event, then an exception
is thrown: either the controller *or* one of the view listeners must always
Expand Down Expand Up @@ -482,7 +482,7 @@ as possible to the client (e.g. sending emails).

.. sidebar:: ``kernel.terminate`` in the Symfony Framework

If you use the ``SwiftmailerBundle`` with Symfony2 and use ``memory``
If you use the SwiftmailerBundle with Symfony2 and use ``memory``
spooling, then the :class:`Symfony\\Bundle\\SwiftmailerBundle\\EventListener\\EmailSenderListener`
is activated, which actually delivers any emails that you scheduled to
send during the request.
Expand Down
2 changes: 1 addition & 1 deletion components/options_resolver.rst
Original file line number Diff line number Diff line change
Expand Up @@ -257,7 +257,7 @@ be anything, but it must be an integer. You can configure these types by calling
));
}

Possible types are the ones associated with the ``is_*`` php functions or a
Possible types are the ones associated with the ``is_*`` PHP functions or a
class name. You can also pass an array of types as the value. For instance,
``array('null', 'string')`` allows ``port`` to be ``null`` or a ``string``.

Expand Down
2 changes: 1 addition & 1 deletion components/routing/introduction.rst
Original file line number Diff line number Diff line change
Expand Up @@ -265,7 +265,7 @@ other loaders that work the same way:
* :class:`Symfony\\Component\\Routing\\Loader\\PhpFileLoader`

If you use the :class:`Symfony\\Component\\Routing\\Loader\\PhpFileLoader` you
have to provide the name of a php file which returns a :class:`Symfony\\Component\\Routing\\RouteCollection`::
have to provide the name of a PHP file which returns a :class:`Symfony\\Component\\Routing\\RouteCollection`::

// RouteProvider.php
use Symfony\Component\Routing\RouteCollection;
Expand Down
Loading