Skip to content

Commit c0f24a3

Browse files
committed
Merge branch '4.3' into 4.4
* 4.3: Fixed many spelling issues
2 parents a129ed7 + 377d585 commit c0f24a3

34 files changed

+123
-116
lines changed

bundles/best_practices.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@ A namespace becomes a bundle as soon as you add a bundle class to it. The
2626
bundle class name must follow these rules:
2727

2828
* Use only alphanumeric characters and underscores;
29-
* Use a StudlyCaps name (i.e. camelCase with the first letter uppercased);
29+
* Use a StudlyCaps name (i.e. camelCase with an uppercase first letter);
3030
* Use a descriptive and short name (no more than two words);
3131
* Prefix the name with the concatenation of the vendor (and optionally the
3232
category namespaces);

components/asset.rst

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -119,8 +119,9 @@ suffix to any asset path::
119119
echo $package->getUrl('image.png');
120120
// result: image.png?v1
121121

122-
In case you want to modify the version format, pass a sprintf-compatible format
123-
string as the second argument of the ``StaticVersionStrategy`` constructor::
122+
In case you want to modify the version format, pass a ``sprintf``-compatible
123+
format string as the second argument of the ``StaticVersionStrategy``
124+
constructor::
124125

125126
// puts the 'version' word before the version value
126127
$package = new Package(new StaticVersionStrategy('v1', '%s?version=%s'));

components/config.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ The Config Component
66
====================
77

88
The Config component provides several classes to help you find, load,
9-
combine, autofill and validate configuration values of any kind, whatever
9+
combine, fill and validate configuration values of any kind, whatever
1010
their source may be (YAML, XML, INI files, or for instance a database).
1111

1212
Installation

components/console/helpers/processhelper.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ useful information about process status.
99

1010
To display process details, use the :class:`Symfony\\Component\\Console\\Helper\\ProcessHelper`
1111
and run your command with verbosity. For example, running the following code with
12-
a very verbose verbosity (e.g. -vv)::
12+
a very verbose verbosity (e.g. ``-vv``)::
1313

1414
use Symfony\Component\Process\Process;
1515

components/console/helpers/progressbar.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -278,7 +278,7 @@ the example above.
278278
Bar Settings
279279
~~~~~~~~~~~~
280280

281-
Amongst the placeholders, ``bar`` is a bit special as all the characters used
281+
Among the placeholders, ``bar`` is a bit special as all the characters used
282282
to display it can be customized::
283283

284284
// the finished part of the bar

components/console/helpers/questionhelper.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -266,7 +266,7 @@ convenient for passwords::
266266
.. caution::
267267

268268
When you ask for a hidden response, Symfony will use either a binary, change
269-
stty mode or use another trick to hide the response. If none is available,
269+
``stty`` mode or use another trick to hide the response. If none is available,
270270
it will fallback and allow the response to be visible unless you set this
271271
behavior to ``false`` using
272272
:method:`Symfony\\Component\\Console\\Question\\Question::setHiddenFallback`

components/console/usage.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ built-in options as well as a couple of built-in commands for the Console compon
1010
.. note::
1111

1212
These examples assume you have added a file ``application.php`` to run at
13-
the cli::
13+
the CLI::
1414

1515
#!/usr/bin/env php
1616
<?php

components/dependency_injection/compilation.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -78,7 +78,7 @@ A very simple extension may just load configuration files into the container::
7878

7979
This does not gain very much compared to loading the file directly into
8080
the overall container being built. It just allows the files to be split
81-
up amongst the modules/bundles. Being able to affect the configuration
81+
up among the modules/bundles. Being able to affect the configuration
8282
of a module from configuration files outside of the module/bundle is needed
8383
to make a complex application configurable. This can be done by specifying
8484
sections of config files loaded directly into the container as being for

components/dom_crawler.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -157,7 +157,7 @@ and :method:`Symfony\\Component\\DomCrawler\\Crawler::filter`::
157157
method.
158158

159159
The default namespace is removed when loading the content if it's the only
160-
namespace in the document. It's done to simplify the xpath queries.
160+
namespace in the document. It's done to simplify the XPath queries.
161161

162162
Namespaces can be explicitly registered with the
163163
:method:`Symfony\\Component\\DomCrawler\\Crawler::registerNamespace` method::
@@ -219,7 +219,7 @@ Get the first parent (heading toward the document root) of the element that matc
219219
Accessing Node Values
220220
~~~~~~~~~~~~~~~~~~~~~
221221

222-
Access the node name (HTML tag name) of the first node of the current selection (eg. "p" or "div")::
222+
Access the node name (HTML tag name) of the first node of the current selection (e.g. "p" or "div")::
223223

