opencafe / datium

src/Datium.php

Doc Comments +13 added lines, -14 removed lines

@@ -196,7 +196,7 @@ 
    * Get current datetime
    *
    * @since  Aug 17 2015
-   * @return object
+   * @return Datium
    */
     public static function now()
     {
@@ -217,7 +217,7 @@ 
    * @param integer $minute minute number
    * @param integer $second second number
    *
-   * @return object
+   * @return Datium
    */
     public static function create(
         $year = 2000,
@@ -257,7 +257,7 @@ 
     * Accecpt Timestamp as Datium initializion
     *
     * @param  timestamp $timestamp Input timestamp value
-    * @return object
+    * @return Datium
     */
     public static function createTimestamp( $timestamp )
     {
@@ -286,7 +286,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)
     {
@@ -332,7 +332,7 @@ 
     *
     * @param object $calendar Assigned calendar to when calendar should start.
     *
-    * @return object
+    * @return Datium
     */
     public function to($calendar)
     {
@@ -386,7 +386,7 @@ 
    *
    * @param string $value How much date should be added to current date
    *
-   * @return object
+   * @return Datium
    */
     public function add($value)
     {
@@ -428,7 +428,7 @@ 
    *
    * @param string $value How much date should increase from current date
    *
-   * @return obejct
+   * @return Datium
    */
     public function sub($value)
     {
@@ -468,9 +468,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()
     {
@@ -484,7 +483,7 @@ 
     /**
     * Calculate how many time ago datetime happens
     *
-    * @return string
+    * @return TimeAgo
     */
     public function ago()
     {
@@ -500,7 +499,7 @@ 
     *
     * @since Aug, 22 2015
     *
-    * @return integer
+    * @return DayOf
     */
     public function dayOf()
     {
@@ -533,7 +532,7 @@ 
     *
     * @since Oct 22, 2015
     *
-    * @return object
+    * @return DateTime
     */
     public function object()
     {
@@ -547,7 +546,7 @@ 
     *
     * @param string $language language short name fa, en, ar ...
     *
-    * @return object
+    * @return Datium
     */
     public function lang($language = 'fa')
     {
@@ -567,7 +566,7 @@ 
     /**
     * Return object as timestamp
     *
-    * @return timestamp
+    * @return integer
     */
     public function timestamp()
     {

Indentation +126 added lines, -126 removed lines

@@ -34,17 +34,17 @@ 
 {
 
     /**
-   * Store DateTime object
-   */
+     * Store DateTime object
+     */
     protected $date_time;
 
     protected static $static_date_time;
 
     /**
-   * Store config file statements
-   *
-   * @param array
-   */
+     * Store config file statements
+     *
+     * @param array
+     */
     protected $config;
 
     protected $date_interval_expression;
@@ -62,10 +62,10 @@ 
     protected $fromConfig;
 
     /**
-   * Return store day number
-   *
-   * @param integer
-   */
+     * Return store day number
+     *
+     * @param integer
+     */
     protected $day_of;
 
     protected $leap;
@@ -93,15 +93,15 @@ 
     protected static $timestamp;
 
     /**
-    * Timeago
-    *
-    * @param integer
-    */
+     * Timeago
+     *
+     * @param integer
+     */
     protected $ago;
 
     /**
-    * Datium class constructure
-    */
+     * Datium class constructure
+     */
     public function __construct()
     {
 
@@ -167,10 +167,10 @@ 
     }
 
     /**
-    * Return all datetime parts as an object
-    *
-    * @return object
-    */
+     * Return all datetime parts as an object
+     *
+     * @return object
+     */
     public function all()
     {
 
@@ -193,11 +193,11 @@ 
     }
 
     /**
-   * Get current datetime
-   *
-   * @since  Aug 17 2015
-   * @return object
-   */
+     * Get current datetime
+     *
+     * @since  Aug 17 2015
+     * @return object
+     */
     public static function now()
     {
 
@@ -208,17 +208,17 @@ 
     }
 
     /**
-   * Create new date time
-   *
-   * @param integer $year   Year number
-   * @param integer $month  month number
-   * @param integer $day    day number
-   * @param integer $hour   hour number
-   * @param integer $minute minute number
-   * @param integer $second second number
-   *
-   * @return object
-   */
+     * Create new date time
+     *
+     * @param integer $year   Year number
+     * @param integer $month  month number
+     * @param integer $day    day number
+     * @param integer $hour   hour number
+     * @param integer $minute minute number
+     * @param integer $second second number
+     *
+     * @return object
+     */
     public static function create(
         $year = 2000,
         $month = 1,
@@ -230,8 +230,8 @@ 
 
 
         /**
-       * When we want to set a Datetime object to Datium
-       */
+         * When we want to set a Datetime object to Datium
+         */
         if (func_num_args() === 1) {
             self::$static_date_time = func_get_arg(0);
 
@@ -254,11 +254,11 @@ 
     }
 
     /**
-    * Accecpt Timestamp as Datium initializion
-    *
-    * @param  timestamp $timestamp Input timestamp value
-    * @return object
-    */
+     * Accecpt Timestamp as Datium initializion
+     *
+     * @param  timestamp $timestamp Input timestamp value
+     * @return object
+     */
     public static function createTimestamp( $timestamp )
     {
 
@@ -281,13 +281,13 @@ 
     }
 
     /**
-    * Select The range between two date object
-    *
-    * @param object $date_start Start of the DateTime
-    * @param object $date_end   End of the DateTime
-    *
-    * @return object
-    */
+     * Select The range between two date object
+     *
+     * @param object $date_start Start of the DateTime
+     * @param object $date_end   End of the DateTime
+     *
+     * @return object
+     */
     public static function between($date_start, $date_end)
     {
 
@@ -302,12 +302,12 @@ 
     }
 
     /**
-   * Convert from current calendar, what type is current calendar?
-   *
-   * @param object $calendar Assigned calendar to start from
-   *
-   * @return $object
-   */
+     * Convert from current calendar, what type is current calendar?
+     *
+     * @param object $calendar Assigned calendar to start from
+     *
+     * @return $object
+     */
     public function from($calendar)
     {
 
@@ -317,8 +317,8 @@ 
 
 
         /**
-     * We need this part for DayOf class
-     */
+         * We need this part for DayOf class
+         */
         $this->calendar_type = $calendar;
 
         $this->translate_to = $calendar;
@@ -328,12 +328,12 @@ 
     }
 
     /**
-    * Convert date to current Date
-    *
-    * @param object $calendar Assigned calendar to when calendar should start.
-    *
-    * @return object
-    */
+     * Convert date to current Date
+     *
+     * @param object $calendar Assigned calendar to when calendar should start.
+     *
+     * @return object
+     */
     public function to($calendar)
     {
 
@@ -342,8 +342,8 @@ 
         $this->date_time = $this->convert->to($calendar);
 
         /**
-     * We need this part for DayOf class
-     */
+         * We need this part for DayOf class
+         */
         $this->calendar_type = $calendar;
 
         $this->translate_to = $calendar;
@@ -353,13 +353,13 @@ 
     }
 
     /**
-   * Difference between two time
-   *
-   * @param DateTime $start Start of the date
-   * @param DateTime $end   End of the date
-   *
-   * @return object
-   */
+     * Difference between two time
+     *
+     * @param DateTime $start Start of the date
+     * @param DateTime $end   End of the date
+     *
+     * @return object
+     */
     public static function diff($start, $end)
     {
 
@@ -382,12 +382,12 @@ 
     }
 
     /**
-   * Add new date value to current date
-   *
-   * @param string $value How much date should be added to current date
-   *
-   * @return object
-   */
+     * Add new date value to current date
+     *
+     * @param string $value How much date should be added to current date
+     *
+     * @return object
+     */
     public function add($value)
     {
 
@@ -424,12 +424,12 @@ 
     }
 
     /**
-   * Sub date from current date
-   *
-   * @param string $value How much date should increase from current date
-   *
-   * @return obejct
-   */
+     * Sub date from current date
+     *
+     * @param string $value How much date should increase from current date
+     *
+     * @return obejct
+     */
     public function sub($value)
     {
 
@@ -466,12 +466,12 @@ 
     }
 
     /**
-   * Check if current year is leap or not
-   *
-   * @param string $type Name of the calendar to caculate leap year
-   *
-   * @return boolean
-   */
+     * Check if current year is leap or not
+     *
+     * @param string $type Name of the calendar to caculate leap year
+     *
+     * @return boolean
+     */
     public function leap()
     {
 
@@ -482,10 +482,10 @@ 
     }
 
     /**
-    * Calculate how many time ago datetime happens
-    *
-    * @return string
-    */
+     * Calculate how many time ago datetime happens
+     *
+     * @return string
+     */
     public function ago()
     {
 
@@ -496,12 +496,12 @@ 
     }
 
     /**
-    * Caculate day of year or week
-    *
-    * @since Aug, 22 2015
-    *
-    * @return integer
-    */
+     * Caculate day of year or week
+     *
+     * @since Aug, 22 2015
+     *
+     * @return integer
+     */
     public function dayOf()
     {
 
@@ -529,12 +529,12 @@ 
     // }
 
     /**
-    * Return Datetime as a original object
-    *
-    * @since Oct 22, 2015
-    *
-    * @return object
-    */
+     * Return Datetime as a original object
+     *
+     * @since Oct 22, 2015
+     *
+     * @return object
+     */
     public function object()
     {
 
@@ -543,12 +543,12 @@ 
     }
 
     /**
-    * Translate current date string to selected language
-    *
-    * @param string $language language short name fa, en, ar ...
-    *
-    * @return object
-    */
+     * Translate current date string to selected language
+     *
+     * @param string $language language short name fa, en, ar ...
+     *
+     * @return object
+     */
     public function lang($language = 'fa')
     {
 
@@ -565,10 +565,10 @@ 
     }
 
     /**
-    * Return object as timestamp
-    *
-    * @return timestamp
-    */
+     * Return object as timestamp
+     *
+     * @return timestamp
+     */
     public function timestamp()
     {
 
@@ -577,14 +577,14 @@ 
     }
 
     /**
-   * Return fainal result
-   *
-   * @param string $format Date format
-   *
-   * @since Aug 17 2015
-   *
-   * @return string
-   */
+     * Return fainal result
+     *
+     * @param string $format Date format
+     *
+     * @since Aug 17 2015
+     *
+     * @return string
+     */
     public function get($format = 'Y-m-d H:i:s')
     {
 
@@ -600,7 +600,7 @@ 
 
         if (is_null($this->toConfig)) {
             $this->toConfig = include 'CalendarSettings/' .
-                                       ucfirst($this->translate_to) . '.php';
+                                        ucfirst($this->translate_to) . '.php';
         }
 
         $string_date = $this->date_time->format($format);

Spacing +36 added lines, -36 removed lines

@@ -113,9 +113,9 @@ 
 
         $this->config = include 'Config.php';
 
-        $this->calendar_type = $this->config[ 'default_calendar' ];
+        $this->calendar_type = $this->config['default_calendar'];
 
-        date_default_timezone_set($this->config[ 'timezone' ]);
+        date_default_timezone_set($this->config['timezone']);
 
         $this->calendar_type = 'gregorian';
 
@@ -126,7 +126,7 @@ 
 
                 $this->date_time = new DateTime();
 
-                $this->date_time->setTimestamp( self::$timestamp );
+                $this->date_time->setTimestamp(self::$timestamp);
 
                 break;
 
@@ -141,15 +141,15 @@ 
                 $this->date_time = new DateTime('now');
 
                 $this->date_time->setDate(
-                    self::$array_date[ 'year' ],
-                    self::$array_date[ 'month' ],
-                    self::$array_date[ 'day' ]
+                    self::$array_date['year'],
+                    self::$array_date['month'],
+                    self::$array_date['day']
                 );
 
                 $this->date_time->setTime(
-                    self::$array_date[ 'hour' ],
-                    self::$array_date[ 'minute' ],
-                    self::$array_date[ 'second' ]
+                    self::$array_date['hour'],
+                    self::$array_date['minute'],
+                    self::$array_date['second']
                 );
 
                 break;
@@ -174,7 +174,7 @@ 
     public function all()
     {
 
-        return ( object ) array(
+        return (object) array(
 
         'second' => $this->date_time->format('s'),
 
@@ -259,10 +259,10 @@ 
     * @param  timestamp $timestamp Input timestamp value
     * @return object
     */
-    public static function createTimestamp( $timestamp )
+    public static function createTimestamp($timestamp)
     {
 
-      if( $timestamp != null && is_int( $timestamp ) )
+      if ($timestamp != null && is_int($timestamp))
       {
 
         self::$call_type = 'create-timestamp';
@@ -392,15 +392,15 @@ 
     {
 
         $this->date_interval_expression = str_replace(
-            $this->config[ 'date_simple' ],
-            $this->config[ 'date_interval' ],
+            $this->config['date_simple'],
+            $this->config['date_interval'],
             $value
         );
 
         $unit = 'P';
 
         if (strpos($this->date_interval_expression, 'T')) {
-            $this->date_interval_expression= str_replace(
+            $this->date_interval_expression = str_replace(
                 'T',
                 '',
                 $this->date_interval_expression
@@ -412,7 +412,7 @@ 
         $this->date_interval_expression = str_replace(
             ' ',
             '',
-            $unit . $this->date_interval_expression
+            $unit.$this->date_interval_expression
         );
 
         $this->date_time->add(
@@ -434,15 +434,15 @@ 
     {
 
         $this->date_interval_expression = str_replace(
-            $this->config[ 'date_simple' ],
-            $this->config[ 'date_interval' ],
+            $this->config['date_simple'],
+            $this->config['date_interval'],
             $value
         );
 
         $unit = 'P';
 
         if (strpos($this->date_interval_expression, 'T')) {
-            $this->date_interval_expression= str_replace(
+            $this->date_interval_expression = str_replace(
                 'T',
                 '',
                 $this->date_interval_expression
@@ -454,7 +454,7 @@ 
         $this->date_interval_expression = str_replace(
             ' ',
             '',
-            $unit . $this->date_interval_expression
+            $unit.$this->date_interval_expression
         );
 
         $this->date_time->sub(
@@ -593,52 +593,52 @@ 
         // $this->translate_to_file = include( 'Lang/' . $this->language . '/general.php' );
 
         if (is_null($this->fromConfig)) {
-            $this->fromConfig = include 'CalendarSettings/' .
-                                ucfirst($this->translate_from) . '.php';
+            $this->fromConfig = include 'CalendarSettings/'.
+                                ucfirst($this->translate_from).'.php';
         }
 
 
         if (is_null($this->toConfig)) {
-            $this->toConfig = include 'CalendarSettings/' .
-                                       ucfirst($this->translate_to) . '.php';
+            $this->toConfig = include 'CalendarSettings/'.
+                                       ucfirst($this->translate_to).'.php';
         }
 
         $string_date = $this->date_time->format($format);
 
         if ($this->translate_to != 'gregorian') {
             $string_date = str_replace(
-                $this->fromConfig[ 'month' ],
-                $this->toConfig[ 'month' ],
+                $this->fromConfig['month'],
+                $this->toConfig['month'],
                 $string_date
             );
 
             $string_date = str_replace(
-                $this->fromConfig[ 'days_of_week' ],
-                $this->toConfig[ 'days_of_week' ][ $this->gregorian_DayofWeek ],
+                $this->fromConfig['days_of_week'],
+                $this->toConfig['days_of_week'][$this->gregorian_DayofWeek],
                 $string_date
             );
 
             $string_date = str_replace(
-                $this->fromConfig[ 'numbers' ],
-                $this->toConfig[ 'numbers' ],
+                $this->fromConfig['numbers'],
+                $this->toConfig['numbers'],
                 $string_date
             );
 
             $string_date = str_replace(
-                $this->fromConfig[ 'am_time' ],
-                $this->toConfig[ 'am_time' ],
+                $this->fromConfig['am_time'],
+                $this->toConfig['am_time'],
                 $string_date
             );
 
             $string_date = str_replace(
-                $this->fromConfig[ 'pm_time' ],
-                $this->toConfig[ 'pm_time' ],
+                $this->fromConfig['pm_time'],
+                $this->toConfig['pm_time'],
                 $string_date
             );
 
             $string_date = str_replace(
-                $this->fromConfig[ 'end_of_days' ],
-                $this->toConfig[ 'end_of_days' ],
+                $this->fromConfig['end_of_days'],
+                $this->toConfig['end_of_days'],
                 $string_date
             );
         }