Skip to content

Latest commit

 

History

History
333 lines (247 loc) · 8.06 KB

Upgrade.md

File metadata and controls

333 lines (247 loc) · 8.06 KB
Raw

Upgrade instruction

This document describes the changes needed when upgrading because of a BC break. For the full list of changes, please look at the Changelog file.

2.0 to 2.1

Controllers and commands now use DI and are defined as services.

Projects overriding them will need to adapt their code to fit with these changes. Note that backward compatibility is not ensured for such usage. Relying on extension points of the bundle (mostly through events) is preferred.

2.0.0-alpha3 to 2.0.0-beta1

Methods and properties removed from FOS\UserBundle\Model\User

  • $locked
  • $expired and $expiredAt
  • $credentialsExpired and $credentialsExpiredAt
  • setLocked() and isLocked()
  • setExpired() and setExpiresAt()
  • setCredentialsExpired() and setCredentialsExpireAt()

These properties were used to implement advanced features of the AdvancedUserInterface from the Symfony component, but neither Symfony nor this bundle are providing ways to use these features fully (expired credentials would just prevent logging in for instance). Projects needing to use these advanced feature should add the fields they need in their User class and override the corresponding method to provide an implementation fitting their requirement. Projects wanting to keep the previous behavior of the bundle can copy the condition used in 1.3.7.

You need to drop the removed fields from your database schema, because they aren't mapped anymore.

Propel

Propel integration has been moved to a separate bundle and can be installed using composer:

composer require friendsofsymfony/propel1-user-bundle

Once installed, walk through the readme to enable Propel support.

LoginManager

The signature of the LoginManager constructor has changed.

Before:

class LoginManager
{
    public function __construct(
        TokenStorageInterface $tokenStorage,
        UserCheckerInterface $userChecker,
        SessionAuthenticationStrategyInterface $sessionStrategy,
        ContainerInterface $container
    );
}

After:

class LoginManager
{
    public function __construct(
        TokenStorageInterface $tokenStorage,
        UserCheckerInterface $userChecker,
        SessionAuthenticationStrategyInterface $sessionStrategy,
        RequestStack $requestStack,
        RememberMeServicesInterface $rememberMeService = null
    );
}

Templates

Following Symfony coding standards template names are now lowercase. Please rename if you use custom templates.

Before:

public function checkEmailAction()
{
    return $this->render('FOSUserBundle:Registration:checkEmail.html.twig');
}

After:

public function checkEmailAction()
{
    return $this->render('@FOSUser/Registration/check_email.html.twig');
}

UserListener

The signature of the UserListener constructor has changed and now requires an implementation of PasswordUpdaterInterface and CanonicalFieldsUpdater.

Before:

class UserListener
{
    public function __construct(ContainerInterface $container);
}

After:

class UserListener
{
    public function __construct(
        PasswordUpdaterInterface $passwordUpdater,
        CanonicalFieldsUpdater $canonicalFieldsUpdater
    );
}

UserManager

The public methods refreshUser, loadUserByUsername and supportsClass have been removed. Please use the UserProvider instead.

Before:

$userManager->refreshUser($user);
$userManager->loadUserByUsername($username);
$userManager->supportsClass($class);

After:

$userProvider->refreshUser($user);
$userProvider->loadUserByUsername($username);
$userProvider->supportsClass($class);

The signature of the UserManager constructor has changed and now requires an implementation of PasswordUpdaterInterface and CanonicalFieldsUpdater.

Before:

class UserManager
{
    public function __construct(
        EncoderFactoryInterface $encoderFactory,
        CanonicalizerInterface $usernameCanonicalizer,
        CanonicalizerInterface $emailCanonicalizer
    );
}

After:

class UserManager
{
    public function __construct(
        PasswordUpdaterInterface $passwordUpdater,
        CanonicalFieldsUpdater $canonicalFieldsUpdater
    );
}

Validator

The signature of the Validator Initializer constructor has changed and now requires an implementation of CanonicalFieldsUpdater.

Before:

class Initializer
{
    public function __construct(UserManagerInterface $userManager);
}

After:

class Initializer
{
    public function __construct(CanonicalFieldsUpdater $canonicalFieldsUpdater);
}

1.3 to 2.0.0-alpha1

User Provider

Using the UserManager as a user provider is no longer supported and is deprecated. Change your security.yml's provider section to look like:

security:
    # ...
    providers:
        fos_userbundle:
            id: fos_user.user_provider.username

Configuration

The XML namespace is changed from http://example.org/schema/dic/fos_user to http://friendsofsymfony.github.io/schema/dic/user.

User and Group class

This bundle now registers mappings for the classes in the Model namespace directly, instead of having empty extending classes. The User and Group classes in the Entity and Document namespaces are deprecated, you should update your User and Group classes to extend the classes found in Model. The old classes will are still available for now, but throw deprecated warnings. They will be removed in the next alpha.

1.3.4 to 1.3.5

The characters used in generated tokens have changed. They now include dashes and underscores as well. Any routing requirement matching them should be updated to [\w\-]+.

Before:

my_route:
    path: /{token}
    requirement:
        token: \w+

After:

my_route:
    path: /{token}
    requirement:
        token: '[\w\-]+'

1.2 to 1.3

Forms

The profile form no longer wraps the user in a CheckPassword class. If you were overriding the form handler, you will need to update it to pass the user object directly.

Groups

The FOS\UserBundle\Model\GroupableInterface interface now expects the getGroups method to return a Traversable instead of expecting a Doctrine Collection. Doctrine-based implementation are unchanged but the Propel implementation now returns the PropelCollection instead of wrapping it.

Manager classes

The different Doctrine-based manager classes are deprecated and will be removed in 2.0 in favor of the common implementation. If you were extending the UserManager class for a Doctrine implementation, you need to change the parent class to FOS\UserBundle\Doctrine\UserManager.

Propel implementation

The Propel backend does not require the UserProxy anymore as the UserInterface is now implementated on the model itself. you will have to change your config:

Before:

fos_user:
    user_class: FOS\UserBundle\Propel\UserProxy
    propel_user_class: FOS\UserBundle\Propel\User

After:

fos_user:
    user_class: FOS\UserBundle\Propel\User

Token generation

The generation of the token is not done by the User class anymore. If you were using the generateToken or generateConfirmationToken in your own code, you need to use the fos_user.util.token_generator service to generate the token.

1.1 to 1.2

This file describes the needed changes when upgrading from 1.1 to 1.2

Removed the user-level algorithm.

If you are experiencing the exception No encoder has been configured for account "Acme\DemoBundle\Entity\User" after upgrading, please consider the following.

The encoder now needs to be configured in the SecurityBundle configuration as described in the official documentation. If you were using the default value of the bundle, the config should look like this to reuse the same settings:

#app/config/security.yml
security:
    encoders:
        "FOS\UserBundle\Model\UserInterface":
            algorithm: sha512
            encode_as_base64: false
            iterations: 1