Fix code styling

sertxudeveloper · Jul 17, 2023 · 43bba8a · 43bba8a
1 parent 4b90430
commit 43bba8a
Show file tree

Hide file tree

Showing 52 changed files with 22 additions and 416 deletions.
diff --git a/publishable/database/factories/LyraUserFactory.php b/publishable/database/factories/LyraUserFactory.php
@@ -17,8 +17,6 @@ class LyraUserFactory extends Factory
 
     /**
      * Define the model's default state.
-     *
-     * @return array
      */
     public function definition(): array {
         return [

diff --git a/publishable/database/migrations/2014_10_12_000000_create_lyra_users_table.php b/publishable/database/migrations/2014_10_12_000000_create_lyra_users_table.php
@@ -7,8 +7,6 @@
 new class extends Migration {
     /**
      * Run the migrations.
-     *
-     * @return void
      */
     public function up(): void {
         Schema::create('lyra_users', function (Blueprint $table) {
@@ -24,8 +22,6 @@ public function up(): void {
 
     /**
      * Reverse the migrations.
-     *
-     * @return void
      */
     public function down(): void {
         Schema::dropIfExists('lyra_users');

diff --git a/publishable/database/migrations/2014_10_12_100000_create_lyra_password_resets_table.php b/publishable/database/migrations/2014_10_12_100000_create_lyra_password_resets_table.php
@@ -7,8 +7,6 @@
 new class extends Migration {
     /**
      * Run the migrations.
-     *
-     * @return void
      */
     public function up(): void {
         Schema::create('lyra_password_resets', function (Blueprint $table) {
@@ -20,8 +18,6 @@ public function up(): void {
 
     /**
      * Reverse the migrations.
-     *
-     * @return void
      */
     public function down(): void {
         Schema::dropIfExists('lyra_password_resets');

diff --git a/publishable/database/seeders/LyraDatabaseSeeder.php b/publishable/database/seeders/LyraDatabaseSeeder.php
@@ -9,8 +9,6 @@ class LyraDatabaseSeeder extends Seeder
 {
     /**
      * Seed the application's database.
-     *
-     * @return void
      */
     public function run(): void {
         LyraUser::factory(1)->create();

diff --git a/src/Actions/Action.php b/src/Actions/Action.php
@@ -14,7 +14,6 @@ abstract class Action implements ShouldQueue
 {
     use Dispatchable, InteractsWithQueue, Queueable, SerializesModels;
 
-    /** @var Model */
     public Model $model;
 
     /**
@@ -30,17 +29,13 @@ public function __construct($model = null) {
 
     /**
      * Get the label of the resource
-     *
-     * @return string
      */
     public static function label(): string {
         return Str::title(Str::snake(class_basename(get_called_class()), ' '));
     }
 
     /**
      * Get the slug of the resource
-     *
-     * @return string
      */
     public static function slug(): string {
         return Str::kebab(class_basename(get_called_class()));

diff --git a/src/Cards/Card.php b/src/Cards/Card.php
@@ -8,17 +8,13 @@ abstract class Card
 {
     /**
      * Get the label of the card
-     *
-     * @return string
      */
     public function label(): string {
         return Str::title(Str::snake(class_basename(get_called_class()), ' '));
     }
 
     /**
      * Get the slug of the card
-     *
-     * @return string
      */
     public function slug(): string {
         return Str::kebab(class_basename(get_called_class()));

diff --git a/src/Cards/MetricCard.php b/src/Cards/MetricCard.php
@@ -9,45 +9,33 @@ abstract class MetricCard extends Card
 {
     /**
      * The card component
-     *
-     * @var string
      */
     public string $component = 'card-metric';
 
     /**
      * Precision for the rounding method
-     *
-     * @var int
      */
     public int $precision = 0;
 
     /**
      * Calculate the value of the metric in the specified range.
      * Supported 'count', 'min', 'max', 'avg' and 'sum' methods
      *
-     * @param  Request  $request
      * @return float[]
      */
     abstract public function calculate(Request $request): array;
 
     /**
      * Count instances of the model
      *
-     * @param  Request  $request
-     * @param  string|Builder  $model
-     * @param  string|null  $column
-     * @param  string|null  $dateColumn
      * @return float[]
      */
-    public function count(Request $request, Builder|string $model, ?string $column = null, ?string $dateColumn = null): array {
+    public function count(Request $request, Builder|string $model, string $column = null, string $dateColumn = null): array {
         return $this->query($request, $model, 'count', $column, $dateColumn);
     }
 
     /**
      * Generate current range from selected interval
-     *
-     * @param  Request  $request
-     * @return array
      */
     public function currentRange(Request $request): array {
         $range = $request->input('range') ?? $this->defaultRange();
@@ -57,19 +45,13 @@ public function currentRange(Request $request): array {
 
     /**
      * Get the key of the default range
-     *
-     * @return string
      */
     public function defaultRange(): string {
         return '3 months';
     }
 
     /**
      * Calculate the difference between the two intervals
-     *
-     * @param  float  $current
-     * @param  float  $previous
-     * @return float|int
      */
     public function difference(float $current, float $previous): float|int {
         return ($previous == 0) ? ($current * 100) : (($current - $previous) / $previous * 100);
@@ -78,34 +60,23 @@ public function difference(float $current, float $previous): float|int {
     /**
      * Get the maximum value of the specified column
      *
-     * @param  Request  $request
-     * @param  string|Builder  $model
-     * @param  string  $column
-     * @param  string|null  $dateColumn
      * @return float[]
      */
-    public function max(Request $request, Builder|string $model, string $column, ?string $dateColumn = null): array {
+    public function max(Request $request, Builder|string $model, string $column, string $dateColumn = null): array {
         return $this->query($request, $model, 'max', $column, $dateColumn);
     }
 
     /**
      * Get the minimum value of the specified column
      *
-     * @param  Request  $request
-     * @param  string|Builder  $model
-     * @param  string  $column
-     * @param  string|null  $dateColumn
      * @return float[]
      */
-    public function min(Request $request, Builder|string $model, string $column, ?string $dateColumn = null): array {
+    public function min(Request $request, Builder|string $model, string $column, string $dateColumn = null): array {
         return $this->query($request, $model, 'min', $column, $dateColumn);
     }
 
     /**
      * Generate previous range from selected interval
-     *
-     * @param  Request  $request
-     * @return array
      */
     public function previousRange(Request $request): array {
         $range = $request->input('range') ?? $this->defaultRange();
@@ -116,14 +87,9 @@ public function previousRange(Request $request): array {
     /**
      * Return the result of the query
      *
-     * @param  Request  $request
-     * @param  string|Builder  $model
-     * @param  string  $method
-     * @param  string|null  $column
-     * @param  string|null  $dateColumn
      * @return float[]
      */
-    public function query(Request $request, Builder|string $model, string $method, ?string $column = null, ?string $dateColumn = null): array {
+    public function query(Request $request, Builder|string $model, string $method, string $column = null, string $dateColumn = null): array {
         $query = $model instanceof Builder ? $model : $model::query();
         $column = $column ?? $query->getModel()->getQualifiedKeyName();
         $createdAt = $query->getModel()->getCreatedAtColumn();
@@ -154,21 +120,14 @@ public function ranges(): array {
     /**
      * Get the aggregate value of the specified column
      *
-     * @param  Request  $request
-     * @param  string|Builder  $model
-     * @param  string  $column
-     * @param  string|null  $dateColumn
      * @return float[]
      */
-    public function sum(Request $request, Builder|string $model, string $column, ?string $dateColumn = null): array {
+    public function sum(Request $request, Builder|string $model, string $column, string $dateColumn = null): array {
         return $this->query($request, $model, 'sum', $column, $dateColumn);
     }
 
     /**
      * Transform the card into a JSON array.
-     *
-     * @param  Request  $request
-     * @return array
      */
     public function toArray(Request $request): array {
         [$current, $previous] = $this->calculate($request);

diff --git a/src/Cards/PartitionCard.php b/src/Cards/PartitionCard.php
@@ -10,37 +10,28 @@ abstract class PartitionCard extends Card
 {
     /**
      * The card component
-     *
-     * @var string
      */
     public string $component = 'card-partition';
 
     /**
      * Precision for the rounding method
-     *
-     * @var int
      */
     public int $precision = 0;
 
     /**
      * Limit the quantity of results
-     *
-     * @var int
      */
     public int $limit = 6;
 
     /**
      * Show the quantity instead of the percentage in the items list
-     *
-     * @var bool
      */
     public bool $showQuantity = false;
 
     /**
      * Calculate the value in the specified range
      * Supported 'count', 'min', 'max', 'avg' and 'sum' methods
      *
-     * @param  Request  $request
      * @return array[]
      */
     abstract public function calculate(Request $request): array;
@@ -64,23 +55,15 @@ public function colors(): array {
     /**
      * Count instances of the model
      *
-     * @param  Request  $request
-     * @param  string|Builder  $model
-     * @param  string  $groupBy
-     * @param  string|null  $column
      * @return array[]
      */
-    public function count(Request $request, Builder|string $model, string $groupBy, ?string $column = null): array {
+    public function count(Request $request, Builder|string $model, string $groupBy, string $column = null): array {
         return $this->query($request, $model, 'count', $column, $groupBy);
     }
 
     /**
      * Get the maximum value of the specified column
      *
-     * @param  Request  $request
-     * @param  string|Builder  $model
-     * @param  string  $column
-     * @param  string  $groupBy
      * @return array[]
      */
     public function max(Request $request, Builder|string $model, string $column, string $groupBy): array {
@@ -90,10 +73,6 @@ public function max(Request $request, Builder|string $model, string $column, str
     /**
      * Get the minimum value of the specified column
      *
-     * @param  Request  $request
-     * @param  string|Builder  $model
-     * @param  string  $column
-     * @param  string  $groupBy
      * @return array[]
      */
     public function min(Request $request, Builder|string $model, string $column, string $groupBy): array {
@@ -103,11 +82,6 @@ public function min(Request $request, Builder|string $model, string $column, str
     /**
      * Return the result of the query
      *
-     * @param  Request  $request
-     * @param  string|Builder  $model
-     * @param  string  $method
-     * @param  string|null  $column
-     * @param  string  $groupBy
      * @return array[]
      */
     public function query(Request $request, Builder|string $model, string $method, ?string $column, string $groupBy): array {
@@ -119,20 +93,16 @@ public function query(Request $request, Builder|string $model, string $method, ?
         }
 
         $values = $query
-      ->addSelect(DB::raw("$method($column) as value"))
-      ->orderByDesc('value')
-      ->get();
+            ->addSelect(DB::raw("$method($column) as value"))
+            ->orderByDesc('value')
+            ->get();
 
         return $values->toArray();
     }
 
     /**
      * Get the aggregate value of the specified column
      *
-     * @param  Request  $request
-     * @param  string|Builder  $model
-     * @param  string  $column
-     * @param  string  $groupBy
      * @return array[]
      */
     public function sum(Request $request, Builder|string $model, string $column, string $groupBy): array {
@@ -141,9 +111,6 @@ public function sum(Request $request, Builder|string $model, string $column, str
 
     /**
      * Transform the card into a JSON array.
-     *
-     * @param  Request  $request
-     * @return array
      */
     public function toArray(Request $request): array {
         $values = collect($this->calculate($request));