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 ) {

Indentation +27 added lines, -27 removed lines

@@ -94,10 +94,10 @@ 
   }
 
 /**
-   *convert shamsi year to gregorian year
-   * @since Oct, 16 2015
-   * @return object
-   */
+ *convert shamsi year to gregorian year
+ * @since Oct, 16 2015
+ * @return object
+ */
 public function shamsiToGregorian( $date_time ) {
 
 $this->date_time = $date_time;
@@ -154,15 +154,15 @@ 
   $this->date_time->setDate( $gregorian_year, $gregorian_month, $gregorian_day );
 
 
- return $this->date_time;
+  return $this->date_time;
 
 }
 
 /**
-   *convert shamsi year to ghamari year
-   * @since Oct, 17 2015
-   * @return object
-   */
+ *convert shamsi year to ghamari year
+ * @since Oct, 17 2015
+ * @return object
+ */
 public function shamsiToGhamari( $date_time ) {
 
     $this->date_time = $date_time;
@@ -181,9 +181,9 @@ 
 
       }
 
-     $this->temp_day += $this->day;
+      $this->temp_day += $this->day;
 
-     $this->leap = new Leap( $this->year );
+      $this->leap = new Leap( $this->year );
 
     if( $this->leap->get() && $this->month > 11 ) $this->temp_day++;
 
@@ -195,15 +195,15 @@ 
 
     $_month = $_year[1];
 
-     $var_temp = '0.0';
+      $var_temp = '0.0';
 
       for ( $i = strlen( $_month ); $i > 2; $i-- ) {
 
         $var_temp .= '0';
 
-     }
+      }
 
-     $var_temp .= '1';
+      $var_temp .= '1';
 
     $_month = $_month * $var_temp ;
 
@@ -219,7 +219,7 @@ 
 
     for ( $i = strlen( $_day );  $i > 2;  $i-- ) {
 
-       $var_temp .= '0' ;
+        $var_temp .= '0' ;
 
     }
 
@@ -233,17 +233,17 @@ 
 
     $this->day = $_day[0];
 
-   $this->date_time->setDate( $this->year, $this->month, $this->day );
+    $this->date_time->setDate( $this->year, $this->month, $this->day );
 
-   return $this->date_time;
+    return $this->date_time;
 
 }
 
 /**
-   *convert ghamari year to shamsi year
-   * @since Oct, 17 2015
-   * @return object
-   */
+ *convert ghamari year to shamsi year
+ * @since Oct, 17 2015
+ * @return object
+ */
 public function ghamariToShamsi( $date_time ) {
 
 $this->date_time = $date_time;
@@ -289,15 +289,15 @@ 
 
   $this->date_time->setDate( $shamsi_year, $shamsi_month, $shamsi_day );
 
- return $this->date_time;
+  return $this->date_time;
 
 }
 
   /**
-    * convert ghamari year to gregorian year
-    * @since Oct, 17 2015
-    * @return object
-    */
+   * convert ghamari year to gregorian year
+   * @since Oct, 17 2015
+   * @return object
+   */
   public function ghamariToGregorian( $date_time ) {
 
     $this->date_time = $date_time;
@@ -343,7 +343,7 @@ 
 
       $this->date_time->setDate( $gregorian_year, $gregorian_month, $gregorian_day );
 
-     return $this->date_time;
+      return $this->date_time;
 
   }
 

src/Events/Events.php

Doc Comments +4 added lines

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

Indentation +78 added lines, -78 removed lines

