Merge pull request #2016 from FriendsOfSymfony/remove-outdated-doc

Tobion · web-flow · commit 2096a0e5dc00 · 2019-08-01T22:17:13.000+02:00
Remove outdated doc
diff --git a/.travis.yml b/.travis.yml
@@ -15,7 +15,7 @@ matrix:
   include:
     # lowest dependencies
     - php: 7.1
-      env: COMPOSER_FLAGS="--prefer-lowest" SYMFONY_DEPRECATIONS_HELPER=weak
+      env: COMPOSER_FLAGS="--prefer-lowest"
     # Symfony 3 LTS
     - php: 7.2
       env: SYMFONY_LTS='^3'
@@ -30,7 +30,7 @@ matrix:
 
 before_install:
   - echo "memory_limit=4G" >> ~/.phpenv/versions/$(phpenv version-name)/etc/conf.d/travis.ini
-  - if [ "$TRAVIS_PHP_VERSION" != "hhvm" ]; then phpenv config-rm xdebug.ini || true; fi
+  - phpenv config-rm xdebug.ini || true
   - if [ "$DEPENDENCIES" != "" ]; then composer config minimum-stability $DEPENDENCIES; fi
   - if [ "$SYMFONY_LTS" != "" ]; then composer require --dev --no-update symfony/lts=$SYMFONY_LTS; fi
 
diff --git a/Controller/TemplatingExceptionController.php b/Controller/TemplatingExceptionController.php
@@ -39,7 +39,7 @@ public function __construct(
      * @param int     $statusCode
      * @param bool    $showException
      *
-     * @return TemplateReferenceInterface
+     * @return string|TemplateReferenceInterface
      */
     abstract protected function findTemplate(Request $request, $statusCode, $showException);
 }
