From 4c41e57bc2527d2bd0741ce08f7da17c059ba024 Mon Sep 17 00:00:00 2001
From: recursive_tree <recursivetreemail@gmail.com>
Date: Fri, 13 Oct 2023 14:57:09 +0200
Subject: [PATCH] styleci

---
 src/Contracts/HasTypeID.php      | 22 +++++++-
 src/Contracts/IPriceable.php     | 27 ++++++++--
 src/Helpers/UserAgentBuilder.php | 91 ++++++++++++++++++++++----------
 src/Items/EveType.php            | 29 ++++++++--
 src/Items/PriceableEveType.php   | 30 +++++++++--
 5 files changed, 156 insertions(+), 43 deletions(-)

diff --git a/src/Contracts/HasTypeID.php b/src/Contracts/HasTypeID.php
index 51fd5db8..a31b1dbe 100644
--- a/src/Contracts/HasTypeID.php
+++ b/src/Contracts/HasTypeID.php
@@ -1,5 +1,25 @@
 <?php
 
+/*
+ * This file is part of SeAT
+ *
+ * Copyright (C) 2015 to present Leon Jacobs
+ *
+ * This program is free software; you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation; either version 2 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License along
+ * with this program; if not, write to the Free Software Foundation, Inc.,
+ * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
+ */
+
 namespace Seat\Services\Contracts;
 
 /**
@@ -11,4 +31,4 @@ interface HasTypeID
      * @return int The eve type id of this object
      */
     public function getTypeID(): int;
-}
\ No newline at end of file
+}
diff --git a/src/Contracts/IPriceable.php b/src/Contracts/IPriceable.php
index 437875d7..f69f5b26 100644
--- a/src/Contracts/IPriceable.php
+++ b/src/Contracts/IPriceable.php
@@ -1,5 +1,25 @@
 <?php
 
+/*
+ * This file is part of SeAT
+ *
+ * Copyright (C) 2015 to present Leon Jacobs
+ *
+ * This program is free software; you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation; either version 2 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License along
+ * with this program; if not, write to the Free Software Foundation, Inc.,
+ * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
+ */
+
 namespace Seat\Services\Contracts;
 
 /**
@@ -15,9 +35,10 @@ interface IPriceable extends HasTypeID
     public function getAmount(): int;
 
     /**
-     * Set the price of this object
-     * @param float $price
+     * Set the price of this object.
+     *
+     * @param  float  $price
      * @return void
      */
     public function setPrice(float $price): void;
-}
\ No newline at end of file
+}
diff --git a/src/Helpers/UserAgentBuilder.php b/src/Helpers/UserAgentBuilder.php
index 6c9db3c7..9ce30b09 100644
--- a/src/Helpers/UserAgentBuilder.php
+++ b/src/Helpers/UserAgentBuilder.php
@@ -1,5 +1,25 @@
 <?php
 
+/*
+ * This file is part of SeAT
+ *
+ * Copyright (C) 2015 to present Leon Jacobs
+ *
+ * This program is free software; you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation; either version 2 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License along
+ * with this program; if not, write to the Free Software Foundation, Inc.,
+ * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
+ */
+
 namespace Seat\Services\Helpers;
 
 use Composer\InstalledVersions;
