Skip to content

Commit 0586ec4

Browse files
committed
[Components] consistent headlines
1 parent 127beed commit 0586ec4

33 files changed

+86
-86
lines changed

components/config/caching.rst

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
.. index::
22
single: Config; Caching based on resources
33

4-
Caching based on resources
4+
Caching Based on Resources
55
==========================
66

77
When all configuration resources are loaded, you may want to process the configuration

components/config/definition.rst

+15-15
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
11
.. index::
22
single: Config; Defining and processing configuration values
33

4-
Defining and processing configuration values
4+
Defining and Processing Configuration Values
55
============================================
66

7-
Validating configuration values
7+
Validating Configuration Values
88
-------------------------------
99

1010
After loading configuration values from all kinds of resources, the values
@@ -38,7 +38,7 @@ they are when first encountered. Also, some keys are only available when
3838
another key has a specific value (in the sample configuration above: the
3939
``memory`` key only makes sense when the ``driver`` is ``sqlite``).
4040

41-
Defining a hierarchy of configuration values using the TreeBuilder
41+
Defining a Hierarchy of Configuration Values Using the TreeBuilder
4242
------------------------------------------------------------------
4343

4444
All the rules concerning configuration values can be defined using the
@@ -66,10 +66,10 @@ should be returned from a custom ``Configuration`` class which implements the
6666
}
6767
}
6868

69-
Adding node definitions to the tree
69+
Adding Node Definitions to the Tree
7070
-----------------------------------
7171

72-
Variable nodes
72+
Variable Nodes
7373
~~~~~~~~~~~~~~
7474

7575
A tree contains node definitions which can be laid out in a semantic way.
@@ -91,7 +91,7 @@ The root node itself is an array node, and has children, like the boolean
9191
node ``auto_connect`` and the scalar node ``default_connection``. In general:
9292
after defining a node, a call to ``end()`` takes you one step up in the hierarchy.
9393

94-
Node type
94+
Node Type
9595
~~~~~~~~~
9696

9797
It is possible to validate the type of a provided value by using the appropriate
@@ -108,7 +108,7 @@ node definition. Node type are available for:
108108
and are created with ``node($name, $type)`` or their associated shortcut
109109
``xxxxNode($name)`` method.
110110

111-
Numeric node constraints
111+
Numeric Node Constraints
112112
~~~~~~~~~~~~~~~~~~~~~~~~
113113

114114
.. versionadded:: 2.2
@@ -133,7 +133,7 @@ allowing to validate the value::
133133
->end()
134134
;
135135

136-
Enum nodes
136+
Enum Nodes
137137
~~~~~~~~~~
138138

139139
.. versionadded:: 2.1
@@ -152,7 +152,7 @@ values::
152152

153153
This will restrict the ``gender`` option to be either ``male`` or ``female``.
154154

155-
Array nodes
155+
Array Nodes
156156
~~~~~~~~~~~
157157

158158
It is possible to add a deeper level to the hierarchy, by adding an array
@@ -193,7 +193,7 @@ inside the current node. According to the prototype definition in the example
193193
above, it is possible to have multiple connection arrays (containing a ``driver``,
194194
``host``, etc.).
195195

196-
Array node options
196+
Array Node Options
197197
~~~~~~~~~~~~~~~~~~
198198

199199
Before defining the children of an array node, you can provide options like:
@@ -236,7 +236,7 @@ In XML, each ``parameters`` node would have a ``name`` attribute (along with
236236
the final array. The ``useAttributeAsKey`` is useful for normalizing how
237237
arrays are specified between different formats like XML and YAML.
238238

239-
Default and required values
239+
Default and required Values
240240
---------------------------
241241

242242
For all node types, it is possible to define default values and replacement
@@ -316,7 +316,7 @@ you can take advantage of the shortcut
316316
The ``canBeDisabled`` method looks about the same except that the section
317317
would be enabled by default.
318318

319-
Merging options
319+
Merging Options
320320
---------------
321321

322322
Extra options concerning the merge process may be provided. For arrays:
@@ -330,7 +330,7 @@ For all nodes:
330330
``cannotBeOverwritten()``
331331
don’t let other configuration arrays overwrite an existing value for this node
332332

333-
Appending sections
333+
Appending Sections
334334
------------------
335335

336336
If you have a complex configuration to validate then the tree can grow to
@@ -502,7 +502,7 @@ By changing a string value into an associative array with ``name`` as the key::
502502
->end()
503503
;
504504

505-
Validation rules
505+
Validation Rules
506506
----------------
507507

508508
More advanced validation rules can be provided using the
@@ -548,7 +548,7 @@ Usually, "then" is a closure. Its return value will be used as a new value
548548
for the node, instead
549549
of the node's original value.
550550

551-
Processing configuration values
551+
Processing Configuration Values
552552
-------------------------------
553553

554554
The :class:`Symfony\\Component\\Config\\Definition\\Processor` uses the tree

components/config/resources.rst

+4-4
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
11
.. index::
22
single: Config; Loading resources
33

4-
Loading resources
4+
Loading Resources
55
=================
66

7-
Locating resources
7+
Locating Resources
88
------------------
99

1010
Loading the configuration normally starts with a search for resources – in
@@ -24,7 +24,7 @@ look in this directory first. The third argument indicates whether or not the
2424
locator should return the first file it has found, or an array containing
2525
all matches.
2626

27-
Resource loaders
27+
Resource Loaders
2828
----------------
2929

3030
For each type of resource (YAML, XML, annotation, etc.) a loader must be defined.
@@ -57,7 +57,7 @@ class, which allows for recursively importing other resources::
5757
}
5858
}
5959

