Skip to content

Commit 4ad0caf

Browse files
committed
[WIP] Making consistent component names throughout the docs
1 parent 0eb2531 commit 4ad0caf

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

64 files changed

+150
-150
lines changed

book/forms.rst

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -11,8 +11,8 @@ learning the most important features of the form library along the way.
1111

1212
.. note::
1313

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

1818
.. index::
@@ -185,7 +185,7 @@ it into a format that's suitable for being rendered in an HTML form.
185185
The form system is smart enough to access the value of the protected
186186
``task`` property via the ``getTask()`` and ``setTask()`` methods on the
187187
``Task`` class. Unless a property is public, it *must* have a "getter" and
188-
"setter" method so that the form component can get and put data onto the
188+
"setter" method so that the Form component can get and put data onto the
189189
property. For a Boolean property, you can use an "isser" or "hasser" method
190190
(e.g. ``isPublished()`` or ``hasReminder()``) instead of a getter (e.g.
191191
``getPublished()`` or ``getReminder()``).
@@ -1017,7 +1017,7 @@ Embedded Forms
10171017
Often, you'll want to build a form that will include fields from many different
10181018
objects. For example, a registration form may contain data belonging to
10191019
a ``User`` object as well as many ``Address`` objects. Fortunately, this
1020-
is easy and natural with the form component.
1020+
is easy and natural with the Form component.
10211021
10221022
Embedding a Single Object
10231023
~~~~~~~~~~~~~~~~~~~~~~~~~
@@ -1221,7 +1221,7 @@ do this, create a new template file that will store the new markup:
12211221
</div>
12221222
12231223
The ``form_row`` form fragment is used when rendering most fields via the
1224-
``form_row`` function. To tell the form component to use your new ``form_row``
1224+
``form_row`` function. To tell the Form component to use your new ``form_row``
12251225
fragment defined above, add the following to the top of the template that
12261226
renders the form:
12271227
@@ -1706,7 +1706,7 @@ Learn more from the Cookbook
17061706
* :doc:`/cookbook/form/dynamic_form_modification`
17071707
* :doc:`/cookbook/form/data_transformers`
17081708
1709-
.. _`Symfony2 Form Component`: https://github.com/symfony/Form
1709+
.. _`Symfony2 Form component`: https://github.com/symfony/Form
17101710
.. _`DateTime`: http://php.net/manual/en/class.datetime.php
17111711
.. _`Twig Bridge`: https://github.com/symfony/symfony/tree/2.2/src/Symfony/Bridge/Twig
17121712
.. _`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

book/from_flat_php_to_symfony2.rst

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -247,7 +247,7 @@ the layout:
247247
You've now introduced a methodology that allows for the reuse of the
248248
layout. Unfortunately, to accomplish this, you're forced to use a few ugly
249249
PHP functions (``ob_start()``, ``ob_get_clean()``) in the template. Symfony2
250-
uses a ``Templating`` component that allows this to be accomplished cleanly
250+
uses a Templating component that allows this to be accomplished cleanly
251251
and easily. You'll see it in action shortly.
252252

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

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

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

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

694694
* Symfony2's HTTP-centric architecture gives you access to powerful tools

book/http_fundamentals.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -293,7 +293,7 @@ and create the appropriate response based on your application logic*.
293293
.. tip::
294294

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

book/internals.rst

Lines changed: 15 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -25,8 +25,8 @@ on top of the previous one.
2525
Composer's autoloader (``vendor/autoload.php``), which is included in
2626
the ``app/autoload.php`` file.
2727

28-
``HttpFoundation`` Component
29-
~~~~~~~~~~~~~~~~~~~~~~~~~~~~
28+
HttpFoundation Component
29+
~~~~~~~~~~~~~~~~~~~~~~~~
3030

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

4747
.. note::
4848

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

51-
``HttpKernel`` Component
52-
~~~~~~~~~~~~~~~~~~~~~~~~
51+
HttpKernel Component
52+
~~~~~~~~~~~~~~~~~~~~
5353

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

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

6363
.. seealso::
6464

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

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

236236
.. tip::
237237

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

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

431431
.. index::
432-
single: Event Dispatcher
432+
single: EventDispatcher
433433

434-
The Event Dispatcher
435-
--------------------
434+
The EventDispatcher
435+
-------------------
436436

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

441441
.. index::
442442
single: Profiler
@@ -657,4 +657,4 @@ Learn more from the Cookbook
657657
* :doc:`/cookbook/event_dispatcher/class_extension`
658658
* :doc:`/cookbook/event_dispatcher/method_behavior`
659659

660-
.. _`Symfony2 Dependency Injection component`: https://github.com/symfony/DependencyInjection
660+
.. _`Symfony2 DependencyInjection component`: https://github.com/symfony/DependencyInjection

book/security.rst

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@ application with HTTP Basic authentication.
3131
Basic Example: HTTP Authentication
3232
----------------------------------
3333

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

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

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

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

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

@@ -2088,7 +2088,7 @@ Final Words
20882088
-----------
20892089

20902090
Security can be a deep and complex issue to solve correctly in your application.
2091-
Fortunately, Symfony's security component follows a well-proven security
2091+
Fortunately, Symfony's Security component follows a well-proven security
20922092
model based around *authentication* and *authorization*. Authentication,
20932093
which always happens first, is handled by a firewall whose job is to determine
20942094
the identity of the user through several different methods (e.g. HTTP authentication,

book/service_container.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@ the service container makes writing good code so easy.
3131
.. tip::
3232

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

3636
.. index::
3737
single: Service Container; What is a service?

book/translation.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,7 @@ In this chapter, you'll learn how to prepare an application to support multiple
3030
locales and then how to create translations for multiple locales. Overall,
3131
the process has several common steps:
3232

33-
#. Enable and configure Symfony's ``Translation`` component;
33+
#. Enable and configure Symfony's Translation component;
3434

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

components/class_loader/cache_class_loader.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ Introduction
1212
------------
1313

1414
Finding the file for a particular class can be an expensive task. Luckily,
15-
the Class Loader Component comes with two classes to cache the mapping
15+
the ClassLoader component comes with two classes to cache the mapping
1616
from a class to its containing file. Both the :class:`Symfony\\Component\\ClassLoader\\ApcClassLoader`
1717
and the :class:`Symfony\\Component\\ClassLoader\\XcacheClassLoader` wrap
1818
around an object which implements a ``findFile()`` method to find the file

components/class_loader/index.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
1-
Class Loader
2-
============
1+
ClassLoader
2+
===========
33

44
.. toctree::
55
:maxdepth: 2

components/class_loader/introduction.rst

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
11
.. index::
2-
single: Components; Class Loader
2+
single: Components; ClassLoader
33

4-
The Class Loader Component
5-
==========================
4+
The ClassLoader Component
5+
=========================
66

7-
The Class Loader Component provides tools to autoload your classes and
7+
The ClassLoader component provides tools to autoload your classes and
88
cache their locations for performance.
99

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

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

components/config/introduction.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ The Config Component
88
Introduction
99
------------
1010

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

components/console/helpers/index.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ The Console Helpers
1111
formatterhelper
1212
progresshelper
1313

14-
The Console Components comes with some useful helpers. These helpers contain
14+
The Console component comes with some useful helpers. These helpers contain
1515
function to ease some common tasks.
1616

1717
.. include:: map.rst.inc

components/console/introduction.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ You can install the component in 2 different ways:
2222

2323
.. note::
2424

25-
Windows does not support ANSI colors by default so the Console Component detects and
25+
Windows does not support ANSI colors by default so the Console component detects and
2626
disables colors where Windows does not have support. However, if Windows is not
2727
configured with an ANSI driver and your console commands invoke other scripts which
2828
emit ANSI color sequences, they will be shown as raw escape characters.

components/console/usage.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ Using Console Commands, Shortcuts and Built-in Commands
55
=======================================================
66

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

1010
.. note::
1111

components/css_selector.rst

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55
The CssSelector Component
66
=========================
77

8-
The CssSelector Component converts CSS selectors to XPath expressions.
8+
The CssSelector component converts CSS selectors to XPath expressions.
99

1010
Installation
1111
------------
@@ -41,8 +41,8 @@ be converted to an XPath equivalent. This XPath expression can then be used
4141
with other functions and classes that use XPath to find elements in a
4242
document.
4343

44-
The ``CssSelector`` component
45-
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
44+
The CssSelector component
45+
~~~~~~~~~~~~~~~~~~~~~~~~~
4646

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

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

6969
Limitations of the CssSelector component

components/dependency_injection/compilation.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ It is compiled by running::
1313

1414
$container->compile();
1515

16-
The compile method uses *Compiler Passes* for the compilation. The Dependency Injection
16+
The compile method uses *Compiler Passes* for the compilation. The DependencyInjection
1717
component comes with several passes which are automatically registered for
1818
compilation. For example the :class:`Symfony\\Component\\DependencyInjection\\Compiler\\CheckDefinitionValidityPass`
1919
checks for various potential issues with the definitions that have been set
@@ -148,7 +148,7 @@ like this::
148148
)
149149

150150
Whilst you can manually manage merging the different files, it is much better
151-
to use :doc:`the Config Component </components/config/introduction>` to merge
151+
to use :doc:`the Config component </components/config/introduction>` to merge
152152
and validate the config values. Using the configuration processing you could
153153
access the config value this way::
154154

components/dependency_injection/index.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
1-
Dependency Injection
2-
====================
1+
DependencyInjection
2+
===================
33

44
.. toctree::
55
:maxdepth: 2

components/dependency_injection/introduction.rst

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -2,10 +2,10 @@
22
single: Dependency Injection
33
single: Components; DependencyInjection
44

5-
The Dependency Injection Component
6-
==================================
5+
The DependencyInjection Component
6+
=================================
77

8-
The Dependency Injection component allows you to standardize and centralize
8+
The DependencyInjection component allows you to standardize and centralize
99
the way objects are constructed in your application.
1010

1111
For an introduction to Dependency Injection and service containers see
@@ -184,7 +184,7 @@ for the services rather than using PHP to define the services as in the above
184184
examples. In anything but the smallest applications it make sense to organize
185185
the service definitions by moving them into one or more configuration files.
186186
To do this you also need to install
187-
:doc:`the Config Component </components/config/introduction>`.
187+
:doc:`the Config component </components/config/introduction>`.
188188

189189
Loading an XML config file::
190190

components/dependency_injection/workflow.rst

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -12,17 +12,17 @@ Symfony2 full stack framework will help you see how this all fits together,
1212
whether you are using the full stack framework or looking to use the service
1313
container in another application.
1414

15-
The full stack framework uses the ``HttpKernel`` component to manage the loading
15+
The full stack framework uses the HttpKernel component to manage the loading
1616
of the service container configuration from the application and bundles and
17-
also handles the compilation and caching. Even if you are not using ``HttpKernel``,
17+
also handles the compilation and caching. Even if you are not using HttpKernel,
1818
it should give you an idea of one way of organizing configuration in a modular
1919
application.
2020

2121
Working with cached Container
2222
-----------------------------
2323

2424
Before building it, the kernel checks to see if a cached version of the container
25-
exists. The ``HttpKernel`` has a debug setting and if this is false, the
25+
exists. The HttpKernel has a debug setting and if this is false, the
2626
cached version is used if it exists. If debug is true then the kernel
2727
:doc:`checks to see if configuration is fresh </components/config/caching>`
2828
and if it is, the cached version of the container is used. If not then the container

0 commit comments

Comments
 (0)