opencafe / datium

src/Datium.php

Doc Comments +11 added lines, -12 removed lines

@@ -193,7 +193,7 @@ 
      * Get current datetime
      *
      * @since  Aug 17 2015
-     * @return object
+     * @return Datium
      */
     public static function now()
     {
@@ -232,7 +232,7 @@ 
      * @param integer $minute minute number
      * @param integer $second second number
      *
-     * @return object
+     * @return Datium
      */
     public static function create(
         $year = 2000,
@@ -272,7 +272,7 @@ 
      *
      * @param  timestamp $timestamp Input timestamp value
      *
-     * @return object
+     * @return Datium
      */
     public static function createTimestamp($timestamp)
     {
@@ -300,7 +300,7 @@ 
      * @param object $date_start Start of the DateTime
      * @param object $date_end   End of the DateTime
      *
-     * @return object
+     * @return Datium
      */
     public static function between($date_start, $date_end)
     {
@@ -346,7 +346,7 @@ 
      *
      * @param object $calendar Assigned calendar to when calendar should start.
      *
-     * @return object
+     * @return Datium
      */
     public function to($calendar)
     {
@@ -402,7 +402,7 @@ 
      *
      * @param string $value How much date should be added to current date
      *
-     * @return object
+     * @return Datium
      */
     public function add($value)
     {
@@ -444,7 +444,7 @@ 
      *
      * @param string $value How much date should increase from current date
      *
-     * @return obejct
+     * @return Datium
      */
     public function sub($value)
     {
@@ -484,9 +484,8 @@ 
     /**
      * Check if current year is leap or not
      *
-     * @param string $type Name of the calendar to caculate leap year
      *
-     * @return boolean
+     * @return Leap
      */
     public function leap()
     {
@@ -502,7 +501,7 @@ 
      *
      * @since Aug, 22 2015
      *
-     * @return integer
+     * @return DayOf
      */
     public function dayOf()
     {
@@ -549,7 +548,7 @@ 
      *
      * @param string $language language short name fa, en, ar ...
      *
-     * @return object
+     * @return Datium
      */
     public function lang($language = 'fa')
     {
@@ -569,7 +568,7 @@ 
     /**
      * Return object as timestamp
      *
-     * @return timestamp
+     * @return integer
      */
     public function timestamp()
     {

Spacing +2 added lines, -2 removed lines

@@ -171,7 +171,7 @@ 
     public function all()
     {
 
-        return ( object )array(
+        return (object) array(
 
             'second' => $this->date_time->format('s'),
 
@@ -391,7 +391,7 @@ 
 
         $difference->year = $difference->y;
 
-        $difference->simple = ( new SimpleDiff( $start, $end, $difference ) );
+        $difference->simple = (new SimpleDiff($start, $end, $difference));
 
         return $difference;
 

src/SimpleDiff.php

Doc Comments +4 added lines, -3 removed lines

@@ -34,8 +34,9 @@ 
     /**
     * SimpleDiff Class constructure
     *
-    * @param DateTime $time_difference The time to calculate with now
-    * @param string $lang Language
+    * @param DateTime $difference The time to calculate with now
+    * @param \DateTime $start
+    * @param \DateTime $end
     */
     public function __construct($start, $end, $difference )
     {
@@ -65,8 +66,8 @@ 
     /**
     * Read ago config file
     *
-    * @param integer $date date index in ago config file
     * @param string $type duration type on ago config file
+    * @param integer $value
     */
     public function read( $value, $type )
     {

Indentation +24 added lines, -24 removed lines

@@ -32,11 +32,11 @@ 
     private $blockList;
 
     /**
-    * SimpleDiff Class constructure
-    *
-    * @param DateTime $time_difference The time to calculate with now
-    * @param string $lang Language
-    */
+     * SimpleDiff Class constructure
+     *
+     * @param DateTime $time_difference The time to calculate with now
+     * @param string $lang Language
+     */
     public function __construct($start, $end, $difference )
     {
 
@@ -51,10 +51,10 @@ 
     }
 
     /**
-    * Return difference period as an object
-    *
-    * @return object
-    */
+     * Return difference period as an object
+     *
+     * @return object
+     */
     public function all()
     {
 
@@ -63,11 +63,11 @@ 
     }
 
     /**
-    * Read ago config file
-    *
-    * @param integer $date date index in ago config file
-    * @param string $type duration type on ago config file
-    */
+     * Read ago config file
+     *
+     * @param integer $date date index in ago config file
+     * @param string $type duration type on ago config file
+     */
     public function read( $value, $type )
     {
 
@@ -98,7 +98,7 @@ 
       if( array_key_exists( $value, $config[ $type ] ) ) {
 
         $str = Lang::get( $this->language, $config[ $type ][ $value ] )
-               . $time;
+                . $time;
 
         return $str;
 
@@ -114,11 +114,11 @@ 
     }
 
     /**
-    * Show priority of duration
-    *
-    * @param integer $date date index in ago config file
-    * @param string $type duration type on ago config file
-    */
+     * Show priority of duration
+     *
+     * @param integer $date date index in ago config file
+     * @param string $type duration type on ago config file
+     */
     public function priority( $date, $type )
     {
 
@@ -144,10 +144,10 @@ 
     }
 
     /**
-    * Return fainal SimpleDiff result
-    *
-    * @return string
-    */
+     * Return fainal SimpleDiff result
+     *
+     * @return string
+     */
     public function get()
     {
 

Spacing +22 added lines, -22 removed lines

@@ -37,12 +37,12 @@ 
     * @param DateTime $time_difference The time to calculate with now
     * @param string $lang Language
     */
-    public function __construct($start, $end, $difference )
+    public function __construct($start, $end, $difference)
     {
 
       $this->language = 'en';
 
-      $this->result =  $difference;
+      $this->result = $difference;
 
       $this->blockList = [
         'just-now'
@@ -68,46 +68,46 @@ 
     * @param integer $date date index in ago config file
     * @param string $type duration type on ago config file
     */
-    public function read( $value, $type )
+    public function read($value, $type)
     {
 
-      $config = include __DIR__ . '/config/diff.php';
+      $config = include __DIR__.'/config/diff.php';
 
-      if( $this->result->invert ) {
+      if ($this->result->invert) {
 
-        $time = ' ' . Lang::get( $this->language, 'remaining' );
+        $time = ' '.Lang::get($this->language, 'remaining');
 
       } else {
 
-        $time = ' ' . Lang::get( $this->language, 'ago' );
+        $time = ' '.Lang::get($this->language, 'ago');
 
       }
 
-      if( isset( $config[ $type ][ $value ] ) && in_array(
+      if (isset($config[$type][$value]) && in_array(
 
-                $config[ $type ][ $value ],
+                $config[$type][$value],
 
                 $this->blockList
 
-                ) ) {
+                )) {
 
                 $time = null;
 
                 }
 
-      if( array_key_exists( $value, $config[ $type ] ) ) {
+      if (array_key_exists($value, $config[$type])) {
 
-        $str = Lang::get( $this->language, $config[ $type ][ $value ] )
+        $str = Lang::get($this->language, $config[$type][$value])
                . $time;
 
         return $str;
 
       } else {
 
-        return Lang::getNumbers( $this->language, $value ) . " " . Lang::get(
+        return Lang::getNumbers($this->language, $value)." ".Lang::get(
                                           $this->language,
-                                          $config[ $type ][ '*' ]
-                                        ) . $time;
+                                          $config[$type]['*']
+                                        ).$time;
 
       }
 
@@ -119,12 +119,12 @@ 
     * @param integer $date date index in ago config file
     * @param string $type duration type on ago config file
     */
-    public function priority( $date, $type )
+    public function priority($date, $type)
     {
 
-      if( $date != 0 ) {
+      if ($date != 0) {
 
-        return $this->read( $date, $type );
+        return $this->read($date, $type);
 
       } else {
 
@@ -134,7 +134,7 @@ 
 
     }
 
-    public function lang( $value )
+    public function lang($value)
     {
 
       $this->language = $value;
@@ -160,11 +160,11 @@ 
         'second' =>  $this->result->second
       ];
 
-      foreach( $duration as $index => $value ) {
+      foreach ($duration as $index => $value) {
 
-        if( $this->priority( $value, $index ) != false ) {
+        if ($this->priority($value, $index) != false) {
 
-          return $this->priority( $value, $index );
+          return $this->priority($value, $index);
 
         }
 

src/DayOf.php

Spacing +4 added lines, -4 removed lines

@@ -44,9 +44,9 @@ 
     public function year()
     {
 
-        $this->config = include __DIR__.'/CalendarSettings/' . ucfirst($this->calendar_type) . '.php';
+        $this->config = include __DIR__.'/CalendarSettings/'.ucfirst($this->calendar_type).'.php';
 
-        return $this->config[ 'day_of_year' ]( $this->date_time );
+        return $this->config['day_of_year']($this->date_time);
 
     }
 
@@ -60,9 +60,9 @@ 
     public function week()
     {
 
-        $this->config = include __DIR__.'/CalendarSettings/' . ucfirst($this->calendar_type) . '.php';
+        $this->config = include __DIR__.'/CalendarSettings/'.ucfirst($this->calendar_type).'.php';
 
-        return $this->config[ 'day_of_week' ]( $this->date_time );
+        return $this->config['day_of_week']($this->date_time);
 
     }
 }

src/Lang.php

Spacing +8 added lines, -8 removed lines

@@ -49,12 +49,12 @@ 
         /**
         * Fetch translated expression to langTable attribute
         */
-        self::$langTable = include __DIR__ . '/lang/' . $language . '/general.php';
+        self::$langTable = include __DIR__.'/lang/'.$language.'/general.php';
 
         foreach (self::$langTable as $key => $translate) {
-            if (isset(self::$config[ $key ])) {
-                if (self::$config[ $key ]) {
-                    self::$config[ $key ] = $translate;
+            if (isset(self::$config[$key])) {
+                if (self::$config[$key]) {
+                    self::$config[$key] = $translate;
                 }
             }
         }
@@ -71,7 +71,7 @@ 
     public static function get($lang, $value)
     {
 
-        $file = include( __DIR__ . '/lang/' . $lang . '/general.php');
+        $file = include(__DIR__.'/lang/'.$lang.'/general.php');
 
         return $file[$value];
 
@@ -83,14 +83,14 @@ 
      * @param  integer $numbers
      * @return string
      */
-    public static function getNumbers( $lang, $numbers )
+    public static function getNumbers($lang, $numbers)
     {
 
       $result = null;
 
-      $file = include( __DIR__ . '/lang/' . $lang . '/general.php');
+      $file = include(__DIR__.'/lang/'.$lang.'/general.php');
 
-      foreach(  str_split( $numbers, 1 ) as $key => $value ) {
+      foreach (str_split($numbers, 1) as $key => $value) {
 
         $result .= $file[$value];
 

src/Convert.php

Spacing +30 added lines, -30 removed lines

@@ -78,9 +78,9 @@ 
     public function from($calendar)
     {
 
-        $this->calendar_file = include __DIR__.'/CalendarSettings/' . ucfirst($calendar) . '.php';
+        $this->calendar_file = include __DIR__.'/CalendarSettings/'.ucfirst($calendar).'.php';
 
-        return $this->calendar_file[ 'convert_from' ]( $this->date_time );
+        return $this->calendar_file['convert_from']($this->date_time);
 
     }
 
@@ -95,9 +95,9 @@ 
     public function to($calendar)
     {
 
-        $this->calendar_file = include __DIR__.'/CalendarSettings/' . ucfirst($calendar) . '.php';
+        $this->calendar_file = include __DIR__.'/CalendarSettings/'.ucfirst($calendar).'.php';
 
-        return $this->calendar_file[ 'convert_to' ]( $this->date_time );
+        return $this->calendar_file['convert_to']($this->date_time);
 
     }
 
@@ -122,7 +122,7 @@ 
 
           $days_of_year = 0;
 
-        foreach ($this->config[ 'month_days_number' ] as $month => $value) {
+        foreach ($this->config['month_days_number'] as $month => $value) {
             if ($this->month > $month) {
                 $days_of_year += $value;
             }
@@ -130,25 +130,25 @@ 
 
           $days_of_year += $this->day;
 
-          $days_of_leap_years =  intval(( ( $this->year - 1 ) / 4 ));
+          $days_of_leap_years = intval((($this->year - 1) / 4));
 
-          $days_of_jalali_years = ( ( ( $this->year - 1 ) * 365 ) + $days_of_year + $days_of_leap_years );
+          $days_of_jalali_years = ((($this->year - 1) * 365) + $days_of_year + $days_of_leap_years);
 
           $days_of_gregorain_years = $days_of_jalali_years + 226899;
 
         if ($this->month < 10) {
-            $days_of_gregorain_years = $days_of_gregorain_years - intval(( ( $this->year + 621 ) / 4 ));
-        } elseif (( ( 10 == $this->month ) && ( $this->day > 10 ) ) || ( $this->month > 10 )) {
-            $days_of_gregorain_years = $days_of_gregorain_years - intval(( ( $this->year + 622 ) / 4 ));
+            $days_of_gregorain_years = $days_of_gregorain_years - intval((($this->year + 621) / 4));
+        } elseif (((10 == $this->month) && ($this->day > 10)) || ($this->month > 10)) {
+            $days_of_gregorain_years = $days_of_gregorain_years - intval((($this->year + 622) / 4));
         }
 
-            $gregorian_month = ( $days_of_gregorain_years % 365 );
+            $gregorian_month = ($days_of_gregorain_years % 365);
 
             $gregorian_year = intval($days_of_gregorain_years / 365) + 1;
 
             $this->config = include __DIR__.'/Gregorian.php';
 
-        foreach ($this->config[ 'month_days_number' ] as $month => $value) {
+        foreach ($this->config['month_days_number'] as $month => $value) {
             if ($gregorian_month < $value) {
                 break;
             }
@@ -184,7 +184,7 @@ 
 
         $this->day = $this->date_time->format('d');
 
-        $this->temp_day = 0 ;
+        $this->temp_day = 0;
 
         $this->config = include __DIR__.'/Jalali.php';
 
@@ -200,7 +200,7 @@ 
             $this->temp_day++;
         }
 
-        $_year = ( ( ( ( ( $this->year - 1 ) * 365.2422 ) + $this->temp_day ) - 119) / 354.3670 ) + 1;
+        $_year = ((((($this->year - 1) * 365.2422) + $this->temp_day) - 119) / 354.3670) + 1;
 
         $_year = explode('.', $_year);
 
@@ -216,9 +216,9 @@ 
 
          $var_temp .= '1';
 
-        $_month = $_month * $var_temp ;
+        $_month = $_month * $var_temp;
 
-        $_month = ( $_month * 12 ) + 1;
+        $_month = ($_month * 12) + 1;
 
         $_month = explode('.', $_month);
 
@@ -229,14 +229,14 @@ 
         $var_temp = '0.0';
 
         for ($i = strlen($_day); $i > 2; $i--) {
-            $var_temp .= '0' ;
+            $var_temp .= '0';
         }
 
         $var_temp .= '1';
 
         $_day = $_day * $var_temp;
 
-        $_day = ( $_day * 29.530 );
+        $_day = ($_day * 29.530);
 
         $_day = explode('.', $_day);
 
@@ -269,7 +269,7 @@ 
 
           $this->config = include __DIR__.'/Hijri.php';
 
-        foreach ($this->config[ 'month_days_number' ] as $month => $value) {
+        foreach ($this->config['month_days_number'] as $month => $value) {
             if ($this->month > $month) {
                 $days_of_year += $value;
             }
@@ -277,21 +277,21 @@ 
 
           $days_of_year += $this->day;
 
-          $days_of_leap_years =  intval(( ( $this->year - 1 ) / 3 ));
+          $days_of_leap_years = intval((($this->year - 1) / 3));
 
-          $days_of_hijri_years = ( ( ( $this->year - 1 ) * 354 ) + $days_of_year + $days_of_leap_years );
+          $days_of_hijri_years = ((($this->year - 1) * 354) + $days_of_year + $days_of_leap_years);
 
           $days_of_jalali_years = $days_of_hijri_years + 179;
 
-          $days_of_jalali_years = $days_of_jalali_years - intval(( ( $this->year - 43 ) / 4 ));
+          $days_of_jalali_years = $days_of_jalali_years - intval((($this->year - 43) / 4));
 
-          $jalali_month = ( $days_of_jalali_years % 365 );
+          $jalali_month = ($days_of_jalali_years % 365);
 
           $jalali_year = intval($days_of_jalali_years / 365) + 1;
 
           $this->config = include __DIR__.'/Jalali.php';
 
-        foreach ($this->config[ 'month_days_number' ] as $month => $value) {
+        foreach ($this->config['month_days_number'] as $month => $value) {
             if ($jalali_month < $value) {
                 break;
             }
@@ -330,7 +330,7 @@ 
 
         $this->config = include __DIR__.'/Hijri.php';
 
-        foreach ($this->config[ 'month_days_number' ] as $month => $value) {
+        foreach ($this->config['month_days_number'] as $month => $value) {
             if ($this->month > $month) {
                 $days_of_year += $value;
             }
@@ -338,21 +338,21 @@ 
 
         $days_of_year += $this->day;
 
-        $days_of_leap_years =  intval(( ( $this->year - 1 ) / 3 ));
+        $days_of_leap_years = intval((($this->year - 1) / 3));
 
-        $days_of_hijri_years = ( ( ( $this->year - 1 ) * 354 ) + $days_of_year + $days_of_leap_years );
+        $days_of_hijri_years = ((($this->year - 1) * 354) + $days_of_year + $days_of_leap_years);
 
         $days_of_gregorain_years = $days_of_hijri_years + 227078;
 
-        $days_of_gregorain_years = $days_of_gregorain_years - intval(( ( $this->year + 578 ) / 4 ));
+        $days_of_gregorain_years = $days_of_gregorain_years - intval((($this->year + 578) / 4));
 
-        $gregorian_month = ( $days_of_gregorain_years % 365 );
+        $gregorian_month = ($days_of_gregorain_years % 365);
 
         $gregorian_year = intval($days_of_gregorain_years / 365) + 1;
 
         $this->config = include __DIR__.'/Gregorian.php';
 
-        foreach ($this->config[ 'month_days_number' ] as $month => $value) {
+        foreach ($this->config['month_days_number'] as $month => $value) {
             if ($gregorian_month < $value) {
                 break;
             }