Merge branch 'master' of github.com:Rias500/craft-telegram-notificati…

…on-channel

src/TelegramNotificationChannel.php

@@ -1,24 +1,22 @@
 <?php
 /**
- * Telegram Notification Channel plugin for Craft CMS 3.x
+ * Telegram Notification Channel plugin for Craft CMS 3.x.
  *
  * A Telegram notification channel for the Craft Notifications plugin
  *
  * @link      https://rias.be
+ *
  * @copyright Copyright (c) 2018 Rias
  */
 
 namespace rias\telegramnotificationchannel;
 
-use rias\notifications\events\RegisterChannelsEvent;
-use rias\notifications\services\NotificationsService;
-use rias\telegramnotificationchannel\models\Settings;
-
 use Craft;
 use craft\base\Plugin;
 use craft\services\Plugins;
-use craft\events\PluginEvent;
-
+use rias\notifications\events\RegisterChannelsEvent;
+use rias\notifications\services\NotificationsService;
+use rias\telegramnotificationchannel\models\Settings;
 use rias\telegramnotificationchannel\models\Telegram;
 use rias\telegramnotificationchannel\models\TelegramChannel;
 use yii\base\Event;
@@ -34,10 +32,11 @@
  * https://craftcms.com/docs/plugins/introduction
  *
  * @author    Rias
- * @package   TelegramNotificationChannel
+ *
  * @since     1.0.0
  *
  * @property  Settings $settings
+ *
  * @method    Settings getSettings()
  */
 class TelegramNotificationChannel extends Plugin
@@ -47,7 +46,7 @@ class TelegramNotificationChannel extends Plugin
 
     /**
      * Static property that is an instance of this plugin class so that it can be accessed via
-     * TelegramNotificationChannel::$plugin
+     * TelegramNotificationChannel::$plugin.
      *
      * @var TelegramNotificationChannel
      */
@@ -58,14 +57,13 @@ class TelegramNotificationChannel extends Plugin
 
     /**
      * Set our $plugin static property to this class so that it can be accessed via
-     * TelegramNotificationChannel::$plugin
+     * TelegramNotificationChannel::$plugin.
      *
      * Called after the plugin class is instantiated; do any one-time initialization
      * here such as hooks and events.
      *
      * If you have a '/vendor/autoload.php' file, it will be loaded for you automatically;
      * you do not need to load it in your init() method.
-     *
      */
     public function init()
     {
@@ -100,16 +98,17 @@ protected function createSettingsModel()
      * Returns the rendered settings HTML, which will be inserted into the content
      * block on the settings page.
      *
-     * @return string The rendered settings HTML
      * @throws \Twig_Error_Loader
      * @throws \yii\base\Exception
+     *
+     * @return string The rendered settings HTML
      */
     protected function settingsHtml(): string
     {
         return Craft::$app->view->renderTemplate(
             'telegram-notification-channel/settings',
             [
-                'settings' => $this->getSettings()
+                'settings' => $this->getSettings(),
             ]
         );
     }

src/config.php

@@ -1,15 +1,16 @@
 <?php
 /**
- * Telegram Notification Channel plugin for Craft CMS 3.x
+ * Telegram Notification Channel plugin for Craft CMS 3.x.
  *
  * A Telegram notification channel for the Craft Notifications plugin
  *
  * @link      https://rias.be
+ *
  * @copyright Copyright (c) 2018 Rias
  */
 
 /**
- * Telegram Notification Channel config.php
+ * Telegram Notification Channel config.php.
  *
  * This file exists only as a template for the Telegram Notification Channel settings.
  * It does nothing on its own.
@@ -24,7 +25,7 @@
 
 return [
 
-    /**
+    /*
      * This sets the Telegram Bot token which can be acquired by speaking with
      * the Botfather (https://core.telegram.org/bots#6-botfather)
     */

src/exceptions/CouldNotSendNotification.php

@@ -20,8 +20,10 @@ public static function telegramRespondedWithAnError(ClientException $exception)
         if ($result = json_decode($exception->getResponse()->getBody())) {
             $description = $result->description ?: $description;
         }
+
         return new static("Telegram responded with an error `{$statusCode} - {$description}`");
     }
