Skip to content

[WIP] Making consistent component names throughout the docs #3183

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 2 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
12 changes: 6 additions & 6 deletions book/forms.rst
Original file line number Diff line number Diff line change
Expand Up @@ -11,8 +11,8 @@ learning the most important features of the form library along the way.

.. note::

The Symfony form component is a standalone library that can be used outside
of Symfony2 projects. For more information, see the `Symfony2 Form Component`_
The Symfony Form component is a standalone library that can be used outside
of Symfony2 projects. For more information, see the `Symfony2 Form component`_
on Github.

.. index::
Expand Down Expand Up @@ -185,7 +185,7 @@ it into a format that's suitable for being rendered in an HTML form.
The form system is smart enough to access the value of the protected
``task`` property via the ``getTask()`` and ``setTask()`` methods on the
``Task`` class. Unless a property is public, it *must* have a "getter" and
"setter" method so that the form component can get and put data onto the
"setter" method so that the Form component can get and put data onto the
property. For a Boolean property, you can use an "isser" or "hasser" method
(e.g. ``isPublished()`` or ``hasReminder()``) instead of a getter (e.g.
``getPublished()`` or ``getReminder()``).
Expand Down Expand Up @@ -1017,7 +1017,7 @@ Embedded Forms
Often, you'll want to build a form that will include fields from many different
objects. For example, a registration form may contain data belonging to
a ``User`` object as well as many ``Address`` objects. Fortunately, this
is easy and natural with the form component.
is easy and natural with the Form component.

Embedding a Single Object
~~~~~~~~~~~~~~~~~~~~~~~~~
Expand Down Expand Up @@ -1221,7 +1221,7 @@ do this, create a new template file that will store the new markup:
</div>

The ``form_row`` form fragment is used when rendering most fields via the
``form_row`` function. To tell the form component to use your new ``form_row``
``form_row`` function. To tell the Form component to use your new ``form_row``
fragment defined above, add the following to the top of the template that
renders the form:

Expand Down Expand Up @@ -1706,7 +1706,7 @@ Learn more from the Cookbook
* :doc:`/cookbook/form/dynamic_form_modification`
* :doc:`/cookbook/form/data_transformers`

.. _`Symfony2 Form Component`: https://github.com/symfony/Form
.. _`Symfony2 Form component`: https://github.com/symfony/Form
.. _`DateTime`: http://php.net/manual/en/class.datetime.php
.. _`Twig Bridge`: https://github.com/symfony/symfony/tree/2.2/src/Symfony/Bridge/Twig
.. _`form_div_layout.html.twig`: https://github.com/symfony/symfony/blob/2.2/src/Symfony/Bridge/Twig/Resources/views/Form/form_div_layout.html.twig
Expand Down
6 changes: 3 additions & 3 deletions book/from_flat_php_to_symfony2.rst
Original file line number Diff line number Diff line change
Expand Up @@ -247,7 +247,7 @@ the layout:
You've now introduced a methodology that allows for the reuse of the
layout. Unfortunately, to accomplish this, you're forced to use a few ugly
PHP functions (``ob_start()``, ``ob_get_clean()``) in the template. Symfony2
uses a ``Templating`` component that allows this to be accomplished cleanly
uses a Templating component that allows this to be accomplished cleanly
and easily. You'll see it in action shortly.

Adding a Blog "show" Page
Expand Down Expand Up @@ -583,7 +583,7 @@ them for you. Here's the same sample application, now built in Symfony2::
}

The two controllers are still lightweight. Each uses the :doc:`Doctrine ORM library </book/doctrine>`
to retrieve objects from the database and the ``Templating`` component to
to retrieve objects from the database and the Templating component to
render a template and return a ``Response`` object. The list template is
now quite a bit simpler:

Expand Down Expand Up @@ -688,7 +688,7 @@ migrating the blog from flat PHP to Symfony2 has improved life:
Templating, Security, Form, Validation and Translation components (to name
a few);

* The application now enjoys **fully-flexible URLs** thanks to the ``Routing``
* The application now enjoys **fully-flexible URLs** thanks to the Routing
component;

