Skip to content

Commit a480b9f

Browse files
committed
Tag classes as internal or final as appropriate
Classes are tagged in phpdoc rather than actually becoming final for backward compatibility in the 2.x branch.
1 parent 3c0d934 commit a480b9f

36 files changed

+110
-0
lines changed

Command/ActivateUserCommand.php

+3
Original file line numberDiff line numberDiff line change
@@ -20,6 +20,9 @@
2020

2121
/**
2222
* @author Antoine Hérault <[email protected]>
23+
*
24+
* @internal
25+
* @final
2326
*/
2427
class ActivateUserCommand extends Command
2528
{

Command/ChangePasswordCommand.php

+4
Original file line numberDiff line numberDiff line change
@@ -18,6 +18,10 @@
1818
use Symfony\Component\Console\Output\OutputInterface;
1919
use Symfony\Component\Console\Question\Question;
2020

21+
/**
22+
* @internal
23+
* @final
24+
*/
2125
class ChangePasswordCommand extends Command
2226
{
2327
protected static $defaultName = 'fos:user:change-password';

Command/CreateUserCommand.php

+3
Original file line numberDiff line numberDiff line change
@@ -23,6 +23,9 @@
2323
* @author Matthieu Bontemps <[email protected]>
2424
* @author Thibault Duplessis <[email protected]>
2525
* @author Luis Cordova <[email protected]>
26+
*
27+
* @internal
28+
* @final
2629
*/
2730
class CreateUserCommand extends Command
2831
{

Command/DeactivateUserCommand.php

+3
Original file line numberDiff line numberDiff line change
@@ -20,6 +20,9 @@
2020

2121
/**
2222
* @author Antoine Hérault <[email protected]>
23+
*
24+
* @internal
25+
* @final
2326
*/
2427
class DeactivateUserCommand extends Command
2528
{

Command/DemoteUserCommand.php

+3
Original file line numberDiff line numberDiff line change
@@ -17,6 +17,9 @@
1717
/**
1818
* @author Antoine Hérault <[email protected]>
1919
* @author Lenar Lõhmus <[email protected]>
20+
*
21+
* @internal
22+
* @final
2023
*/
2124
class DemoteUserCommand extends RoleCommand
2225
{

Command/PromoteUserCommand.php

+3
Original file line numberDiff line numberDiff line change
@@ -19,6 +19,9 @@
1919
* @author Thibault Duplessis <[email protected]>
2020
* @author Luis Cordova <[email protected]>
2121
* @author Lenar Lõhmus <[email protected]>
22+
*
23+
* @internal
24+
* @final
2225
*/
2326
class PromoteUserCommand extends RoleCommand
2427
{

Command/RoleCommand.php

+2
Original file line numberDiff line numberDiff line change
@@ -21,6 +21,8 @@
2121

2222
/**
2323
* @author Lenar Lõhmus <[email protected]>
24+
*
25+
* @internal
2426
*/
2527
abstract class RoleCommand extends Command
2628
{

DependencyInjection/Compiler/CheckForMailerPass.php

+3
Original file line numberDiff line numberDiff line change
@@ -19,6 +19,9 @@
1919
* Checks to see if the mailer service exists.
2020
*
2121
* @author Ryan Weaver <[email protected]>
22+
*
23+
* @internal
24+
* @final
2225
*/
2326
class CheckForMailerPass implements CompilerPassInterface
2427
{

DependencyInjection/Compiler/CheckForSessionPass.php

+3
Original file line numberDiff line numberDiff line change
@@ -19,6 +19,9 @@
1919
* Checks to see if the session service exists.
2020
*
2121
* @author Ryan Weaver <[email protected]>
22+
*
23+
* @internal
24+
* @final
2225
*/
2326
class CheckForSessionPass implements CompilerPassInterface
2427
{

DependencyInjection/Compiler/InjectRememberMeServicesPass.php

+3
Original file line numberDiff line numberDiff line change
@@ -19,6 +19,9 @@
1919
* Inject RememberMeServices into LoginManager.
2020
*
2121
* @author Vasily Khayrulin <[email protected]>
22+
*
23+
* @internal
24+
* @final
2225
*/
2326
class InjectRememberMeServicesPass implements CompilerPassInterface
2427
{

DependencyInjection/Compiler/InjectUserCheckerPass.php

+3
Original file line numberDiff line numberDiff line change
@@ -19,6 +19,9 @@
1919
* Injects firewall's UserChecker into LoginManager.
2020
*
2121
* @author Gocha Ossinkine <[email protected]>
22+
*
23+
* @internal
24+
* @final
2225
*/
2326
class InjectUserCheckerPass implements CompilerPassInterface
2427
{

DependencyInjection/Compiler/ValidationPass.php

+3
Original file line numberDiff line numberDiff line change
@@ -18,6 +18,9 @@
1818
* Registers the additional validators according to the storage.
1919
*
2020
* @author Christophe Coevoet <[email protected]>
21+
*
22+
* @internal
23+
* @final
2124
*/
2225
class ValidationPass implements CompilerPassInterface
2326
{

DependencyInjection/Configuration.php

+3
Original file line numberDiff line numberDiff line change
@@ -23,6 +23,9 @@
2323
* sections are normalized, and merged.
2424
*
2525
* @author Christophe Coevoet <[email protected]>
26+
*
27+
* @internal
28+
* @final
2629
*/
2730
class Configuration implements ConfigurationInterface
2831
{

DependencyInjection/FOSUserExtension.php

+4
Original file line numberDiff line numberDiff line change
@@ -19,6 +19,10 @@
1919
use Symfony\Component\DependencyInjection\Reference;
2020
use Symfony\Component\HttpKernel\DependencyInjection\Extension;
2121

22+
/**
23+
* @internal
24+
* @final
25+
*/
2226
class FOSUserExtension extends Extension
2327
{
2428
/**

Doctrine/CouchDB/UserListener.php

+4
Original file line numberDiff line numberDiff line change
@@ -18,6 +18,10 @@
1818
use FOS\UserBundle\Util\CanonicalFieldsUpdater;
1919
use FOS\UserBundle\Util\PasswordUpdaterInterface;
2020

21+
/**
22+
* @internal
23+
* @final
24+
*/
2125
class UserListener implements EventSubscriber
2226
{
2327
private $passwordUpdater;

Doctrine/UserListener.php

+3
Original file line numberDiff line numberDiff line change
@@ -25,6 +25,9 @@
2525
*
2626
* @author Christophe Coevoet <[email protected]>
2727
* @author David Buchmann <[email protected]>
28+
*
29+
* @internal
30+
* @final
2831
*/
2932
class UserListener implements EventSubscriber
3033
{

Event/FilterGroupResponseEvent.php

+3
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,9 @@
1515
use Symfony\Component\HttpFoundation\Request;
1616
use Symfony\Component\HttpFoundation\Response;
1717

18+
/**
19+
* @final
20+
*/
1821
class FilterGroupResponseEvent extends GroupEvent
1922
{
2023
/**

Event/FilterUserResponseEvent.php

+3
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,9 @@
1515
use Symfony\Component\HttpFoundation\Request;
1616
use Symfony\Component\HttpFoundation\Response;
1717

18+
/**
19+
* @final
20+
*/
1821
class FilterUserResponseEvent extends UserEvent
1922
{
2023
private $response;

Event/FormEvent.php

+3
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,9 @@
1616
use Symfony\Component\HttpFoundation\Request;
1717
use Symfony\Component\HttpFoundation\Response;
1818

19+
/**
20+
* @final
21+
*/
1922
class FormEvent extends Event
2023
{
2124
/**

Event/GetResponseGroupEvent.php

+3
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,9 @@
1313

1414
use Symfony\Component\HttpFoundation\Response;
1515

16+
/**
17+
* @final
18+
*/
1619
class GetResponseGroupEvent extends GroupEvent
1720
{
1821
/**

EventListener/AuthenticationListener.php

+4
Original file line numberDiff line numberDiff line change
@@ -20,6 +20,10 @@
2020
use Symfony\Component\EventDispatcher\LegacyEventDispatcherProxy;
2121
use Symfony\Component\Security\Core\Exception\AccountStatusException;
2222

23+
/**
24+
* @internal
25+
* @final
26+
*/
2327
class AuthenticationListener implements EventSubscriberInterface
2428
{
2529
/**

EventListener/EmailConfirmationListener.php

+4
Original file line numberDiff line numberDiff line change
@@ -20,6 +20,10 @@
2020
use Symfony\Component\HttpFoundation\Session\SessionInterface;
2121
use Symfony\Component\Routing\Generator\UrlGeneratorInterface;
2222

23+
/**
24+
* @internal
25+
* @final
26+
*/
2327
class EmailConfirmationListener implements EventSubscriberInterface
2428
{
2529
private $mailer;

EventListener/FlashListener.php

+4
Original file line numberDiff line numberDiff line change
@@ -17,6 +17,10 @@
1717
use Symfony\Component\HttpFoundation\Session\SessionInterface;
1818
use Symfony\Component\Translation\TranslatorInterface;
1919

20+
/**
21+
* @internal
22+
* @final
23+
*/
2024
class FlashListener implements EventSubscriberInterface
2125
{
2226
/**

EventListener/LastLoginListener.php

+4
Original file line numberDiff line numberDiff line change
@@ -19,6 +19,10 @@
1919
use Symfony\Component\Security\Http\Event\InteractiveLoginEvent;
2020
use Symfony\Component\Security\Http\SecurityEvents;
2121

22+
/**
23+
* @internal
24+
* @final
25+
*/
2226
class LastLoginListener implements EventSubscriberInterface
2327
{
2428
protected $userManager;

EventListener/ResettingListener.php

+4
Original file line numberDiff line numberDiff line change
@@ -18,6 +18,10 @@
1818
use Symfony\Component\HttpFoundation\RedirectResponse;
1919
use Symfony\Component\Routing\Generator\UrlGeneratorInterface;
2020

21+
/**
22+
* @internal
23+
* @final
24+
*/
2125
class ResettingListener implements EventSubscriberInterface
2226
{
2327
/**

FOSUserBundle.php

+2
Original file line numberDiff line numberDiff line change
@@ -25,6 +25,8 @@
2525
/**
2626
* @author Matthieu Bontemps <[email protected]>
2727
* @author Thibault Duplessis <[email protected]>
28+
*
29+
* @final
2830
*/
2931
class FOSUserBundle extends Bundle
3032
{

Form/DataTransformer/UserToUsernameTransformer.php

+2
Original file line numberDiff line numberDiff line change
@@ -20,6 +20,8 @@
2020
* Transforms between a UserInterface instance and a username string.
2121
*
2222
* @author Thibault Duplessis <[email protected]>
23+
*
24+
* @final
2325
*/
2426
class UserToUsernameTransformer implements DataTransformerInterface
2527
{

Form/Type/ChangePasswordFormType.php

+3
Original file line numberDiff line numberDiff line change
@@ -19,6 +19,9 @@
1919
use Symfony\Component\Security\Core\Validator\Constraints\UserPassword;
2020
use Symfony\Component\Validator\Constraints\NotBlank;
2121

22+
/**
23+
* @final
24+
*/
2225
class ChangePasswordFormType extends AbstractType
2326
{
2427
/**

Form/Type/ProfileFormType.php

+3
Original file line numberDiff line numberDiff line change
@@ -19,6 +19,9 @@
1919
use Symfony\Component\Security\Core\Validator\Constraints\UserPassword;
2020
use Symfony\Component\Validator\Constraints\NotBlank;
2121

22+
/**
23+
* @final
24+
*/
2225
class ProfileFormType extends AbstractType
2326
{
2427
/**

Form/Type/RegistrationFormType.php

+3
Original file line numberDiff line numberDiff line change
@@ -18,6 +18,9 @@
1818
use Symfony\Component\Form\FormBuilderInterface;
1919
use Symfony\Component\OptionsResolver\OptionsResolver;
2020

21+
/**
22+
* @final
23+
*/
2124
class RegistrationFormType extends AbstractType
2225
{
2326
/**

Form/Type/ResettingFormType.php

+3
Original file line numberDiff line numberDiff line change
@@ -17,6 +17,9 @@
1717
use Symfony\Component\Form\FormBuilderInterface;
1818
use Symfony\Component\OptionsResolver\OptionsResolver;
1919

20+
/**
21+
* @final
22+
*/
2023
class ResettingFormType extends AbstractType
2124
{
2225
/**

Form/Type/UsernameFormType.php

+2
Original file line numberDiff line numberDiff line change
@@ -20,6 +20,8 @@
2020
* Form type for representing a UserInterface instance by its username string.
2121
*
2222
* @author Thibault Duplessis <[email protected]>
23+
*
24+
* @final
2325
*/
2426
class UsernameFormType extends AbstractType
2527
{

Mailer/NoopMailer.php

+2
Original file line numberDiff line numberDiff line change
@@ -19,6 +19,8 @@
1919
* and allows to use this bundle without swiftmailer.
2020
*
2121
* @author Thibault Duplessis <[email protected]>
22+
*
23+
* @final
2224
*/
2325
class NoopMailer implements MailerInterface
2426
{

Util/CanonicalFieldsUpdater.php

+2
Original file line numberDiff line numberDiff line change
@@ -17,6 +17,8 @@
1717
* Class updating the canonical fields of the user.
1818
*
1919
* @author Christophe Coevoet <[email protected]>
20+
*
21+
* @final
2022
*/
2123
class CanonicalFieldsUpdater
2224
{

Util/UserManipulator.php

+3
Original file line numberDiff line numberDiff line change
@@ -23,6 +23,9 @@
2323
*
2424
* @author Christophe Coevoet <[email protected]>
2525
* @author Luis Cordova <[email protected]>
26+
*
27+
* @internal
28+
* @final
2629
*/
2730
class UserManipulator
2831
{

Validator/Initializer.php

+3
Original file line numberDiff line numberDiff line change
@@ -19,6 +19,9 @@
1919
* Automatically updates the canonical fields before validation.
2020
*
2121
* @author Christophe Coevoet <[email protected]>
22+
*
23+
* @internal
24+
* @final
2225
*/
2326
class Initializer implements ObjectInitializerInterface
2427
{

0 commit comments

Comments
 (0)