Merge pull request #189 from line/minor_fixes

Add and fix comments, variable names, typos and coding styles

Author: Vaduz

composer.json

@@ -29,7 +29,9 @@
   "require": {
     "php": ">=5.5",
     "ext-curl": "*",
-    "ext-json": "*"
+    "ext-json": "*",
+    "ext-sockets": "*",
+    "ext-posix": "*"
   },
   "require-dev": {
     "phpunit/phpunit": "^4.8.24||^5||^6",

examples/KitchenSink/src/LINEBot/KitchenSink/EventHandler/AccountLinkEventHandler.php

@@ -32,6 +32,7 @@ class AccountLinkEventHandler
 
     /**
      * BeaconEventHandler constructor.
+     *
      * @param LINEBot $bot
      * @param \Monolog\Logger $logger
      * @param AccountLinkEvent $accountLinkEvent
@@ -43,6 +44,9 @@ public function __construct($bot, $logger, AccountLinkEvent $accountLinkEvent)
         $this->accountLinkEvent = $accountLinkEvent;
     }
 
+    /**
+     * @throws \ReflectionException
+     */
     public function handle()
     {
         $this->bot->replyText(

examples/KitchenSink/src/LINEBot/KitchenSink/EventHandler/BeaconEventHandler.php

@@ -44,6 +44,9 @@ public function __construct($bot, $logger, BeaconDetectionEvent $beaconEvent)
         $this->beaconEvent = $beaconEvent;
     }
 
+    /**
+     * @throws \ReflectionException
+     */
     public function handle()
     {
         $this->bot->replyText(

examples/KitchenSink/src/LINEBot/KitchenSink/EventHandler/FollowEventHandler.php

@@ -44,6 +44,9 @@ public function __construct($bot, $logger, FollowEvent $followEvent)
         $this->followEvent = $followEvent;
     }
 
+    /**
+     * @throws \ReflectionException
+     */
     public function handle()
     {
         $this->bot->replyText($this->followEvent->getReplyToken(), 'Got followed event');

examples/KitchenSink/src/LINEBot/KitchenSink/EventHandler/JoinEventHandler.php

@@ -44,6 +44,10 @@ public function __construct($bot, $logger, JoinEvent $joinEvent)
         $this->joinEvent = $joinEvent;
     }
 
+    /**
+     * @throws LINEBot\Exception\InvalidEventSourceException
+     * @throws \ReflectionException
+     */
     public function handle()
     {
         if ($this->joinEvent->isGroupEvent()) {

examples/KitchenSink/src/LINEBot/KitchenSink/EventHandler/MessageHandler/AudioMessageHandler.php

@@ -55,9 +55,9 @@ public function handle()
         $contentId = $this->audioMessage->getMessageId();
         $audio = $this->bot->getMessageContent($contentId)->getRawBody();
 
-        $tmpfilePath = tempnam($_SERVER['DOCUMENT_ROOT'] . '/static/tmpdir', 'audio-');
-        unlink($tmpfilePath);
-        $filePath = $tmpfilePath . '.mp4';
+        $tempFilePath = tempnam($_SERVER['DOCUMENT_ROOT'] . '/static/tmpdir', 'audio-');
+        unlink($tempFilePath);
+        $filePath = $tempFilePath . '.mp4';
         $filename = basename($filePath);
 
         $fh = fopen($filePath, 'x');

examples/KitchenSink/src/LINEBot/KitchenSink/EventHandler/MessageHandler/Flex/FlexSampleRestaurant.php

@@ -40,6 +40,9 @@
 use LINE\LINEBot\MessageBuilder\Flex\ComponentBuilder\TextComponentBuilder;
 use LINE\LINEBot\MessageBuilder\Flex\ContainerBuilder\BubbleContainerBuilder;
 
+/**
+ * @SuppressWarnings(PHPMD.CouplingBetweenObjects)
+ */
 class FlexSampleRestaurant
 {
     /**

examples/KitchenSink/src/LINEBot/KitchenSink/EventHandler/MessageHandler/Flex/FlexSampleShopping.php

@@ -37,6 +37,9 @@
 use LINE\LINEBot\MessageBuilder\Flex\ContainerBuilder\BubbleContainerBuilder;
 use LINE\LINEBot\MessageBuilder\Flex\ContainerBuilder\CarouselContainerBuilder;
 
+/**
+ * @SuppressWarnings(PHPMD.CouplingBetweenObjects)
+ */
 class FlexSampleShopping
 {
     private static $items = [

examples/KitchenSink/src/LINEBot/KitchenSink/EventHandler/MessageHandler/ImageMessageHandler.php

@@ -55,9 +55,9 @@ public function handle()
         $contentId = $this->imageMessage->getMessageId();
         $image = $this->bot->getMessageContent($contentId)->getRawBody();
 
-        $tmpfilePath = tempnam($_SERVER['DOCUMENT_ROOT'] . '/static/tmpdir', 'image-');
-        unlink($tmpfilePath);
-        $filePath = $tmpfilePath . '.jpg';
+        $tempFilePath = tempnam($_SERVER['DOCUMENT_ROOT'] . '/static/tmpdir', 'image-');
+        unlink($tempFilePath);
+        $filePath = $tempFilePath . '.jpg';
         $filename = basename($filePath);
 
         $fh = fopen($filePath, 'x');

examples/KitchenSink/src/LINEBot/KitchenSink/EventHandler/MessageHandler/TextMessageHandler.php

@@ -45,6 +45,11 @@
 use LINE\LINEBot\MessageBuilder\TemplateBuilder\CarouselTemplateBuilder;
 use LINE\LINEBot\MessageBuilder\TemplateBuilder\ConfirmTemplateBuilder;
 
+/**
+ * @SuppressWarnings(PHPMD.CouplingBetweenObjects)
+ * @SuppressWarnings(PHPMD.CyclomaticComplexity)
+ * @SuppressWarnings(PHPMD.ExcessiveMethodLength)
+ */
 class TextMessageHandler implements EventHandler
 {
     /** @var LINEBot $bot */
@@ -71,6 +76,10 @@ public function __construct($bot, $logger, \Slim\Http\Request $req, TextMessage
         $this->textMessage = $textMessage;
     }
 
+    /**
+     * @throws LINEBot\Exception\InvalidEventSourceException
+     * @throws \ReflectionException
+     */
     public function handle()
     {
         $text = $this->textMessage->getText();
@@ -204,13 +213,19 @@ public function handle()
     /**
      * @param string $replyToken
      * @param string $text
+     * @throws \ReflectionException
      */
     private function echoBack($replyToken, $text)
     {
         $this->logger->info("Returns echo message $replyToken: $text");
         $this->bot->replyText($replyToken, $text);
     }
 
+    /**
+     * @param $replyToken
+     * @param $userId
+     * @throws \ReflectionException
+     */
     private function sendProfile($replyToken, $userId)
     {
         if (!isset($userId)) {