Refactoring and docs fixes

TelegramBot · Dec 12, 2015 · ae0a3d1 · ae0a3d1
1 parent 4d54469
commit ae0a3d1
Show file tree

Hide file tree

Showing 9 changed files with 38 additions and 6 deletions.
diff --git a/src/BaseType.php b/src/BaseType.php
@@ -28,6 +28,10 @@ abstract class BaseType
      * Validate input data
      *
      * @param array $data
+     *
+     * @return bool
+     *
+     * @throws InvalidArgumentException
      */
     public static function validate($data)
     {

diff --git a/src/BotApi.php b/src/BotApi.php
@@ -361,6 +361,8 @@ public function getUserProfilePhotos($userId, $offset = 0, $limit = 100)
      * @param \CURLFile|string $certificate Upload your public key certificate
      *                                      so that the root certificate in use can be checked
      *
+     * @return string
+     *
      * @throws \TelegramBot\Api\Exception
      */
     public function setWebhook($url = '', $certificate = null)

diff --git a/src/Types/Location.php b/src/Types/Location.php
@@ -55,6 +55,8 @@ public function getLatitude()
 
     /**
      * @param float $latitude
+     *
+     * @throws InvalidArgumentException
      */
     public function setLatitude($latitude)
     {
@@ -75,6 +77,8 @@ public function getLongitude()
 
     /**
      * @param float $longitude
+     *
+     * @throws InvalidArgumentException
      */
     public function setLongitude($longitude)
     {

diff --git a/src/Types/PhotoSize.php b/src/Types/PhotoSize.php
@@ -87,6 +87,8 @@ public function getFileSize()
 
     /**
      * @param int $fileSize
+     *
+     * @throws InvalidArgumentException
      */
     public function setFileSize($fileSize)
     {
@@ -107,6 +109,8 @@ public function getHeight()
 
     /**
      * @param int $height
+     *
+     * @throws InvalidArgumentException
      */
     public function setHeight($height)
     {
@@ -127,6 +131,8 @@ public function getWidth()
 
     /**
      * @param int $width
+     *
+     * @throws InvalidArgumentException
      */
     public function setWidth($width)
     {

diff --git a/src/Types/Update.php b/src/Types/Update.php
@@ -21,7 +21,7 @@ class Update extends BaseType implements TypeInterface
      */
     static protected $map = [
         'update_id' => true,
-        'message' => \TelegramBot\Api\Types\Message::class,
+        'message' => Message::class,
     ];
 
     /**
@@ -37,7 +37,7 @@ class Update extends BaseType implements TypeInterface
     /**
      * Optional. New incoming message of any kind — text, photo, sticker, etc.
      *
-     * @var \TelegramBot\Api\Types\Message
+     * @var Message
      */
     protected $message;
 
@@ -68,7 +68,7 @@ public function getMessage()
     /**
      * @param Message $message
      */
-    public function setMessage($message)
+    public function setMessage(Message $message)
     {
         $this->message = $message;
     }

diff --git a/src/Types/User.php b/src/Types/User.php
@@ -87,6 +87,8 @@ public function getId()
 
     /**
      * @param int $id
+     *
+     * @throws InvalidArgumentException
      */
     public function setId($id)
     {

diff --git a/src/Types/UserProfilePhotos.php b/src/Types/UserProfilePhotos.php
@@ -28,7 +28,7 @@ class UserProfilePhotos extends BaseType implements TypeInterface
      */
     static protected $map = [
         'total_count' => true,
-        'photos' => \TelegramBot\Api\Types\ArrayOfArrayOfPhotoSize::class,
+        'photos' => ArrayOfArrayOfPhotoSize::class,
     ];
 
     /**
@@ -72,6 +72,8 @@ public function getTotalCount()
 
     /**
      * @param int $totalCount
+     *
+     * @throws InvalidArgumentException
      */
     public function setTotalCount($totalCount)
     {

diff --git a/src/Types/Video.php b/src/Types/Video.php
@@ -31,7 +31,7 @@ class Video extends BaseType implements TypeInterface
         'width' => true,
         'height' => true,
         'duration' => true,
-        'thumb' => \TelegramBot\Api\Types\PhotoSize::class,
+        'thumb' => PhotoSize::class,
         'mime_type' => true,
         'file_size' => true
     ];
@@ -67,7 +67,7 @@ class Video extends BaseType implements TypeInterface
     /**
      * Video thumbnail
      *
-     * @var \TelegramBot\Api\Types\PhotoSize
+     * @var PhotoSize
      */
     protected $thumb;
 
@@ -96,6 +96,8 @@ public function getDuration()
 
     /**
      * @param int $duration
+     *
+     * @throws InvalidArgumentException
      */
     public function setDuration($duration)
     {
@@ -132,6 +134,8 @@ public function getFileSize()
 
     /**
      * @param int $fileSize
+     *
+     * @throws InvalidArgumentException
      */
     public function setFileSize($fileSize)
     {
@@ -152,6 +156,8 @@ public function getHeight()
 
     /**
      * @param int $height
+     *
+     * @throws InvalidArgumentException
      */
     public function setHeight($height)
     {
@@ -204,6 +210,8 @@ public function getWidth()
 
     /**
      * @param int $width
+     *
+     * @throws InvalidArgumentException
      */
     public function setWidth($width)
     {

diff --git a/src/Types/Voice.php b/src/Types/Voice.php
@@ -87,6 +87,8 @@ public function getDuration()
 
     /**
      * @param int $duration
+     *
+     * @throws InvalidArgumentException
      */
     public function setDuration($duration)
     {
@@ -123,6 +125,8 @@ public function getFileSize()
 
     /**
      * @param int $fileSize
+     *
+     * @throws InvalidArgumentException
      */
     public function setFileSize($fileSize)
     {
-Original file line number
+Diff line change
@@ Expand Up / @@ -87,6 +87,8 @@ public function getId() @@
         /**
          * @param int $id
+         *
+         * @throws InvalidArgumentException
          */
         public function setId($id)
         {
@@ Expand Down @@