+
     /**
      * Thrown when there's no bot token provided.
      *
@@ -33,6 +35,7 @@ public static function telegramBotTokenNotProvided($message)
     {
         return new static($message);
     }
+
     /**
      * Thrown when we're unable to communicate with Telegram.
      *
@@ -42,6 +45,7 @@ public static function couldNotCommunicateWithTelegram()
     {
         return new static('The communication with Telegram failed.');
     }
+
     /**
      * Thrown when there is no chat id provided.
      *
@@ -51,4 +55,4 @@ public static function chatIdNotProvided()
     {
         return new static('Telegram notification chat ID was not provided. Please refer usage docs.');
     }
-}
+}

src/models/Settings.php

@@ -1,22 +1,22 @@
 <?php
 /**
- * Telegram Notification Channel plugin for Craft CMS 3.x
+ * Telegram Notification Channel plugin for Craft CMS 3.x.
  *
  * A Telegram notification channel for the Craft Notifications plugin
  *
  * @link      https://rias.be
+ *
  * @copyright Copyright (c) 2018 Rias
  */
 
 namespace rias\telegramnotificationchannel\models;
 
-use rias\telegramnotificationchannel\TelegramNotificationChannel;
-
 use Craft;
 use craft\base\Model;
+use rias\telegramnotificationchannel\TelegramNotificationChannel;
 
 /**
- * TelegramNotificationChannel Settings Model
+ * TelegramNotificationChannel Settings Model.
  *
  * This is a model used to define the plugin's settings.
  *
@@ -26,7 +26,7 @@
  * https://craftcms.com/docs/plugins/models
  *
  * @author    Rias
- * @package   TelegramNotificationChannel
+ *
  * @since     1.0.0
  */
 class Settings extends Model
@@ -35,7 +35,7 @@ class Settings extends Model
     // =========================================================================
 
     /**
-     * Some field model attribute
+     * Some field model attribute.
      *
      * @var string
      */

src/models/Telegram.php

@@ -52,7 +52,7 @@ protected function httpClient()
      *
      * @link https://core.telegram.org/bots/api#sendmessage
      *
-     * @param array    $params
+     * @param array $params
      *
      * @var int|string $params ['chat_id']
      * @var string     $params ['text']
@@ -62,8 +62,9 @@ protected function httpClient()
      * @var int        $params ['reply_to_message_id']
      * @var string     $params ['reply_markup']
      *
-     * @return mixed
      * @throws CouldNotSendNotification
+     *
+     * @return mixed
      */
     public function sendMessage($params)
     {

src/models/TelegramChannel.php

@@ -1,6 +1,5 @@
 <?php
 
-
 namespace rias\telegramnotificationchannel\models;
 
 use rias\notifications\models\Notification;
@@ -12,6 +11,7 @@ class TelegramChannel
      * @var Telegram
      */
     protected $telegram;
+
     /**
      * Channel constructor.
      *
@@ -48,4 +48,4 @@ public function send($notifiable, Notification $notification)
         $params = $message->toArray();
         $this->telegram->sendMessage($params);
     }
-}
+}

src/models/TelegramMessage.php

@@ -45,6 +45,7 @@ public function __construct($content = '')
     public function to($chatId)
     {
         $this->payload['chat_id'] = $chatId;
+
         return $this;
     }
 
@@ -58,6 +59,7 @@ public function to($chatId)
     public function content($content)
     {
         $this->payload['text'] = $content;
+
         return $this;
     }
 
@@ -74,6 +76,7 @@ public function button($text, $url)
         $this->buttons[] = compact('text', 'url');
         $replyMarkup['inline_keyboard'] = array_chunk($this->buttons, 2);
         $this->payload['reply_markup'] = json_encode($replyMarkup);
+
         return $this;
     }
 
@@ -87,6 +90,7 @@ public function button($text, $url)
     public function options(array $options)
     {
         $this->payload = array_merge($this->payload, $options);
+
         return $this;
     }
 
@@ -109,4 +113,4 @@ public function toArray()
     {
         return $this->payload;
     }
-}
+}

src/translations/en/telegram-notification-channel.php

@@ -1,23 +1,24 @@
 <?php
 /**
- * Telegram Notification Channel plugin for Craft CMS 3.x
+ * Telegram Notification Channel plugin for Craft CMS 3.x.
  *
  * A Telegram notification channel for the Craft Notifications plugin
  *
  * @link      https://rias.be
+ *
  * @copyright Copyright (c) 2018 Rias
  */
 
 /**
- * Telegram Notification Channel en Translation
+ * Telegram Notification Channel en Translation.
  *
  * Returns an array with the string to be translated (as passed to `Craft::t('telegram-notification-channel', '...')`) as
  * the key, and the translation as the value.
  *
  * http://www.yiiframework.com/doc-2.0/guide-tutorial-i18n.html
  *
  * @author    Rias
- * @package   TelegramNotificationChannel
+ *
  * @since     1.0.0
  */
 return [