code styles: header_comment and ordered_imports (#175)

.php_cs.dist

@@ -1,6 +1,14 @@
 <?php
 
+$fileHeaderComment = <<<COMMENT
+This file is part of the Kimai time-tracking app.
+
+For the full copyright and license information, please view the LICENSE
+file that was distributed with this source code.
+COMMENT;
+
 return PhpCsFixer\Config::create()
+    ->setRiskyAllowed(true)
     ->setRules([
         'encoding' => true,
         'full_opening_tag' => true,
@@ -14,6 +22,9 @@ return PhpCsFixer\Config::create()
         'lowercase_constants' => true,
         'lowercase_keywords' => true,
         'method_argument_space' => ['on_multiline' => 'ensure_fully_multiline'],
+        'header_comment' => ['header' => $fileHeaderComment, 'separate' => 'both'],
+        'no_php4_constructor' => true,
+        'ordered_imports' => true,
         'no_break_comment' => true,
         'no_closing_tag' => true,
         'no_spaces_after_function_name' => true,

src/Controller/AbstractController.php

@@ -9,8 +9,8 @@
 
 namespace App\Controller;
 
-use Symfony\Component\Security\Core\Exception\AccessDeniedException;
 use Symfony\Bundle\FrameworkBundle\Controller\Controller;
+use Symfony\Component\Security\Core\Exception\AccessDeniedException;
 
 /**
  * The abstract base controller.

src/Controller/ActivityController.php

@@ -9,10 +9,10 @@
 
 namespace App\Controller;
 
-use Symfony\Bundle\FrameworkBundle\Controller\Controller;
-use Sensio\Bundle\FrameworkExtraBundle\Configuration\Security;
 use App\Entity\Activity;
 use App\Repository\ActivityRepository;
+use Sensio\Bundle\FrameworkExtraBundle\Configuration\Security;
+use Symfony\Bundle\FrameworkBundle\Controller\Controller;
 
 /**
  * Controller used to manage activity contents in the public part of the site.

src/Controller/Admin/ActivityController.php

@@ -10,16 +10,16 @@
 namespace App\Controller\Admin;
 
 use App\Controller\AbstractController;
-use Pagerfanta\Pagerfanta;
-use Symfony\Component\HttpFoundation\Request;
 use App\Entity\Activity;
-use Sensio\Bundle\FrameworkExtraBundle\Configuration\Method;
-use Sensio\Bundle\FrameworkExtraBundle\Configuration\Route;
-use Sensio\Bundle\FrameworkExtraBundle\Configuration\Security;
-use Sensio\Bundle\FrameworkExtraBundle\Configuration\Cache;
 use App\Form\ActivityEditForm;
 use App\Form\Toolbar\ActivityToolbarForm;
 use App\Repository\Query\ActivityQuery;
+use Pagerfanta\Pagerfanta;
+use Sensio\Bundle\FrameworkExtraBundle\Configuration\Cache;
+use Sensio\Bundle\FrameworkExtraBundle\Configuration\Method;
+use Sensio\Bundle\FrameworkExtraBundle\Configuration\Route;
+use Sensio\Bundle\FrameworkExtraBundle\Configuration\Security;
+use Symfony\Component\HttpFoundation\Request;
 
 /**
  * Controller used to manage activities in the admin part of the site.

src/Controller/Admin/CustomerController.php

@@ -10,15 +10,15 @@
 namespace App\Controller\Admin;
 
 use App\Controller\AbstractController;
-use Pagerfanta\Pagerfanta;
-use Symfony\Component\HttpFoundation\Request;
 use App\Entity\Customer;
-use Sensio\Bundle\FrameworkExtraBundle\Configuration\Method;
-use Sensio\Bundle\FrameworkExtraBundle\Configuration\Route;
-use Sensio\Bundle\FrameworkExtraBundle\Configuration\Security;
 use App\Form\CustomerEditForm;
 use App\Form\Toolbar\CustomerToolbarForm;
 use App\Repository\Query\CustomerQuery;
+use Pagerfanta\Pagerfanta;
+use Sensio\Bundle\FrameworkExtraBundle\Configuration\Method;
+use Sensio\Bundle\FrameworkExtraBundle\Configuration\Route;
+use Sensio\Bundle\FrameworkExtraBundle\Configuration\Security;
+use Symfony\Component\HttpFoundation\Request;
 
 /**
  * Controller used to manage activities in the admin part of the site.

src/Controller/Admin/ProjectController.php

@@ -10,17 +10,17 @@
 namespace App\Controller\Admin;
 
 use App\Controller\AbstractController;
-use Pagerfanta\Pagerfanta;
-use Symfony\Component\HttpFoundation\Request;
 use App\Entity\Customer;
 use App\Entity\Project;
-use Sensio\Bundle\FrameworkExtraBundle\Configuration\Method;
-use Sensio\Bundle\FrameworkExtraBundle\Configuration\Route;
-use Sensio\Bundle\FrameworkExtraBundle\Configuration\Security;
-use Sensio\Bundle\FrameworkExtraBundle\Configuration\Cache;
 use App\Form\ProjectEditForm;
 use App\Form\Toolbar\ProjectToolbarForm;
 use App\Repository\Query\ProjectQuery;
+use Pagerfanta\Pagerfanta;
+use Sensio\Bundle\FrameworkExtraBundle\Configuration\Cache;
+use Sensio\Bundle\FrameworkExtraBundle\Configuration\Method;
+use Sensio\Bundle\FrameworkExtraBundle\Configuration\Route;
+use Sensio\Bundle\FrameworkExtraBundle\Configuration\Security;
+use Symfony\Component\HttpFoundation\Request;
 
 /**
  * Controller used to manage projects in the admin part of the site.

src/Controller/Admin/TimesheetController.php

@@ -16,10 +16,10 @@ use App\Form\TimesheetEditForm;
 use App\Form\Toolbar\TimesheetAdminToolbarForm;
 use App\Repository\Query\TimesheetQuery;
 use Pagerfanta\Pagerfanta;
-use Symfony\Component\HttpFoundation\Request;
 use Sensio\Bundle\FrameworkExtraBundle\Configuration\Method;
 use Sensio\Bundle\FrameworkExtraBundle\Configuration\Route;
 use Sensio\Bundle\FrameworkExtraBundle\Configuration\Security;
+use Symfony\Component\HttpFoundation\Request;
 
 /**
  * Controller used for manage timesheet entries in the admin part of the site.

src/Controller/DashboardController.php

@@ -9,16 +9,16 @@
 
 namespace App\Controller;
 
-use App\Entity\User;
 use App\Entity\Activity;
 use App\Entity\Customer;
 use App\Entity\Project;
 use App\Entity\Timesheet;
+use App\Entity\User;
 use App\Repository\Query\TimesheetQuery;
-use Symfony\Bundle\FrameworkBundle\Controller\Controller;
 use Sensio\Bundle\FrameworkExtraBundle\Configuration\Method;
 use Sensio\Bundle\FrameworkExtraBundle\Configuration\Route;
 use Sensio\Bundle\FrameworkExtraBundle\Configuration\Security;
+use Symfony\Bundle\FrameworkBundle\Controller\Controller;
 
 /**
  * Dashboard controller for the admin area.

src/Controller/HelpController.php

@@ -10,10 +10,10 @@
 namespace App\Controller;
 
 use App\Constants;
-use Symfony\Bundle\FrameworkBundle\Controller\Controller;
 use Sensio\Bundle\FrameworkExtraBundle\Configuration\Method;
 use Sensio\Bundle\FrameworkExtraBundle\Configuration\Route;
 use Sensio\Bundle\FrameworkExtraBundle\Configuration\Security;
+use Symfony\Bundle\FrameworkBundle\Controller\Controller;
 
 /**
  * This controller can render the markdown documentation from /var/docs/

src/Controller/ProfileController.php

@@ -9,18 +9,18 @@
 
 namespace App\Controller;
 
+use App\Entity\Timesheet;
 use App\Entity\User;
 use App\Form\UserEditType;
 use App\Form\UserPasswordType;
 use App\Form\UserPreferencesForm;
 use App\Form\UserRolesType;
+use App\Repository\TimesheetRepository;
 use App\Voter\UserVoter;
-use Symfony\Component\Form\Form;
-use App\Entity\Timesheet;
 use Sensio\Bundle\FrameworkExtraBundle\Configuration\Method;
 use Sensio\Bundle\FrameworkExtraBundle\Configuration\Route;
 use Sensio\Bundle\FrameworkExtraBundle\Configuration\Security;
-use App\Repository\TimesheetRepository;
+use Symfony\Component\Form\Form;
 use Symfony\Component\HttpFoundation\Request;
 
 /**

src/Controller/TimesheetController.php

@@ -15,10 +15,10 @@ use App\Form\TimesheetEditForm;
 use App\Form\Toolbar\TimesheetToolbarForm;
 use App\Repository\Query\TimesheetQuery;
 use Pagerfanta\Pagerfanta;
+use Sensio\Bundle\FrameworkExtraBundle\Configuration\Cache;
 use Sensio\Bundle\FrameworkExtraBundle\Configuration\Method;
 use Sensio\Bundle\FrameworkExtraBundle\Configuration\Route;
 use Sensio\Bundle\FrameworkExtraBundle\Configuration\Security;
-use Sensio\Bundle\FrameworkExtraBundle\Configuration\Cache;
 use Symfony\Component\HttpFoundation\Request;
 
 /**

src/DataFixtures/TimesheetFixtures.php

@@ -9,11 +9,11 @@
 
 namespace App\DataFixtures;
 
-use App\Entity\User;
 use App\Entity\Activity;
 use App\Entity\Customer;
 use App\Entity\Project;
 use App\Entity\Timesheet;
+use App\Entity\User;
 use Doctrine\Bundle\FixturesBundle\Fixture;
 use Doctrine\Common\Persistence\ObjectManager;
 

src/Doctrine/TablePrefixSubscriber.php

@@ -9,8 +9,8 @@
 
 namespace App\Doctrine;
 
-use Doctrine\ORM\Event\LoadClassMetadataEventArgs;
 use Doctrine\Common\EventSubscriber;
+use Doctrine\ORM\Event\LoadClassMetadataEventArgs;
 
 /**
  * Adds a prefix to every doctrine entity AKA database table

src/Doctrine/TimesheetSubscriber.php

@@ -9,11 +9,11 @@
 
 namespace App\Doctrine;
 
+use App\Entity\Timesheet;
 use App\Timesheet\CalculatorInterface;
 use Doctrine\Common\EventSubscriber;
-use Doctrine\ORM\Event\PreUpdateEventArgs;
 use Doctrine\ORM\Event\LifecycleEventArgs;
-use App\Entity\Timesheet;
+use Doctrine\ORM\Event\PreUpdateEventArgs;
 
 /**
  * A listener to make sure all Timesheet entries will have a proper duration.

src/Entity/User.php

@@ -1,14 +1,21 @@
 <?php
 
+/*
+ * This file is part of the Kimai time-tracking app.
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
 namespace App\Entity;
 
 use App\Validator\Constraints as KimaiAssert;
 use Doctrine\Common\Collections\ArrayCollection;
 use Doctrine\Common\Collections\Collection;
 use Doctrine\ORM\Mapping as ORM;
+use Symfony\Bridge\Doctrine\Validator\Constraints\UniqueEntity;
 use Symfony\Component\Security\Core\User\UserInterface;
 use Symfony\Component\Validator\Constraints as Assert;
-use Symfony\Bridge\Doctrine\Validator\Constraints\UniqueEntity;
 
 /**
  * Application main User entity.

src/Entity/UserPreference.php

@@ -1,5 +1,12 @@
 <?php
 
+/*
+ * This file is part of the Kimai time-tracking app.
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
 namespace App\Entity;
 
 use Doctrine\ORM\Mapping as ORM;

src/Event/ConfigureMenuEvent.php

@@ -10,8 +10,8 @@
 namespace App\Event;
 
 use Avanzu\AdminThemeBundle\Event\SidebarMenuEvent;
-use Symfony\Component\HttpFoundation\Request;
 use Symfony\Component\EventDispatcher\Event;
+use Symfony\Component\HttpFoundation\Request;
 
 /**
  * The ConfigureMenuEvent is used for populating navigations.

src/EventSubscriber/MenuBuilderSubscriber.php

@@ -9,11 +9,11 @@
 
 namespace App\EventSubscriber;
 
-use App\Event\ConfigureMainMenuEvent;
 use App\Event\ConfigureAdminMenuEvent;
-use Symfony\Component\EventDispatcher\EventDispatcherInterface;
+use App\Event\ConfigureMainMenuEvent;
-use Avanzu\AdminThemeBundle\Model\MenuItemModel;
 use Avanzu\AdminThemeBundle\Event\SidebarMenuEvent;
+use Avanzu\AdminThemeBundle\Model\MenuItemModel;
+use Symfony\Component\EventDispatcher\EventDispatcherInterface;
 use Symfony\Component\EventDispatcher\EventSubscriberInterface;
 use Symfony\Component\Security\Core\Authorization\AuthorizationCheckerInterface;
 

src/EventSubscriber/MenuSubscriber.php

@@ -9,10 +9,10 @@
 
 namespace App\EventSubscriber;
 
-use App\Event\ConfigureMainMenuEvent;
 use App\Event\ConfigureAdminMenuEvent;
-use Symfony\Component\EventDispatcher\EventSubscriberInterface;
+use App\Event\ConfigureMainMenuEvent;
 use Avanzu\AdminThemeBundle\Model\MenuItemModel;
+use Symfony\Component\EventDispatcher\EventSubscriberInterface;
 use Symfony\Component\Security\Core\Authorization\AuthorizationCheckerInterface;
 
 /**

src/EventSubscriber/RedirectToLocaleSubscriber.php

@@ -1,9 +1,7 @@
 <?php
 
 /*
- * This file is part of the Symfony package.
+ * This file is part of the Kimai time-tracking app.
- *
- * (c) Fabien Potencier <fabien@symfony.com>
  *
  * For the full copyright and license information, please view the LICENSE
  * file that was distributed with this source code.
@@ -11,8 +9,8 @@
 
 namespace App\EventSubscriber;
 
-use Symfony\Component\HttpKernel\Event\GetResponseEvent;
 use Symfony\Component\HttpFoundation\RedirectResponse;
+use Symfony\Component\HttpKernel\Event\GetResponseEvent;
 use Symfony\Component\Routing\Generator\UrlGeneratorInterface;
 
 /**

src/Form/ActivityEditForm.php

@@ -9,9 +9,9 @@
 
 namespace App\Form;
 
-use App\Form\Type\YesNoType;
 use App\Entity\Activity;
 use App\Form\Type\ProjectType;
+use App\Form\Type\YesNoType;
 use App\Repository\ProjectRepository;
 use Symfony\Component\Form\AbstractType;
 use Symfony\Component\Form\Extension\Core\Type\TextareaType;

src/Form/TimesheetEditForm.php

@@ -9,16 +9,16 @@
 
 namespace App\Form;
 
+use App\Entity\Timesheet;
+use App\Form\Type\ActivityGroupedWithCustomerNameType;
 use App\Form\Type\DurationType;
 use App\Form\Type\UserType;
+use App\Repository\ActivityRepository;
 use Symfony\Component\Form\AbstractType;
 use Symfony\Component\Form\Extension\Core\Type\DateTimeType;
 use Symfony\Component\Form\Extension\Core\Type\TextareaType;
 use Symfony\Component\Form\FormBuilderInterface;
 use Symfony\Component\OptionsResolver\OptionsResolver;
-use App\Entity\Timesheet;
-use App\Form\Type\ActivityGroupedWithCustomerNameType;
-use App\Repository\ActivityRepository;
 
 /**
  * Defines the form used to manipulate Timesheet entries.

src/Form/Toolbar/ActivityToolbarForm.php

@@ -9,9 +9,9 @@
 
 namespace App\Form\Toolbar;
 
+use App\Repository\Query\ActivityQuery;
 use Symfony\Component\Form\FormBuilderInterface;
 use Symfony\Component\OptionsResolver\OptionsResolver;
-use App\Repository\Query\ActivityQuery;
 
 /**
  * Defines the form used for filtering the activities.

src/Form/Toolbar/CustomerToolbarForm.php

@@ -9,9 +9,9 @@
 
 namespace App\Form\Toolbar;
 
+use App\Repository\Query\CustomerQuery;
 use Symfony\Component\Form\FormBuilderInterface;
 use Symfony\Component\OptionsResolver\OptionsResolver;
-use App\Repository\Query\CustomerQuery;
 
 /**
  * Defines the form used for filtering the customer.

src/Form/Toolbar/ProjectToolbarForm.php

@@ -9,9 +9,9 @@
 
 namespace App\Form\Toolbar;
 
+use App\Repository\Query\ProjectQuery;
 use Symfony\Component\Form\FormBuilderInterface;
 use Symfony\Component\OptionsResolver\OptionsResolver;
-use App\Repository\Query\ProjectQuery;
 
 /**
  * Defines the form used for filtering the projects.

src/Form/Toolbar/TimesheetToolbarForm.php

@@ -9,10 +9,10 @@
 
 namespace App\Form\Toolbar;
 
+use App\Repository\Query\TimesheetQuery;
 use Symfony\Component\Form\Extension\Core\Type\ChoiceType;
 use Symfony\Component\Form\FormBuilderInterface;
 use Symfony\Component\OptionsResolver\OptionsResolver;
-use App\Repository\Query\TimesheetQuery;
 
 /**
  * Defines the form used for filtering the timesheet.

src/Form/Type/ActivityType.php

@@ -9,11 +9,11 @@
 
 namespace App\Form\Type;
 
+use App\Entity\Activity;
+use App\Repository\ActivityRepository;
 use Symfony\Bridge\Doctrine\Form\Type\EntityType;
 use Symfony\Component\Form\AbstractType;
 use Symfony\Component\OptionsResolver\OptionsResolver;
-use App\Entity\Activity;
-use App\Repository\ActivityRepository;
 
 /**
  * Custom form field type to select an activity.

src/Form/Type/CustomerType.php

@@ -9,10 +9,10 @@
 
 namespace App\Form\Type;
 
+use App\Repository\CustomerRepository;
 use Symfony\Bridge\Doctrine\Form\Type\EntityType;
 use Symfony\Component\Form\AbstractType;
 use Symfony\Component\OptionsResolver\OptionsResolver;
-use App\Repository\CustomerRepository;
 
 /**
  * Custom form field type to select a customer.

src/Form/Type/ProjectType.php

@@ -9,11 +9,11 @@
 
 namespace App\Form\Type;
 
+use App\Entity\Project;
+use App\Repository\ProjectRepository;
 use Symfony\Bridge\Doctrine\Form\Type\EntityType;
 use Symfony\Component\Form\AbstractType;
 use Symfony\Component\OptionsResolver\OptionsResolver;
-use App\Entity\Project;
-use App\Repository\ProjectRepository;
 
 /**
  * Custom form field type to select a project.

src/Repository/ActivityRepository.php

@@ -9,12 +9,12 @@
 
 namespace App\Repository;
 
-use App\Entity\User;
-use Doctrine\ORM\Query;
 use App\Entity\Activity;
 use App\Entity\Timesheet;
+use App\Entity\User;
 use App\Model\ActivityStatistic;
 use App\Repository\Query\ActivityQuery;
+use Doctrine\ORM\Query;
 
 /**
  * Class ActivityRepository

src/Repository/CustomerRepository.php

@@ -10,12 +10,12 @@
 namespace App\Repository;
 
 use App\Entity\Activity;
+use App\Entity\Customer;
 use App\Entity\Project;
 use App\Entity\Timesheet;
-use Doctrine\ORM\Query;
-use App\Entity\Customer;
 use App\Model\CustomerStatistic;
 use App\Repository\Query\CustomerQuery;
+use Doctrine\ORM\Query;
 
 /**
  * Class CustomerRepository

src/Repository/ProjectRepository.php

@@ -10,11 +10,11 @@
 namespace App\Repository;
 
 use App\Entity\Activity;
-use App\Entity\Timesheet;
-use Doctrine\ORM\Query;
 use App\Entity\Project;
+use App\Entity\Timesheet;
 use App\Model\ProjectStatistic;
 use App\Repository\Query\ProjectQuery;
+use Doctrine\ORM\Query;
 
 /**
  * Class ProjectRepository

src/Repository/Query/TimesheetQuery.php

@@ -9,8 +9,8 @@
 
 namespace App\Repository\Query;
 
-use App\Entity\User;
 use App\Entity\Activity;
+use App\Entity\User;
 
 /**
  * Can be used for advanced timesheet repository queries.

src/Repository/TimesheetRepository.php

@@ -9,18 +9,18 @@
 
 namespace App\Repository;
 
-use App\Entity\User;
 use App\Entity\Activity;
 use App\Entity\Timesheet;
-use Doctrine\DBAL\Types\Type;
+use App\Entity\User;
-use Doctrine\ORM\QueryBuilder;
-use Pagerfanta\Pagerfanta;
 use App\Model\Statistic\Month;
 use App\Model\Statistic\Year;
 use App\Model\TimesheetGlobalStatistic;
 use App\Model\TimesheetStatistic;
-use DateTime;
 use App\Repository\Query\TimesheetQuery;
+use DateTime;
+use Doctrine\DBAL\Types\Type;
+use Doctrine\ORM\QueryBuilder;
+use Pagerfanta\Pagerfanta;
 
 /**
  * Class TimesheetRepository

src/Twig/Extensions.php

@@ -9,9 +9,9 @@
 
 namespace App\Twig;
 
+use App\Entity\Timesheet;
 use App\Utils\Duration;
 use Symfony\Component\Intl\Intl;
-use App\Entity\Timesheet;
 use Twig\TwigFilter;
 
 /**

src/Voter/ActivityVoter.php

@@ -9,9 +9,9 @@
 
 namespace App\Voter;
 
+use App\Entity\Activity;
 use App\Entity\User;
 use Symfony\Component\Security\Core\Authentication\Token\TokenInterface;
-use App\Entity\Activity;
 
 /**
  * A voter to check permissions on Activities.

src/Voter/CustomerVoter.php

@@ -9,9 +9,9 @@
 
 namespace App\Voter;
 
+use App\Entity\Customer;
 use App\Entity\User;
 use Symfony\Component\Security\Core\Authentication\Token\TokenInterface;
-use App\Entity\Customer;
 
 /**
  * A voter to check permissions on Customers.

src/Voter/ProjectVoter.php

@@ -9,9 +9,9 @@
 
 namespace App\Voter;
 
+use App\Entity\Project;
 use App\Entity\User;
 use Symfony\Component\Security\Core\Authentication\Token\TokenInterface;
-use App\Entity\Project;
 
 /**
  * A voter to check permissions on Projects.

src/Voter/TimesheetVoter.php

@@ -9,10 +9,10 @@
 
 namespace App\Voter;
 
-use App\Entity\User;
-use Symfony\Component\Security\Core\Authentication\Token\TokenInterface;
 use App\Entity\Activity;
 use App\Entity\Timesheet;
+use App\Entity\User;
+use Symfony\Component\Security\Core\Authentication\Token\TokenInterface;
 
 /**
  * A voter to check permissions on Timesheets.

tests/Repository/Query/CustomerQueryTest.php

@@ -9,8 +9,8 @@
 
 namespace App\Tests\Repository\Query;
 
-use App\Repository\Query\VisibilityQuery;
 use App\Repository\Query\CustomerQuery;
+use App\Repository\Query\VisibilityQuery;
 
 /**
  * @covers \App\Repository\Query\CustomerQuery

tests/Repository/Query/TimesheetQueryTest.php

@@ -9,10 +9,10 @@
 
 namespace App\Tests\Repository\Query;
 
-use App\Entity\User;
 use App\Entity\Activity;
 use App\Entity\Customer;
 use App\Entity\Project;
+use App\Entity\User;
 use App\Repository\Query\TimesheetQuery;
 
 /**

tests/Voter/TimesheetVoterTest.php

@@ -9,14 +9,14 @@
 
 namespace App\Tests\Voter;
 
+use App\Entity\Customer;
+use App\Entity\Timesheet;
 use App\Entity\User;
+use App\Voter\TimesheetVoter;
 use PHPUnit\Framework\TestCase;
 use Symfony\Component\Security\Core\Authentication\Token\UsernamePasswordToken;
 use Symfony\Component\Security\Core\Authorization\AccessDecisionManagerInterface;
 use Symfony\Component\Security\Core\Authorization\Voter\VoterInterface;
-use App\Entity\Customer;
-use App\Entity\Timesheet;
-use App\Voter\TimesheetVoter;
 
 /**
  * @covers \App\Voter\TimesheetVoter