minor #10621 Documented the addLink() shortcut (javiereguiluz)

javiereguiluz · javiereguiluz · commit 0e697b270539 · 2018-10-31T10:23:04.000+01:00
This PR was merged into the master branch. Discussion ---------- Documented the addLink() shortcut This fixes #10612 and #10564. Commits ------- 26817be Documented the addLink() shortcut
diff --git a/weblink.rst b/weblink.rst
@@ -147,13 +147,20 @@ You can also add links to the HTTP response directly from controllers and servic
     {
         public function index(Request $request)
         {
+            // using the addLink() shortcut provided by AbstractController
+            $this->addLink($request, new Link('preload', '/app.css'));
+
+            // alternative if you don't want to use the addLink() shortcut
             $linkProvider = $request->attributes->get('_links', new GenericLinkProvider());
             $request->attributes->set('_links', $linkProvider->withLink(new Link('preload', '/app.css')));
 
             return $this->render('...');
         }
     }
 
+.. versionadded:: 4.2
+    The ``addLink()`` shortcut was introduced in Symfony 4.2.
+
 .. seealso::
 
     WebLink can be used :doc:`as a standalone PHP library </components/weblink>`
