[WIP] Replace Param converter with configurable argument resolvers #436

fabpot · 2016-09-23T18:30:24Z

needs symfony/symfony#20036 for more advanced usage.

fabpot · 2016-09-23T18:35:12Z

Some usage examples:

    /**
     * @Route("/posts/{slug}", name="blog_post")
     * @Method("GET")
     * @Arg("post", expr="repository.findOneBySlug(slug)")
     * This @Arg is technically not needed, but here as a usage example
     */
    public function postShowAction(Post $post)
    {
    }

    /**
     * @param Post[] $posts
     *
     * @Route("/", defaults={"page": 1}, name="blog_index")
     * @Route("/page/{page}", requirements={"page": "[1-9]\d*"}, name="blog_index_paginated")
     * @Method("GET")
     * @Cache(smaxage="10")
     * @Arg("posts", expr="repository.findLatest(page)")
     */
    public function indexAction($posts, $page)
    {
    }

    /**
     * @Route("/{start}/{stop}", defaults={"stop": "2009-09-09"})
     * @Template()
     *
     * @Arg("start", format="Y-m-d:H:i:s")
     */
    public function indexAction(\DateTime $start = null, \DateTime $stop)
    {
        return ['start' => $start, 'stop' => $stop];
    }

linaori · 2016-09-23T19:17:19Z

DependencyInjection/SensioFrameworkExtraExtension.php

