opencafe / datium

src/Convert.php

Doc Comments +4 added lines

@@ -63,6 +63,10 @@
    *
    *\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\
    */
+
+  /**
+   * @param \DateTime $date_time
+   */
   public function __construct( $date_time = NULL ) {
 
     if ( $date_time !== NULL ) {

Braces +38 added lines, -32 removed lines

@@ -125,17 +125,19 @@ 
 
      $this->leap = new leap( $this->year );
 
-     if( $this->leap->get() && $this->month > 2 ) $this->temp_day++;
+     if( $this->leap->get() && $this->month > 2 ) {
+       $this->temp_day++;
+     }
 
      if ( $this->temp_day <= 79 ) {
 
-      if( ( $this->year - 1 ) % 4 == 0 )
-
+      if( ( $this->year - 1 ) % 4 == 0 ) {
+      
         $this->temp_day = $this->temp_day + 11;
-
-      else
-
+      } else {
+      
         $this->temp_day = $this->temp_day + 10;
+      }
 
       $this->year = $this->year - 622;
 
@@ -145,9 +147,7 @@ 
 
         $this->day = 30;
 
-      }
-
-      else {
+      } else {
 
         $this->month = ( $this->temp_day / 30 ) + 10;
 
@@ -155,9 +155,7 @@ 
 
       }
 
-     }
-
-     else {
+     } else {
 
       $this->year = $this->year - 621;
 
@@ -170,18 +168,14 @@ 
           $this->month = ( $this->temp_day / 31 );
 
           $this->day = 31;
-        }
-
-      else {
+        } else {
 
         $this->month = ( $this->temp_day / 31 ) + 1;
 
         $this->day = ( $this->temp_day % 31 );
       }
 
-      }
-
-      else {
+      } else {
 
         $this->temp_day = $this->temp_day - 186;
 
@@ -191,9 +185,7 @@ 
 
         $this->day = 30;
 
-        }
-
-        else {
+        } else {
 
         $this->month = ( $this->temp_day / 30 ) + 7;
 
@@ -240,7 +232,9 @@ 
 
      $this->leap = new leap( $this->year );
 
-    if( $this->leap->get() && $this->month > 11 ) $this->temp_day++;
+    if( $this->leap->get() && $this->month > 11 ) {
+      $this->temp_day++;
+    }
 
     $_year = ( ( ( ( ( $this->year - 1 ) * 365.2422 ) + $this->temp_day ) - 119) / 354.3670 ) + 1;
 
@@ -314,7 +308,9 @@ 
 
 foreach ( $this->config['shamsi_month_days'] as $month => $value ) {
 
-  if( $this->month > $month ) $days_of_year += $value;
+  if( $this->month > $month ) {
+    $days_of_year += $value;
+  }
 
 }
 
@@ -330,9 +326,7 @@ 
 
 $days_of_gregorain_years = $days_of_gregorain_years - intval( ( ( $this->year + 621 ) / 4 ) );
 
-}
-
-elseif ( ( ( 10 == $this->month ) && ( $this->day > 10 ) ) || ( $this->month > 10 ) ) {
+} elseif ( ( ( 10 == $this->month ) && ( $this->day > 10 ) ) || ( $this->month > 10 ) ) {
 
 $days_of_gregorain_years = $days_of_gregorain_years - intval( ( ( $this->year + 622 ) / 4 ) );
 
@@ -344,7 +338,9 @@ 
 
 foreach ($this->config['gregorian_month_days'] as $month => $value) {
 
-  if ( $gregorian_month < $value ) break;
+  if ( $gregorian_month < $value ) {
+    break;
+  }
 
     $gregorian_month -= $value;
 }
@@ -387,7 +383,9 @@ 
 
      $this->leap = new leap( $this->year );
 
-    if( $this->leap->get() && $this->month > 11 ) $this->temp_day++;
+    if( $this->leap->get() && $this->month > 11 ) {
+      $this->temp_day++;
+    }
 
     $_year = ( ( ( ( ( $this->year - 1 ) * 365.2422 ) + $this->temp_day ) - 119) / 354.3670 ) + 1;
 
@@ -460,7 +458,9 @@ 
 
 foreach ( $this->config['islamic_month_days'] as $month => $value ) {
 
-  if( $this->month > $month ) $days_of_year += $value;
+  if( $this->month > $month ) {
+    $days_of_year += $value;
+  }
 
 }
 
@@ -480,7 +480,9 @@ 
 
 foreach ($this->config['shamsi_month_days'] as $month => $value) {
 
-  if ( $shamsi_month < $value ) break;
+  if ( $shamsi_month < $value ) {
+    break;
+  }
 
     $shamsi_month -= $value;
 }
@@ -514,7 +516,9 @@ 
 
     foreach ( $this->config['islamic_month_days'] as $month => $value ) {
 
-      if( $this->month > $month ) $days_of_year += $value;
+      if( $this->month > $month ) {
+        $days_of_year += $value;
+      }
 
     }
 
@@ -534,7 +538,9 @@ 
 
     foreach ($this->config['gregorian_month_days'] as $month => $value) {
 
-      if ( $gregorian_month < $value ) break;
+      if ( $gregorian_month < $value ) {
+        break;
+      }
 
         $gregorian_month -= $value;
     }

src/Datium.php

Doc Comments +8 added lines, -4 removed lines

@@ -108,7 +108,7 @@ 
   /**
    * Get current datetime
    * @since Aug 17 2015
-   * @return object
+   * @return Datium
    */
   public static function now() {
 
@@ -126,7 +126,7 @@ 
    * @param $hour integer
    * @param $minute integer
    * @param $second integer
-   * @return object
+   * @return Datium
    */
   public static function create( $year = 2000, $month = 1, $day = 1, $hour = 0, $minute = 0, $second = 0 ) {
 
@@ -188,7 +188,7 @@ 
   /**
    * Add new date value to current date
    * @param $value string
-   * @return object
+   * @return Datium
    */
   public function add( $value ) {
 
@@ -221,7 +221,7 @@ 
 
   /**
    * Check if current year is leap or not
-   * @return boolean
+   * @return Leap
    */
   public function leap( $type = 'gr') {
 
@@ -261,6 +261,10 @@ 
 
   }
 
+  /**
+   * @param string $calendar
+   * @param string $format
+   */
   public function translate( $calendar, $format ) {
 
   $this->date_time = new Translate( $this->date_time, $calendar, $format, $this->gregorian_DayofWeek );

src/DayOf.php

Doc Comments +2 added lines, -2 removed lines

@@ -70,7 +70,7 @@ 
 
     /**
    * @since Sept, 14 2015
-   * @return integer
+   * @return double
    */
   protected function persian_day_of_year() {
 
@@ -93,7 +93,7 @@ 
 
      /**
    * @since Sept, 14 2015
-   * @return integer
+   * @return double
    */
   protected function islamic_day_of_year() {
 

Braces +12 added lines, -4 removed lines

@@ -80,7 +80,9 @@ 
 
     foreach( $this->config['shamsi_month_days'] as $month => $value ) {
 
-      if ( $month < $this->month ) $this->result += $value;
+      if ( $month < $this->month ) {
+        $this->result += $value;
+      }
 
     }
 
@@ -103,7 +105,9 @@ 
 
     foreach( $this->config['islamic_month_days'] as $month => $value ) {
 
-      if ( $month < $this->month ) $this->result += $value;
+      if ( $month < $this->month ) {
+        $this->result += $value;
+      }
 
     }
 
@@ -155,7 +159,9 @@ 
 
     foreach ( $this->config['week_days_name']['persian'] as $key => $value ) {
 
-      if( $value == $this->day ) return $key += 1;
+      if( $value == $this->day ) {
+        return $key += 1;
+      }
 
     }
 
@@ -171,7 +177,9 @@ 
 
     foreach ( $this->config['week_days_name']['islamic'] as $key => $value ) {
 
-      if( $value == $this->day ) return $key += 1;
+      if( $value == $this->day ) {
+        return $key += 1;
+      }
 
     }
 

src/Events/Events.php

Doc Comments +4 added lines

@@ -56,6 +56,10 @@
 	 *
 	 *\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/
 	 */
+
+	/**
+	 * @param string $path
+	 */
 	private function fetch( $path ) {
 
 		$this->events = include( $path );

src/Leap.php

Doc Comments +1 added lines, -1 removed lines

@@ -100,7 +100,7 @@
   /**
    * check the ghamari year is leap or not
    * @since Oct, 24 2015
-   * @return boolean
+   * @return integer|null
    */
   public function ghamariLeapYear() {
 

src/Translate.php

Doc Comments +3 added lines

@@ -20,6 +20,9 @@
 
   protected $english_number = array( '0', '1', '2', '3', '4', '5', '6', '7', '8', '9' );
 
+  /**
+   * @param \DateTime $date_time
+   */
   public function __construct( $date_time, $calendar, $format, $gregorian_DayofWeek ){
 
     $this->translate = include( 'lang/fa/general.php' );