Apply fixes from StyleCI (#7)

a1383n · StyleCIBot · web-flow · commit f2b6b29f8c0e · 2024-06-13T16:49:35.000+03:30
* Apply fixes from StyleCI * style: Fix code style issues * Delete .github/workflows/php-cs-fixer.yml * Revert "style: Fix code style issues" This reverts commit f972a09. --------- Co-authored-by: StyleCI Bot <bot@styleci.io> Co-authored-by: a1383n <a1383n@users.noreply.github.com>
diff --git a/.github/workflows/php-cs-fixer.yml b/.github/workflows/php-cs-fixer.yml
diff --git a/src/Contracts/EloquentSettingModelInterface.php b/src/Contracts/EloquentSettingModelInterface.php
@@ -5,7 +5,7 @@
 use LaravelEloquentSettings\Enums\SettingValueType;
 
 /**
- * Interface EloquentSettingModelInterface
+ * Interface EloquentSettingModelInterface.
  *
  * This interface defines the contract that EloquentSetting models should adhere to.
  */
@@ -26,7 +26,7 @@ public function getName(): string;
     public function getValue(): mixed;
 
     /**
-     * Set the value type
+     * Set the value type.
      *
      * @param SettingValueType $type
      *
diff --git a/src/Contracts/HasSettingsInterface.php b/src/Contracts/HasSettingsInterface.php
@@ -5,7 +5,7 @@
 use LaravelEloquentSettings\SettingDefinition;
 
 /**
- * Interface HasSettingsInterface
+ * Interface HasSettingsInterface.
  *
  * This interface defines the contract for models that have settings.
  */
@@ -15,6 +15,7 @@ interface HasSettingsInterface
      * Define settings for the model.
      *
      * @param SettingDefinition $definition
+     *
      * @return void
      */
     public function defineSettings(SettingDefinition $definition): void;
diff --git a/src/Contracts/SettingHandlerInterface.php b/src/Contracts/SettingHandlerInterface.php
@@ -5,7 +5,7 @@
 use LaravelEloquentSettings\SettingDefinitionEntity;
 
 /**
- * Interface SettingHandlerInterface
+ * Interface SettingHandlerInterface.
  *
  * This interface defines the contract for handling settings.
  */
@@ -15,7 +15,8 @@ interface SettingHandlerInterface
      * Create a new setting.
      *
      * @param SettingDefinitionEntity $entity
-     * @param mixed $value
+     * @param mixed                   $value
+     *
      * @return void
      */
     public function createSetting(SettingDefinitionEntity $entity, mixed $value): void;
@@ -24,7 +25,8 @@ public function createSetting(SettingDefinitionEntity $entity, mixed $value): vo
      * Update an existing setting.
      *
      * @param SettingDefinitionEntity $entity
-     * @param mixed $value
+     * @param mixed                   $value
+     *
      * @return void
      */
     public function updateSetting(SettingDefinitionEntity $entity, mixed $value): void;
@@ -33,6 +35,7 @@ public function updateSetting(SettingDefinitionEntity $entity, mixed $value): vo
      * Get the value of a setting.
      *
      * @param SettingDefinitionEntity $entity
+     *
      * @return EloquentSettingModelInterface
      */
     public function getSetting(SettingDefinitionEntity $entity): EloquentSettingModelInterface;
diff --git a/src/Contracts/SettingRepositoryInterface.php b/src/Contracts/SettingRepositoryInterface.php
@@ -6,7 +6,7 @@
 use LaravelEloquentSettings\Enums\SettingValueType;
 
 /**
- * Interface SettingRepositoryInterface
+ * Interface SettingRepositoryInterface.
  *
  * This interface defines the contract for interacting with the settings repository.
  */
@@ -16,28 +16,31 @@ interface SettingRepositoryInterface
      * Get a setting by name.
      *
      * @param string $name The name of the setting.
-     * @return EloquentSettingModelInterface The retrieved setting model.
      *
      * @throws ModelNotFoundException If the setting is not found.
+     *
+     * @return EloquentSettingModelInterface The retrieved setting model.
      */
     public function getSettingByName(string $name): EloquentSettingModelInterface;
 
     /**
      * Update a setting by name.
      *
-     * @param string $name The name of the setting.
-     * @param SettingValueType $type The type of the setting value.
-     * @param mixed $value The new value for the setting.
+     * @param string           $name  The name of the setting.
+     * @param SettingValueType $type  The type of the setting value.
+     * @param mixed            $value The new value for the setting.
+     *
      * @return bool|EloquentSettingModelInterface If the update is successful, returns true; otherwise, creates a new setting and returns the model.
      */
     public function updateSettingByName(string $name, SettingValueType $type, mixed $value): bool|EloquentSettingModelInterface;
 
     /**
      * Create a new setting by name.
      *
-     * @param string $name The name of the setting.
-     * @param SettingValueType $type The type of the setting value.
-     * @param mixed $value The value for the new setting.
+     * @param string           $name  The name of the setting.
+     * @param SettingValueType $type  The type of the setting value.
+     * @param mixed            $value The value for the new setting.
+     *
      * @return EloquentSettingModelInterface The created setting model.
      */
     public function createSettingByName(string $name, SettingValueType $type, mixed $value): EloquentSettingModelInterface;
diff --git a/src/Contracts/SettingResolverInterface.php b/src/Contracts/SettingResolverInterface.php
@@ -5,7 +5,7 @@
 use LaravelEloquentSettings\SettingDefinitionEntity;
 
 /**
- * Interface SettingResolverInterface
+ * Interface SettingResolverInterface.
  *
  * This interface defines the contract for resolving settings based on a given entity.
  */
@@ -15,6 +15,7 @@ interface SettingResolverInterface
      * Resolve the setting value based on the provided entity.
      *
      * @param SettingDefinitionEntity $entity
+     *
      * @return mixed
      */
     public function __invoke(SettingDefinitionEntity $entity): mixed;
diff --git a/src/Contracts/SettingSetterInterface.php b/src/Contracts/SettingSetterInterface.php
@@ -5,7 +5,7 @@
 use LaravelEloquentSettings\SettingDefinitionEntity;
 
 /**
- * Interface SettingSetterInterface
+ * Interface SettingSetterInterface.
  *
  * This interface defines the contract for setting values for a given setting entity.
  */
@@ -15,7 +15,8 @@ interface SettingSetterInterface
      * Set the value for the provided setting entity.
      *
      * @param SettingDefinitionEntity $entity
-     * @param mixed $value
+     * @param mixed                   $value
+     *
      * @return void
      */
     public function __invoke(SettingDefinitionEntity $entity, mixed $value = null): void;
diff --git a/src/EloquentSettingManager.php b/src/EloquentSettingManager.php
@@ -9,11 +9,9 @@
 use LaravelEloquentSettings\Contracts\SettingRepositoryInterface;
 
 /**
- * Class EloquentSettingManager
+ * Class EloquentSettingManager.
  *
  * Manager for handling Eloquent model settings.
- *
- * @package LaravelEloquentSettings
  */
 class EloquentSettingManager
 {
@@ -22,9 +20,9 @@ class EloquentSettingManager
      *
      * @param Model $model
      *
-     * @return SettingHandlerInterface
-     *
      * @throws BindingResolutionException
+     *
+     * @return SettingHandlerInterface
      */
     public function getHandler(Model $model): SettingHandlerInterface
     {
diff --git a/src/EloquentSettings.php b/src/EloquentSettings.php
@@ -6,13 +6,11 @@
 use Illuminate\Support\Facades\Facade;
 
 /**
- * Class EloquentSettings
+ * Class EloquentSettings.
  *
  * Facade for accessing the EloquentSettings manager.
  *
  * @method static EloquentSettingManager getHandler(Model $model)
- *
- * @package LaravelEloquentSettings
  */
 class EloquentSettings extends Facade
 {
diff --git a/src/EloquentSettingsServiceProvider.php b/src/EloquentSettingsServiceProvider.php
@@ -8,11 +8,9 @@
 use LaravelEloquentSettings\Repositories\SettingRepository;
 
 /**
- * Class EloquentSettingsServiceProvider
+ * Class EloquentSettingsServiceProvider.
  *
  * Laravel service provider for the EloquentSettings package.
- *
- * @package LaravelEloquentSettings
  */
 class EloquentSettingsServiceProvider extends ServiceProvider
 {
@@ -23,7 +21,7 @@ class EloquentSettingsServiceProvider extends ServiceProvider
      */
     public function register(): void
     {
-        $this->mergeConfigFrom(__DIR__ . '/../config/eloquent_settings.php', 'eloquent_settings');
+        $this->mergeConfigFrom(__DIR__.'/../config/eloquent_settings.php', 'eloquent_settings');
 
         $this->app->bind('eloquent_settings', EloquentSettingManager::class);
 
@@ -48,17 +46,17 @@ public function boot(): void
      */
     protected function registerPublishables(): void
     {
-        if (! $this->app->runningInConsole()) {
+        if (!$this->app->runningInConsole()) {
             return;
         }
 
         $this->publishes([
-            __DIR__ . '/../config/eloquent_settings.php' => config_path('eloquent_settings.php'),
+            __DIR__.'/../config/eloquent_settings.php' => config_path('eloquent_settings.php'),
         ], 'config');
 
         if (empty(glob(database_path('migrations/*_create_eloquent_settings_table.php')))) {
             $this->publishes([
-                __DIR__ . '/../database/migrations/create_eloquent_settings_table.php.stub' => database_path('migrations/' . date('Y_m_d_His', time()) . '_create_eloquent_settings_table.php'),
+                __DIR__.'/../database/migrations/create_eloquent_settings_table.php.stub' => database_path('migrations/'.date('Y_m_d_His', time()).'_create_eloquent_settings_table.php'),
             ], 'migrations');
         }
     }
diff --git a/src/Enums/SettingValueType.php b/src/Enums/SettingValueType.php
@@ -3,7 +3,7 @@
 namespace LaravelEloquentSettings\Enums;
 
 /**
- * Enum SettingValueType
+ * Enum SettingValueType.
  *
  * This enum represents the possible types for setting values.
  */
diff --git a/src/Models/EloquentSetting.php b/src/Models/EloquentSetting.php
@@ -7,11 +7,9 @@
 use LaravelEloquentSettings\Enums\SettingValueType;
 
 /**
- * Class EloquentSetting
+ * Class EloquentSetting.
  *
  * Eloquent model representing a setting.
- *
- * @package LaravelEloquentSettings\Models
  */
 class EloquentSetting extends Model implements EloquentSettingModelInterface
 {
diff --git a/src/Repositories/SettingRepository.php b/src/Repositories/SettingRepository.php
@@ -9,11 +9,9 @@
 use LaravelEloquentSettings\Models\EloquentSetting;
 
 /**
- * Class SettingRepository
+ * Class SettingRepository.
  *
  * Repository for managing and retrieving Eloquent settings.
- *
- * @package LaravelEloquentSettings\Repositories
  */
 class SettingRepository implements SettingRepositoryInterface
 {
@@ -31,6 +29,7 @@ public function __construct(protected readonly MorphMany $morphManyRelation)
      * Get the query for a setting by name.
      *
      * @param string $name The name of the setting.
+     *
      * @return MorphMany<EloquentSetting> The morphMany relation query.
      */
     protected function getSettingByNameQuery(string $name): MorphMany
diff --git a/src/SettingDefinition.php b/src/SettingDefinition.php
@@ -3,11 +3,9 @@
 namespace LaravelEloquentSettings;
 
 /**
- * Class SettingDefinition
+ * Class SettingDefinition.
  *
  * Represents a collection of setting definitions.
- *
- * @package LaravelEloquentSettings
  */
 class SettingDefinition
 {
@@ -20,6 +18,7 @@ class SettingDefinition
      * Define a new setting.
      *
      * @param string $name
+     *
      * @return SettingDefinitionItem
      */
     public function define(string $name): SettingDefinitionItem
diff --git a/src/SettingDefinitionEntity.php b/src/SettingDefinitionEntity.php
@@ -6,31 +6,29 @@
 use LaravelEloquentSettings\Enums\SettingValueType;
 
 /**
- * Class SettingDefinitionEntity
+ * Class SettingDefinitionEntity.
  *
  * Represents a single setting definition entity.
- *
- * @package LaravelEloquentSettings
  */
 class SettingDefinitionEntity
 {
     /**
      * SettingDefinitionEntity constructor.
      *
-     * @param string $name
-     * @param SettingValueType $type
-     * @param mixed $default
-     * @param bool $insertOnDefault
-     * @param bool $nullable
+     * @param string                            $name
+     * @param SettingValueType                  $type
+     * @param mixed                             $default
+     * @param bool                              $insertOnDefault
+     * @param bool                              $nullable
      * @param array<string|ValidationRule>|null $customValidationRules
      */
     public function __construct(
-        public readonly string           $name,
+        public readonly string $name,
         public readonly SettingValueType $type,
-        public readonly mixed            $default,
-        public readonly bool             $insertOnDefault = true,
-        public readonly bool             $nullable = false,
-        public readonly ?array           $customValidationRules = null
+        public readonly mixed $default,
+        public readonly bool $insertOnDefault = true,
+        public readonly bool $nullable = false,
+        public readonly ?array $customValidationRules = null
     ) {
         //
     }
diff --git a/src/SettingDefinitionItem.php b/src/SettingDefinitionItem.php
diff --git a/src/SettingHandler.php b/src/SettingHandler.php
diff --git a/src/SettingResolver.php b/src/SettingResolver.php
diff --git a/src/SettingSetter.php b/src/SettingSetter.php
diff --git a/src/Traits/HasSettings.php b/src/Traits/HasSettings.php

Original file line number	Diff line number	Diff line change
`@@ -5,7 +5,7 @@`
`5`	`5`	`use LaravelEloquentSettings\Enums\SettingValueType;`
`6`	`6`
`7`	`7`	`/**`
`8`		`- * Interface EloquentSettingModelInterface`
	`8`	`+ * Interface EloquentSettingModelInterface.`
`9`	`9`	`*`
`10`	`10`	`* This interface defines the contract that EloquentSetting models should adhere to.`
`11`	`11`	`*/`
`@@ -26,7 +26,7 @@ public function getName(): string;`
`26`	`26`	`public function getValue(): mixed;`
`27`	`27`
`28`	`28`	`/**`
`29`		`- * Set the value type`
	`29`	`+ * Set the value type.`
`30`	`30`	`*`
`31`	`31`	`* @param SettingValueType $type`
`32`	`32`	`*`
Original file line number	Diff line number	Diff line change
`@@ -9,11 +9,9 @@`
`9`	`9`	`use LaravelEloquentSettings\Contracts\SettingRepositoryInterface;`
`10`	`10`
`11`	`11`	`/**`
`12`		`- * Class EloquentSettingManager`
	`12`	`+ * Class EloquentSettingManager.`
`13`	`13`	`*`
`14`	`14`	`* Manager for handling Eloquent model settings.`
`15`		`- *`
`16`		`- * @package LaravelEloquentSettings`
`17`	`15`	`*/`
`18`	`16`	`class EloquentSettingManager`
`19`	`17`	`{`
`@@ -22,9 +20,9 @@ class EloquentSettingManager`
`22`	`20`	`*`
`23`	`21`	`* @param Model $model`
`24`	`22`	`*`
`25`		`- * @return SettingHandlerInterface`
`26`		`- *`
`27`	`23`	`* @throws BindingResolutionException`
	`24`	`+ *`
	`25`	`+ * @return SettingHandlerInterface`
`28`	`26`	`*/`
`29`	`27`	`public function getHandler(Model $model): SettingHandlerInterface`
`30`	`28`	`{`
Original file line number	Diff line number	Diff line change
`@@ -6,13 +6,11 @@`
`6`	`6`	`use Illuminate\Support\Facades\Facade;`
`7`	`7`
`8`	`8`	`/**`
`9`		`- * Class EloquentSettings`
	`9`	`+ * Class EloquentSettings.`
`10`	`10`	`*`
`11`	`11`	`* Facade for accessing the EloquentSettings manager.`
`12`	`12`	`*`
`13`	`13`	`* @method static EloquentSettingManager getHandler(Model $model)`
`14`		`- *`
`15`		`- * @package LaravelEloquentSettings`
`16`	`14`	`*/`
`17`	`15`	`class EloquentSettings extends Facade`
`18`	`16`	`{`
Original file line number	Diff line number	Diff line change
`@@ -8,11 +8,9 @@`
`8`	`8`	`use LaravelEloquentSettings\Repositories\SettingRepository;`
`9`	`9`
`10`	`10`	`/**`
`11`		`- * Class EloquentSettingsServiceProvider`
	`11`	`+ * Class EloquentSettingsServiceProvider.`
`12`	`12`	`*`
`13`	`13`	`* Laravel service provider for the EloquentSettings package.`
`14`		`- *`
`15`		`- * @package LaravelEloquentSettings`
`16`	`14`	`*/`
`17`	`15`	`class EloquentSettingsServiceProvider extends ServiceProvider`
`18`	`16`	`{`
`@@ -23,7 +21,7 @@ class EloquentSettingsServiceProvider extends ServiceProvider`
`23`	`21`	`*/`
`24`	`22`	`public function register(): void`
`25`	`23`	`{`
`26`		`- $this->mergeConfigFrom(__DIR__ . '/../config/eloquent_settings.php', 'eloquent_settings');`
	`24`	`+ $this->mergeConfigFrom(__DIR__.'/../config/eloquent_settings.php', 'eloquent_settings');`
`27`	`25`
`28`	`26`	`$this->app->bind('eloquent_settings', EloquentSettingManager::class);`
`29`	`27`
`@@ -48,17 +46,17 @@ public function boot(): void`
`48`	`46`	`*/`
`49`	`47`	`protected function registerPublishables(): void`
`50`	`48`	`{`
`51`		`- if (! $this->app->runningInConsole()) {`
	`49`	`+ if (!$this->app->runningInConsole()) {`
`52`	`50`	`return;`
`53`	`51`	`}`
`54`	`52`
`55`	`53`	`$this->publishes([`
`56`		`- __DIR__ . '/../config/eloquent_settings.php' => config_path('eloquent_settings.php'),`
	`54`	`+ __DIR__.'/../config/eloquent_settings.php' => config_path('eloquent_settings.php'),`
`57`	`55`	`], 'config');`
`58`	`56`
`59`	`57`	`if (empty(glob(database_path('migrations/*_create_eloquent_settings_table.php')))) {`
`60`	`58`	`$this->publishes([`
`61`		`- __DIR__ . '/../database/migrations/create_eloquent_settings_table.php.stub' => database_path('migrations/' . date('Y_m_d_His', time()) . '_create_eloquent_settings_table.php'),`
	`59`	`+ __DIR__.'/../database/migrations/create_eloquent_settings_table.php.stub' => database_path('migrations/'.date('Y_m_d_His', time()).'_create_eloquent_settings_table.php'),`
`62`	`60`	`], 'migrations');`
`63`	`61`	`}`
`64`	`62`	`}`