8000 Fix all invalid API doc links · symfony/symfony-docs@a858888 · GitHub
[go: up one dir, main page]
Skip to content

Commit a858888

Browse files
wouterjwouterj
committed
Fix all invalid API doc links
1 parent 123d05f commit a858888

File tree

13 files changed

+20
-23
lines changed

13 files changed

+20
-23
lines changed

‎book/http_cache.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -627,7 +627,7 @@ doing so much work.
627627

628628
Symfony also supports weak ETags by passing ``true`` as the second
629629
argument to the
630-
:method:`Symfony\\Component\\HttpFoundation\\Response::setETag` method.
630+
:method:`Symfony\\Component\\HttpFoundation\\Response::setEtag` method.
631631

632632
.. index::
633633
single: Cache; Last-Modified header

‎components/config/definition.rst

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -121,9 +121,9 @@ Numeric Node Constraints
121121
The numeric (float and integer) nodes were introduced in Symfony 2.2.
122122

123123
Numeric nodes (float and integer) provide two extra constraints -
124-
:method:`Symfony\\Component\\Config\\Definition\\Builder::min` and
125-
:method:`Symfony\\Component\\Config\\Definition\\Builder::max` -
126-
allowing to validate the value::
124+
:method:`Symfony\\Component\\Config\\Definition\\Builder\\IntegerNodeDefinition::min`
125+
and :method:`Symfony\\Component\\Config\\Definition\\Builder\\IntegerNodeDefinition::max`
126+
- allowing to validate the value::
127127

128128
$rootNode
129129
->children()

‎components/dom_crawler.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -188,7 +188,7 @@ The crawler supports multiple ways of adding the content::
188188
.. note::
189189

190190
When dealing with character sets other than ISO-8859-1, always add HTML
191-
content using the :method:`Symfony\\Component\\DomCrawler\\Crawler::addHTMLContent`
191+
content using the :method:`Symfony\\Component\\DomCrawler\\Crawler::addHtmlContent`
192192
method where you can specify the second parameter to be your target character
193193
set.
194194

‎components/http_foundation/session_testing.rst

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -21,16 +21,16 @@ The mock storage drivers do not read or write the system globals
2121
``session_id()`` or ``session_name()``. Methods are provided to simulate this if
2222
required:
2323

24-
* :method:`Symfony\\Component\\HttpFoundation\\Session\\SessionStorageInterface::getId`: Gets the
24+
* :method:`Symfony\\Component\\HttpFoundation\\Session\\Storage\\SessionStorageInterface::getId`: Gets the
2525
session ID.
2626

27-
* :method:`Symfony\\Component\\HttpFoundation\\Session\\SessionStorageInterface::setId`: Sets the
27+
* :method:`Symfony\\Component\\HttpFoundation\\Session\\Storage\\SessionStorageInterface::setId`: Sets the
2828
session ID.
2929

30-
* :method:`Symfony\\Component\\HttpFoundation\\Session\\SessionStorageInterface::getName`: Gets the
30+
* :method:`Symfony\\Component\\HttpFoundation\\Session\\Storage\\SessionStorageInterface::getName`: Gets the
3131
session name.
3232

33-
* :method:`Symfony\\Component\\HttpFoundation\\Session\\SessionStorageInterface::setName`: Sets the
33+
* :method:`Symfony\\Component\\HttpFoundation\\Session\\Storage\\SessionStorageInterface::setName`: Sets the
3434
session name.
3535

3636
Unit Testing

‎components/http_foundation/sessions.rst

Lines changed: 0 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -226,9 +226,6 @@ has a simple API
226226
:method:`Symfony\\Component\\HttpFoundation\\Session\\Attribute\\AttributeBagInterface::has`
227227
Returns true if the attribute exists.
228228

229-
:method:`Symfony\\Component\\HttpFoundation\\Session\\Attribute\\AttributeBagInterface::keys`
230-
Returns an array of stored attribute keys.
231-
232229
:method:`Symfony\\Component\\HttpFoundation\\Session\\Attribute\\AttributeBagInterface::replace`
233230
Sets multiple attributes at once: takes a keyed array and sets each key => value pair.
234231

‎components/process.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -158,7 +158,7 @@ To make your code work better on all platforms, you might want to use the
158158
method was introduced in Symfony 2.3.
159159

160160
In case you are building a binary driver, you can use the
161-
:method:`Symfony\\Component\\Process\\Process::setPrefix` method to prefix all
161+
:method:`Symfony\\Component\\Process\\ProcessBuilder::setPrefix` method to prefix all
162162
the generated process commands.
163163

164164
The following example will generate two process commands for a tar binary
@@ -194,7 +194,7 @@ timeout (in seconds)::
194194
$process->run();
195195

196196
If the timeout is reached, a
197-
:class:`Symfony\\Process\\Exception\\RuntimeException` is thrown.
197+
:class:`Symfony\\Component\\Process\\Exception\\RuntimeException` is thrown.
198198

199199
For long running commands, it is your responsibility to perform the timeout
200200
check regularly::

