refactor: Code cleanup

lsst-epo · Feb 24, 2024 · c58a13d · c58a13d
1 parent 3d53b1d
commit c58a13d
Show file tree

Hide file tree

Showing 7 changed files with 20 additions and 17 deletions.
diff --git a/src/CantoDamAssets.php b/src/CantoDamAssets.php
@@ -26,11 +26,10 @@ class CantoDamAssets extends Plugin
 {
     use ServicesTrait;
 
+    public static ?CantoDamAssets $plugin = null;
     public string $schemaVersion = '1.0.1';
     public bool $hasCpSettings = true;
 
-    public static ?CantoDamAssets $plugin = null;
-
     /**
      * @inheritDoc
      */
@@ -93,7 +92,7 @@ static function(RegisterComponentTypesEvent $event) {
         Event::on(
             UserPermissions::class,
             UserPermissions::EVENT_REGISTER_PERMISSIONS,
-            function(RegisterUserPermissionsEvent $event) {
+            static function(RegisterUserPermissionsEvent $event) {
                 $event->permissions[] = [
                     "heading" => "Canto DAM Assets Picker Extraordinaire",
                     "permissions" => [

diff --git a/src/controllers/SyncController.php b/src/controllers/SyncController.php
@@ -18,8 +18,8 @@
 class SyncController extends Controller
 {
     public $defaultAction = 'index';
-    protected array|int|bool $allowAnonymous = self::ALLOW_ANONYMOUS_LIVE;
     public $enableCsrfValidation = false;
+    protected array|int|bool $allowAnonymous = self::ALLOW_ANONYMOUS_LIVE;
 
     public function beforeAction($action): bool
     {

diff --git a/src/fields/CantoDamAsset.php b/src/fields/CantoDamAsset.php
@@ -58,13 +58,6 @@ public function attributeLabels(): array
         ]);
     }
 
-    protected function defineRules(): array
-    {
-        return array_merge(parent::defineRules(), [
-            // ...
-        ]);
-    }
-
     public function getSettingsHtml(): ?string
     {
         return Craft::$app->getView()->renderTemplate('_canto-dam-assets/_components/fieldtypes/CantoDamAsset_settings.twig',
@@ -159,6 +152,13 @@ public function modifyElementsQuery(ElementQueryInterface $query, mixed $value):
     // Protected Methods
     // =========================================================================
 
+    protected function defineRules(): array
+    {
+        return array_merge(parent::defineRules(), [
+            // ...
+        ]);
+    }
+
     protected function searchKeywords(mixed $value, ElementInterface $element): string
     {
         /* @var CantoFieldData $value */

diff --git a/src/lib/laravel/Collection.php b/src/lib/laravel/Collection.php
@@ -2,6 +2,8 @@
 
 namespace lsst\cantodamassets\lib\laravel;
 
+use Closure;
+use Illuminate\Contracts\Support\Arrayable;
 use Illuminate\Support\Collection as LaravelCollection;
 
 class Collection extends LaravelCollection
@@ -10,7 +12,7 @@ class Collection extends LaravelCollection
      * Filter items by the given key value pair.
      *
      * @param string $key
-     * @param \Illuminate\Contracts\Support\Arrayable|iterable $values
+     * @param Arrayable|iterable $values
      * @param bool $strict
      * @return static
      */
@@ -32,7 +34,7 @@ public function whereIn($key, $values, $strict = false)
      * Filter items by the given key value pair.
      *
      * @param string $key
-     * @param \Illuminate\Contracts\Support\Arrayable|iterable $values
+     * @param Arrayable|iterable $values
      * @param bool $strict
      * @return static
      */
@@ -56,7 +58,7 @@ public function whereNotIn($key, $values, $strict = false)
      * @param callable|string $key
      * @param string|null $operator
      * @param mixed $value
-     * @return \Closure
+     * @return Closure
      */
     protected function operatorForWhere($key, $operator = null, $value = null)
     {

diff --git a/src/migrations/m231108_024521_change_to_json_column.php b/src/migrations/m231108_024521_change_to_json_column.php
@@ -11,6 +11,7 @@
 use lsst\cantodamassets\fields\CantoDamAsset;
 use lsst\cantodamassets\lib\laravel\Collection;
 use verbb\supertable\fields\SuperTableField;
+use yii\db\Exception;
 use yii\db\Schema;
 
 /**
@@ -105,7 +106,7 @@ private function changeToJsonColumn(string $table, array $fields): void
      * @param $type
      * @param $using
      * @return void
-     * @throws \yii\db\Exception
+     * @throws Exception
      */
     private function alterColumnUsingPgsql($table, $column, $type, $using): void
     {

diff --git a/src/services/Api.php b/src/services/Api.php
@@ -7,6 +7,7 @@
 use GuzzleHttp\Exception\GuzzleException;
 use lsst\cantodamassets\CantoDamAssets;
 use lsst\cantodamassets\models\CantoFieldData;
+use Throwable;
 use yii\base\Component;
 
 /**
@@ -45,7 +46,7 @@ public function getAuthToken(): ?string
         // Get auth token
         try {
             $response = $client->post($authEndpoint);
-        } catch (\Throwable $e) {
+        } catch (Throwable $e) {
             Craft::error("An exception occurred in getAuthToken()", __METHOD__);
 
             return $e->getMessage();

diff --git a/src/variables/CantoVariable.php b/src/variables/CantoVariable.php
@@ -1,7 +1,7 @@
 <?php
 
 namespace lsst\cantodamassets\variables;
-
+ 
 use nystudio107\pluginvite\variables\ViteVariableInterface;
 use nystudio107\pluginvite\variables\ViteVariableTrait;