@@ -8,47 +8,47 @@ 
 
 class Events {
 
-	private $local;
+  private $local;
 
-	private $events;
+  private $events;
 
-	private $date_time;
+  private $date_time;
 
-	private $convert;
+  private $convert;
 
-	private $result;
+  private $result;
 
-	private $period;
+  private $period;
 
-	private $interval;
+  private $interval;
 
-	private static $date_start;
+  private static $date_start;
 
-	private static $date_end;
+  private static $date_end;
 
-	public function __construct( $date_time, $date_end = NULL ) {
+  public function __construct( $date_time, $date_end = NULL ) {
 
-		if( $date_end !== NULL ) {
+    if( $date_end !== NULL ) {
 
-			Events::$date_start = $date_time;
+      Events::$date_start = $date_time;
 
-			Events::$date_end = $date_end;
+      Events::$date_end = $date_end;
 
-		} else {
+    } else {
 
-			Events::$date_start = $date_time;
+      Events::$date_start = $date_time;
 
-		}
+    }
 
-		$this->convert = new Convert;
+    $this->convert = new Convert;
 
-		$this->date_time = new DateTime();
+    $this->date_time = new DateTime();
 
-		return $this;
+    return $this;
 
-	}
+  }
 
-	/************************************************************
+  /************************************************************
 	 * Fetch Events array from own array file
 	 ************************************************************
 	 *
@@ -56,27 +56,27 @@ 
 	 *
 	 *\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/
 	 */
-	private function fetch( $path ) {
+  private function fetch( $path ) {
 
-		$this->events = include( $path );
+    $this->events = include( $path );
 
-		$this->interval = DateInterval::createFromDateString('1 day');
+    $this->interval = DateInterval::createFromDateString('1 day');
 
-		$this->period = new DatePeriod( Events::$date_start, $this->interval, Events::$date_end );
+    $this->period = new DatePeriod( Events::$date_start, $this->interval, Events::$date_end );
 
-		foreach ( $this->period as $dt ) {
+    foreach ( $this->period as $dt ) {
 
-			if ( isset( $this->events[ 'events' ][ intval( $dt->format('m') ) ][ intval( $dt->format('d') ) ] ) ) {
+      if ( isset( $this->events[ 'events' ][ intval( $dt->format('m') ) ][ intval( $dt->format('d') ) ] ) ) {
 
-				$this->result[ $dt->format( 'Y-m-d' ) ][] = $this->events[ 'events' ][ intval( $dt->format('m') ) ][ intval( $dt->format('d') ) ];
+        $this->result[ $dt->format( 'Y-m-d' ) ][] = $this->events[ 'events' ][ intval( $dt->format('m') ) ][ intval( $dt->format('d') ) ];
 
-			}
+      }
 
-		}
+    }
 
-	}
+  }
 
-	/************************************************************
+  /************************************************************
 	 * Return Array of Events
 	 ************************************************************
 	 *
@@ -85,31 +85,31 @@ 
 	 *
 	 *\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\
 	 */
-	public function get() {
+  public function get() {
 
-		if( ! empty( $this->result ) ) {
+    if( ! empty( $this->result ) ) {
 
-			foreach( $this->result as $key => $day ) {
+      foreach( $this->result as $key => $day ) {
 
-				if ( ! ( $key > Events::$date_start->format( 'Y-m-d' ) && $key < Events::$date_end->format( 'Y-m-d' ) ) ) {
+        if ( ! ( $key > Events::$date_start->format( 'Y-m-d' ) && $key < Events::$date_end->format( 'Y-m-d' ) ) ) {
 
-					unset( $this->result[ $key ] );
+          unset( $this->result[ $key ] );
 
-				}
+        }
 
-			}
+      }
 
-		} else {
+    } else {
 
-			$this->result = array();
+      $this->result = array();
 
-		}
+    }
 
-		return $this->result;
+    return $this->result;
 
-	}
+  }
 
-		/************************************************************
+    /************************************************************
 		 * Return local events - with day start and end as an array
 		 ************************************************************
 		 *
@@ -118,72 +118,72 @@ 
 		 *
 		 *\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\
 		 */
-		public function local( $country_code = "ir" ) {
+    public function local( $country_code = "ir" ) {
 
-				/*
+        /*
 				 * Capitalize the first character of $country_code according the file
 				 * structure.
 				 */
-				$country_code = strtolower( $country_code = 'ir' ) ;
+        $country_code = strtolower( $country_code = 'ir' ) ;
 
-				$this->local = include( 'Localization/' . $country_code . '.php' );
+        $this->local = include( 'Localization/' . $country_code . '.php' );
 
-				foreach( $this->local[ 'events' ] as $month => $events ) {
+        foreach( $this->local[ 'events' ] as $month => $events ) {
 
-					foreach( $events as $day => $event ){
+          foreach( $events as $day => $event ){
 
-						$this->date_time = new DateTime();
+            $this->date_time = new DateTime();
 
-						$this->date_time->setDate( Events::$date_start->format( 'Y' ), $month, $day );
+            $this->date_time->setDate( Events::$date_start->format( 'Y' ), $month, $day );
 
-						switch ( $this->local[ 'default_calendar' ] ) {
+            switch ( $this->local[ 'default_calendar' ] ) {
 
-							case 'shamsi':
+              case 'shamsi':
 
-							$this->date_time->setDate( 1394, $month, $day );
+              $this->date_time->setDate( 1394, $month, $day );
 
-							$this->date_time = Datium::create( $this->date_time )->from( 'shamsi' )->to( 'gregorian' )->object(); //$this->convert->shamsiToGregorian( $this->date_time );
+              $this->date_time = Datium::create( $this->date_time )->from( 'shamsi' )->to( 'gregorian' )->object(); //$this->convert->shamsiToGregorian( $this->date_time );
 
-							break;
+              break;
 
-							case 'ghamari':
+              case 'ghamari':
 
-								$this->date_time = Datium::create(  $this->date_time )->from( 'ghamari' )->to( 'gregorian' )->object(); // $this->convert->ghamariToGregorian( $this->date_time );
+                $this->date_time = Datium::create(  $this->date_time )->from( 'ghamari' )->to( 'gregorian' )->object(); // $this->convert->ghamariToGregorian( $this->date_time );
 
-							break;
+              break;
 
-						}
+            }
 
-						$this->result[ $this->date_time->format( 'Y-m-d' ) ][] =  $event;
+            $this->result[ $this->date_time->format( 'Y-m-d' ) ][] =  $event;
 
-					}
+          }
 
-				}
+        }
 
-				ksort( $this->result );
+        ksort( $this->result );
 
-		return $this;
+    return $this;
 
-	}
+  }
 
-	public function weekend() {
+  public function weekend() {
 
-		return 0;
+    return 0;
 
-	}
+  }
 
-	public function relagious() {
+  public function relagious() {
 
-		return 0;
+    return 0;
 
-	}
+  }
 
-	public function international() {
+  public function international() {
 
-		$this->fetch( 'Global/global.php' );
+    $this->fetch( 'Global/global.php' );
 
-		return $this;
+    return $this;
 
-	}
+  }
 
 }

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() {
 

Indentation +8 added lines, -8 removed lines

@@ -8,7 +8,7 @@ 
   /**
    * @param integer store year value
    */
-	protected $year;
+  protected $year;
 
   /**
    * @param string store type of year value
@@ -25,15 +25,15 @@ 
    * @param $year integer
    * @since Aug, 21 2015
    */
-	public function __construct( $year, $type = 'gregorian' ) {
+  public function __construct( $year, $type = 'gregorian' ) {
 
-			$this->year = $year;
+      $this->year = $year;
 
       $this->type = $type;
 
       return $this;
 
-	}
+  }
 
   /**
    * check the gregorian year is leap or not
@@ -53,7 +53,7 @@ 
    */
   public function shamsiLeapYear() {
 
-		$shamsi_years = 0;
+    $shamsi_years = 0;
 
     while ( $shamsi_years < ( $this->year - 128 ) ) {
 
@@ -70,7 +70,7 @@ 
 
     $this->result = $this->result % 33;
 
-   }
+    }
 
     if ( ( $this->result == 28 ) || ( $this->result == 27 ) ) {
 
@@ -87,7 +87,7 @@ 
 
     $this->result = $this->result % 33;
 
-   }
+    }
 
     if ( ( ( $this->result % 4 ) == 0 ) && ( $this->result != 28 ) ) {
 
@@ -132,7 +132,7 @@ 
 
        $this->result = $this->shamsiLeapYear();
 
-       break;
+        break;
 
       case 'ghamari':
 

src/lang/fa/general.php

Indentation +11 added lines, -11 removed lines

@@ -2,7 +2,7 @@ 
 
   return array(
 
-       'events' => array( 'nowruz' => 'عید نوروز',
+        'events' => array( 'nowruz' => 'عید نوروز',
 
                           'iran_national_day' => 'روز جمهوری اسلامی',
 
@@ -12,16 +12,16 @@ 
         'month' => array(
                           'فروردین',
                           'اردیبهشت',
-                           'خرداد',
-                           'تیر',
-                           'مرداد',
-                           'شهریور',
-                           'مهر',
-                           'آبان',
-                           'آذر',
-                           'دی',
-                           'بهمن',
-                           'اسفند',
+                            'خرداد',
+                            'تیر',
+                            'مرداد',
+                            'شهریور',
+                            'مهر',
+                            'آبان',
+                            'آذر',
+                            'دی',
+                            'بهمن',
+                            'اسفند',
                         ),
 
         'week_days_name' => array(

vendor/composer/ClassLoader.php

Doc Comments +4 added lines

@@ -341,6 +341,10 @@
         return $file;
     }
 
+    /**
+     * @param string $class
+     * @param string $ext
+     */
     private function findFileWithExtension($class, $ext)
     {
         // PSR-4 lookup

src/Config.php

Indentation +1 added lines, -1 removed lines

@@ -125,4 +125,4 @@
    */
   'weekend' => array( 'friday' )
 
- );
+  );

src/Datium.php

Doc Comments +9 added lines, -5 removed lines

@@ -138,7 +138,7 @@ 
   /**
    * Get current datetime
    * @since Aug 17 2015
-   * @return object
+   * @return Datium
    */
   public static function now() {
 
@@ -156,7 +156,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 ) {
 
@@ -195,6 +195,7 @@ 
 
   /**
    * Convert from current calendar, what type is current calendar?
+   * @param string $calendar
    */
   public function from( $calendar ) {
 
@@ -213,6 +214,9 @@ 
 
   }
 
+  /**
+   * @param string $calendar
+   */
   public function to( $calendar ) {
 
     $this->convert = new Convert( $this->date_time );
@@ -245,7 +249,7 @@ 
   /**
    * Add new date value to current date
    * @param $value string
-   * @return object
+   * @return Datium
    */
   public function add( $value ) {
 
@@ -262,7 +266,7 @@ 
   /**
    * Sub date from current date
    * @param $value
-   * @return obejct
+   * @return Datium
    */
   public function sub( $value ) {
 
@@ -278,7 +282,7 @@ 
 
   /**
    * Check if current year is leap or not
-   * @return boolean
+   * @return Leap
    */
   public function leap( $type = 'gregorian') {
 

src/CalendarSettings/Shamsi.php

Indentation +32 added lines, -32 removed lines

@@ -41,19 +41,19 @@ 
 
         $temp_day = 0;
 
-         for ( $i = 1 ; $i < $month ; $i++ ) {
+          for ( $i = 1 ; $i < $month ; $i++ ) {
 
-           $temp_day += $config['month_days_number'][$i];
+            $temp_day += $config['month_days_number'][$i];
 
-         }
+          }
 
-         $temp_day += $day;
+          $temp_day += $day;
 
-         $leap = new Leap( $year );
+          $leap = new Leap( $year );
 
-         if( $leap->get() && $month > 2 ) $temp_day++;
+          if( $leap->get() && $month > 2 ) $temp_day++;
 
-         if ( $temp_day <= 79 ) {
+          if ( $temp_day <= 79 ) {
 
           if( ( $year - 1 ) % 4 == 0 )
 
@@ -81,9 +81,9 @@ 
 
           }
 
-         }
+          }
 
-         else {
+          else {
 
           $year = $year - 621;
 
@@ -129,11 +129,11 @@ 
 
           }
 
-         }
+          }
 
-         $date_time->setDate( $year, $month, $day );
+          $date_time->setDate( $year, $month, $day );
 
-         return $date_time;
+          return $date_time;
 
   },
 
@@ -203,7 +203,7 @@ 
       $date_time->setDate( $gregorian_year, $gregorian_month, $gregorian_day );
 
 
-     return $date_time;
+      return $date_time;
 
   },
 
@@ -264,30 +264,30 @@ 
    */
   'days_of_week' => array (
 
-     'Yekshanbe',
-     'Doshanbe',
-     'Seshanbe',
-     'Chaharshanbe',
-     'Panjshanbe',
-     'Jome',
-     'Shanbe',
+      'Yekshanbe',
+      'Doshanbe',
+      'Seshanbe',
+      'Chaharshanbe',
+      'Panjshanbe',
+      'Jome',
+      'Shanbe',
 
   ),
 
   'start_day_of_week' => 'Shanbe',
 
   'month_days_number' => array(      1 => 31,
-                                     2 => 31,
-                                     3 => 31,
-                                     4 => 31,
-                                     5 => 31,
-                                     6 => 31,
-                                     7 => 30,
-                                     8 => 30,
-                                     9 => 30,
-                                     10 => 30,
-                                     11 => 30,
-                                     12 => 29 ),
+                                      2 => 31,
+                                      3 => 31,
+                                      4 => 31,
+                                      5 => 31,
+                                      6 => 31,
+                                      7 => 30,
+                                      8 => 30,
+                                      9 => 30,
+                                      10 => 30,
+                                      11 => 30,
+                                      12 => 29 ),
 
 
   'day_of_year' => function( $date_time ) {
@@ -354,4 +354,4 @@ 
    */
   'weekend' => array( 'friday' )
 
- );
+  );

src/Lang.php

Indentation +10 added lines, -10 removed lines

@@ -40,21 +40,21 @@
       /**
        * Fetch translated file to config attribute
        */
-       self::$config = include('src/CalendarSettings/Shamsi.php');
+        self::$config = include('src/CalendarSettings/Shamsi.php');
 
-       /**
-        * Fetch translated expression to langTable attribute
-        */
-       self::$langTable = include('lang/' . $language . '/general.php');
+        /**
+         * Fetch translated expression to langTable attribute
+         */
+        self::$langTable = include('lang/' . $language . '/general.php');
 
-       foreach( self::$langTable as $key => $translate ){
+        foreach( self::$langTable as $key => $translate ){
 
-         if(  self::$config[ $key ] ) {
+          if(  self::$config[ $key ] ) {
 
-           self::$config[ $key ] = $translate;
+            self::$config[ $key ] = $translate;
 
-         }
-       }
+          }
+        }
 
     }