‎components/security/authentication.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -101,7 +101,7 @@ Each provider (since it implements
101101
has a method :method:`Symfony\\Component\\Security\\Core\\Authentication\\Provider\\AuthenticationProviderInterface::supports`
102102
by which the ``AuthenticationProviderManager``
103103
can determine if it supports the given token. If this is the case, the
104-
manager then calls the provider's method :class:`Symfony\\Component\\Security\\Core\\Authentication\\Provider\\AuthenticationProviderInterface::authenticate`.
104+
manager then calls the provider's method :method:`Symfony\\Component\\Security\\Core\\Authentication\\Provider\\AuthenticationProviderInterface::authenticate`.
105105
This method should return an authenticated token or throw an
106106
:class:`Symfony\\Component\\Security\\Core\\Exception\\AuthenticationException`
107107
(or any other exception extending it).

‎components/security/authorization.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -177,7 +177,7 @@ Roles
177177

178178
Roles are objects that give expression to a certain right the user has.
179179
The only requirement is that they implement :class:`Symfony\\Component\\Security\\Core\\Role\\RoleInterface`,
180-
which means they should also have a :method:`Symfony\\Component\\Security\\Core\\Role\\Role\\RoleInterface::getRole`
180+
which means they should also have a :method:`Symfony\\Component\\Security\\Core\\Role\\RoleInterface::getRole`
181181
method that returns a string representation of the role itself. The default
182182
:class:`Symfony\\Component\\Security\\Core\\Role\\Role` simply returns its
183183
first constructor argument::

‎cookbook/bundles/configuration.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -353,7 +353,7 @@ In order to use the schema, the XML configuration file must provide an
353353
``xsi:schemaLocation`` attribute pointing to the XSD file for a certain XML
354354
namespace. This location always starts with the XML namespace. This XML
355355
namespace is then replaced with the XSD validation base path returned from
356-
:method:`Extension::getXsdValidationBasePath() <Symfony\\Component\\DependencyInjection\\ExtensionInterface::getXsdValidationBasePath>`
356+
:method:`Extension::getXsdValidationBasePath() <Symfony\\Component\\DependencyInjection\\Extension\\ExtensionInterface::getXsdValidationBasePath>`
357357
method. This namespace is then followed by the rest of the path from the base
358358
path to the file itself.
359359

‎cookbook/controller/service.rst

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -324,7 +324,6 @@ controller:
324324
controller action method called ``Request $request``. The order of the
325325
parameters is not important, but the typehint must be provided.
326326

327-
328327
.. _`Controller class source code`: https://github.com/symfony/symfony/blob/master/src/Symfony/Bundle/FrameworkBundle/Controller/Controller.php
329328
.. _`base Controller class`: https://github.com/symfony/symfony/blob/master/src/Symfony/Bundle/FrameworkBundle/Controller/Controller.php
330329
.. _`FrameworkExtraBundle documentation`: https://symfony.com/doc/current/bundles/SensioFrameworkExtraBundle/annotations/routing.html

‎cookbook/controller/upload_file.rst

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -156,8 +156,9 @@ There are some important things to consider in the code of the above controller:
156156
provides methods for the most common operations when dealing with uploaded files.
157157
#. A well-known security best practice is to never trust the input provided by
158158
users. This also applies to the files uploaded by your visitors. The ``Uploaded``
159-
class provides methods to get the original file extension (:method:`Symfony\\Component\\HttpFoundation\\File\\UploadedFile::getExtension`),
160-
the original file size (:method:`Symfony\\Component\\HttpFoundation\\File\\UploadedFile::getSize`)
159+
class provides methods to get the original file extension
160+
(:method:`Symfony\\Component\\HttpFoundation\\File\\UploadedFile::getExtension`),
161+
the original file size (:method:`Symfony\\Component\\HttpFoundation\\File\\UploadedFile::getClientSize`)
161162
and the original file name (:method:`Symfony\\Component\\HttpFoundation\\File\\UploadedFile::getClientOriginalName`).
162163
However, they are considered *not safe* because a malicious user could tamper
163164
that information. That's why it's always better to generate a unique name and

‎cookbook/routing/redirect_in_config.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ Redirecting Using a Path
1717

1818
Assume there is no default controller for the ``/`` path of your application
1919
and you want to redirect these requests to ``/app``. You will need to use the
20-
:method:`Symfony\\Bundle\\FrameworkBundle\\Controller\\RedirectController::urlRedirect`
20+
:method:`Symfony\\Bundle\\FrameworkBundle\\Controller\\RedirectController::urlRedirectAction`
2121
action to redirect to this new url:
2222

2323
.. configuration-block::
@@ -97,7 +97,7 @@ Redirecting Using a Route
9797
Assume you are migrating your website from WordPress to Symfony, you want to
9898
redirect ``/wp-admin`` to the route ``sonata_admin_dashboard``. You don't know
9999
the path, only the route name. This can be achieved using the
100-
:method:`Symfony\\Bundle\\FrameworkBundle\\Controller\\RedirectController::redirect`
100+
:method:`Symfony\\Bundle\\FrameworkBundle\\Controller\\RedirectController::redirectAction`
101101
action:
102102

103103
.. configuration-block::

‎reference/configuration/framework.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -311,7 +311,7 @@ instance), the host might have been manipulated by an attacker.
311311
You can read "`HTTP Host header attacks`_" for more information about
312312
these kinds of attacks.
313313

314-
The Symfony :method:`Request::getHost() <Symfony\\Component\\HttpFoundation\\Request:getHost>`
314+
The Symfony :method:`Request::getHost() <Symfony\\Component\\HttpFoundation\\Request::getHost>`
315315
method might be vulnerable to some of these attacks because it depends on
316316
the configuration of your web server. One simple solution to avoid these
317317
attacks is to whitelist the hosts that your Symfony application can respond

0 commit comments

Comments
 (0)
0