From e2010d2fc10d73a4afc5a94cc01d589847e66826 Mon Sep 17 00:00:00 2001 From: Nicolas Grekas Date: Wed, 2 Dec 2015 14:02:15 +0100 Subject: [PATCH 1/3] [Form] Add context to FormFactory deprecations --- src/Symfony/Component/Form/FormFactory.php | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/src/Symfony/Component/Form/FormFactory.php b/src/Symfony/Component/Form/FormFactory.php index f7160d550742d..048705f1422fb 100644 --- a/src/Symfony/Component/Form/FormFactory.php +++ b/src/Symfony/Component/Form/FormFactory.php @@ -101,12 +101,12 @@ public function createNamedBuilder($name, $type = 'Symfony\Component\Form\Extens } if ($type instanceof FormTypeInterface) { - @trigger_error('Passing type instances to FormBuilder::add(), Form::add() or the FormFactory is deprecated since version 2.8 and will not be supported in 3.0. Use the fully-qualified type class name instead.', E_USER_DEPRECATED); + @trigger_error(sprintf('Passing type instances to FormBuilder::add(), Form::add() or the FormFactory is deprecated since version 2.8 and will not be supported in 3.0. Use the fully-qualified type class name instead (%s).', get_class($type)), E_USER_DEPRECATED); $type = $this->resolveType($type); } elseif (is_string($type)) { $type = $this->registry->getType($type); } elseif ($type instanceof ResolvedFormTypeInterface) { - @trigger_error('Passing type instances to FormBuilder::add(), Form::add() or the FormFactory is deprecated since version 2.8 and will not be supported in 3.0. Use the fully-qualified type class name instead.', E_USER_DEPRECATED); + @trigger_error(sprintf('Passing type instances to FormBuilder::add(), Form::add() or the FormFactory is deprecated since version 2.8 and will not be supported in 3.0. Use the fully-qualified type class name instead (%s).', get_class($type->getInnerType())), E_USER_DEPRECATED); } else { throw new UnexpectedTypeException($type, 'string, Symfony\Component\Form\ResolvedFormTypeInterface or Symfony\Component\Form\FormTypeInterface'); } From 44a28612daceb07cb8f0ee6f036021373d71ecd3 Mon Sep 17 00:00:00 2001 From: Ryan Weaver Date: Tue, 1 Dec 2015 00:23:10 -0500 Subject: [PATCH 2/3] Refactoring EntityUserProvider::__construct() to not do work, cause cache warm error --- .../Security/User/EntityUserProvider.php | 72 +++++++++++++------ .../Security/User/EntityUserProviderTest.php | 2 +- 2 files changed, 51 insertions(+), 23 deletions(-) diff --git a/src/Symfony/Bridge/Doctrine/Security/User/EntityUserProvider.php b/src/Symfony/Bridge/Doctrine/Security/User/EntityUserProvider.php index b34b9bdec4a67..cb8a59458324d 100644 --- a/src/Symfony/Bridge/Doctrine/Security/User/EntityUserProvider.php +++ b/src/Symfony/Bridge/Doctrine/Security/User/EntityUserProvider.php @@ -27,22 +27,17 @@ */ class EntityUserProvider implements UserProviderInterface { + private $registry; + private $managerName; + private $classOrAlias; private $class; - private $repository; private $property; - private $metadata; - public function __construct(ManagerRegistry $registry, $class, $property = null, $managerName = null) + public function __construct(ManagerRegistry $registry, $classOrAlias, $property = null, $managerName = null) { - $em = $registry->getManager($managerName); - $this->class = $class; - $this->metadata = $em->getClassMetadata($class); - - if (false !== strpos($this->class, ':')) { - $this->class = $this->metadata->getName(); - } - - $this->repository = $em->getRepository($class); + $this->registry = $registry; + $this->managerName = $managerName; + $this->classOrAlias = $classOrAlias; $this->property = $property; } @@ -51,14 +46,15 @@ public function __construct(ManagerRegistry $registry, $class, $property = null, */ public function loadUserByUsername($username) { + $repository = $this->getRepository(); if (null !== $this->property) { - $user = $this->repository->findOneBy(array($this->property => $username)); + $user = $repository->findOneBy(array($this->property => $username)); } else { - if (!$this->repository instanceof UserProviderInterface) { - throw new \InvalidArgumentException(sprintf('The Doctrine repository "%s" must implement UserProviderInterface.', get_class($this->repository))); + if (!$repository instanceof UserProviderInterface) { + throw new \InvalidArgumentException(sprintf('The Doctrine repository "%s" must implement UserProviderInterface.', get_class($repository))); } - $user = $this->repository->loadUserByUsername($username); + $user = $repository->loadUserByUsername($username); } if (null === $user) { @@ -73,18 +69,20 @@ public function loadUserByUsername($username) */ public function refreshUser(UserInterface $user) { - if (!$user instanceof $this->class) { + $class = $this->getClass(); + if (!$user instanceof $class) { throw new UnsupportedUserException(sprintf('Instances of "%s" are not supported.', get_class($user))); } - if ($this->repository instanceof UserProviderInterface) { - $refreshedUser = $this->repository->refreshUser($user); + $repository = $this->getRepository(); + if ($repository instanceof UserProviderInterface) { + $refreshedUser = $repository->refreshUser($user); } else { // The user must be reloaded via the primary key as all other data // might have changed without proper persistence in the database. // That's the case when the user has been changed by a form with // validation errors. - if (!$id = $this->metadata->getIdentifierValues($user)) { + if (!$id = $this->getClassMetadata()->getIdentifierValues($user)) { throw new \InvalidArgumentException('You cannot refresh a user '. 'from the EntityUserProvider that does not contain an identifier. '. 'The user object has to be serialized with its own identifier '. @@ -92,7 +90,7 @@ public function refreshUser(UserInterface $user) ); } - $refreshedUser = $this->repository->find($id); + $refreshedUser = $repository->find($id); if (null === $refreshedUser) { throw new UsernameNotFoundException(sprintf('User with id %s not found', json_encode($id))); } @@ -106,6 +104,36 @@ public function refreshUser(UserInterface $user) */ public function supportsClass($class) { - return $class === $this->class || is_subclass_of($class, $this->class); + return $class === $this->getClass() || is_subclass_of($class, $this->getClass()); + } + + private function getObjectManager() + { + return $this->registry->getManager($this->managerName); + } + + private function getRepository() + { + return $this->getObjectManager()->getRepository($this->classOrAlias); + } + + private function getClass() + { + if (null === $this->class) { + $class = $this->classOrAlias; + + if (false !== strpos($class, ':')) { + $class = $this->getClassMetadata()->getName(); + } + + $this->class = $class; + } + + return $this->class; + } + + private function getClassMetadata() + { + return $this->getObjectManager()->getClassMetadata($this->classOrAlias); } } diff --git a/src/Symfony/Bridge/Doctrine/Tests/Security/User/EntityUserProviderTest.php b/src/Symfony/Bridge/Doctrine/Tests/Security/User/EntityUserProviderTest.php index 8c179cd31f246..6203b9dfb29a7 100644 --- a/src/Symfony/Bridge/Doctrine/Tests/Security/User/EntityUserProviderTest.php +++ b/src/Symfony/Bridge/Doctrine/Tests/Security/User/EntityUserProviderTest.php @@ -92,7 +92,7 @@ public function testSupportProxy() private function getManager($em, $name = null) { $manager = $this->getMock('Doctrine\Common\Persistence\ManagerRegistry'); - $manager->expects($this->once()) + $manager->expects($this->any()) ->method('getManager') ->with($this->equalTo($name)) ->will($this->returnValue($em)); From 36084e6ed84abfab2487703f9c04d570fdb22313 Mon Sep 17 00:00:00 2001 From: Peter Rehm Date: Sat, 5 Dec 2015 10:49:38 +0100 Subject: [PATCH 3/3] Reflected the change of the choice_value option in the Upgrade information --- UPGRADE-2.8.md | 35 +++++++++++++++++++++++++++++++++++ UPGRADE-3.0.md | 35 +++++++++++++++++++++++++++++++++++ 2 files changed, 70 insertions(+) diff --git a/UPGRADE-2.8.md b/UPGRADE-2.8.md index 1166e6ad56491..45f72fb8189c7 100644 --- a/UPGRADE-2.8.md +++ b/UPGRADE-2.8.md @@ -186,6 +186,41 @@ Form } ``` + * In Symfony 2.8 a small BC break was introduced with the new choices_as_values + option. In order to have the choice values populated to the html value attribute + you had to define the choice_value option. This is now not any more needed. + + Before: + + ```php + $form->add('status', 'choice', array( + 'choices' => array( + 'Enabled' => Status::ENABLED, + 'Disabled' => Status::DISABLED, + 'Ignored' => Status::IGNORED, + ), + 'choices_as_values' => true, + // important if you rely on your option value attribute (e.g. for JavaScript) + // this will keep the same functionality as before + 'choice_value' => function ($choice) { + return $choice; + }, + )); + ``` + + After (Symfony 2.8+): + + ```php + $form->add('status', 'choice', array( + 'choices' => array( + 'Enabled' => Status::ENABLED, + 'Disabled' => Status::DISABLED, + 'Ignored' => Status::IGNORED, + ), + 'choices_as_values' => true + )); + ``` + * Returning type instances from `FormTypeInterface::getParent()` is deprecated and will not be supported anymore in Symfony 3.0. Return the fully-qualified class name of the parent type class instead. diff --git a/UPGRADE-3.0.md b/UPGRADE-3.0.md index 7acdcddfe990e..1716b9ef755b5 100644 --- a/UPGRADE-3.0.md +++ b/UPGRADE-3.0.md @@ -365,6 +365,41 @@ UPGRADE FROM 2.x to 3.0 } } ``` + + * In Symfony 2.8 a small BC break was introduced with the new choices_as_values + option. In order to have the choice values populated to the html value attribute + you had to define the choice_value option. This is now not any more needed. + + Before: + + ```php + $form->add('status', 'choice', array( + 'choices' => array( + 'Enabled' => Status::ENABLED, + 'Disabled' => Status::DISABLED, + 'Ignored' => Status::IGNORED, + ), + // choices_as_values will default to true in Symfony 3.0 + 'choices_as_values' => true, + // important if you rely on your option value attribute (e.g. for JavaScript) + // this will keep the same functionality as before + 'choice_value' => function ($choice) { + return $choice; + }, + )); + ``` + + After: + + ```php + $form->add('status', 'choice', array( + 'choices' => array( + 'Enabled' => Status::ENABLED, + 'Disabled' => Status::DISABLED, + 'Ignored' => Status::IGNORED, + ) + )); + ``` * The `request` service was removed. You must inject the `request_stack` service instead.