* Symfony2's HTTP-centric architecture gives you access to powerful tools
Expand Down
2 changes: 1 addition & 1 deletion book/http_fundamentals.rst
Original file line number Diff line number Diff line change
Expand Up @@ -293,7 +293,7 @@ and create the appropriate response based on your application logic*.
.. tip::

The ``Request`` and ``Response`` classes are part of a standalone component
included with Symfony called ``HttpFoundation``. This component can be
included with Symfony called HttpFoundation. This component can be
used entirely independently of Symfony and also provides classes for handling
sessions and file uploads.

Expand Down
30 changes: 15 additions & 15 deletions book/internals.rst
Original file line number Diff line number Diff line change
Expand Up @@ -25,8 +25,8 @@ on top of the previous one.
Composer's autoloader (``vendor/autoload.php``), which is included in
the ``app/autoload.php`` file.

``HttpFoundation`` Component
~~~~~~~~~~~~~~~~~~~~~~~~~~~~
HttpFoundation Component
~~~~~~~~~~~~~~~~~~~~~~~~

The deepest level is the :namespace:`Symfony\\Component\\HttpFoundation`
component. HttpFoundation provides the main objects needed to deal with HTTP.
Expand All @@ -46,10 +46,10 @@ variables:

.. note::

Read more about the :doc:`HttpFoundation Component </components/http_foundation/introduction>`.
Read more about the :doc:`HttpFoundation component </components/http_foundation/introduction>`.

``HttpKernel`` Component
~~~~~~~~~~~~~~~~~~~~~~~~
HttpKernel Component
~~~~~~~~~~~~~~~~~~~~

On top of HttpFoundation is the :namespace:`Symfony\\Component\\HttpKernel`
component. HttpKernel handles the dynamic part of HTTP; it is a thin wrapper
Expand All @@ -58,11 +58,11 @@ handled. It also provides extension points and tools that makes it the ideal
starting point to create a Web framework without too much overhead.

It also optionally adds configurability and extensibility, thanks to the
Dependency Injection component and a powerful plugin system (bundles).
DependencyInjection component and a powerful plugin system (bundles).

.. seealso::

Read more about the :doc:`HttpKernel Component </components/http_kernel/introduction>`,
Read more about the :doc:`HttpKernel component </components/http_kernel/introduction>`,
:doc:`Dependency Injection </book/service_container>` and
:doc:`Bundles </cookbook/bundles/best_practices>`.

Expand Down Expand Up @@ -235,8 +235,8 @@ add the following code at the beginning of your listener method::

.. tip::

If you are not yet familiar with the Symfony2 Event Dispatcher, read the
:doc:`Event Dispatcher Component Documentation </components/event_dispatcher/introduction>`
If you are not yet familiar with the Symfony2 EventDispatcher, read the
:doc:`EventDispatcher component documentation </components/event_dispatcher/introduction>`
section first.

.. index::
Expand Down Expand Up @@ -429,14 +429,14 @@ and set a new ``Exception`` object, or do nothing::
Read more on the :ref:`kernel.exception event <component-http-kernel-kernel-exception>`.

.. index::
single: Event Dispatcher
single: EventDispatcher

The Event Dispatcher
--------------------
The EventDispatcher
-------------------

The event dispatcher is a standalone component that is responsible for much
The EventDispatcher is a standalone component that is responsible for much
of the underlying logic and flow behind a Symfony request. For more information,
see the :doc:`Event Dispatcher Component Documentation </components/event_dispatcher/introduction>`.
see the :doc:`EventDispatcher component documentation </components/event_dispatcher/introduction>`.

.. index::
single: Profiler
Expand Down Expand Up @@ -657,4 +657,4 @@ Learn more from the Cookbook
* :doc:`/cookbook/event_dispatcher/class_extension`
* :doc:`/cookbook/event_dispatcher/method_behavior`

.. _`Symfony2 Dependency Injection component`: https://github.com/symfony/DependencyInjection
.. _`Symfony2 DependencyInjection component`: https://github.com/symfony/DependencyInjection
10 changes: 5 additions & 5 deletions book/security.rst
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ application with HTTP Basic authentication.
Basic Example: HTTP Authentication
----------------------------------

