PHP-CS-Fixer設定ファイル追加。プロパティ、メソッドに型指定

kurozumi · Apr 23, 2024 · d2b7351 · d2b7351
1 parent a38e215
commit d2b7351
Show file tree

Hide file tree

Showing 18 changed files with 173 additions and 43 deletions.
diff --git a/.gitignore b/.gitignore
@@ -1,3 +1,4 @@
 *.tar.gz
 !.gitkeep
 .idea
+.php-cs-fixer.cache
diff --git a/.php-cs-fixer.dist.php b/.php-cs-fixer.dist.php
@@ -0,0 +1,51 @@
+<?php
+
+/*
+ * This file is part of CustomerGroupRank
+ *
+ * Copyright(c) Akira Kurozumi <info@a-zumi.net>
+ *
+ * https://a-zumi.net
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+if (php_sapi_name() !== 'cli') {
+    throw new LogicException();
+}
+
+$header = <<<EOL
+This file is part of CustomerGroupRank
+
+Copyright(c) Akira Kurozumi <info@a-zumi.net>
+
+https://a-zumi.net
+
+For the full copyright and license information, please view the LICENSE
+file that was distributed with this source code.
+EOL;
+
+$rules = [
+    '@Symfony' => true,
+    'array_syntax' => ['syntax' => 'short'],
+    'phpdoc_align' => false,
+    'phpdoc_summary' => false,
+    'phpdoc_scalar' => false,
+    'phpdoc_annotation_without_dot' => false,
+    'no_superfluous_phpdoc_tags' => false,
+    'increment_style' => false,
+    'yoda_style' => false,
+    'header_comment' => ['header' => $header],
+];
+
+$finder = PhpCsFixer\Finder::create()
+    ->in(__DIR__)
+    ->name('*.php')
+;
+$config = new PhpCsFixer\Config();
+
+return $config
+    ->setRules($rules)
+    ->setFinder($finder)
+;
diff --git a/Bundle/CustomerGroupRankBundle.php b/Bundle/CustomerGroupRankBundle.php
@@ -1,7 +1,7 @@
 <?php
 
 /*
- * This file is part of CustomerGroupRank42
+ * This file is part of CustomerGroupRank
  *
  * Copyright(c) Akira Kurozumi <info@a-zumi.net>
  *
@@ -20,7 +20,12 @@
 
 class CustomerGroupRankBundle extends Bundle
 {
-    public function build(ContainerBuilder $container)
+    /**
+     * @param ContainerBuilder $container
+     *
+     * @return void
+     */
+    public function build(ContainerBuilder $container): void
     {
         parent::build($container);
 

diff --git a/DependencyInjection/Compiler/RankPass.php b/DependencyInjection/Compiler/RankPass.php
@@ -1,11 +1,11 @@
 <?php
 
 /*
- * This file is part of EC-CUBE
+ * This file is part of CustomerGroupRank
  *
- * Copyright(c) EC-CUBE CO.,LTD. All Rights Reserved.
+ * Copyright(c) Akira Kurozumi <info@a-zumi.net>
  *
- * http://www.ec-cube.co.jp/
+ * https://a-zumi.net
  *
  * For the full copyright and license information, please view the LICENSE
  * file that was distributed with this source code.
@@ -17,15 +17,19 @@
 use Symfony\Component\DependencyInjection\Compiler\CompilerPassInterface;
 use Symfony\Component\DependencyInjection\Compiler\PriorityTaggedServiceTrait;
 use Symfony\Component\DependencyInjection\ContainerBuilder;
-use Symfony\Component\DependencyInjection\Reference;
 
 class RankPass implements CompilerPassInterface
 {
     use PriorityTaggedServiceTrait;
 
     public const TAG = 'plugin.customer.group.rank';
 
-    public function process(ContainerBuilder $container)
+    /**
+     * @param ContainerBuilder $container
+     *
+     * @return void
+     */
+    public function process(ContainerBuilder $container): void
     {
         $context = $container->findDefinition(Context::class);
 

diff --git a/Entity/GroupTrait.php b/Entity/GroupTrait.php
@@ -1,7 +1,7 @@
 <?php
 
 /*
- * This file is part of CustomerGroupRank42
+ * This file is part of CustomerGroupRank
  *
  * Copyright(c) Akira Kurozumi <info@a-zumi.net>
  *
@@ -17,8 +17,6 @@
 use Eccube\Annotation\EntityExtension;
 
 /**
- * Trait GroupTrait
- *
  * @EntityExtension("Plugin\CustomerGroup42\Entity\Group")
  */
 trait GroupTrait

diff --git a/Event.php b/Event.php
@@ -1,7 +1,7 @@
 <?php
 
 /*
- * This file is part of CustomerGroupRank42
+ * This file is part of CustomerGroupRank
  *
  * Copyright(c) Akira Kurozumi <info@a-zumi.net>
  *
@@ -18,13 +18,21 @@
 
 class Event implements EventSubscriberInterface
 {
-    public static function getSubscribedEvents()
+    /**
+     * @return string[]
+     */
+    public static function getSubscribedEvents(): array
     {
         return [
             '@CustomerGroup42/admin/Customer/Group/edit.twig' => 'onTemplateAdminCustomerGroupEdit',
         ];
     }
 
+    /**
+     * @param TemplateEvent $event
+     *
+     * @return void
+     */
     public function onTemplateAdminCustomerGroupEdit(TemplateEvent $event): void
     {
         $event->addSnippet('@CustomerGroupRank42/admin/Customer/Group/edit.twig');

diff --git a/Form/Extension/Admin/GroupTypeExtension.php b/Form/Extension/Admin/GroupTypeExtension.php
@@ -1,7 +1,7 @@
 <?php
 
 /*
- * This file is part of CustomerGroupRank42
+ * This file is part of CustomerGroupRank
  *
  * Copyright(c) Akira Kurozumi <info@a-zumi.net>
  *
@@ -23,7 +23,13 @@
 
 class GroupTypeExtension extends AbstractTypeExtension
 {
-    public function buildForm(FormBuilderInterface $builder, array $options)
+    /**
+     * @param FormBuilderInterface $builder
+     * @param array $options
+     *
+     * @return void
+     */
+    public function buildForm(FormBuilderInterface $builder, array $options): void
     {
         $builder
             ->add('buyTimes', NumberType::class, [

diff --git a/PluginManager.php b/PluginManager.php
@@ -1,7 +1,7 @@
 <?php
 
 /*
- * This file is part of CustomerGroupRank42
+ * This file is part of CustomerGroupRank
  *
  * Copyright(c) Akira Kurozumi <info@a-zumi.net>
  *
@@ -21,7 +21,16 @@
 
 class PluginManager extends AbstractPluginManager
 {
-    public function enable(array $meta, ContainerInterface $container)
+    /**
+     * @param array $meta
+     * @param ContainerInterface $container
+     *
+     * @return void
+     *
+     * @throws \Psr\Container\ContainerExceptionInterface
+     * @throws \Psr\Container\NotFoundExceptionInterface
+     */
+    public function enable(array $meta, ContainerInterface $container): void
     {
         /** @var EntityManagerInterface $entityManager */
         $entityManager = $container->get('doctrine.orm.entity_manager');

diff --git a/Repository/QueryCustomizer/GroupSearchCustomizer.php b/Repository/QueryCustomizer/GroupSearchCustomizer.php
@@ -1,7 +1,7 @@
 <?php
 
 /*
- * This file is part of CustomerGroupRank42
+ * This file is part of CustomerGroupRank
  *
  * Copyright(c) Akira Kurozumi <info@a-zumi.net>
  *
@@ -20,7 +20,14 @@
 
 class GroupSearchCustomizer implements QueryCustomizer
 {
-    public function customize(QueryBuilder $builder, $params, $queryKey)
+    /**
+     * @param QueryBuilder $builder
+     * @param $params
+     * @param $queryKey
+     *
+     * @return void
+     */
+    public function customize(QueryBuilder $builder, $params, $queryKey): void
     {
         if (
             isset($params['buyTimes']) && isset($params['buyTotal'])
@@ -34,7 +41,10 @@ public function customize(QueryBuilder $builder, $params, $queryKey)
         }
     }
 
-    public function getQueryKey()
+    /**
+     * @return string
+     */
+    public function getQueryKey(): string
     {
         return QueryKey::GROUP_SEARCH;
     }

diff --git a/Resource/config/bundles.php b/Resource/config/bundles.php
@@ -1,16 +1,16 @@
 <?php
 
 /*
- * This file is part of EC-CUBE
+ * This file is part of CustomerGroupRank
  *
- * Copyright(c) EC-CUBE CO.,LTD. All Rights Reserved.
+ * Copyright(c) Akira Kurozumi <info@a-zumi.net>
  *
- * http://www.ec-cube.co.jp/
+ * https://a-zumi.net
  *
  * For the full copyright and license information, please view the LICENSE
  * file that was distributed with this source code.
  */
 
 return [
-    \Plugin\CustomerGroupRank42\Bundle\CustomerGroupRankBundle::class => ['all' => true],
+    Plugin\CustomerGroupRank42\Bundle\CustomerGroupRankBundle::class => ['all' => true],
 ];
diff --git a/Security/EventListener/LoginListener.php b/Security/EventListener/LoginListener.php
@@ -1,7 +1,7 @@
 <?php
 
 /*
- * This file is part of CustomerGroupRank42
+ * This file is part of CustomerGroupRank
  *
  * Copyright(c) Akira Kurozumi <info@a-zumi.net>
  *
@@ -23,20 +23,25 @@ class LoginListener
     /**
      * @var Context
      */
-    private $context;
+    private Context $context;
 
     /**
      * @var EntityManagerInterface
      */
-    private $entityManager;
+    private EntityManagerInterface $entityManager;
 
     public function __construct(Context $context, EntityManagerInterface $entityManager)
     {
         $this->context = $context;
         $this->entityManager = $entityManager;
     }
 
-    public function onInteractiveLogin(InteractiveLoginEvent $event)
+    /**
+     * @param InteractiveLoginEvent $event
+     *
+     * @return void
+     */
+    public function onInteractiveLogin(InteractiveLoginEvent $event): void
     {
         $user = $event->getAuthenticationToken()->getUser();
         if (!$user instanceof Customer) {

diff --git a/Service/Rank/Context.php b/Service/Rank/Context.php
@@ -1,7 +1,7 @@
 <?php
 
 /*
- * This file is part of CustomerGroupRank42
+ * This file is part of CustomerGroupRank
  *
  * Copyright(c) Akira Kurozumi <info@a-zumi.net>
  *
@@ -17,13 +17,26 @@
 
 class Context
 {
-    private $ranks = [];
+    /**
+     * @var array
+     */
+    private array $ranks = [];
 
-    public function addRank(RankInterface $rank)
+    /**
+     * @param RankInterface $rank
+     *
+     * @return void
+     */
+    public function addRank(RankInterface $rank): void
     {
         $this->ranks[] = $rank;
     }
 
+    /**
+     * @param Customer $customer
+     *
+     * @return void
+     */
     public function decide(Customer $customer): void
     {
         /** @var Rank $rank */

diff --git a/Service/Rank/Rank.php b/Service/Rank/Rank.php
@@ -1,7 +1,7 @@
 <?php
 
 /*
- * This file is part of CustomerGroupRank42
+ * This file is part of CustomerGroupRank
  *
  * Copyright(c) Akira Kurozumi <info@a-zumi.net>
  *
@@ -23,7 +23,7 @@ class Rank implements RankInterface
     /**
      * @var EntityManagerInterface
      */
-    protected $entityManager;
+    protected EntityManagerInterface $entityManager;
 
     public function __construct(EntityManagerInterface $entityManager)
     {

diff --git a/Service/Rank/RankInterface.php b/Service/Rank/RankInterface.php
@@ -1,7 +1,7 @@
 <?php
 
 /*
- * This file is part of CustomerGroupRank42
+ * This file is part of CustomerGroupRank
  *
  * Copyright(c) Akira Kurozumi <info@a-zumi.net>
  *

diff --git a/Tests/DependencyInjection/Compiler/RankPassTest.php b/Tests/DependencyInjection/Compiler/RankPassTest.php
@@ -1,7 +1,7 @@
 <?php
 
 /*
- * This file is part of CustomerGroupRank42
+ * This file is part of CustomerGroupRank
  *
  * Copyright(c) Akira Kurozumi <info@a-zumi.net>
  *
@@ -22,7 +22,7 @@
 
 class RankPassTest extends TestCase
 {
-    public function testTestRankが追加されるか()
+    public function testTestRankが追加されるか(): void
     {
         $container = new ContainerBuilder();
         $container->register(Context::class)