224224
// returns the node name (HTML tag name) of the first child element under <body>
225225
$tag = $crawler->filterXPath('//body/*')->nodeName();

components/expression_language.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -102,9 +102,9 @@ PHP type (including objects)::
102102
[
103103
'fruit' => $apple,
104104
]
105-
));
105+
)); // displays "Honeycrisp"
106106

107-
This will print "Honeycrisp". For more information, see the :doc:`/components/expression_language/syntax`
107+
For more information, see the :doc:`/components/expression_language/syntax`
108108
entry, especially :ref:`component-expression-objects` and :ref:`component-expression-arrays`.
109109

110110
Caching

components/filesystem.rst

Lines changed: 38 additions & 36 deletions
Original file line numberDiff line numberDiff line change
@@ -44,8 +44,8 @@ endpoint for filesystem operations::
4444
string, an array or any object implementing :phpclass:`Traversable` as
4545
the target argument.
4646

47-
mkdir
48-
~~~~~
47+
``mkdir``
48+
~~~~~~~~~
4949

5050
:method:`Symfony\\Component\\Filesystem\\Filesystem::mkdir` creates a directory recursively.
5151
On POSIX filesystems, directories are created with a default mode value
@@ -65,12 +65,12 @@ On POSIX filesystems, directories are created with a default mode value
6565
.. note::
6666

6767
The directory permissions are affected by the current `umask`_.
68-
Set the umask for your webserver, use PHP's :phpfunction:`umask`
68+
Set the ``umask`` for your webserver, use PHP's :phpfunction:`umask`
6969
function or use the :phpfunction:`chmod` function after the
7070
directory has been created.
7171

72-
exists
73-
~~~~~~
72+
``exists``
73+
~~~~~~~~~~
7474

7575
:method:`Symfony\\Component\\Filesystem\\Filesystem::exists` checks for the
7676
presence of one or more files or directories and returns ``false`` if any of
@@ -88,8 +88,8 @@ them is missing::
8888
You can pass an array or any :phpclass:`Traversable` object as the first
8989
argument.
9090

91-
copy
92-
~~~~
91+
``copy``
92+
~~~~~~~~
9393

