Apply fixes from StyleCI

calchen · Dec 5, 2021 · 0a5ce89 · 0a5ce89
1 parent 271af20
commit 0a5ce89
Show file tree

Hide file tree

Showing 23 changed files with 70 additions and 82 deletions.
diff --git a/src/DingtalkRobot.php b/src/DingtalkRobot.php
@@ -61,9 +61,9 @@ public function __construct()
     /**
      * 指定机器人名称，默认为 default.
      *
-     * @param string $name
-     *
+     * @param  string  $name
      * @return $this
+     *
      * @throws Exception
      */
     public function robot($name = 'default'): self
@@ -126,9 +126,9 @@ public function robot($name = 'default'): self
     /**
      * 将创建好的 message 对象保存到当前对象中以便后续发送
      *
-     * @param Message $message
-     *
+     * @param  Message  $message
      * @return $this
+     *
      * @throws Exception
      */
     public function setMessage(Message $message): self
@@ -178,6 +178,7 @@ private function getHttpClient(): ClientInterface
      * 发起请求，返回的内容与直接调用钉钉接口返回的内容一致.
      *
      * @return array
+     *
      * @throws Exception
      */
     public function send(): array

diff --git a/src/DingtalkRobotChannel.php b/src/DingtalkRobotChannel.php
@@ -17,8 +17,8 @@ class DingtalkRobotChannel
     /**
      * Send the given notification.
      *
-     * @param              $notifiable
-     * @param Notification $notification
+     * @param  $notifiable
+     * @param  Notification  $notification
      *
      * @throws Exception
      */