diff --git a/Negotiation/FormatNegotiator.php b/Negotiation/FormatNegotiator.php
@@ -25,6 +25,7 @@ class FormatNegotiator extends BaseNegotiator
 {
     private $map = [];
     private $requestStack;
+    private $mimeTypes;
 
     public function __construct(RequestStack $requestStack, array $mimeTypes = array())
     {
diff --git a/Request/ParameterBag.php b/Request/ParameterBag.php
@@ -36,7 +36,7 @@ public function getParams(Request $request)
         if (!isset($this->params[$requestId]) || empty($this->params[$requestId]['controller'])) {
             throw new \InvalidArgumentException('Controller and method needs to be set via setController.');
         }
-        if ($this->params[$requestId]['params'] === null) {
+        if (null === $this->params[$requestId]['params']) {
             return $this->initParams($requestId);
         }
 
diff --git a/Resources/doc/2-the-view-layer.rst b/Resources/doc/2-the-view-layer.rst
@@ -168,8 +168,6 @@ the important ones for configuring the view:
 * ``setResponse(Response $response)`` - The response instance that is populated
   by the ``ViewHandler``.
 
-See `this example code`_ for more details.
-
 Forms and Views
 ---------------
 
@@ -310,7 +308,6 @@ default of ``twig``:
 
 .. code-block:: yaml
 
-    # app/config/config.yml
     fos_rest:
         view:
             formats:
@@ -323,8 +320,6 @@ default of ``twig``:
             failed_validation: HTTP_BAD_REQUEST
             default_engine: twig
 
-See `this example configuration`_ for more details.
-
 Custom handler
 --------------
 
@@ -348,12 +343,7 @@ Note there are several public methods on the ``ViewHandler`` which can be helpfu
 * ``createRedirectResponse()``
 * ``renderTemplate()``
 
-There is an example inside LiipHelloBundle to show how to register a custom handler
-(for an RSS feed):
-https://github.com/liip/LiipHelloBundle/blob/master/View/RSSViewHandler.php
-https://github.com/liip/LiipHelloBundle/blob/master/Resources/config/config.yml
-
-There is another example in ``Resources\doc\examples``:
+There is an example for how to register a custom handler (for an RSS feed) in ``Resources\doc\examples``:
 https://github.com/FriendsOfSymfony/FOSRestBundle/blob/master/Resources/doc/examples/RssHandler.php
 
 Here is an example using a closure registered inside a Controller action:
@@ -418,7 +408,6 @@ Simply add the following to your configuration
 
 .. code-block:: yaml
 
-    # app/config/config.yml
     fos_rest:
         view:
             jsonp_handler: ~
@@ -429,7 +418,6 @@ is valid or not.
 
 .. code-block:: yaml
 
-    # app/config/config.yml
     fos_rest:
         view:
             jsonp_handler:
@@ -439,7 +427,6 @@ Finally the filter can also be disabled by setting it to false.
 
 .. code-block:: yaml
 
-    # app/config/config.yml
     fos_rest:
         view:
             jsonp_handler:
@@ -469,8 +456,6 @@ That was it!
 .. _`Symfony Serializer Component`: http://symfony.com/doc/current/components/serializer.html
 .. _`serializer`: https://github.com/schmittjoh/serializer
 .. _`JMSSerializerBundle`: https://github.com/schmittjoh/JMSSerializerBundle
-.. _`this example code`: https://github.com/liip/LiipHelloBundle/blob/master/Controller/HelloController.php
-.. _`this example configuration`: https://github.com/liip-forks/symfony-standard/blob/techtalk/app/config/config.yml
 .. _`CVE-2014-4671`: http://web.nvd.nist.gov/view/vuln/detail?vulnId=CVE-2014-4671
 .. _`Abusing JSONP with Rosetta Flash`: http://miki.it/blog/2014/7/8/abusing-jsonp-with-rosetta-flash/
 .. _`NelmioSecurityBundle`: https://github.com/nelmio/NelmioSecurityBundle
diff --git a/Resources/doc/3-listener-support.rst b/Resources/doc/3-listener-support.rst
@@ -17,7 +17,6 @@ to enable a few additional listeners:
 
 .. code-block:: yaml
 
-    # app/config/config.yml
     fos_rest:
         param_fetcher_listener: true
         body_listener: true
@@ -37,7 +36,6 @@ appropriate event:
 
 .. code-block:: yaml
 
-    # app/config/config.yml
     fos_rest:
         body_listener:
             service: my_body_listener
@@ -120,7 +118,6 @@ since 2.5.
 
 .. code-block:: yaml
 
-    # app/config/config.yml
     fos_rest:
         view:
             mime_types: {'jsonp': ['application/javascript+jsonp']}
@@ -210,7 +207,6 @@ rules on the request ``path``, ``host``, ``methods`` and ``ip``.
 
 .. code-block:: yaml
 
-    # app/config/config.yml
     fos_rest:
         zone:
             - { path: ^/api/* }
diff --git a/Resources/doc/4-exception-controller-support.rst b/Resources/doc/4-exception-controller-support.rst
@@ -12,7 +12,6 @@ configuration:
 
 .. code-block:: yaml
 
-    # app/config/config.yml
     fos_rest:
         exception:
             enabled: true
@@ -38,7 +37,6 @@ constant of the ``Symfony\Component\HttpFoundation\Response`` class:
 
 .. code-block:: yaml
 
-    # app/config/config.yml
     fos_rest:
         exception:
             codes:
diff --git a/Resources/doc/5-automatic-route-generation_single-restful-controller.rst b/Resources/doc/5-automatic-route-generation_single-restful-controller.rst
@@ -11,14 +11,10 @@ You may specify a ``default_format`` that the routing loader will use for the
 
 .. code-block:: yaml
 
-    # app/config/config.yml
     fos_rest:
         routing_loader:
             default_format: json
 
-Many of the features explained below are used in the following example code:
-https://github.com/liip/LiipHelloBundle/blob/master/Controller/RestController.php
-
 Single RESTful controller routes
 --------------------------------
 
@@ -28,7 +24,6 @@ are explained in the next section.
 
 .. code-block:: yaml
 
-    # app/config/routing.yml
     users:
         type:     rest
         host:     m.example.com
@@ -351,7 +346,6 @@ some configuration:
 
 .. code-block:: yaml
 
-    # app/config/config.yml
     fos_rest:
         routing_loader:
             include_format:       false
@@ -412,15 +406,15 @@ Example class implementing ``InflectorInterface``:
         }
     }
 
-Define your service in ``config.yml``:
+Define your service:
 
 .. code-block:: yaml
 
     services:
         acme.hellobundle.util.inflector:
           class: Acme\HelloBundle\Util\Inflector\NoopInflector
 
-Tell ``fos_rest`` to use your own service as inflector, also in ``config.yml``:
+Tell ``fos_rest`` to use your own service as inflector:
 
 .. code-block:: yaml
 
diff --git a/Resources/doc/6-automatic-route-generation_multiple-restful-controllers.rst b/Resources/doc/6-automatic-route-generation_multiple-restful-controllers.rst
@@ -40,11 +40,10 @@ XML collection:
 Notice ``parent: users`` option in the second case. This option specifies that
 the comments resource is child of the users resource.
 
-It is also necessary to add ``type: rest`` to the ``routing.yml`` file:
+It is also necessary to add ``type: rest`` to the ``routes.yaml`` file:
 
 .. code-block:: yaml
 
-    # app/config/routing.yml
     acme_hello:
         type: rest
         host:   hostname.example.com
@@ -112,11 +111,10 @@ resources of ``UsersController::getUser()`` resource.
 Include resource collections in application routing
 ---------------------------------------------------
 
-Last step is mapping of your collection routes into the application ``routing.yml``:
+Last step is mapping of your collection routes into the application ``routes.yaml``:
 
 .. code-block:: yaml
 
-    # app/config/routing.yml
     users:
         type:     rest
         resource: "@AcmeHelloBundle/Resources/config/users_routes.yml"
@@ -151,7 +149,7 @@ a file loaded by the rest loader.):
 
 .. code-block:: yaml
 
-    # app/config/routing.yml
+    # config/routes.yaml
     users:
         type: rest  # Required for ``RestYamlLoader`` to process imported routes
         prefix: /api
diff --git a/Resources/doc/body_listener.rst b/Resources/doc/body_listener.rst
@@ -17,7 +17,6 @@ decoder is explicitly kept to its default service):
 
 .. code-block:: yaml
 
-    # app/config/config.yml
     fos_rest:
         body_listener:
             decoders:
@@ -51,7 +50,6 @@ to camel cased ones, you can use the ``camel_keys`` array normalizer:
 
 .. code-block:: yaml
 
-    # app/config/config.yml
     fos_rest:
         body_listener:
             array_normalizer: fos_rest.normalizer.camel_keys
@@ -77,7 +75,6 @@ You can also create your own array normalizer by implementing the
 
 .. code-block:: yaml
 
-    # app/config/config.yml
     fos_rest:
         body_listener:
             array_normalizer: acme.normalizer.custom
@@ -87,7 +84,6 @@ If you want form data to be normalized, you can use the ``forms`` flag:
 
 .. code-block:: yaml
 
-    # app/config/config.yml
     fos_rest:
         body_listener:
             array_normalizer:
diff --git a/Resources/doc/format_listener.rst b/Resources/doc/format_listener.rst
@@ -24,7 +24,6 @@ Setting ``priorities`` to a non-empty array enables Accept header negotiations.
 
 .. code-block:: yaml
 
-    # app/config/config.yml
     fos_rest:
         format_listener:
             enabled: true
@@ -98,7 +97,6 @@ format will remain unchanged.
 
 .. code-block:: yaml
 
-    # app/config/config.yml
     fos_rest:
         format_listener:
             enabled: true
diff --git a/Resources/doc/index.rst b/Resources/doc/index.rst
@@ -59,17 +59,10 @@ Example applications
 The following bundles/applications use the FOSRestBundle and can be used as a
 guideline:
 
-- The `LiipHelloBundle`_ provides several examples for the RestBundle.
-
-- There is also `a fork of the Symfony2 Standard Edition`_ that is configured to
-  show the LiipHelloBundle examples.
-
 - The `FOSCommentBundle`_ uses FOSRestBundle for its API.
 
 - The `Symfony2 Rest Edition`_ provides a complete example of how to build a
   controller that works for both HTML as well as JSON/XML.
 
-.. _`LiipHelloBundle`: https://github.com/liip/LiipHelloBundle
-.. _`a fork of the Symfony2 Standard Edition`: https://github.com/liip-forks/symfony-standard/tree/techtalk
 .. _`FOSCommentBundle`: https://github.com/FriendsOfSymfony/FOSCommentBundle
 .. _`Symfony2 Rest Edition`: https://github.com/gimler/symfony-rest-edition
diff --git a/Resources/doc/param_fetcher_listener.rst b/Resources/doc/param_fetcher_listener.rst
@@ -6,7 +6,6 @@ configured for the matched controller so that the user does not need to do this
 
 .. code-block:: yaml
 
-    # app/config/config.yml
     fos_rest:
         param_fetcher_listener: true
 
@@ -139,7 +138,6 @@ request attributes
 
 .. code-block:: yaml
 
-    # app/config/config.yml
     fos_rest:
         param_fetcher_listener: force
 
diff --git a/Resources/doc/request_body_converter_listener.rst b/Resources/doc/request_body_converter_listener.rst
@@ -10,15 +10,13 @@ and have the converters enabled:
 
 .. code-block:: yaml
 
-    # app/config/config.yml
     sensio_framework_extra:
         request: { converters: true }
 
 To enable the Request body converter, add the following configuration:
 
 .. code-block:: yaml
 
-    # app/config/config.yml
     fos_rest:
         body_converter:
             enabled: true
@@ -68,7 +66,6 @@ enabling validation:
 
 .. code-block:: yaml
 
-    # app/config/config.yml
     fos_rest:
         body_converter:
             enabled: true
diff --git a/Resources/doc/versioning.rst b/Resources/doc/versioning.rst
diff --git a/Resources/doc/view_response_listener.rst b/Resources/doc/view_response_listener.rst

Original file line number	Diff line number	Diff line change
`@@ -39,7 +39,7 @@ public function __construct(`
`39`	`39`	`* @param int $statusCode`
`40`	`40`	`* @param bool $showException`
`41`	`41`	`*`
`42`		`- * @return TemplateReferenceInterface`
	`42`	`+ * @return string\|TemplateReferenceInterface`
`43`	`43`	`*/`
`44`	`44`	`abstract protected function findTemplate(Request $request, $statusCode, $showException);`
`45`	`45`	`}`
Original file line number	Diff line number	Diff line change
`@@ -25,6 +25,7 @@ class FormatNegotiator extends BaseNegotiator`
`25`	`25`	`{`
`26`	`26`	`private $map = [];`
`27`	`27`	`private $requestStack;`
	`28`	`+ private $mimeTypes;`
`28`	`29`
`29`	`30`	`public function __construct(RequestStack $requestStack, array $mimeTypes = array())`
`30`	`31`	`{`
Original file line number	Diff line number	Diff line change
`@@ -36,7 +36,7 @@ public function getParams(Request $request)`
`36`	`36`	`if (!isset($this->params[$requestId]) \|\| empty($this->params[$requestId]['controller'])) {`
`37`	`37`	`throw new \InvalidArgumentException('Controller and method needs to be set via setController.');`
`38`	`38`	`}`
`39`		`- if ($this->params[$requestId]['params'] === null) {`
	`39`	`+ if (null === $this->params[$requestId]['params']) {`
`40`	`40`	`return $this->initParams($requestId);`
`41`	`41`	`}`
`42`	`42`