-                'Sensio\\Bundle\\FrameworkExtraBundle\\Request\\ParamConverter\\ParamConverterManager',
-            ));
+        if ($config['request']['resolvers']) {
+            $annotationsToLoad[] = 'resolvers.xml';


What if you want to use the @Arg feature without using the default set of resolvers? If I'm not using doctrine nor the datetime resolver in a project, I don't really need them but would like to expand on the feature.

Sure, performance/configurability/lazyness is something that needs to be done. This is an early PoC.

linaori · 2016-09-23T19:18:55Z

Annotation/Arg.php

+ */
+class Arg
+{
+    private $arg;


This one is meant to be stand-alone and not a ConfigurationInterface implementation?

Yes, it is handled in a total different and more flexible way (options are validated via OptionsResolver). I think ConfigurationInterface should die :)

It's still a pretty cool extension point and used by some packages. Anyway, this is probably a challenge for later on.

https://github.com/FriendsOfSymfony/FOSHttpCacheBundle/blob/master/Configuration/InvalidatePath.php
https://github.com/jaytaph/RateLimitBundle/blob/master/Annotation/RateLimit.php
https://github.com/mayeco/EasyAnnotationBundle

Google in:github.com "extends ConfigurationAnnotation"

linaori · 2016-09-23T19:22:21Z

EventListener/ControllerArgumentOptionsListener.php

+
+        if (!is_array($controller)) {
+            return;
+        }


In theory normal functions can be controllers too (afaik anonymous doesn't support docblocks but not sure), this would make it a string, I think the same goes for static declared methods in a string 'Foo::barAction'.

Anonymous functions do support docblocks, but unfortunately, this is a known limitation of Doctrine Annotations: doctrine/annotations#83

linaori · 2016-09-23T19:23:55Z

EventListener/ControllerArgumentOptionsListener.php

+                throw new LogicException(sprintf('Wrong @Arg configuration for argument "%s" on "%s".', $name, $context), 0, $e);
+            }
+
+            $event->getRequest()->attributes->set($parameter->getName().'_options', $options);


Ah nice leveraging the use of the old setup here, that would prevent them from being executed unless they set a higher priority on their own converter. This should probably be documented as pitfall if they decide to use a higher priority and still try to use @Arg.

linaori · 2016-09-23T19:34:13Z

Request/ArgumentValueResolver/DoctrineResolver.php

@@ -69,26 +111,26 @@ public function apply(Request $request, ParamConverter $configuration)
            // find by identifier?
        } elseif (false === $object = $this->find($class, $request, $options, $name)) {
            // find by criteria
+// FIXME: to be done elsewhere for expr for instance
+$method = $method->isArray() ? 'findBy' : 'findOneBy';


$method->isArray() should probably be $metadata->isArray()

I think this case should only occur when guessing, otherwise it's simply a miss-configuration. If it's an array requested, it should probably never even hit findOne cases and thus never have an identifier in the URL. That means it can only be findBy and deserves its own case in this construction

linaori · 2016-09-23T19:36:50Z

This solution looks a lot more elegant than ParamConverters and feels less like a "hack". Is there any specific reason to not have this in Symfony (+doctrine bridge) instead of the bundle at this point? As long as the feature is opt-in it should be all cool.

fabpot · 2016-09-23T19:51:27Z

@iltar Having this part of Symfony is indeed a possibility that I've thought of. Creating a new HttpKernel Annotation sub-namespace is one idea, creating a new Annotation component is another one. In any case, I'd like this code to be moved outside of a bundle as it can be useful to Drupal or Silex as well.

linaori · 2016-09-23T20:04:30Z

Not just Drupal or Silex, pretty much every framework could use this ^^

Koc · 2016-09-23T20:06:39Z

How we can understand what repository to use when loading array of posts? By parsing param phpdoc?

stof · 2016-09-23T22:17:19Z

This is a huge BC break as long as the SecurityListener is not refactored to run after argument resolvers, as it would mean that the expression does not receive the converted arguments anymore.

linaori · 2016-09-25T08:24:30Z

EventListener/ControllerArgumentOptionsListener.php

+        $method = new \ReflectionMethod($className, $controller[1]);
+        $annotations = $this->reader->getMethodAnnotations($method);
+        $context = $className.'::'.$controller[1].'()';
+        $argumentMetadata = $this->metadataFactory->createArgumentMetadata($controller);


I was just thinking this might need some internal caching so that it's only generated once. Arguments will now be generated in this method and the HttpKernel.

Could probably store it in an array internally at least for the current request:
https://github.com/symfony/symfony/blob/master/src/Symfony/Component/HttpKernel/ControllerMetadata/ArgumentMetadataFactory.php

HeahDude · 2017-01-11T17:15:23Z

Request/ParamConverter/ParamConverterInterface.php

- *
- * @author Fabien Potencier <fabien@symfony.com>
- */
-interface ParamConverterInterface


We should deprecate it first in 3.x, shouldn't we?

… resolvers (chalasr) This PR was merged into the 3.3-dev branch. Discussion ---------- [HttpKernel][FrameworkBundle] Lazy load argument value resolvers | Q | A | ------------- | --- | Branch? | master | Bug fix? | no | New feature? | yes | BC breaks? | no | Deprecations? | no | Tests pass? | yes | Fixed tickets | n/a | License | MIT | Doc PR | n/a The ArgumentResolver resolves an arg using the first ArgumentValueResolver which `supports()` it (which can be complex, see e.g. [sensiolabs/SensioFrameworkExtraBundle#436](https://github.com/sensiolabs/SensioFrameworkExtraBundle/pull/436/files#diff-865d48d9369c4431bce36ba642834570R10)). Commits ------- 02b4aaa [HttpKernel] Lazy load argument value resolvers

TomasVotruba · 2020-04-04T00:51:53Z

Any ETA?

fabpot · 2020-09-12T07:04:23Z

Closing in favor of symfony/symfony#37829

fabpot added 3 commits September 22, 2016 18:09

moved the DateTime param converter to an argument resolver

65118ea

added the Doctrine resolver

5599c8c

removed the old converter parameter code

d3b4ac1

fabpot mentioned this pull request Sep 23, 2016

[WIP] [HttpKernel] added phpdoc information support for the argument resolver symfony/symfony#20036

Closed

fabpot changed the title ~~Replace Param converter with configurable argument resolvers~~ [WIP] Replace Param converter with configurable argument resolvers Sep 23, 2016

linaori reviewed Sep 23, 2016

View reviewed changes

linaori reviewed Sep 25, 2016

View reviewed changes

GuilhemN mentioned this pull request Oct 14, 2016

Introduction of Manipulative Param Converters FriendsOfSymfony/FOSRestBundle#1595

Open

linaori mentioned this pull request Jan 6, 2017

[3.1][HttpKernel] ArgumentResolver not used as ParamConverter bails out symfony/symfony#19354

Closed

HeahDude reviewed Jan 11, 2017

View reviewed changes

HeahDude mentioned this pull request Oct 3, 2017

Changing how IsGranted works so that it can use all controller args as subject #517

Merged

jvasseur mentioned this pull request Apr 19, 2018

UserValueResolver and SecurityUserValueResolver improvement symfony/symfony#26971

Closed

ogizanagi mentioned this pull request May 1, 2018

Add EnumValueResolver Elao/PhpEnums#59

Merged

vudaltsov mentioned this pull request Dec 26, 2018

[RFC][HttpKernel] Configurable argument value resolvers symfony/symfony#29692

Closed

fabpot closed this Sep 12, 2020

[WIP] Replace Param converter with configurable argument resolvers #436

[WIP] Replace Param converter with configurable argument resolvers #436

Uh oh!

Conversation

fabpot commented Sep 23, 2016 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

fabpot commented Sep 23, 2016 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

linaori commented Sep 23, 2016

Uh oh!

fabpot commented Sep 23, 2016

Uh oh!

linaori commented Sep 23, 2016

Uh oh!

Koc commented Sep 23, 2016

Uh oh!

stof commented Sep 23, 2016

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

TomasVotruba commented Apr 4, 2020

Uh oh!

fabpot commented Sep 12, 2020

Uh oh!

Uh oh!

Pfad - The Proxy pFad of © 2024 Garber Painting. All rights reserved.

fabpot commented Sep 23, 2016 •

edited

Loading

fabpot commented Sep 23, 2016 •

edited

Loading