@@ -9,7 +29,7 @@
 
 /**
  * A helper to build user agents for seat packages
- * Structure and terms according to https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/User-Agent
+ * Structure and terms according to https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/User-Agent.
  */
 class UserAgentBuilder
 {
@@ -18,8 +38,9 @@ class UserAgentBuilder
     protected array $comments = [];
 
     /**
-     * Set the product part of the user agent
-     * @param string $product The new product name
+     * Set the product part of the user agent.
+     *
+     * @param  string  $product  The new product name
      * @return $this
      */
     public function product(string $product): UserAgentBuilder {
@@ -29,8 +50,9 @@ public function product(string $product): UserAgentBuilder {
     }
 
     /**
-     * Set the version of the product
-     * @param string $version
+     * Set the version of the product.
+     *
+     * @param  string  $version
      * @return $this
      */
     public function version(string $version): UserAgentBuilder {
@@ -40,8 +62,9 @@ public function version(string $version): UserAgentBuilder {
     }
 
     /**
-     * Configures the product and version of the user agent for a seat plugin
-     * @param string|AbstractSeatPlugin $plugin A plugin service provider instance or the FCQN of the service provider (e.g. MyServiceProvider::class)
+     * Configures the product and version of the user agent for a seat plugin.
+     *
+     * @param  string|AbstractSeatPlugin  $plugin  A plugin service provider instance or the FCQN of the service provider (e.g. MyServiceProvider::class)
      * @return $this
      */
     public function seatPlugin(string|AbstractSeatPlugin $plugin): UserAgentBuilder {
@@ -55,21 +78,23 @@ public function seatPlugin(string|AbstractSeatPlugin $plugin): UserAgentBuilder
     }
 
     /**
-     * Configures the product and version of the user agent for a packagist package
-     * @param string $vendor The packagist vendor name
-     * @param string $package The packagist package name
+     * Configures the product and version of the user agent for a packagist package.
+     *
+     * @param  string  $vendor  The packagist vendor name
+     * @param  string  $package  The packagist package name
      * @return $this
      */
     public function packagist(string $vendor, string $package): UserAgentBuilder {
-        $this->product = sprintf('%s:%s',$vendor, $package);
+        $this->product = sprintf('%s:%s', $vendor, $package);
         $this->version = $this->getPackageVersion($vendor, $package);
 
         return $this;
     }
 
     /**
-     * Adds a comment containing the product and version of the user agent for a seat plugin
-     * @param string|AbstractSeatPlugin $plugin A plugin service provider instance or the FCQN of the service provider (e.g. MyServiceProvider::class)
+     * Adds a comment containing the product and version of the user agent for a seat plugin.
+     *
+     * @param  string|AbstractSeatPlugin  $plugin  A plugin service provider instance or the FCQN of the service provider (e.g. MyServiceProvider::class)
      * @return $this
      */
     public function commentSeatPlugin(string|AbstractSeatPlugin $plugin): UserAgentBuilder {
@@ -83,20 +108,22 @@ public function commentSeatPlugin(string|AbstractSeatPlugin $plugin): UserAgentB
     }
 
     /**
-     * Adds a comment containing the product and version of the user agent for a packagist package
-     * @param string $vendor The packagist vendor name
-     * @param string $package The packagist package name
+     * Adds a comment containing the product and version of the user agent for a packagist package.
+     *
+     * @param  string  $vendor  The packagist vendor name
+     * @param  string  $package  The packagist package name
      * @return $this
      */
     public function commentPackagist(string $vendor, string $package): UserAgentBuilder {
-        $this->comment(sprintf('%s:%s/%s',$vendor, $package, $this->getPackageVersion($vendor, $package)));
+        $this->comment(sprintf('%s:%s/%s', $vendor, $package, $this->getPackageVersion($vendor, $package)));
 
         return $this;
     }
 
     /**
-     * Add a comment to the user agent
-     * @param string $comment the comment
+     * Add a comment to the user agent.
+     *
+     * @param  string  $comment  the comment
      * @return $this
      */
     public function comment(string $comment): UserAgentBuilder {
@@ -107,33 +134,39 @@ public function comment(string $comment): UserAgentBuilder {
 
     /**
      * Adds a reasonable set of default comments for any seat plugin.
+     *
      * @return $this
+     *
      * @throws SettingException
      */
     public function defaultComments(): UserAgentBuilder {
         $this->comment(sprintf('(admin contact: %s)', setting('admin_contact', true) ?? 'not specified'));
         $this->comment('(https://github.com/eveseat/seat)');
-        $this->commentPackagist('eveseat','seat');
-        $this->commentPackagist('eveseat','web');
-        $this->commentPackagist('eveseat','eveapi');
+        $this->commentPackagist('eveseat', 'seat');
+        $this->commentPackagist('eveseat', 'web');
+        $this->commentPackagist('eveseat', 'eveapi');
+
         return $this;
     }
 
     /**
-     * Assembles the user agent form its product, version, and comments into a string
+     * Assembles the user agent form its product, version, and comments into a string.
+     *
      * @return string The user agent
      */
     public function build(): string {
-        if($this->product === null || $this->version===null) {
+        if($this->product === null || $this->version === null) {
             throw new \Error('version or product not set.');
         }
-        return sprintf('%s/%s %s', $this->product, $this->version, implode(' ',$this->comments));
+
+        return sprintf('%s/%s %s', $this->product, $this->version, implode(' ', $this->comments));
     }
 
     /**
-     * Gets the installed version of a packagist package
-     * @param string $vendor The packagist vendor name
-     * @param string $package The packagist package name
+     * Gets the installed version of a packagist package.
+     *
+     * @param  string  $vendor  The packagist vendor name
+     * @param  string  $package  The packagist package name
      * @return string
      */
     private function getPackageVersion(string $vendor, string $package): string {
@@ -143,4 +176,4 @@ private function getPackageVersion(string $vendor, string $package): string {
             return 'unknown';
         }
     }
-}
\ No newline at end of file
+}
diff --git a/src/Items/EveType.php b/src/Items/EveType.php
index d9662465..a23fcf48 100644
--- a/src/Items/EveType.php
+++ b/src/Items/EveType.php
@@ -1,21 +1,40 @@
 <?php
 
-namespace Seat\Services\Items;
+/*
+ * This file is part of SeAT
+ *
+ * Copyright (C) 2015 to present Leon Jacobs
+ *
+ * This program is free software; you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation; either version 2 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License along
+ * with this program; if not, write to the Free Software Foundation, Inc.,
+ * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
+ */
 
+namespace Seat\Services\Items;
 
 use Seat\Services\Contracts\HasTypeID;
 
 /**
- * A basic implementation of HasTypeID
+ * A basic implementation of HasTypeID.
  */
 class EveType implements HasTypeID
 {
     protected int $type_id;
 
     /**
-     * @param int|HasTypeID $type_id
+     * @param  int|HasTypeID  $type_id
      */
-    public function __construct(int | HasTypeID $type_id)
+    public function __construct(int|HasTypeID $type_id)
     {
         if($type_id instanceof HasTypeID){
             $type_id = $type_id->getTypeID();
@@ -31,4 +50,4 @@ public function getTypeID(): int
     {
         return $this->type_id;
     }
-}
\ No newline at end of file
+}
diff --git a/src/Items/PriceableEveType.php b/src/Items/PriceableEveType.php
index 194ca44d..dbe6b95b 100644
--- a/src/Items/PriceableEveType.php
+++ b/src/Items/PriceableEveType.php
@@ -1,12 +1,32 @@
 <?php
 
+/*
+ * This file is part of SeAT
+ *
+ * Copyright (C) 2015 to present Leon Jacobs
+ *
+ * This program is free software; you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation; either version 2 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License along
+ * with this program; if not, write to the Free Software Foundation, Inc.,
+ * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
+ */
+
 namespace Seat\Services\Items;
 
 use Seat\Services\Contracts\HasTypeID;
 use Seat\Services\Contracts\IPriceable;
 
 /**
- * A basic implementation od IPriceable
+ * A basic implementation od IPriceable.
  */
 class PriceableEveType extends EveType implements IPriceable
 {
@@ -14,8 +34,8 @@ class PriceableEveType extends EveType implements IPriceable
     protected float $amount;
 
     /**
-     * @param int|HasTypeID $type_id The eve type to be appraised
-     * @param float $amount The amount of this type to be appraised
+     * @param  int|HasTypeID  $type_id  The eve type to be appraised
+     * @param  float  $amount  The amount of this type to be appraised
      */
     public function __construct(int|HasTypeID $type_id, float $amount)
     {
@@ -41,11 +61,11 @@ public function getPrice(): float
     }
 
     /**
-     * @param float $price The new price of this item stack
+     * @param  float  $price  The new price of this item stack
      * @return void
      */
     public function setPrice(float $price): void
     {
        $this->price = $price;
     }
-}
\ No newline at end of file
+}