60-
Finding the right loader
60+
Finding the right Loader
6161
------------------------
6262

6363
The :class:`Symfony\\Component\\Config\\Loader\\LoaderResolver` receives as

components/console/events.rst

+2-2
Original file line numberDiff line numberDiff line change
@@ -51,7 +51,7 @@ dispatched. Listeners receive a
5151
$application = $command->getApplication();
5252
});
5353

54-
The ``ConsoleEvents::TERMINATE`` event
54+
The ``ConsoleEvents::TERMINATE`` Event
5555
--------------------------------------
5656

5757
**Typical Purposes**: To perform some cleanup actions after the command has
@@ -89,7 +89,7 @@ Listeners receive a
8989
It is then dispatched just before the ``ConsoleEvents::EXCEPTION`` event.
9090
The exit code received in this case is the exception code.
9191

92-
The ``ConsoleEvents::EXCEPTION`` event
92+
The ``ConsoleEvents::EXCEPTION`` Event
9393
--------------------------------------
9494

9595
**Typical Purposes**: Handle exceptions thrown during the execution of a

components/console/helpers/dialoghelper.rst

+3-3
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ All the methods inside the Dialog Helper have an
1616
argument, the question as the second argument and the default value as the last
1717
argument.
1818

19-
Asking the User for confirmation
19+
Asking the User for Confirmation
2020
--------------------------------
2121

2222
Suppose you want to confirm an action before actually executing it. Add
@@ -172,7 +172,7 @@ You can also ask and validate a hidden response::
172172
If you want to allow the response to be visible if it cannot be hidden for
173173
some reason, pass true as the fifth argument.
174174

175-
Let the user choose from a list of Answers
175+
Let the User Choose from a List of Answers
176176
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
177177

178178
.. versionadded:: 2.2
@@ -244,7 +244,7 @@ this set the seventh argument to ``true``::
244244
Now, when the user enters ``1,2``, the result will be:
245245
``You have just selected: blue, yellow``.
246246

247-
Testing a Command which expects input
247+
Testing a Command which Expects Input
248248
-------------------------------------
249249

250250
If you want to write a unit test for a command which expects some kind of input

components/console/introduction.rst

+1-1
Original file line numberDiff line numberDiff line change
@@ -437,7 +437,7 @@ method::
437437
You can also test a whole console application by using
438438
:class:`Symfony\\Component\\Console\\Tester\\ApplicationTester`.
439439

440-
Calling an existing Command
440+
Calling an Existing Command
441441
---------------------------
442442

443443
If a command depends on another one being run before it, instead of asking the

components/console/single_command_tool.rst

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
.. index::
22
single: Console; Single command application
33

4-
Building a Single Command Application
4+
Building a single Command Application
55
=====================================
66

77
When building a command line tool, you may not need to provide several commands.

components/css_selector.rst

+4-4
Original file line numberDiff line numberDiff line change
@@ -18,8 +18,8 @@ You can install the component in 2 different ways:
1818
Usage
1919
-----
2020

21-
Why use CSS selectors?
22-
~~~~~~~~~~~~~~~~~~~~~~
21+
Why to Use CSS selectors?
22+
~~~~~~~~~~~~~~~~~~~~~~~~~
2323

2424
When you're parsing an HTML or an XML document, by far the most powerful
2525
method is XPath.
@@ -41,7 +41,7 @@ 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
44+
The CssSelector Component
4545
~~~~~~~~~~~~~~~~~~~~~~~~~
4646

4747
The component's only goal is to convert CSS selectors to their XPath
@@ -66,7 +66,7 @@ You can use this expression with, for instance, :phpclass:`DOMXPath` or
6666
uses the CssSelector component to find elements based on a CSS selector
6767
string. See the :doc:`/components/dom_crawler` for more details.
6868

69-
Limitations of the CssSelector component
69+
Limitations of the CssSelector Component
7070
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
7171

7272
Not all CSS selectors can be converted to XPath equivalents.

components/dependency_injection/advanced.rst