The security component can be configured via your application configuration.
The Security component can be configured via your application configuration.
In fact, most standard security setups are just a matter of using the right
configuration. The following configuration tells Symfony to secure any URL
matching ``/admin/*`` and to ask the user for credentials using basic HTTP
Expand Down Expand Up @@ -1034,7 +1034,7 @@ the one seen in the previous section. For example, suppose you have a service
You can restrict use of this class - no matter where it's being used from -
to users that have a specific role.

For more information on how you can use the security component to secure
For more information on how you can use the Security component to secure
different services and methods in your application, see :doc:`/cookbook/security/securing_services`.

Access Control Lists (ACLs): Securing Individual Database Objects
Expand All @@ -1045,7 +1045,7 @@ posts. Now, you want a user to be able to edit his own comments, but not
those of other users. Also, as the admin user, you yourself want to be able
to edit *all* comments.

The security component comes with an optional access control list (ACL) system
The Security component comes with an optional access control list (ACL) system
that you can use when you need to control access to individual instances
of an object in your system. *Without* ACL, you can secure your system so that
only certain users can edit blog comments in general. But *with* ACL, you
Expand Down Expand Up @@ -2035,7 +2035,7 @@ Utilities
.. versionadded:: 2.2
The ``StringUtils`` and ``SecureRandom`` classes were added in Symfony 2.2

The Symfony Security Component comes with a collection of nice utilities related
The Symfony Security component comes with a collection of nice utilities related
to security. These utilities are used by Symfony, but you should also use
them if you want to solve the problem they address.

Expand Down Expand Up @@ -2088,7 +2088,7 @@ Final Words
-----------

Security can be a deep and complex issue to solve correctly in your application.
Fortunately, Symfony's security component follows a well-proven security
Fortunately, Symfony's Security component follows a well-proven security
model based around *authentication* and *authorization*. Authentication,
which always happens first, is handled by a firewall whose job is to determine
the identity of the user through several different methods (e.g. HTTP authentication,
Expand Down
4 changes: 2 additions & 2 deletions book/service_container.rst
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
.. index::
single: Service Container
single: Dependency Injection; Container
single: DependencyInjection; Container

Service Container
=================
Expand Down Expand Up @@ -31,7 +31,7 @@ the service container makes writing good code so easy.
.. tip::

If you want to know a lot more after reading this chapter, check out
the :doc:`Dependency Injection Component Documentation </components/dependency_injection/introduction>`.
the :doc:`DependencyInjection component documentation </components/dependency_injection/introduction>`.

.. index::
single: Service Container; What is a service?
Expand Down
2 changes: 1 addition & 1 deletion book/translation.rst
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ In this chapter, you'll learn how to prepare an application to support multiple
locales and then how to create translations for multiple locales. Overall,
the process has several common steps:

#. Enable and configure Symfony's ``Translation`` component;
#. Enable and configure Symfony's Translation component;

#. Abstract strings (i.e. "messages") by wrapping them in calls to the ``Translator``;

Expand Down
8 changes: 4 additions & 4 deletions components/class_loader/cache_class_loader.rst
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
.. index::
single: APC; ApcClassLoader
single: Class Loader; ApcClassLoader
single: Class Loader; Cache
single: Class Loader; XcacheClassLoader
single: ClassLoader; ApcClassLoader
single: ClassLoader; Cache
single: ClassLoader; XcacheClassLoader
single: XCache; XcacheClassLoader

Cache a Class Loader
Expand All @@ -12,7 +12,7 @@ Introduction
------------

Finding the file for a particular class can be an expensive task. Luckily,
the Class Loader Component comes with two classes to cache the mapping
the ClassLoader component comes with two classes to cache the mapping
from a class to its containing file. Both the :class:`Symfony\\Component\\ClassLoader\\ApcClassLoader`
and the :class:`Symfony\\Component\\ClassLoader\\XcacheClassLoader` wrap
around an object which implements a ``findFile()`` method to find the file
Expand Down
2 changes: 1 addition & 1 deletion components/class_loader/class_loader.rst
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
.. index::
single: Class Loader; PSR-0 Class Loader
single: ClassLoader; PSR-0 Class Loader

The PSR-0 Class Loader
======================
Expand Down
2 changes: 1 addition & 1 deletion components/class_loader/debug_class_loader.rst
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
.. index::
single: Class Loader; DebugClassLoader
single: ClassLoader; DebugClassLoader

Debugging a Class Loader
========================
Expand Down
4 changes: 2 additions & 2 deletions components/class_loader/index.rst
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
Class Loader
============
ClassLoader
===========

.. toctree::
:maxdepth: 2
Expand Down
10 changes: 5 additions & 5 deletions components/class_loader/introduction.rst
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
.. index::
single: Components; Class Loader
single: Components; ClassLoader

The Class Loader Component
==========================
The ClassLoader Component
=========================

The Class Loader Component provides tools to autoload your classes and
The ClassLoader component provides tools to autoload your classes and
cache their locations for performance.

Usage
Expand All @@ -20,7 +20,7 @@ the class. Symfony2 provides two autoloaders, which are able to load your classe
* :doc:`/components/class_loader/map_class_loader`: loads classes using
a static map from class name to file path.

Additionally, the Symfony Class Loader Component ships with a set of wrapper
Additionally, the Symfony ClassLoader component ships with a set of wrapper
classes which can be used to add additional functionality on top of existing
autoloaders:

Expand Down
2 changes: 1 addition & 1 deletion components/class_loader/map_class_loader.rst
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
.. index::
single: Class Loader; MapClassLoader
single: ClassLoader; MapClassLoader

MapClassLoader
==============
Expand Down
2 changes: 1 addition & 1 deletion components/config/introduction.rst
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ The Config Component
Introduction
------------

The Config Component provides several classes to help you find, load, combine,
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).

Expand Down
2 changes: 1 addition & 1 deletion components/console/helpers/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ The Console Helpers
formatterhelper
progresshelper

The Console Components comes with some useful helpers. These helpers contain
The Console component comes with some useful helpers. These helpers contain
function to ease some common tasks.

.. include:: map.rst.inc
2 changes: 1 addition & 1 deletion components/console/introduction.rst
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ You can install the component in 2 different ways:

.. note::

Windows does not support ANSI colors by default so the Console Component detects and
Windows does not support ANSI colors by default so the Console component detects and
disables colors where Windows does not have support. However, if Windows is not
configured with an ANSI driver and your console commands invoke other scripts which
emit ANSI color sequences, they will be shown as raw escape characters.
Expand Down
2 changes: 1 addition & 1 deletion components/console/usage.rst
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ Using Console Commands, Shortcuts and Built-in Commands
=======================================================

In addition to the options you specify for your commands, there are some
built-in options as well as a couple of built-in commands for the console component.
built-in options as well as a couple of built-in commands for the Console component.

.. note::

Expand Down
10 changes: 5 additions & 5 deletions components/css_selector.rst
Original file line number Diff line number Diff line change
@@ -1,11 +1,11 @@
.. index::
single: CSS Selector
single: CssSelector
single: Components; CssSelector

The CssSelector Component
=========================

The CssSelector Component converts CSS selectors to XPath expressions.
The CssSelector component converts CSS selectors to XPath expressions.

Installation
------------
Expand Down Expand Up @@ -41,8 +41,8 @@ be converted to an XPath equivalent. This XPath expression can then be used
with other functions and classes that use XPath to find elements in a
document.

The ``CssSelector`` component
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
The CssSelector component
~~~~~~~~~~~~~~~~~~~~~~~~~

The component's only goal is to convert CSS selectors to their XPath
equivalents::
Expand All @@ -63,7 +63,7 @@ You can use this expression with, for instance, :phpclass:`DOMXPath` or
.. tip::

The :method:`Crawler::filter() <Symfony\\Component\\DomCrawler\\Crawler::filter>` method
uses the ``CssSelector`` component to find elements based on a CSS selector
uses the CssSelector component to find elements based on a CSS selector
string. See the :doc:`/components/dom_crawler` for more details.

Limitations of the CssSelector component
Expand Down
2 changes: 1 addition & 1 deletion components/dependency_injection/advanced.rst
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
.. index::
single: Dependency Injection; Advanced configuration
single: DependencyInjection; Advanced configuration

Advanced Container Configuration
================================
Expand Down
Loading