Implement PHP CS Fixer and a coding standard to follow (#471)

* Create PHP CS Fixer config and add to CI workflow * Run php cs fixer on project * Add newline at end of file * Update to use PHP CS Fixer v3 * Run v3 config on project * Run seperate config in CI
2025-10-31 13:41:09 -04:00 · 2021-05-21 12:57:51 +01:00
parent 633cad9b89
commit 9e98a96d61
316 changed files with 4715 additions and 3195 deletions
--- a/app/Listeners/Updates/Listener.php
+++ b/app/Listeners/Updates/Listener.php
@ -5,13 +5,13 @@ namespace Crater\Listeners\Updates;
 // Implementation taken from Akaunting - https://github.com/akaunting/akaunting
 class Listener
 {
-    const VERSION = '';
+    public const VERSION = '';

    /**
     * Check if should listen.
     *
     * @param  $event
-     * @return boolean
+     * @return bool
     */
    protected function isListenerFired($event)
    {
--- a/app/Listeners/Updates/v1/Version110.php
+++ b/app/Listeners/Updates/v1/Version110.php
@ -2,16 +2,14 @@

 namespace Crater\Listeners\Updates\v1;

-use Illuminate\Contracts\Queue\ShouldQueue;
-use Illuminate\Queue\InteractsWithQueue;
 use Crater\Events\UpdateFinished;
 use Crater\Listeners\Updates\Listener;
-use Crater\Models\Setting;
 use Crater\Models\Currency;
+use Crater\Models\Setting;

 class Version110 extends Listener
 {
-    const VERSION = '1.1.0';
+    public const VERSION = '1.1.0';

    /**
     * Create the event listener.
@ -42,59 +40,59 @@ class Version110 extends Listener
        Setting::setSetting('version', static::VERSION);
    }

-    private function addCurrencies() {
-
+    private function addCurrencies()
+    {
        $currencies = [
            '13' => [
-                'symbol' => 'S$'
+                'symbol' => 'S$',
            ],
            '16' => [
-                'symbol' => '₫'
+                'symbol' => '₫',
            ],
            '17' => [
-                'symbol' => 'Fr.'
+                'symbol' => 'Fr.',
            ],
            '21' => [
-                'symbol' => '฿'
+                'symbol' => '฿',
            ],
            '22' => [
-                'symbol' => '₦'
+                'symbol' => '₦',
            ],
            '26' => [
-                'symbol' => 'HK$'
+                'symbol' => 'HK$',
            ],
            '35' => [
-                'symbol' => 'NAƒ'
+                'symbol' => 'NAƒ',
            ],
            '38' => [
-                'symbol' => 'GH₵'
+                'symbol' => 'GH₵',
            ],
            '39' => [
-                'symbol' => 'Лв.'
+                'symbol' => 'Лв.',
            ],
            '42' => [
-                'symbol' => 'RON'
+                'symbol' => 'RON',
            ],
            '44' => [
-                'symbol' => 'SِAR'
+                'symbol' => 'SِAR',
            ],
            '46' => [
-                'symbol' => 'Rf'
+                'symbol' => 'Rf',
            ],
            '47' => [
-                'symbol' => '₡'
+                'symbol' => '₡',
            ],
            '54' => [
-                'symbol' => '‎د.ت'
+                'symbol' => '‎د.ت',
            ],
            '55' => [
-                'symbol' => '₽'
+                'symbol' => '₽',
            ],
            '57' => [
-                'symbol' => 'ر.ع.'
+                'symbol' => 'ر.ع.',
            ],
            '58' => [
-                'symbol' => '₴'
+                'symbol' => '₴',
            ],

        ];
@ -109,7 +107,7 @@ class Version110 extends Listener
            'symbol' => 'KWD ',
            'precision' => '3',
            'thousand_separator' => ',',
-            'decimal_separator' => '.'
+            'decimal_separator' => '.',
        ]);
    }
 }
--- a/app/Listeners/Updates/v2/Version200.php
+++ b/app/Listeners/Updates/v2/Version200.php
@ -2,17 +2,14 @@

 namespace Crater\Listeners\Updates\v2;

-use Illuminate\Contracts\Queue\ShouldQueue;
-use Illuminate\Queue\InteractsWithQueue;
-use Illuminate\Database\Schema\Blueprint;
-use Crater\Listeners\Updates\Listener;
 use Crater\Events\UpdateFinished;
+use Crater\Listeners\Updates\Listener;
 use Crater\Models\Setting;
-use Crater\Models\Address;
+use Illuminate\Database\Schema\Blueprint;

 class Version200 extends Listener
 {
-    const VERSION = '2.0.0';
+    public const VERSION = '2.0.0';

    /**
     * Create the event listener.
@ -52,7 +49,8 @@ class Version200 extends Listener
        $this->updateVersion();
    }

-    private function replaceStateAndCityName() {
+    private function replaceStateAndCityName()
+    {
        \Schema::table('addresses', function (Blueprint $table) {
            $table->string('state')->nullable();
            $table->string('city')->nullable();
@ -61,12 +59,12 @@ class Version200 extends Listener
        $addresses = \Crater\Models\Address::all();
        foreach ($addresses as $add) {
            $city = \Crater\City::find($add->city_id);
-            if($city) {
+            if ($city) {
                $add->city = $city->name;
            }

            $state = \Crater\State::find($add->state_id);
-            if($state) {
+            if ($state) {
                $add->state = $state->name;
            }

@ -74,7 +72,8 @@ class Version200 extends Listener
        }
    }

-    private function dropForeignKey() {
+    private function dropForeignKey()
+    {
        \Schema::table('addresses', function (Blueprint $table) {
            $table->dropForeign('addresses_state_id_foreign');
            $table->dropForeign('addresses_city_id_foreign');
@ -83,7 +82,8 @@ class Version200 extends Listener
        });
    }

-    private function dropSchemas() {
+    private function dropSchemas()
+    {
        \Schema::disableForeignKeyConstraints();

        \Schema::dropIfExists('states');
@ -92,7 +92,8 @@ class Version200 extends Listener
        \Schema::enableForeignKeyConstraints();
    }

-    private function deleteFiles() {
+    private function deleteFiles()
+    {
        \File::delete(
            database_path('migrations/2017_05_06_172817_create_cities_table.php'),
            database_path('migrations/2017_05_06_173711_create_states_table.php'),
@ -103,7 +104,8 @@ class Version200 extends Listener
        );
    }

-    private function updateVersion() {
+    private function updateVersion()
+    {
        Setting::setSetting('version', static::VERSION);
    }
 }
--- a/app/Listeners/Updates/v2/Version201.php
+++ b/app/Listeners/Updates/v2/Version201.php
@ -2,16 +2,14 @@

 namespace Crater\Listeners\Updates\v2;

-use Illuminate\Contracts\Queue\ShouldQueue;
-use Illuminate\Queue\InteractsWithQueue;
-use Illuminate\Database\Schema\Blueprint;
 use Crater\Events\UpdateFinished;
 use Crater\Listeners\Updates\Listener;
 use Crater\Models\Setting;
+use Illuminate\Database\Schema\Blueprint;

 class Version201 extends Listener
 {
-    const VERSION = '2.0.1';
+    public const VERSION = '2.0.1';

    /**
     * Create the event listener.
@ -45,20 +43,21 @@ class Version201 extends Listener
        Setting::setSetting('version', static::VERSION);
    }

-    private function removeLanguageFiles() {
+    private function removeLanguageFiles()
+    {
        $en = resource_path('assets/js/plugins/en.js');
        $es = resource_path('assets/js/plugins/es.js');
        $fr = resource_path('assets/js/plugins/fr.js');

-        if(file_exists($en)) {
+        if (file_exists($en)) {
            unlink($en);
        }

-        if(file_exists($es)) {
+        if (file_exists($es)) {
            unlink($es);
        }

-        if(file_exists($fr)) {
+        if (file_exists($fr)) {
            unlink($fr);
        }
    }
--- a/app/Listeners/Updates/v2/Version202.php
+++ b/app/Listeners/Updates/v2/Version202.php
@ -2,15 +2,13 @@

 namespace Crater\Listeners\Updates\v2;

-use Illuminate\Contracts\Queue\ShouldQueue;
-use Illuminate\Queue\InteractsWithQueue;
 use Crater\Events\UpdateFinished;
 use Crater\Listeners\Updates\Listener;
 use Crater\Models\Setting;

 class Version202 extends Listener
 {
-    const VERSION = '2.0.2';
+    public const VERSION = '2.0.2';

    /**
     * Create the event listener.
--- a/app/Listeners/Updates/v2/Version210.php
+++ b/app/Listeners/Updates/v2/Version210.php
@ -2,16 +2,14 @@

 namespace Crater\Listeners\Updates\v2;

-use Illuminate\Contracts\Queue\ShouldQueue;
-use Illuminate\Queue\InteractsWithQueue;
 use Crater\Events\UpdateFinished;
 use Crater\Listeners\Updates\Listener;
-use Crater\Models\Setting;
 use Crater\Models\CompanySetting;
+use Crater\Models\Setting;

 class Version210 extends Listener
 {
-    const VERSION = '2.1.0';
+    public const VERSION = '2.1.0';

    /**
     * Create the event listener.
@ -50,7 +48,7 @@ class Version210 extends Listener
            'estimate_prefix' => 'EST',
            'estimate_auto_generate' => 'YES',
            'payment_prefix' => 'PAY',
-            'payment_auto_generate' => 'YES'
+            'payment_auto_generate' => 'YES',
        ];

        foreach ($settings as $key => $value) {
--- a/app/Listeners/Updates/v3/Version300.php
+++ b/app/Listeners/Updates/v3/Version300.php
@ -2,21 +2,19 @@

 namespace Crater\Listeners\Updates\v3;

-use Illuminate\Contracts\Queue\ShouldQueue;
-use Illuminate\Queue\InteractsWithQueue;
+use Crater\Listeners\Updates\Listener;
+use Crater\Models\Currency;
+use Crater\Models\Item;
+use Crater\Models\Payment;
+use Crater\Models\PaymentMethod;
 use Crater\Models\Setting;
 use Crater\Models\Unit;
-use Crater\Models\PaymentMethod;
-use Crater\Models\Currency;
-use Crater\Models\Payment;
-use Crater\Models\Item;
 use Crater\Models\User;
-use Crater\Listeners\Updates\Listener;
 use Illuminate\Database\Schema\Blueprint;

 class Version300 extends Listener
 {
-    const VERSION = '3.0.0';
+    public const VERSION = '3.0.0';

    /**
     * Create the event listener.
@ -122,7 +120,7 @@ class Version300 extends Listener
            'symbol' => 'RSD',
            'precision' => '2',
            'thousand_separator' => '.',
-            'decimal_separator' => ','
+            'decimal_separator' => ',',
        ]);
    }

--- a/app/Listeners/Updates/v3/Version310.php
+++ b/app/Listeners/Updates/v3/Version310.php
@ -2,20 +2,15 @@

 namespace Crater\Listeners\Updates\v3;

-use Illuminate\Contracts\Queue\ShouldQueue;
-use Illuminate\Queue\InteractsWithQueue;
-use Crater\Listeners\Updates\Listener;
-use Illuminate\Database\Schema\Blueprint;
-use Crater\Events\UpdateFinished;
-use Crater\Models\Setting;
-use Crater\Models\Currency;
-use Schema;
 use Artisan;
+use Crater\Events\UpdateFinished;
+use Crater\Listeners\Updates\Listener;
+use Crater\Models\Currency;
+use Crater\Models\Setting;

 class Version310 extends Listener
 {
-    const VERSION = '3.1.0';
-
+    public const VERSION = '3.1.0';

    /**
     * Handle the event.
@ -32,7 +27,7 @@ class Version310 extends Listener
        Currency::firstOrCreate(
            [
                'name' => 'Kyrgyzstani som',
-                'code' => 'KGS'
+                'code' => 'KGS',
            ],
            [
                'name' => 'Kyrgyzstani som',
@ -40,7 +35,7 @@ class Version310 extends Listener
                'symbol' => 'С̲ ',
                'precision' => '2',
                'thousand_separator' => '.',
-                'decimal_separator' => ','
+                'decimal_separator' => ',',
            ]
        );

--- a/app/Listeners/Updates/v3/Version311.php
+++ b/app/Listeners/Updates/v3/Version311.php
@ -2,15 +2,14 @@

 namespace Crater\Listeners\Updates\v3;

-use Crater\Listeners\Updates\Listener;
-use Crater\Events\UpdateFinished;
-use Crater\Models\Setting;
-use Crater\Models\Currency;
 use Artisan;
+use Crater\Events\UpdateFinished;
+use Crater\Listeners\Updates\Listener;
+use Crater\Models\Setting;

 class Version311 extends Listener
 {
-    const VERSION = '3.1.1';
+    public const VERSION = '3.1.1';

    /**
     * Handle the event.