+1-1
Original file line numberDiff line numberDiff line change
@@ -156,7 +156,7 @@ service by asking for the ``bar`` service like this::
156156
bar: "@foo"
157157
158158
159-
Requiring files
159+
Requiring Files
160160
---------------
161161

162162
There might be use cases when you need to include another file just before

components/dependency_injection/compilation.rst

+1-1
Original file line numberDiff line numberDiff line change
@@ -273,7 +273,7 @@ but also load a secondary one only if a certain parameter is set::
273273

274274
.. _components-dependency-injection-compiler-passes:
275275

276-
Prepending Configuration passed to the Extension
276+
Prepending Configuration Passed to the Extension
277277
------------------------------------------------
278278

279279
.. versionadded:: 2.2

components/dependency_injection/definitions.rst

+2-2
Original file line numberDiff line numberDiff line change
@@ -33,10 +33,10 @@ it to the container using::
3333

3434
$container->setDefinition($id, $definition);
3535

36-
Working with a definition
36+
Working with a Definition
3737
-------------------------
3838

39-
Creating a new definition
39+
Creating a new Definition
4040
~~~~~~~~~~~~~~~~~~~~~~~~~
4141

4242
If you need to create a new definition rather than manipulate one retrieved

components/dependency_injection/introduction.rst

+2-2
Original file line numberDiff line numberDiff line change
@@ -160,7 +160,7 @@ like this::
160160

161161
$newsletterManager = $container->get('newsletter_manager');
162162

163-
Avoiding Your Code Becoming Dependent on the Container
163+
Avoiding your Code Becoming Dependent on the Container
164164
------------------------------------------------------
165165

166166
Whilst you can retrieve services from the container directly it is best
@@ -175,7 +175,7 @@ should be as few times as possible at the entry point to your application.
175175

176176
.. _components-dependency-injection-loading-config:
177177

178-
Setting Up the Container with Configuration Files
178+
Setting up the Container with Configuration Files
179179
-------------------------------------------------
180180

181181
As well as setting up the services using PHP as above you can also use

components/dependency_injection/lazy_services.rst

+5-5
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ Lazy Services
77
.. versionadded:: 2.3
88
Lazy services were added in Symfony 2.3.
99

10-
Why Lazy Services?
10+
Why lazy Services?
1111
------------------
1212

1313
In some cases, you may want to inject a service that is a bit heavy to instantiate,
@@ -36,13 +36,13 @@ the `ProxyManager bridge`_:
3636

3737
If you're using the full-stack framework, the proxy manager bridge is already
3838
included but the actual proxy manager needs to be included. Therefore add
39-
39+
4040
.. code-block:: json
4141
4242
"require": {
4343
"ocramius/proxy-manager": "0.4.*"
4444
}
45-
45+
4646
to your ``composer.json``. Afterwards compile your container and check
4747
to make sure that you get a proxy for your lazy services.
4848

@@ -79,13 +79,13 @@ the same signature of the class representing the service. You can also inject
7979
the service just like normal into other services. The object that's actually
8080
injected will be the proxy.
8181

82-
To check if your proxy works you can simply check the interface of the
82+
To check if your proxy works you can simply check the interface of the
8383
received object.
8484

8585
.. code-block:: php
8686
8787
var_dump(class_implements($service));
88-
88+
8989
If the class implements the ``ProxyManager\Proxy\LazyLoadingInterface`` your
9090
lazy loaded services are working.
9191

components/dependency_injection/parentservices.rst

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
.. index::
22
single: DependencyInjection; Parent services
33

4-
Managing Common Dependencies with Parent Services
4+
Managing common Dependencies with parent Services
55
=================================================
66

77
As you add more functionality to your application, you may well start to have
@@ -299,7 +299,7 @@ would cause an exception to be raised for a non-abstract service.
299299
You can just extract common parts of similar service definitions into
300300
a parent service without also extending a parent class in PHP.
301301

302-
Overriding Parent Dependencies
302+
Overriding parent Dependencies
303303
------------------------------
304304

305305
There may be times where you want to override what class is passed in for

components/dependency_injection/tags.rst

+2-2
Original file line numberDiff line numberDiff line change
@@ -64,7 +64,7 @@ Then, define the chain as a service:
6464
6565
$container->setDefinition('acme_mailer.transport_chain', new Definition('%acme_mailer.transport_chain.class%'));
6666
67-
Define Services with a Custom Tag
67+
Define Services with a custom Tag
6868
---------------------------------
6969

7070
Now you might want several of the ``\Swift_Transport`` classes to be instantiated
@@ -172,7 +172,7 @@ run when the container is compiled::
172172
stack framework. See :doc:`/cookbook/service_container/compiler_passes`
173173
for more details.
174174

175-
Adding additional attributes on Tags
175+
Adding additional Attributes on Tags
176176
------------------------------------
177177

178178
Sometimes you need additional information about each service that's tagged with your tag.

0 commit comments

Comments
 (0)