Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/vasekpurchart/doctrine-date-time-immutable-types-bundle
Bundle integration of Doctrine DateTimeImmutable types for Symfony
https://github.com/vasekpurchart/doctrine-date-time-immutable-types-bundle
Last synced: 22 days ago
JSON representation
Bundle integration of Doctrine DateTimeImmutable types for Symfony
- Host: GitHub
- URL: https://github.com/vasekpurchart/doctrine-date-time-immutable-types-bundle
- Owner: VasekPurchart
- License: other
- Created: 2015-06-17T20:17:19.000Z (over 9 years ago)
- Default Branch: master
- Last Pushed: 2023-04-24T22:58:14.000Z (over 1 year ago)
- Last Synced: 2024-09-17T15:27:54.855Z (about 2 months ago)
- Language: PHP
- Size: 68.4 KB
- Stars: 10
- Watchers: 2
- Forks: 3
- Open Issues: 2
-
Metadata Files:
- Readme: readme.md
- License: license.md
Awesome Lists containing this project
README
Doctrine DateTimeImmutable Types Bundle
=======================================
> In [Doctrine DBAL 2.6](https://github.com/doctrine/dbal/releases/tag/v2.6.0) immutable DateTime types were added, so this bundle no longer uses [custom DateTime types implementation](https://github.com/VasekPurchart/Doctrine-Date-Time-Immutable-Types), but rather offers control, how the immutable types are registered, offering the possibility to replace the original DateTime types.
> If you cannot upgrade to Doctrine DBAL 2.6 use [1.0 version](https://github.com/VasekPurchart/Doctrine-Date-Time-Immutable-Types-Bundle/tree/1.0) of this bundle, which uses the [`vasek-purchart/doctrine-date-time-immutable-types`](https://github.com/VasekPurchart/Doctrine-Date-Time-Immutable-Types) custom DateTime types implementation.
### Why would I want to use immutable types?
All Doctrine date/time based types are using `DateTime` instances, which are mutable. This can lead to breaking encapsulation and therefore bugs. For two reasons:
1) You accidentally modify a date when you are doing some computation on it:
```php
createdDate;
}
}
```
```php
getCreatedDate()); // 2015-01-01 00:00:00
$logRow->getCreatedDate()->modify('+14 days');
var_dump($logRow->getCreatedDate()); // 2015-01-15 00:00:00
```
2) Or you *do* intentionally try to update it, which fails because Doctrine will not see this:
```php
getRenewDate()->modify('+1 year');
$entityManager->persist($product);
// no updates will be fired because Doctrine could not detect change
// (objects are compared by identity)
$entityManager->flush();
```
You can prevent this behaviour by returning a new instance (cloning) or using [`DateTimeImmutable`](http://php.net/manual/en/class.datetimeimmutable.php) (which returns a new instance when modified).
Configuration
-------------
Configuration structure with listed default values:
```yaml
# app/config/config.yml
doctrine_date_time_immutable_types:
# Choose under which names the types will be registered.
register: add # One of "add"; "replace"
```
`register`
* `add` - add types as new - suffixed with `_immutable` (e.g. `datetime_immutable`) - this is already done by DBAL from version 2.6
* `replace` - replace the original types `date`, `time`, `datetime`, `datetimetz`, i.e. making them immutable
Usage
-----
If you are using the `replace` option, you don't need to change any property mappings of your entities.
If you are using the `add` option (default), you only have to suffix your field types with `_immutable`:
```php
createdDate;
}
}
```
```php
getCreatedDate()); // 2015-01-01 00:00:00
$logRow->getCreatedDate()->modify('+14 days');
var_dump($logRow->getCreatedDate()); // 2015-01-01 00:00:00
```
Installation
------------
Install package [`vasek-purchart/doctrine-date-time-immutable-types-bundle`](https://packagist.org/packages/vasek-purchart/doctrine-date-time-immutable-types-bundle) with [Composer](https://getcomposer.org/):
```
composer require vasek-purchart/doctrine-date-time-immutable-types-bundle
```
Register the bundle in your application kernel:
```php
// app/AppKernel.php
public function registerBundles()
{
return array(
// ...
new VasekPurchart\DoctrineDateTimeImmutableTypesBundle\DoctrineDateTimeImmutableTypesBundle(),
);
}
```