diff --git a/src/Exceptions/Exception.php b/src/Exceptions/Exception.php
@@ -14,9 +14,9 @@ class Exception extends \Exception
     /**
      * 重写构造方法，直接根据 code 取错误消息.
      *
-     * @param string         $message
-     * @param int            $code
-     * @param Throwable|null $previous
+     * @param  string  $message
+     * @param  int  $code
+     * @param  Throwable|null  $previous
      */
     public function __construct($message = '', $code = 0, Throwable $previous = null)
     {

diff --git a/src/Message/ActionCardMessage.php b/src/Message/ActionCardMessage.php
@@ -31,10 +31,10 @@ class ActionCardMessage extends Message
     /**
      * ActionCardMessage constructor.
      *
-     * @param string|null $title          首屏会话透出的展示内容
-     * @param string|null $text           markdown 格式的消息
-     * @param int|null    $hideAvatar     0-按钮竖直排列，1-按钮横向排列
-     * @param int|null    $btnOrientation 0-正常发消息者头像,1-隐藏发消息者头像
+     * @param  string|null  $title  首屏会话透出的展示内容
+     * @param  string|null  $text  markdown 格式的消息
+     * @param  int|null  $hideAvatar  0-按钮竖直排列，1-按钮横向排列
+     * @param  int|null  $btnOrientation  0-正常发消息者头像,1-隐藏发消息者头像
      *
      * @throws InvalidConfigurationException
      */
@@ -48,12 +48,12 @@ public function __construct(string $title = null, string $text = null, $hideAvat
     /**
      *  ActionCard 的整体跳转和独立跳转两种类型中 title text hideAvatar btnOrientation 都是共同拥有的.
      *
-     * @param string   $title          首屏会话透出的展示内容
-     * @param string   $text           markdown 格式的消息
-     * @param int|null $hideAvatar     0-按钮竖直排列，1-按钮横向排列
-     * @param int|null $btnOrientation 0-正常发消息者头像,1-隐藏发消息者头像
-     *
+     * @param  string  $title  首屏会话透出的展示内容
+     * @param  string  $text  markdown 格式的消息
+     * @param  int|null  $hideAvatar  0-按钮竖直排列，1-按钮横向排列
+     * @param  int|null  $btnOrientation  0-正常发消息者头像,1-隐藏发消息者头像
      * @return ActionCardMessage
+     *
      * @throws InvalidConfigurationException
      */
     public function setMessage(string $title, string $text, $hideAvatar = null, $btnOrientation = null): self
@@ -85,10 +85,9 @@ public function setMessage(string $title, string $text, $hideAvatar = null, $btn
     /**
      * 设置整体跳转类型参数，与独立跳转互斥.
      *
-     * @param string $singleTitle 单个按钮的方案。(设置此项和singleURL后btns无效。)
-     * @param string $singleUrl   点击singleTitle按钮触发的URL
-     * @param bool   $pcSlide     链接是否在 PC 端侧栏打开，true 在 PC 端侧栏打开；false 在系统默认浏览器
-     *
+     * @param  string  $singleTitle  单个按钮的方案。(设置此项和singleURL后btns无效。)
+     * @param  string  $singleUrl  点击singleTitle按钮触发的URL
+     * @param  bool  $pcSlide  链接是否在 PC 端侧栏打开，true 在 PC 端侧栏打开；false 在系统默认浏览器
      * @return $this
      */
     public function setSingle(string $singleTitle, string $singleUrl, bool $pcSlide = true): self
@@ -103,10 +102,9 @@ public function setSingle(string $singleTitle, string $singleUrl, bool $pcSlide
     /**
      * 设置独立跳转类型按钮参数，可设置多个，与整体跳转互斥.
      *
-     * @param string $title     按钮方案
-     * @param string $actionUrl 点击按钮触发的URL
-     * @param bool   $pcSlide   链接是否在 PC 端侧栏打开，true 在 PC 端侧栏打开；false 在系统默认浏览器
-     *
+     * @param  string  $title  按钮方案
+     * @param  string  $actionUrl  点击按钮触发的URL
+     * @param  bool  $pcSlide  链接是否在 PC 端侧栏打开，true 在 PC 端侧栏打开；false 在系统默认浏览器
      * @return ActionCardMessage
      */
     public function addButton(string $title, string $actionUrl, bool $pcSlide = true): self

diff --git a/src/Message/AtTrait.php b/src/Message/AtTrait.php
@@ -15,9 +15,9 @@ trait AtTrait
     /**
      * 通过手机号码指定“被@人列表”.
      *
-     * @param string|array $mobiles 被@人的手机号(在text内容里要有@手机号)
-     *
+     * @param  string|array  $mobiles  被@人的手机号(在text内容里要有@手机号)
      * @return Message
+     *
      * @throws InvalidArgumentException
      */
     public function at($mobiles): self

diff --git a/src/Message/FeedCardMessage.php b/src/Message/FeedCardMessage.php
@@ -30,11 +30,10 @@ public function setMessage()
     /**
      * 增加链接.
      *
-     * @param string $title      单条信息文本
-     * @param string $messageUrl 点击单条信息到跳转链接
-     * @param string $picUrl     单条信息后面图片的URL
-     * @param bool   $pcSlide    链接是否在 PC 端侧栏打开，true 在 PC 端侧栏打开；false 在系统默认浏览器
-     *
+     * @param  string  $title  单条信息文本
+     * @param  string  $messageUrl  点击单条信息到跳转链接
+     * @param  string  $picUrl  单条信息后面图片的URL
+     * @param  bool  $pcSlide  链接是否在 PC 端侧栏打开，true 在 PC 端侧栏打开；false 在系统默认浏览器
      * @return FeedCardMessage
      */
     public function addLink(string $title, string $messageUrl, string $picUrl, bool $pcSlide = true): self

diff --git a/src/Message/LinkMessage.php b/src/Message/LinkMessage.php
@@ -12,11 +12,11 @@ class LinkMessage extends Message
     /**
      * LinkMessage constructor.
      *
-     * @param string|null $title      消息标题
-     * @param string|null $text       消息内容。如果太长只会部分展示
-     * @param string|null $messageUrl 点击消息跳转的 URL
-     * @param string      $picUrl     图片 URL
-     * @param bool        $pcSlide    链接是否在 PC 端侧栏打开，true 在 PC 端侧栏打开；false 在系统默认浏览器
+     * @param  string|null  $title  消息标题
+     * @param  string|null  $text  消息内容。如果太长只会部分展示
+     * @param  string|null  $messageUrl  点击消息跳转的 URL
+     * @param  string  $picUrl  图片 URL
+     * @param  bool  $pcSlide  链接是否在 PC 端侧栏打开，true 在 PC 端侧栏打开；false 在系统默认浏览器
      */
     public function __construct(
         string $title = null,
@@ -31,12 +31,11 @@ public function __construct(
     }
 
     /**
-     * @param string $title      消息标题
-     * @param string $text       消息内容。如果太长只会部分展示
-     * @param string $messageUrl 点击消息跳转的 URL
-     * @param string $picUrl     图片 URL
-     * @param bool   $pcSlide    链接是否在 PC 端侧栏打开，true 在 PC 端侧栏打开；false 在系统默认浏览器
-     *
+     * @param  string  $title  消息标题
+     * @param  string  $text  消息内容。如果太长只会部分展示
+     * @param  string  $messageUrl  点击消息跳转的 URL
+     * @param  string  $picUrl  图片 URL
+     * @param  bool  $pcSlide  链接是否在 PC 端侧栏打开，true 在 PC 端侧栏打开；false 在系统默认浏览器
      * @return LinkMessage
      */
     public function setMessage(

diff --git a/src/Message/MarkdownMessage.php b/src/Message/MarkdownMessage.php
@@ -14,8 +14,8 @@ class MarkdownMessage extends Message
     /**
      * MarkdownMessage constructor.
      *
-     * @param string|null $title 首屏会话透出的展示内容
-     * @param string|null $text  markdown 格式的消息
+     * @param  string|null  $title  首屏会话透出的展示内容
+     * @param  string|null  $text  markdown 格式的消息
      */
     public function __construct(string $title = null, string $text = null)
     {
@@ -25,9 +25,8 @@ public function __construct(string $title = null, string $text = null)
     }
 
     /**
-     * @param string $title 首屏会话透出的展示内容
-     * @param string $text  markdown 格式的消息
-     *
+     * @param  string  $title  首屏会话透出的展示内容
+     * @param  string  $text  markdown 格式的消息
      * @return MarkdownMessage
      */
     public function setMessage(string $title, string $text): self

diff --git a/src/Message/Message.php b/src/Message/Message.php
@@ -31,8 +31,7 @@ public function getMessage(): array
     /**
      * 设置接受消息的机器人名称.
      *
-     * @param string $robot
-     *
+     * @param  string  $robot
      * @return Message
      */
     public function setRobot(string $robot): self
@@ -57,9 +56,8 @@ public function getRobot(): string
      *
      * @link https://ding-doc.dingtalk.com/doc#/serverapi2/iat9q8/e300ae98
      *
-     * @param string $url
-     * @param bool   $pcSlide
-     *
+     * @param  string  $url
+     * @param  bool  $pcSlide
      * @return string
      */
     public function getFinalUrl(string $url, bool $pcSlide = true): string

diff --git a/src/Message/TextMessage.php b/src/Message/TextMessage.php
@@ -14,7 +14,7 @@ class TextMessage extends Message
     /**
      * TextMessage constructor.
      *
-     * @param string|null $content 消息内容
+     * @param  string|null  $content  消息内容
      */
     public function __construct(string $content = null)
     {
@@ -24,8 +24,7 @@ public function __construct(string $content = null)
     }
 
     /**
-     * @param string $content 消息内容
-     *
+     * @param  string  $content  消息内容
      * @return TextMessage
      */
     public function setMessage(string $content): self

diff --git a/src/Robot.php b/src/Robot.php
@@ -31,7 +31,7 @@ public function getName(): string
     }
 
     /**
-     * @param string $name
+     * @param  string  $name
      */
     public function setName(string $name)
     {

diff --git a/tests/Notifications/ActionCardIndependentJumpNotification.php b/tests/Notifications/ActionCardIndependentJumpNotification.php
@@ -33,9 +33,9 @@ public function via($notifiable)
     }
 
     /**
-     * @param Robot $notifiable
-     *
+     * @param  Robot  $notifiable
      * @return Message
+     *
      * @throws InvalidConfigurationException
      */
     public function toDingTalkRobot($notifiable): Message

diff --git a/tests/Notifications/ActionCardInvalidBtnOrientationNotification.php b/tests/Notifications/ActionCardInvalidBtnOrientationNotification.php
@@ -33,9 +33,9 @@ public function via($notifiable)
     }
 
     /**
-     * @param Robot $notifiable
-     *
+     * @param  Robot  $notifiable
      * @return Message
+     *
      * @throws InvalidConfigurationException
      */
     public function toDingTalkRobot($notifiable): Message

diff --git a/tests/Notifications/ActionCardInvalidHideAvatarNotification.php b/tests/Notifications/ActionCardInvalidHideAvatarNotification.php
@@ -33,9 +33,9 @@ public function via($notifiable)
     }
 
     /**
-     * @param Robot $notifiable
-     *
+     * @param  Robot  $notifiable
      * @return Message
+     *
      * @throws InvalidConfigurationException
      */
     public function toDingTalkRobot($notifiable): Message

diff --git a/tests/Notifications/ActionCardOverallJumpNotification.php b/tests/Notifications/ActionCardOverallJumpNotification.php
@@ -33,9 +33,9 @@ public function via($notifiable)
     }
 
     /**
-     * @param Robot $notifiable
-     *
+     * @param  Robot  $notifiable
      * @return Message
+     *
      * @throws InvalidConfigurationException
      */
     public function toDingTalkRobot($notifiable): Message

diff --git a/tests/Notifications/EmptyNotification.php b/tests/Notifications/EmptyNotification.php
@@ -26,8 +26,7 @@ public function via($notifiable)
     }
 
     /**
-     * @param Robot $notifiable
-     *
+     * @param  Robot  $notifiable
      * @return Message
      */
     public function toDingTalkRobot($notifiable)

diff --git a/tests/Notifications/FeedCardNotification.php b/tests/Notifications/FeedCardNotification.php
@@ -32,8 +32,7 @@ public function via($notifiable)
     }
 
     /**
-     * @param Robot $notifiable
-     *
+     * @param  Robot  $notifiable
      * @return Message
      */
     public function toDingTalkRobot($notifiable): Message

