├── LICENSE
├── README.md
├── composer.json
└── src
    ├── ChronosServiceProvider.php
    └── Eloquent
        ├── Chronos.php
        ├── Concerns
            ├── ChronosGetPivotClass.php
            ├── ChronosInteractsWithPivotTable.php
            ├── ChronosRelations.php
            └── ChronosTimestamps.php
        ├── Model.php
        └── Relations
            ├── BelongsToMany.php
            ├── MorphPivot.php
            ├── MorphToMany.php
            └── Pivot.php


/LICENSE:
--------------------------------------------------------------------------------
 1 | MIT License
 2 | 
 3 | Copyright (c) 2020 Ricardo Cino
 4 | 
 5 | Permission is hereby granted, free of charge, to any person obtaining a copy
 6 | of this software and associated documentation files (the "Software"), to deal
 7 | in the Software without restriction, including without limitation the rights
 8 | to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 9 | copies of the Software, and to permit persons to whom the Software is
10 | furnished to do so, subject to the following conditions:
11 | 
12 | The above copyright notice and this permission notice shall be included in all
13 | copies or substantial portions of the Software.
14 | 
15 | THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16 | IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17 | FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18 | AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19 | LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20 | OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21 | SOFTWARE.
22 | 


--------------------------------------------------------------------------------
/README.md:
--------------------------------------------------------------------------------
 1 | # Laravel Chronos
 2 | 
 3 | <a href="https://github.com/cino/laravel-chronos/actions"><img src="https://github.com/cino/laravel-chronos/workflows/LaravelChronos/badge.svg" alt="Build Status"></a>
 4 | <a href="https://scrutinizer-ci.com/g/cino/laravel-chronos/?branch=master"><img src="https://scrutinizer-ci.com/g/cino/laravel-chronos/badges/coverage.png?b=master" alt="Code Coverage"></a>
 5 | <a href="https://poser.pugx.org/cino/laravel-chronos/license"><img src="https://poser.pugx.org/cino/laravel-chronos/license" alt="Code Coverage"></a>
 6 | 
 7 | This package is for enabling the usage of Chronos in Laravel, this will not cover all cases but at least gives you Chronos instances in favor of Carbon, most of the time. (You'll see that in the Laravel source there are enough cases where it calls Carbon directly.)
 8 | 
 9 | 
10 | ## Installation
11 | 
12 | The preferred method of installation is via [Composer](). Run the following
13 | command to install the package and add it as a requirement to your project's
14 | `composer.json`:
15 | 
16 | ```bash
17 | composer require cino/laravel-chronos
18 | ```
19 | 
20 | ## Usage
21 | 
22 | There are now 2 options to add this behaviour to your models. Either of the options will override functions to return a Chronos object instead of a Carbon object, the first and preferred option is to use the Chronos trait from \Cino\LaravelChronos\Eloquent\Chronos like below: 
23 | 
24 | ### Trait
25 | ```php
26 | use Cino\LaravelChronos\Eloquent\Chronos;
27 | use Illuminate\Database\Eloquent\Model;
28 | 
29 | class User extends Model
30 | {
31 |     use Chronos;
32 | }
33 | ```
34 | 
35 | ### Extending model
36 | The second option is to change your models to extend the Model class from \Cino\LaravelChronos\Eloquent\Model which actually also uses the trait from above.
37 | 
38 | ```php
39 | 
40 | use Cino\LaravelChronos\Eloquent\Model;
41 | 
42 | class MyModel extends Model
43 | {
44 | 
45 | }
46 | ```
47 | 
48 | ## License
49 | This open-source software is licenced under the [MIT license](LICENSE.md).
50 | 


--------------------------------------------------------------------------------
/composer.json:
--------------------------------------------------------------------------------
 1 | {
 2 |   "name": "cino/laravel-chronos",
 3 |   "description": "Replaces Carbon in Laravel by CakePHP's Chronos library",
 4 |   "type": "library",
 5 |   "license": "MIT",
 6 |   "keywords": [
 7 |     "laravel",
 8 |     "lumen",
 9 |     "eloquent",
10 |     "chronos",
11 |     "carbon",
12 |     "carbon-replacement",
13 |     "date"
14 |   ],
15 |   "authors": [
16 |     {
17 |       "name": "Ricardo Cino",
18 |       "homepage": "https://github.com/cino"
19 |     }
20 |   ],
21 |   "support": {
22 |     "issues": "https://github.com/cino/laravel-chronos/issues",
23 |     "source": "https://github.com/cino/laravel-chronos"
24 |   },
25 |   "require": {
26 |     "php": "^7.2",
27 |     "illuminate/database": "6.* || 7.*",
28 |     "illuminate/support": "6.* || 7.*",
29 |     "cakephp/chronos": "1.* || 2.*"
30 |   },
31 |   "autoload": {
32 |     "psr-4": {
33 |       "Cino\\LaravelChronos\\": "src/"
34 |     }
35 |   },
36 |   "autoload-dev": {
37 |     "psr-4": {
38 |       "Cino\\LaravelChronos\\Tests\\": "tests/"
39 |     }
40 |   },
41 |   "config": {
42 |     "sort-packages": true
43 |   },
44 |   "extra": {
45 |     "laravel": {
46 |       "providers": [
47 |         "\\Cino\\LaravelChronos\\ChronosServiceProvider"
48 |       ]
49 |     }
50 |   },
51 |   "minimum-stability": "stable",
52 |   "require-dev": {
53 |     "mockery/mockery": "^1.3",
54 |     "phpunit/phpunit": "^8.4 || ^9.0"
55 |   }
56 | }
57 | 


--------------------------------------------------------------------------------
/src/ChronosServiceProvider.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace Cino\LaravelChronos;
 4 | 
 5 | use Cake\Chronos\Chronos;
 6 | use Illuminate\Support\Facades\Date;
 7 | use Illuminate\Support\ServiceProvider;
 8 | 
 9 | class ChronosServiceProvider extends ServiceProvider
10 | {
11 |     public function register()
12 |     {
13 |         Date::use(Chronos::class);
14 |     }
15 | }
16 | 


--------------------------------------------------------------------------------
/src/Eloquent/Chronos.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace Cino\LaravelChronos\Eloquent;
 4 | 
 5 | use Cino\LaravelChronos\Eloquent\Concerns\ChronosRelations;
 6 | use Cino\LaravelChronos\Eloquent\Concerns\ChronosTimestamps;
 7 | use Cino\LaravelChronos\Eloquent\Relations\Pivot;
 8 | use Illuminate\Database\Eloquent\Model as BaseModel;
 9 | use Illuminate\Support\Collection;
10 | 
11 | /**
12 |  * @mixin \Illuminate\Database\Eloquent\Model
13 |  */
14 | trait Chronos
15 | {
16 |     use ChronosRelations;
17 |     use ChronosTimestamps;
18 | 
19 |     /**
20 |      * Create a new pivot model instance.
21 |      *
22 |      * @param \Illuminate\Database\Eloquent\Model $parent
23 |      * @param array $attributes
24 |      * @param string $table
25 |      * @param bool $exists
26 |      * @param string|null $using
27 |      * @return \Cino\LaravelChronos\Eloquent\Relations\Pivot
28 |      */
29 |     public function newPivot(BaseModel $parent, array $attributes, $table, $exists, $using = null)
30 |     {
31 |         return $using ? $using::fromRawAttributes($parent, $attributes, $table, $exists)
32 |             : Pivot::fromAttributes($parent, $attributes, $table, $exists);
33 |     }
34 | 
35 |     /**
36 |      * Reload the current model instance with fresh attributes from the database.
37 |      *
38 |      * @return \Illuminate\Database\Eloquent\Model
39 |      */
40 |     public function refresh()
41 |     {
42 |         if (!$this->exists) {
43 |             return $this;
44 |         }
45 | 
46 |         $this->setRawAttributes(
47 |             static::newQueryWithoutScopes()->findOrFail($this->getKey())->attributes
48 |         );
49 | 
50 |         $this->load(Collection::make($this->relations)->reject(function ($relation) {
51 |             return $relation instanceof Pivot;
52 |         })->keys()->all());
53 | 
54 |         $this->syncOriginal();
55 | 
56 |         return $this;
57 |     }
58 | }
59 | 


--------------------------------------------------------------------------------
/src/Eloquent/Concerns/ChronosGetPivotClass.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace Cino\LaravelChronos\Eloquent\Concerns;
 4 | 
 5 | use Cino\LaravelChronos\Eloquent\Relations\Pivot;
 6 | 
 7 | trait ChronosGetPivotClass
 8 | {
 9 |     /**
10 |      * Get the class being used for pivot models.
11 |      *
12 |      * @return string
13 |      */
14 |     public function getPivotClass()
15 |     {
16 |         return $this->using ?? Pivot::class;
17 |     }
18 | }
19 | 


--------------------------------------------------------------------------------
/src/Eloquent/Concerns/ChronosInteractsWithPivotTable.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace Cino\LaravelChronos\Eloquent\Concerns;
 4 | 
 5 | use Illuminate\Database\Eloquent\Relations\Pivot;
 6 | 
 7 | trait ChronosInteractsWithPivotTable
 8 | {
 9 |     /**
10 |      * Get the pivot models that are currently attached.
11 |      *
12 |      * @return \Illuminate\Support\Collection
13 |      */
14 |     protected function getCurrentlyAttachedPivots()
15 |     {
16 |         return $this->newPivotQuery()->get()->map(function ($record) {
17 |             $class = $this->using ? $this->using : Pivot::class;
18 | 
19 |             $pivot = $class::fromRawAttributes($this->parent, (array)$record, $this->getTable(), true);
20 | 
21 |             return $pivot->setPivotKeys($this->foreignPivotKey, $this->relatedPivotKey);
22 |         });
23 |     }
24 | }
25 | 


--------------------------------------------------------------------------------
/src/Eloquent/Concerns/ChronosRelations.php:
--------------------------------------------------------------------------------
  1 | <?php
  2 | 
  3 | namespace Cino\LaravelChronos\Eloquent\Concerns;
  4 | 
  5 | use Cino\LaravelChronos\Eloquent\Relations\BelongsToMany;
  6 | use Cino\LaravelChronos\Eloquent\Relations\MorphToMany;
  7 | use Illuminate\Database\Eloquent\Builder;
  8 | use Illuminate\Database\Eloquent\Model;
  9 | 
 10 | trait ChronosRelations
 11 | {
 12 |     /**
 13 |      * Define a many-to-many relationship.
 14 |      *
 15 |      * @param string $related
 16 |      * @param string|null $table
 17 |      * @param string|null $foreignPivotKey
 18 |      * @param string|null $relatedPivotKey
 19 |      * @param string|null $parentKey
 20 |      * @param string|null $relatedKey
 21 |      * @param string|null $relation
 22 |      * @return \Cino\LaravelChronos\Eloquent\Relations\BelongsToMany
 23 |      */
 24 |     public function belongsToMany(
 25 |         $related,
 26 |         $table = null,
 27 |         $foreignPivotKey = null,
 28 |         $relatedPivotKey = null,
 29 |         $parentKey = null,
 30 |         $relatedKey = null,
 31 |         $relation = null
 32 |     ) {
 33 |         return parent::belongsToMany(...func_get_args());
 34 |     }
 35 | 
 36 |     /**
 37 |      * Define a polymorphic many-to-many relationship.
 38 |      *
 39 |      * @param string $related
 40 |      * @param string $name
 41 |      * @param string|null $table
 42 |      * @param string|null $foreignPivotKey
 43 |      * @param string|null $relatedPivotKey
 44 |      * @param string|null $parentKey
 45 |      * @param string|null $relatedKey
 46 |      * @param bool $inverse
 47 |      * @return \Cino\LaravelChronos\Eloquent\Relations\MorphToMany
 48 |      */
 49 |     public function morphToMany(
 50 |         $related,
 51 |         $name,
 52 |         $table = null,
 53 |         $foreignPivotKey = null,
 54 |         $relatedPivotKey = null,
 55 |         $parentKey = null,
 56 |         $relatedKey = null,
 57 |         $inverse = false
 58 |     ) {
 59 |         return parent::morphToMany(...func_get_args());
 60 |     }
 61 | 
 62 |     /**
 63 |      * Define a polymorphic, inverse many-to-many relationship.
 64 |      *
 65 |      * @param string $related
 66 |      * @param string $name
 67 |      * @param string|null $table
 68 |      * @param string|null $foreignPivotKey
 69 |      * @param string|null $relatedPivotKey
 70 |      * @param string|null $parentKey
 71 |      * @param string|null $relatedKey
 72 |      * @return \Cino\LaravelChronos\Eloquent\Relations\MorphToMany
 73 |      */
 74 |     public function morphedByMany(
 75 |         $related,
 76 |         $name,
 77 |         $table = null,
 78 |         $foreignPivotKey = null,
 79 |         $relatedPivotKey = null,
 80 |         $parentKey = null,
 81 |         $relatedKey = null
 82 |     ) {
 83 |         return parent::morphedByMany(...func_get_args());
 84 |     }
 85 | 
 86 |     /**
 87 |      * Instantiate a new BelongsToMany relationship.
 88 |      *
 89 |      * @param \Illuminate\Database\Eloquent\Builder $query
 90 |      * @param \Illuminate\Database\Eloquent\Model $parent
 91 |      * @param string $table
 92 |      * @param string $foreignPivotKey
 93 |      * @param string $relatedPivotKey
 94 |      * @param string $parentKey
 95 |      * @param string $relatedKey
 96 |      * @param string|null $relationName
 97 |      * @return \Cino\LaravelChronos\Eloquent\Relations\BelongsToMany
 98 |      */
 99 |     protected function newBelongsToMany(
100 |         Builder $query,
101 |         Model $parent,
102 |         $table,
103 |         $foreignPivotKey,
104 |         $relatedPivotKey,
105 |         $parentKey,
106 |         $relatedKey,
107 |         $relationName = null
108 |     ) {
109 |         return new BelongsToMany($query, $parent, $table, $foreignPivotKey, $relatedPivotKey, $parentKey, $relatedKey,
110 |             $relationName);
111 |     }
112 | 
113 |     /**
114 |      * Instantiate a new MorphToMany relationship.
115 |      *
116 |      * @param \Illuminate\Database\Eloquent\Builder $query
117 |      * @param \Illuminate\Database\Eloquent\Model $parent
118 |      * @param string $name
119 |      * @param string $table
120 |      * @param string $foreignPivotKey
121 |      * @param string $relatedPivotKey
122 |      * @param string $parentKey
123 |      * @param string $relatedKey
124 |      * @param string|null $relationName
125 |      * @param bool $inverse
126 |      * @return \Cino\LaravelChronos\Eloquent\Relations\MorphToMany
127 |      */
128 |     protected function newMorphToMany(
129 |         Builder $query,
130 |         Model $parent,
131 |         $name,
132 |         $table,
133 |         $foreignPivotKey,
134 |         $relatedPivotKey,
135 |         $parentKey,
136 |         $relatedKey,
137 |         $relationName = null,
138 |         $inverse = false
139 |     ) {
140 |         return new MorphToMany($query, $parent, $name, $table, $foreignPivotKey, $relatedPivotKey, $parentKey,
141 |             $relatedKey,
142 |             $relationName, $inverse);
143 |     }
144 | 
145 | }
146 | 


--------------------------------------------------------------------------------
/src/Eloquent/Concerns/ChronosTimestamps.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace Cino\LaravelChronos\Eloquent\Concerns;
 4 | 
 5 | use Cake\Chronos\Chronos;
 6 | use Cake\Chronos\ChronosInterface;
 7 | use DateTimeInterface;
 8 | 
 9 | trait ChronosTimestamps
10 | {
11 |     /**
12 |      * Return a timestamp as DateTime object with time set to 00:00:00.
13 |      *
14 |      * @param mixed $value
15 |      * @return \Cake\Chronos\Chronos
16 |      */
17 |     protected function asDate($value)
18 |     {
19 |         return $this->asDateTime($value)->startOfDay();
20 |     }
21 | 
22 |     /**
23 |      * Return a timestamp as DateTime object.
24 |      *
25 |      * @param mixed $value
26 |      * @return \Cake\Chronos\Chronos
27 |      */
28 |     public function asDateTime($value)
29 |     {
30 |         // If this value is already a Chronos instance, we shall just return it as is.
31 |         // This prevents us having to re-instantiate a Chronos instance when we know
32 |         // it already is one, which wouldn't be fulfilled by the DateTime check.
33 |         if ($value instanceof ChronosInterface) {
34 |             return $value;
35 |         }
36 | 
37 |         // If the value is already a DateTime instance, we will just skip the rest of
38 |         // these checks since they will be a waste of time, and hinder performance
39 |         // when checking the field. We will just return the DateTime right away.
40 |         if ($value instanceof DateTimeInterface) {
41 |             return Chronos::instance($value);
42 |         }
43 | 
44 |         // If this value is an integer, we will assume it is a UNIX timestamp's value
45 |         // and format a Carbon object from this timestamp. This allows flexibility
46 |         // when defining your date fields as they might be UNIX timestamps here.
47 |         if (is_numeric($value)) {
48 |             return Chronos::createFromTimestamp($value);
49 |         }
50 | 
51 |         // If the value is in simply year, month, day format, we will instantiate the
52 |         // Chronos instances from that format. Again, this provides for simple date
53 |         // fields on the database.
54 |         if ($this->isStandardDateFormat($value)) {
55 |             return Chronos::createFromFormat('Y-m-d', $value)->startOfDay();
56 |         }
57 | 
58 |         // If everything else try parsing.
59 |         return Chronos::parse($value);
60 |     }
61 | 
62 |     /**
63 |      * @return \Cake\Chronos\Chronos
64 |      */
65 |     public function freshTimestamp()
66 |     {
67 |         return new Chronos;
68 |     }
69 | }
70 | 


--------------------------------------------------------------------------------
/src/Eloquent/Model.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace Cino\LaravelChronos\Eloquent;
 4 | 
 5 | use Illuminate\Database\Eloquent\Model as BaseModel;
 6 | 
 7 | abstract class Model extends BaseModel
 8 | {
 9 |     use Chronos;
10 | }
11 | 


--------------------------------------------------------------------------------
/src/Eloquent/Relations/BelongsToMany.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace Cino\LaravelChronos\Eloquent\Relations;
 4 | 
 5 | use Cino\LaravelChronos\Eloquent\Concerns\ChronosGetPivotClass;
 6 | use Cino\LaravelChronos\Eloquent\Concerns\ChronosInteractsWithPivotTable;
 7 | use Illuminate\Database\Eloquent\Relations\BelongsToMany as BaseBelongsToMany;
 8 | 
 9 | class BelongsToMany extends BaseBelongsToMany
10 | {
11 |     use ChronosGetPivotClass;
12 |     use ChronosInteractsWithPivotTable;
13 | }
14 | 


--------------------------------------------------------------------------------
/src/Eloquent/Relations/MorphPivot.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace Cino\LaravelChronos\Eloquent\Relations;
 4 | 
 5 | use Cino\LaravelChronos\Eloquent\Concerns\ChronosTimestamps;
 6 | use Illuminate\Database\Eloquent\Relations\MorphPivot as BaseMorphPivot;
 7 | 
 8 | class MorphPivot extends BaseMorphPivot
 9 | {
10 |     use ChronosTimestamps;
11 | }
12 | 


--------------------------------------------------------------------------------
/src/Eloquent/Relations/MorphToMany.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace Cino\LaravelChronos\Eloquent\Relations;
 4 | 
 5 | use Cino\LaravelChronos\Eloquent\Concerns\ChronosGetPivotClass;
 6 | use Cino\LaravelChronos\Eloquent\Concerns\ChronosRelations;
 7 | use Illuminate\Database\Eloquent\Relations\MorphToMany as BaseMorphToMany;
 8 | 
 9 | class MorphToMany extends BaseMorphToMany
10 | {
11 |     use ChronosGetPivotClass;
12 |     use ChronosRelations;
13 | 
14 |     /**
15 |      * Create a new pivot model instance.
16 |      *
17 |      * @param array $attributes
18 |      * @param bool $exists
19 |      * @return \Cino\LaravelChronos\Eloquent\Relations\MorphPivot
20 |      */
21 |     public function newPivot(array $attributes = [], $exists = false)
22 |     {
23 |         $using = $this->using;
24 | 
25 |         $pivot = $using
26 |             ? $using::fromRawAttributes($this->parent, $attributes, $this->table, $exists)
27 |             : MorphPivot::fromAttributes($this->parent, $attributes, $this->table, $exists);
28 | 
29 |         $pivot->setPivotKeys($this->foreignPivotKey, $this->relatedPivotKey)
30 |             ->setMorphType($this->morphType)
31 |             ->setMorphClass($this->morphClass);
32 | 
33 |         return $pivot;
34 |     }
35 | }
36 | 


--------------------------------------------------------------------------------
/src/Eloquent/Relations/Pivot.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace Cino\LaravelChronos\Eloquent\Relations;
 4 | 
 5 | use Cino\LaravelChronos\Eloquent\Concerns\ChronosTimestamps;
 6 | use Illuminate\Database\Eloquent\Relations\Pivot as BasePivot;
 7 | 
 8 | class Pivot extends BasePivot
 9 | {
10 |     use ChronosTimestamps;
11 | }
12 | 


--------------------------------------------------------------------------------