Merge pull request #3 from arif98741/master

Merge Request for Docblock, Code Optimization and Others

Author: rakibdevs

src/Exceptions/InvalidNumber.php

@@ -6,6 +6,9 @@
 
 class InvalidNumber extends Exception
 {
+    /**
+     * @return static
+     */
 	public static function message()
 	{
 		return new static("The given value is not a valid number.");

src/Exceptions/InvalidRange.php

@@ -6,6 +6,10 @@
 
 class InvalidRange extends Exception
 {
+    /**
+     * @param $max
+     * @return static
+     */
 	public static function message($max = 999999999999999)
 	{
 		return new static("The given value is not in valid range. Maximum accepted value is " . $max);

src/Facades/NumberToBangla.php

@@ -10,8 +10,11 @@
 
 class NumberToBangla extends Facade
 {
+    /**
+     * @return string
+     */
 	protected static function getFacadeAccessor(): string
     {
         return 'bangla-number';
     }
-}
+}

src/NumberToBangla.php

@@ -2,41 +2,69 @@
 
 namespace Rakibhstu\Banglanumber;
 
-use Rakibhstu\Banglanumber\ProcessNumber;
-use Rakibhstu\Banglanumber\ProcessDate;
-
 class NumberToBangla
 {
-    protected $process;
+    /**
+     * @var ProcessNumber
+     */
+    private $process;
 
-    protected $date;
+    /**
+     * @var ProcessDate
+     */
+    private $date;
 
+    /**
+     * Number to Bangla Constructor
+     */
     public function __construct()
     {
         $this->process = new ProcessNumber();
         $this->date    = new ProcessDate();
     }
 
+    /**
+     * @param $number
+     * @return string
+     */
     public function bnNum($number)
     {
         return $this->process->bnNum($number);
     }
 
+    /**
+     * @param $number
+     * @return string
+     */
     public  function bnWord($number)
     {
         return $this->process->bnWord($number);
     }
 
+    /**
+     * @param $number
+     * @return string
+     */
     public  function bnMoney($number)
     {
         return $this->process->bnMoney($number);
     }
 
+    /**
+     * @param $number
+     * @return string
+     */
     public function bnCommaLakh($number)
     {
         return $this->process->bnCommaLakh($number);
     }
 
+    /**
+     * @param $number
+     * @return string
+     * @throws Exceptions\InvalidNumber
+     * @throws Exceptions\InvalidRange
+     */
     public function bnMonth($number)
     {
         return $this->date->bnMonth($number);

src/NumberToBanglaServiceProvider.php

@@ -3,7 +3,6 @@
 namespace Rakibhstu\Banglanumber;
 
 use Illuminate\Support\ServiceProvider;
-use Rakibhstu\Banglanumber\NumberToBangla;
 
 class NumberToBanglaServiceProvider extends ServiceProvider
 {

src/ProcessDate.php

@@ -7,7 +7,10 @@
 
 class ProcessDate
 {
-    protected  $bn_month = [
+    /**
+     * @var string[]
+     */
+    private $bn_month = [
         '1' => 'জানুয়ারি',
         '2' => 'ফেব্রুয়ারি',
         '3' => 'মার্চ',
@@ -22,21 +25,12 @@ class ProcessDate
         '12' => 'ডিসেম্বর'
     ];
 
-    protected  $numbers = [
-        '০',
-        '১',
-        '২',
-        '৩',
-        '৪',
-        '৫',
-        '৬',
-        '৭',
-        '৮',
-        '৯'
-    ];
-
 
-    public function isValid($number)
+    /**
+     * @throws InvalidNumber
+     * @throws InvalidRange
+     */
+    private function isValid($number)
     {
         if (!is_numeric($number)) {
             throw InvalidNumber::message();
@@ -48,6 +42,10 @@ public function isValid($number)
     }
 
 
+    /**
+     * @throws InvalidNumber
+     * @throws InvalidRange
+     */
     public function bnMonth($number)
     {
         $this->isValid($number);

src/ProcessNumber.php

@@ -7,6 +7,9 @@
 
 class ProcessNumber
 {
+    /**
+     * @var string[]
+     */
     protected $words = [
         '',
         'এক',
@@ -110,6 +113,9 @@ class ProcessNumber
         'নিরানব্বই'
     ];
 
+    /**
+     * @var string[]
+     */
     protected $bn_num = [
         'শূন্য',
         'এক',
@@ -123,6 +129,9 @@ class ProcessNumber
         'নয়'
     ];
 
+    /**
+     * @var string[]
+     */
     protected $numbers = [
         '০',
         '১',
@@ -137,6 +146,10 @@ class ProcessNumber
     ];
 
 
+    /**
+     * @throws InvalidNumber
+     * @throws InvalidRange
+     */
     public function isValid($number)
     {
         if (!is_numeric($number)) {
@@ -148,6 +161,12 @@ public function isValid($number)
         }
     }
 
+    /**
+     * @param $number
+     * @return string
+     * @throws InvalidNumber
+     * @throws InvalidRange
+     */
     public function bnNum($number)
     {
         $this->isValid($number);
@@ -156,9 +175,15 @@ public function bnNum($number)
     }
 
 
+    /**
+     * @param $number
+     * @return string
+     * @throws InvalidNumber
+     * @throws InvalidRange
+     */
     public function bnWord($number)
     {
-        $valid = $this->isValid($number);
+        $this->isValid($number);
 
         if ($number == 0) {
             return 'শূন্য';
@@ -171,6 +196,12 @@ public function bnWord($number)
         return $this->toWord($number);
     }
 
+    /**
+     * @param $number
+     * @return string
+     * @throws InvalidNumber
+     * @throws InvalidRange
+     */
     public function bnMoney($number)
     {
         $this->isValid($number);
@@ -186,6 +217,10 @@ public function bnMoney($number)
         return $this->toWord($number) . ' টাকা ';
     }
 
+    /**
+     * @throws InvalidNumber
+     * @throws InvalidRange
+     */
     public function bnCommaLakh($number)
     {
         $this->isValid($number);
@@ -195,6 +230,10 @@ public function bnCommaLakh($number)
         return strtr($n, $this->numbers);
     }
 
+    /**
+     * @param $num
+     * @return string
+     */
     protected function toWord($num)
     {
         $text = '';
@@ -228,19 +267,23 @@ protected function toWord($num)
             $text .= $this->words[$hundred] . ' শত ';
         }
 
-        $hundred_div = (int) ($thousand_div % 100);
+        $hundred_div = $thousand_div % 100;
         if ($hundred_div > 0) {
             $text .= $this->words[$hundred_div];
         }
 
         return $text;
     }
 
+    /**
+     * @param $num
+     * @return string
+     */
     protected function toDecimalWord($num)
     {
         $text = '';
         $decimalParts = str_split($num);
-        foreach ($decimalParts as $key => $decimalPart) {
+        foreach ($decimalParts as $decimalPart) {
             $text .= $this->bn_num[$decimalPart] . ' ';
         }
 
@@ -249,7 +292,7 @@ protected function toDecimalWord($num)
 
     /**
      * Convert float number to text
-     * 
+     *
      */
     private function convertFloatNumberToWord($number)
     {
@@ -264,7 +307,8 @@ private function convertFloatNumberToWord($number)
 
     /**
      * Convert float number to money format
-     * 
+     * @param $number
+     * @return string
      */
     private function convertFloatNumberToMoneyFormat($number)
     {

tests/CreatesApplication.php

@@ -3,13 +3,14 @@
 namespace Tests;
 
 use Illuminate\Contracts\Console\Kernel;
+use Illuminate\Foundation\Application;
 
 trait CreatesApplication
 {
     /**
      * Creates the application.
      *
-     * @return \Illuminate\Foundation\Application
+     * @return Application
      */
     public function createApplication()
     {