diff --git a/tests/Notifications/LinkNotification.php b/tests/Notifications/LinkNotification.php
@@ -32,8 +32,7 @@ public function via($notifiable)
     }
 
     /**
-     * @param Robot $notifiable
-     *
+     * @param  Robot  $notifiable
      * @return Message
      */
     public function toDingTalkRobot($notifiable): Message

diff --git a/tests/Notifications/MarkdownAtAllNotification.php b/tests/Notifications/MarkdownAtAllNotification.php
@@ -32,8 +32,7 @@ public function via($notifiable)
     }
 
     /**
-     * @param Robot $notifiable
-     *
+     * @param  Robot  $notifiable
      * @return Message
      */
     public function toDingTalkRobot($notifiable): Message

diff --git a/tests/Notifications/MarkdownAtPersonNotification.php b/tests/Notifications/MarkdownAtPersonNotification.php
@@ -33,9 +33,9 @@ public function via($notifiable)
     }
 
     /**
-     * @param Robot $notifiable
-     *
+     * @param  Robot  $notifiable
      * @return Message
+     *
      * @throws InvalidArgumentException
      */
     public function toDingTalkRobot($notifiable): Message

diff --git a/tests/Notifications/TextAtAllNotification.php b/tests/Notifications/TextAtAllNotification.php
@@ -32,8 +32,7 @@ public function via($notifiable)
     }
 
     /**
-     * @param Robot $notifiable
-     *
+     * @param  Robot  $notifiable
      * @return Message
      */
     public function toDingTalkRobot($notifiable): Message

diff --git a/tests/Notifications/TextAtInvalidNotification.php b/tests/Notifications/TextAtInvalidNotification.php
@@ -33,9 +33,9 @@ public function via($notifiable)
     }
 
     /**
-     * @param Robot $notifiable
-     *
+     * @param  Robot  $notifiable
      * @return Message
+     *
      * @throws InvalidArgumentException
      */
     public function toDingTalkRobot($notifiable): Message

diff --git a/tests/Notifications/TextAtPersonNotification.php b/tests/Notifications/TextAtPersonNotification.php
@@ -33,9 +33,9 @@ public function via($notifiable)
     }
 
     /**
-     * @param Robot $notifiable
-     *
+     * @param  Robot  $notifiable
      * @return Message
+     *
      * @throws InvalidArgumentException
      */
     public function toDingTalkRobot($notifiable): Message