9494
:method:`Symfony\\Component\\Filesystem\\Filesystem::copy` makes a copy of a
9595
single file (use :method:`Symfony\\Component\\Filesystem\\Filesystem::mirror` to
@@ -103,8 +103,8 @@ by the third boolean argument::
103103
// image.jpg will be overridden
104104
$filesystem->copy('image-ICC.jpg', 'image.jpg', true);
105105

106-
touch
107-
~~~~~
106+
``touch``
107+
~~~~~~~~~
108108

109109
:method:`Symfony\\Component\\Filesystem\\Filesystem::touch` sets access and
110110
modification time for a file. The current time is used by default. You can set
@@ -122,8 +122,8 @@ your own with the second argument. The third argument is the access time::
122122
You can pass an array or any :phpclass:`Traversable` object as the first
123123
argument.
124124

125-
chown
126-
~~~~~
125+
``chown``
126+
~~~~~~~~~
127127

128128
:method:`Symfony\\Component\\Filesystem\\Filesystem::chown` changes the owner of
129129
a file. The third argument is a boolean recursive option::
@@ -138,8 +138,8 @@ a file. The third argument is a boolean recursive option::
138138
You can pass an array or any :phpclass:`Traversable` object as the first
139139
argument.
140140

141-
chgrp
142-
~~~~~
141+
``chgrp``
142+
~~~~~~~~~
143143

144144
:method:`Symfony\\Component\\Filesystem\\Filesystem::chgrp` changes the group of
145145
a file. The third argument is a boolean recursive option::
@@ -154,8 +154,8 @@ a file. The third argument is a boolean recursive option::
154154
You can pass an array or any :phpclass:`Traversable` object as the first
155155
argument.
156156

157-
chmod
158-
~~~~~
157+
``chmod``
158+
~~~~~~~~~
159159

160160
:method:`Symfony\\Component\\Filesystem\\Filesystem::chmod` changes the mode or
161161
permissions of a file. The fourth argument is a boolean recursive option::
@@ -170,8 +170,8 @@ permissions of a file. The fourth argument is a boolean recursive option::
170170
You can pass an array or any :phpclass:`Traversable` object as the first
171171
argument.
172172

173-
remove
174-
~~~~~~
173+
``remove``
174+
~~~~~~~~~~
175175

176176
:method:`Symfony\\Component\\Filesystem\\Filesystem::remove` deletes files,
177177
directories and symlinks::
@@ -183,8 +183,8 @@ directories and symlinks::
183183
You can pass an array or any :phpclass:`Traversable` object as the first
184184
argument.
185185

186-
rename
187-
~~~~~~
186+
``rename``
187+
~~~~~~~~~~
188188

189189
:method:`Symfony\\Component\\Filesystem\\Filesystem::rename` changes the name
190190
of a single file or directory::
@@ -194,8 +194,8 @@ of a single file or directory::
194194
// renames a directory
195195
$filesystem->rename('/tmp/files', '/path/to/store/files');
196196

197-
symlink
198-
~~~~~~~
197+
``symlink``
198+
~~~~~~~~~~~
199199

200200
:method:`Symfony\\Component\\Filesystem\\Filesystem::symlink` creates a
201201
symbolic link from the target to the destination. If the filesystem does not
@@ -207,8 +207,8 @@ support symbolic links, a third boolean argument is available::
207207
// does not support symbolic links
208208
$filesystem->symlink('/path/to/source', '/path/to/destination', true);
209209

210-
readlink
211-
~~~~~~~~
210+
``readlink``
211+
~~~~~~~~~~~~
212212

213213
:method:`Symfony\\Component\\Filesystem\\Filesystem::readlink` read links targets.
214214

@@ -238,8 +238,8 @@ Its behavior is the following::
238238
* if ``$path`` does not exist, it returns null.
239239
* if ``$path`` exists, it returns its absolute fully resolved final version.
240240

241-
makePathRelative
242-
~~~~~~~~~~~~~~~~
241+
``makePathRelative``
242+
~~~~~~~~~~~~~~~~~~~~
243243

244244
:method:`Symfony\\Component\\Filesystem\\Filesystem::makePathRelative` takes two
245245
absolute paths and returns the relative path from the second path to the first one::
@@ -252,8 +252,8 @@ absolute paths and returns the relative path from the second path to the first o
252252
// returns 'videos/'
253253
$filesystem->makePathRelative('/tmp/videos', '/tmp')
254254

255-
mirror
256-
~~~~~~
255+
``mirror``
256+
~~~~~~~~~~
257257

258258
:method:`Symfony\\Component\\Filesystem\\Filesystem::mirror` copies all the
259259
contents of the source directory into the target one (use the
@@ -262,8 +262,8 @@ files)::
262262

263263
$filesystem->mirror('/path/to/source', '/path/to/target');
264264

265-
isAbsolutePath
266-
~~~~~~~~~~~~~~
265+
``isAbsolutePath``
266+
~~~~~~~~~~~~~~~~~~
267267

268268
:method:`Symfony\\Component\\Filesystem\\Filesystem::isAbsolutePath` returns
269269
``true`` if the given path is absolute, ``false`` otherwise::
@@ -277,16 +277,18 @@ isAbsolutePath
277277
// returns false
278278
$filesystem->isAbsolutePath('../dir');
279279

280-
tempnam
281-
~~~~~~~
280+
``tempnam``
281+
~~~~~~~~~~~
282282

283-
:method:`Symfony\\Component\\Filesystem\\Filesystem::tempnam` creates a temporary file with a unique filename, and returns its path, or throw an exception on failure::
283+
:method:`Symfony\\Component\\Filesystem\\Filesystem::tempnam` creates a
284+
temporary file with a unique filename, and returns its path, or throw an
285+
exception on failure::
284286

285287
// returns a path like : /tmp/prefix_wyjgtF
286288
$filesystem->tempnam('/tmp', 'prefix_');
287289

288-
dumpFile
289-
~~~~~~~~
290+
``dumpFile``
291+
~~~~~~~~~~~~
290292

291293
:method:`Symfony\\Component\\Filesystem\\Filesystem::dumpFile` saves the given
292294
contents into a file. It does this in an atomic manner: it writes a temporary
@@ -298,8 +300,8 @@ complete new file (but never a partially-written file)::
298300

299301
The ``file.txt`` file contains ``Hello World`` now.
300302

301-
appendToFile
302-
~~~~~~~~~~~~
303+
``appendToFile``
304+
~~~~~~~~~~~~~~~~
303305

304306
:method:`Symfony\\Component\\Filesystem\\Filesystem::appendToFile` adds new
305307
contents at the end of some file::

components/process.rst

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -51,7 +51,7 @@ the contents of the output and
5151
the contents of the error output.
5252

5353
You can also use the :class:`Symfony\\Component\\Process\\Process` class with the
54-
foreach construct to get the output while it is generated. By default, the loop waits
54+
for each construct to get the output while it is generated. By default, the loop waits
5555
for new output before going to the next iteration::
5656

5757
$process = new Process(['ls', '-lsa']);
@@ -163,7 +163,7 @@ env vars you want to remove::
163163
Getting real-time Process Output
164164
--------------------------------
165165

166-
When executing a long running command (like rsync-ing files to a remote
166+
When executing a long running command (like ``rsync`` to a remote
167167
server), you can give feedback to the end user in real-time by passing an
168168
anonymous function to the
169169
:method:`Symfony\\Component\\Process\\Process::run` method::
@@ -280,7 +280,7 @@ Streaming to the Standard Input of a Process
280280
Before a process is started, you can specify its standard input using either the
281281
:method:`Symfony\\Component\\Process\\Process::setInput` method or the 4th argument
282282
of the constructor. The provided input can be a string, a stream resource or a
283-
Traversable object::
283+
``Traversable`` object::
284284

285285
$process = new Process(['cat']);
286286
$process->setInput('foobar');
@@ -310,7 +310,7 @@ provides the :class:`Symfony\\Component\\Process\\InputStream` class::
310310
echo $process->getOutput();
311311

312312
The :method:`Symfony\\Component\\Process\\InputStream::write` method accepts scalars,
313-
stream resources or Traversable objects as argument. As shown in the above example,
313+
stream resources or ``Traversable`` objects as argument. As shown in the above example,
314314
you need to explicitly call the :method:`Symfony\\Component\\Process\\InputStream::close`
315315
method when you are done writing to the standard input of the subprocess.
316316

components/property_access.rst

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -112,9 +112,9 @@ Using Getters
112112
~~~~~~~~~~~~~
113113

114114
The ``getValue()`` method also supports reading using getters. The method will
115-
be created using common naming conventions for getters. It camelizes the
116-
property name (``first_name`` becomes ``FirstName``) and prefixes it with
117-
``get``. So the actual method becomes ``getFirstName()``::
115+
be created using common naming conventions for getters. It transform the
116+
property name to camelCase (``first_name`` becomes ``FirstName``) and prefixes
117+
it with ``get``. So the actual method becomes ``getFirstName()``::
118118

119119
// ...
120120
class Person

components/property_info.rst

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -281,8 +281,8 @@ Each object will provide 6 attributes, available in the 6 methods:
281281

282282
.. _`components-property-info-type-builtin`:
283283

284-
Type::getBuiltInType()
285-
~~~~~~~~~~~~~~~~~~~~~~
284+
``Type::getBuiltInType()``
285+
~~~~~~~~~~~~~~~~~~~~~~~~~~
286286

287287
The :method:`Type::getBuiltinType() <Symfony\\Component\\PropertyInfo\\Type::getBuiltinType>`
288288
method returns the built-in PHP data type, which can be one of these
@@ -292,22 +292,22 @@ string values: ``array``, ``bool``, ``callable``, ``float``, ``int``,
292292
Constants inside the :class:`Symfony\\Component\\PropertyInfo\\Type`
293293
class, in the form ``Type::BUILTIN_TYPE_*``, are provided for convenience.
294294

295-
Type::isNullable()
296-
~~~~~~~~~~~~~~~~~~
295+
``Type::isNullable()``
296+
~~~~~~~~~~~~~~~~~~~~~~
297297

298298
The :method:`Type::isNullable() <Symfony\\Component\\PropertyInfo\\Type::isNullable>`
299299
method will return a boolean value indicating whether the property parameter
300300
can be set to ``null``.
301301

302-
Type::getClassName()
303-
~~~~~~~~~~~~~~~~~~~~
302+
``Type::getClassName()``
303+
~~~~~~~~~~~~~~~~~~~~~~~~
304304

305305
If the :ref:`built-in PHP data type <components-property-info-type-builtin>`
306306
is ``object``, the :method:`Type::getClassName() <Symfony\\Component\\PropertyInfo\\Type::getClassName>`
307307
method will return the fully-qualified class or interface name accepted.
308308

309-
Type::isCollection()
310-
~~~~~~~~~~~~~~~~~~~~
309+
``Type::isCollection()``
310+
~~~~~~~~~~~~~~~~~~~~~~~~
311311

312312
The :method:`Type::isCollection() <Symfony\\Component\\PropertyInfo\\Type::isCollection>`
313313
method will return a boolean value indicating if the property parameter is
@@ -326,8 +326,8 @@ this returns ``true`` if:
326326

327327
The support of phpDocumentor collection types was introduced in Symfony 4.2.
328328

329-
Type::getCollectionKeyType() & Type::getCollectionValueType()
330-
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
329+
``Type::getCollectionKeyType()`` & ``Type::getCollectionValueType()``
330+
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
331331

332332
If the property is a collection, additional type objects may be returned
333333
for both the key and value types of the collection (if the information is

0 commit comments

Comments
 (0)