9.7 KiB
UPGRADE FROM 2.5 to 2.6
Form
-
The "empty_value" option in the types "choice", "date", "datetime" and "time" was deprecated and replaced by a new option "placeholder". You should use the option "placeholder" together with the view variables "placeholder" and "placeholder_in_choices" now.
The option "empty_value" and the view variables "empty_value" and "empty_value_in_choices" will be removed in Symfony 3.0.
Before:
$form->add('category', 'choice', array( 'choices' => array('politics', 'media'), 'empty_value' => 'Select a category...', ));
After:
$form->add('category', 'choice', array( 'choices' => array('politics', 'media'), 'placeholder' => 'Select a category...', ));
Before:
{{ form.vars.empty_value }} {% if form.vars.empty_value_in_choices %} ... {% endif %}
After:
{{ form.vars.placeholder }} {% if form.vars.placeholder_in_choices %} ... {% endif %}
Validator
-
The internal method
setConstraint()
was added toSymfony\Component\Validator\Context\ExecutionContextInterface
. With this method, the context is informed about the constraint that is currently being validated.If you implement this interface, make sure to add the method to your implementation. The easiest solution is to just implement an empty method:
public function setConstraint(Constraint $constraint) { }
-
Prior to 2.6
Symfony\Component\Validator\Constraints\ExpressionValidator
would not execute the Expression if it was attached to a property on an object and that property was set tonull
or an empty string.To emulate the old behaviour change your expression to something like this:
value == null or (YOUR_EXPRESSION)
Security
-
The
SecurityContextInterface
is marked as deprecated in favor of theSymfony\Component\Security\Core\Authorization\AuthorizationCheckerInterface
andSymfony\Component\Security\Core\Authentication\Token\Storage\TokenStorageInterface
.isGranted => AuthorizationCheckerInterface getToken => TokenStorageInterface setToken => TokenStorageInterface
The Implementations have moved too, The
SecurityContext
is marked as deprecated and has been split to use theAuthorizationCheckerInterface
andTokenStorage
. This change is 100% Backwards Compatible as the SecurityContext delegates the methods. -
The service
security.context
is deprecated along with the above change. Recommended to use instead:@security.authorization_checker => isGranted() @security.token_storage => getToken() @security.token_storage => setToken()
HttpFoundation
- The
PdoSessionHandler
to store sessions in a database changed significantly.- By default, it now implements session locking to prevent loss of data by concurrent access to the same session.
- It does so using a transaction between opening and closing a session. For this reason, it's not recommended to use the same database connection that you also use for your application logic. Otherwise you have to make sure to access your database after the session is closed and committed. Instead of passing an existing connection to the handler, you can now also pass a DSN string which will be used to lazy-connect when a session is started.
- Since accessing a session now blocks when the same session is still open, it is best practice to save the session as soon as you don't need to write to it anymore. For example, read-only AJAX request to a session can save the session immediately after opening it to increase concurrency.
- As alternative to transactional locking you can also use advisory locks which do not require a transaction.
Additionally, you can also revert back to no locking in case you have custom logic to deal with race conditions
like an optimistic concurrency control approach. The locking strategy can be chosen by passing the corresponding
constant as
lock_mode
option, e.g.new PdoSessionHandler($pdoOrDsn, array('lock_mode' => PdoSessionHandler::LOCK_NONE))
. For more information please read the class documentation.
- The expected schema of the table changed.
- Session data is binary text that can contain null bytes and thus should also be saved as-is in a binary column like BLOB. For this reason, the handler does not base64_encode the data anymore.
- A new column to store the lifetime of a session is required. This allows to have different lifetimes per session configured via session.gc_maxlifetime ini setting.
- You would need to migrate the table manually if you want to keep session information of your users.
- You could use
PdoSessionHandler::createTable
to initialize a correctly defined table depending on the used database vendor.
- By default, it now implements session locking to prevent loss of data by concurrent access to the same session.
OptionsResolver
-
The "array" type hint was removed from the
OptionsResolverInterface
methodssetRequired()
,setAllowedValues()
,addAllowedValues()
,setAllowedTypes()
andaddAllowedTypes()
. You must remove the type hint from your implementations. -
The interface
OptionsResolverInterface
was deprecated, sinceOptionsResolver
instances are not supposed to be shared between classes. You should type hint againstOptionsResolver
instead.Before:
protected function configureOptions(OptionsResolverInterface $resolver) { // ... }
After:
protected function configureOptions(OptionsResolver $resolver) { // ... }
-
OptionsResolver::isRequired()
now returnstrue
if a required option has a default value set. The new methodisMissing()
exhibits the old functionality ofisRequired()
.Before:
$resolver->setRequired(array('port')); $resolver->isRequired('port'); // => true $resolver->setDefaults(array('port' => 25)); $resolver->isRequired('port'); // => false
After:
$resolver->setRequired(array('port')); $resolver->isRequired('port'); // => true $resolver->isMissing('port'); // => true $resolver->setDefaults(array('port' => 25)); $resolver->isRequired('port'); // => true $resolver->isMissing('port'); // => false
-
OptionsResolver::replaceDefaults()
was deprecated. Useclear()
andsetDefaults()
instead.Before:
$resolver->replaceDefaults(array( 'port' => 25, ));
After:
$resolver->clear(); $resolver->setDefaults(array( 'port' => 25, ));
-
OptionsResolver::setOptional()
was deprecated. UsesetDefined()
instead.Before:
$resolver->setOptional(array('port'));
After:
$resolver->setDefined('port');
-
OptionsResolver::isKnown()
was deprecated. UseisDefined()
instead.Before:
if ($resolver->isKnown('port')) { // ... }
After:
if ($resolver->isDefined('port')) { // ... }
-
The methods
setAllowedValues()
,addAllowedValues()
,setAllowedTypes()
andaddAllowedTypes()
were changed to modify one option at a time instead of batch processing options. The old API exists for backwards compatibility, but will be removed in Symfony 3.0.Before:
$resolver->setAllowedValues(array( 'method' => array('POST', 'GET'), ));
After:
$resolver->setAllowedValues('method', array('POST', 'GET'));
-
The class
Options
was merged intoOptionsResolver
. If you instantiated this class manually, you should instantiateOptionsResolver
now.Options
is now a marker interface implemented byOptionsResolver
.Before:
$options = new Options();
After:
$resolver = new OptionsResolver();
-
Normalizers for defined but unset options are not executed anymore. If you want to have them executed, you should define a default value.
Before:
$resolver->setOptional(array('port')); $resolver->setNormalizers(array( 'port' => function ($options, $value) { // return normalized value } )); $options = $resolver->resolve($options);
After:
$resolver->setDefault('port', null); $resolver->setNormalizer('port', function ($options, $value) { // return normalized value }); $options = $resolver->resolve($options);
-
When undefined options are passed,
resolve()
now throws anUndefinedOptionsException
instead of anInvalidOptionsException
.InvalidOptionsException
is only thrown when option values fail their validation constraints.Before:
$resolver->setDefaults(array( 'transport' => 'smtp', 'port' => 25, )); $resolver->setAllowedTypes(array( 'port' => 'integer', )); // throws InvalidOptionsException $resolver->resolve(array('foo' => 'bar')); // throws InvalidOptionsException $resolver->resolve(array('port' => '25'));
After:
$resolver->setDefaults(array( 'transport' => 'smtp', 'port' => 25, )); $resolver->setAllowedTypes(array( 'port' => 'integer', )); // throws UndefinedOptionsException $resolver->resolve(array('foo' => 'bar')); // throws InvalidOptionsException $resolver->resolve(array('port' => '25'));