Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/dsentker/doctrinewatcher
Allows to track changes on doctrine entities with an easy-to-use and highly customizable API.
https://github.com/dsentker/doctrinewatcher
change-detector change-tracker doctrine-extension doctrine-orm doctrine2 entity-component
Last synced: 2 months ago
JSON representation
Allows to track changes on doctrine entities with an easy-to-use and highly customizable API.
- Host: GitHub
- URL: https://github.com/dsentker/doctrinewatcher
- Owner: dsentker
- License: mit
- Created: 2017-09-07T14:49:13.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2023-10-06T12:58:09.000Z (about 1 year ago)
- Last Synced: 2024-10-08T13:31:49.220Z (3 months ago)
- Topics: change-detector, change-tracker, doctrine-extension, doctrine-orm, doctrine2, entity-component
- Language: PHP
- Homepage: https://dsentker.github.io/WatcherDocumentation/
- Size: 304 KB
- Stars: 4
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
# Watcher
[]()
[]()
[]()
**Allows to track changes on doctrine entities with an easy-to-use and highly customizable API.**
## Documentation
[View Documentation](https://dsentker.github.io/WatcherDocumentation/)
## Quick example
You can use this library to track changes to Doctrine Entities. Use annotations to define the fields that you want to monitor. They determine where the changes are to be saved.
```php
// User Entity class
/**
* @Column(type="string")
* @WatchedField // <-- Watcher now tracks changes related to this field
*/
protected string $emailAddress;
```
***
```php
/**
* @var $dbParams array
* @var $config Configuration
*/
$em = EntityManager::create($dbParams, $config, Watcher::createEventManager(new DatabaseHandler()));
Watcher::registerAnnotations();
/** @var $user User */
$user = $em->getRepository(User::class)->find(1);
$user->setUsername("A new username");
$em->persist($user);
$em->flush();
/** @var EntityLogRepository $logRepo */
$logRepo = $em->getRepository(EntityLog::class);
/** @var EntityLog[] $changes */
$changes = $logRepo->getLogsFromEntity($user);
$lastChange = $changes[0];
echo vsprintf("Last updated at (%s): Changed %s from '%s' to '%s'", [
$lastChange->getChangedAt()->format('Y-m-d'),
$lastChange->getFieldLabel(),
$lastChange->getOldValue(),
$lastChange->getNewValue(),
]); // Last updated at 2017-09-07: Changed Email Address from '[email protected]' to '[email protected]'
```
## Symfony4 services.yaml integration (example)
```yaml
watcher.db_handler:
class: App\Utils\AppWatcherHandler #your handler, e.g. Database Handler
autowire: true
Watcher\EventListener\FlushListener:
calls:
- method: pushUpdateHandler
arguments:
- '@watcher.db_handler'
- method: setAnnotationReader
arguments:
- '@annotations.reader'
tags:
- { name: doctrine.event_listener, event: onFlush }
Watcher\EventListener\LoadListener:
arguments:
- 'App\Entity\EntityLog' # The entity which relates to EntityLogRepository
tags:
- { name: doctrine.event_listener, event: postLoad }
```
## Known Limitations
* This package is able to track changes on single fields and associations (collections), but depends
on the concept of Doctrine, [which is limited to track changes on fields on the **owning side**](http://docs.doctrine-project.org/projects/doctrine-orm/en/latest/reference/unitofwork-associations.html). That means, that inverse side associations (`@OneToMany`) are NOT supported. `@ManyToMany` and `@ManyToOne` associations _are_ supported.
* Also consider the overhead. If you've chosen the DatabaseHandler, each tracked entity change results in a single database request.
## Testing
TBD (support is appreciated!)
## Credits
* [Daniel Sentker](https://github.com/dsentker)
## Submitting bugs and feature requests
Bugs and feature request are tracked on GitHub.
## ToDo
* Use interfaces for everything
* Easy Symfony integration
* Write tests
* Optimize performance (group changes?)
## External Libraries
This library depends on Doctrine (surprise!) and subpackages.
## Copyright and license
_Watcher_ is licensed for use under the MIT License (MIT). Please see LICENSE for more information.