Skip to content

Commit 4417191

Browse files
committed
Fix all invalid API doc links
1 parent 56dd990 commit 4417191

File tree

17 files changed

+49
-61
lines changed

17 files changed

+49
-61
lines changed

book/controller.rst

Lines changed: 4 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -429,9 +429,7 @@ A great way to see the core functionality in action is to look in the
429429
Redirecting
430430
~~~~~~~~~~~
431431

432-
If you want to redirect the user to another page, use the
433-
:method:`Symfony\\Bundle\\FrameworkBundle\\Controller\\Controller::redirect`
434-
method::
432+
If you want to redirect the user to another page, use the ``redirect()`` method::
435433

436434
public function indexAction()
437435
{
@@ -750,10 +748,9 @@ Forwarding to Another Controller
750748
--------------------------------
751749

752750
Though not very common, you can also forward to another controller internally
753-
with the :method:`Symfony\\Bundle\\FrameworkBundle\\Controller\\Controller::forward`
754-
method. Instead of redirecting the user's browser, it makes an internal sub-request,
755-
and calls the controller. The ``forward()`` method returns the ``Response``
756-
object that's returned from *that* controller::
751+
with the ``forward()`` method. Instead of redirecting the user's browser, it
752+
makes an internal sub-request, and calls the controller. The ``forward()``
753+
method returns the ``Response`` object that's returned from *that* controller::
757754

758755
public function indexAction($name)
759756
{

book/doctrine.rst

Lines changed: 4 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -519,11 +519,10 @@ of the bundle::
519519
.. tip::
520520

521521
This article shows working with Doctrine from within a controller by using
522-
the :method:`Symfony\\Bundle\\FrameworkBundle\\Controller\\Controller::getDoctrine`
523-
method of the controller. This method is a shortcut to get the
524-
``doctrine`` service. You can work with Doctrine anywhere else
525-
by injecting that service in the service. See
526-
:doc:`/book/service_container` for more on creating your own services.
522+
the ``getDoctrine()`` method of the controller. This method is a shortcut
523+
to get the ``doctrine`` service. You can work with Doctrine anywhere else
524+
by injecting that service in the service. See :doc:`/book/service_container`
525+
for more on creating your own services.
527526

528527
Take a look at the previous example in more detail:
529528

book/http_cache.rst

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -181,8 +181,7 @@ from your application and returning them to the client.
181181
error_log($kernel->getLog());
182182

183183
The ``AppCache`` object has a sensible default configuration, but it can be
184-
finely tuned via a set of options you can set by overriding the
185-
:method:`Symfony\\Bundle\\FrameworkBundle\\HttpCache\\HttpCache::getOptions`
184+
finely tuned via a set of options you can set by overriding the ``getOptions()``
186185
method::
187186

188187
// app/AppCache.php
@@ -627,7 +626,7 @@ doing so much work.
627626

628627
Symfony also supports weak ETags by passing ``true`` as the second
629628
argument to the
630-
:method:`Symfony\\Component\\HttpFoundation\\Response::setETag` method.
629+
:method:`Symfony\\Component\\HttpFoundation\\Response::setEtag` method.
631630

632631
.. index::
633632
single: Cache; Last-Modified header

components/config/definition.rst

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

119119
Numeric nodes (float and integer) provide two extra constraints -
120-
:method:`Symfony\\Component\\Config\\Definition\\Builder::min` and
121-
:method:`Symfony\\Component\\Config\\Definition\\Builder::max` -
122-
allowing to validate the value::
120+
:method:`Symfony\\Component\\Config\\Definition\\Builder\\IntegerNodeDefinition::min`
121+
and :method:`Symfony\\Component\\Config\\Definition\\Builder\\IntegerNodeDefinition::max`
122+
- allowing to validate the value::
123123

124124
$rootNode
125125
->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/form/introduction.rst

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -379,9 +379,8 @@ Creating a simple Form
379379

380380
If you're using the Symfony Framework, then the form factory is available
381381
automatically as a service called ``form.factory``. Also, the default
382-
base controller class has a :method:`Symfony\\Bundle\\FrameworkBundle\\Controller::createFormBuilder`
383-
method, which is a shortcut to fetch the form factory and call ``createBuilder``
384-
on it.
382+
base controller class has a ``createFormBuilder()`` method, which is a
383+
shortcut to fetch the form factory and call ``createBuilder`` on it.
385384

386385
Creating a form is done via a :class:`Symfony\\Component\\Form\\FormBuilder`
387386
object, where you build and configure different fields. The form builder

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: 2 additions & 3 deletions
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).
@@ -204,8 +204,7 @@ own, it just needs to follow these rules:
204204
:method:`Symfony\\Component\\Security\\Core\\Encoder\\PasswordEncoderInterface::isPasswordValid`
205205
must first of all make sure the password is not too long, i.e. the password length is no longer
206206
than 4096 characters. This is for security reasons (see `CVE-2013-5750`_), and you can use the
207-
:method:`Symfony\\Component\\Security\\Core\\Encoder\\BasePasswordEncoder::isPasswordTooLong`
208-
method for this check::
207+
``isPasswordTooLong()`` method for this check::
209208

210209
use Symfony\Component\Security\Core\Encoder\BasePasswordEncoder;
211210
use Symfony\Component\Security\Core\Exception\BadCredentialsException;

0 commit comments

Comments
 (0)