Type declarations

Author: brandonkelly

src/Group.php

@@ -13,14 +13,14 @@
 class Group extends Model
 {
     /**
-     * @var int
+     * @var int|null
      */
-    public $id;
+    public ?int $id = null;
 
     /**
-     * @var string
+     * @var string|null
      */
-    public $name;
+    public ?string $name = null;
 
     /**
      * @inheritdoc

src/Plugin.php

@@ -99,7 +99,7 @@ class Plugin extends \craft\base\Plugin
      * @see request()
      * @since 2.3.0
      */
-    private $_pendingJobs = [];
+    private array $_pendingJobs = [];
 
     /**
      * @inheritdoc

src/SendRequestJob.php

@@ -18,12 +18,12 @@ class SendRequestJob extends BaseJob
     /**
      * @var int The request ID to send
      */
-    public $requestId;
+    public int $requestId;
 
     /**
      * @var int|null The webhook ID
      */
-    public $webhookId;
+    public ?int $webhookId = null;
 
     /**
      * @inheritdoc
@@ -79,7 +79,7 @@ private function _data(): array
      *
      * @return Webhook|null
      */
-    private function _webhook()
+    private function _webhook(): ?Webhook
     {
         if (!$this->webhookId) {
             return null;

src/Settings.php

@@ -11,43 +11,43 @@ class Settings extends Model
      * @var bool Whether all webhooks should be disabled.
      * @since 2.4.1
      */
-    public $disableAllWebhooks = false;
+    public bool $disableAllWebhooks = false;
 
     /**
      * @var int The maximum depth that the plugin should go into objects/arrays when converting them to arrays for
      * event payloads.
      */
-    public $maxDepth = 5;
+    public int $maxDepth = 5;
 
     /**
      * @var int The maximum number of request attempts that should be made.
      */
-    public $maxAttempts = 1;
+    public int $maxAttempts = 1;
 
     /**
      * @var int|null The time delay in seconds that initial webhook request attempts should have.
      * @since 2.4.0
      */
-    public $initialDelay;
+    public ?int $initialDelay = null;
 
     /**
      * @var int The time delay in seconds between request retries.
      * @since 2.3.0
      */
-    public $retryDelay = 60;
+    public int $retryDelay = 60;
 
     /**
      * @var int|null The time (in seconds) that request history should be saved in the database before being
      * deletable via garbage collection.
      * @since 3.4.0
      */
-    public $purgeDuration = 604800;
+    public ?int $purgeDuration = 604800;
 
     /**
      * @var array Custom config options that should be applied when creating Guzzle clients.
      * @since 2.3.0
      */
-    public $guzzleConfig = [];
+    public array $guzzleConfig = [];
 
     /**
      * @inheritdoc

src/Webhook.php

@@ -19,84 +19,84 @@
 class Webhook extends Model
 {
     /**
-     * @var int
+     * @var int|null
      */
-    public $id;
+    public ?int $id = null;
 
     /**
      * @var int|null
      */
-    public $groupId;
+    public ?int $groupId = null;
 
     /**
      * @var bool
      */
-    public $enabled = true;
+    public bool $enabled = true;
 
     /**
-     * @var string
+     * @var string|null
      */
-    public $name;
+    public ?string $name = null;
 
     /**
-     * @var string
+     * @var string|null
      */
-    public $class;
+    public ?string $class = null;
 
     /**
-     * @var string
+     * @var string|null
      */
-    public $event;
+    public ?string $event = null;
 
     /**
      * @var array
      */
-    public $filters = [];
+    public array $filters = [];
 
     /**
      * @var string|null
      */
-    public $debounceKeyFormat;
+    public ?string $debounceKeyFormat = null;
 
     /**
      * @var string
      */
-    public $method = 'post';
+    public string $method = 'post';
 
     /**
-     * @var string
+     * @var string|null
      */
-    public $url;
+    public ?string $url = null;
 
     /**
      * @var array
      */
-    public $headers = [];
+    public array $headers = [];
 
     /**
      * @var string|null
      */
-    public $userAttributes;
+    public ?string $userAttributes = null;
 
     /**
      * @var string|null
      */
-    public $senderAttributes;
+    public ?string $senderAttributes = null;
 
     /**
      * @var string|null
      */
-    public $eventAttributes;
+    public ?string $eventAttributes = null;
 
     /**
      * @var string|null
      */
-    public $payloadTemplate;
+    public ?string $payloadTemplate = null;
 
     /**
      * @inheritdoc
      */
-    public function attributeLabels()
+    public function attributeLabels(): array
     {
         return [
             'class' => Craft::t('webhooks', 'Sender Class'),
@@ -190,7 +190,7 @@ function() {
      * @param array|null $params
      * @param Validator $validator
      */
-    public function validateAttributeList(string $attribute, array $params = null, Validator $validator)
+    public function validateAttributeList(string $attribute, ?array $params, Validator $validator)
     {
         $regex = $params['regex'] ?? '/^[a-z]\w*(?:\.[a-z]\w*)*$/i';
 

src/WebhookHelper.php

@@ -164,7 +164,7 @@ private static function _findClasses(): array
      * @param string $doc
      * @return string|null
      */
-    private static function _shortDesc(string $doc)
+    private static function _shortDesc(string $doc): ?string
     {
         foreach (preg_split("/\r\n|\n|\r/", $doc) as $line) {
             $line = preg_replace('/^[\/\*\s]*(?:@event\s+[^\s]+\s+)?/', '', $line);

src/controllers/WebhooksController.php

@@ -112,7 +112,7 @@ public function actionEdit(int $id = null, int $groupId = null, Webhook $webhook
      * @return Response|null
      * @throws BadRequestHttpException
      */
-    public function actionSave()
+    public function actionSave(): ?Response
     {
         $this->requirePostRequest();
 

src/records/Webhook.php

@@ -26,7 +26,7 @@
  */
 class Webhook extends ActiveRecord
 {
-    public static function tableName()
+    public static function tableName(): string
     {
         return '{{%webhooks}}';
     }