ayman-mahgoub/compare-engine-tracker

This package used to compare to objects with the same type

dev-master 2020-02-01 23:40 UTC

Requires

• doctrine/annotations: ^1.6

Requires (Dev)

• phpunit/phpunit: ^7

MIT

• Ayman Mahgoub

• annotations
• library
• doctrine
• compareEngineTracker
• compare-engine-tracker

README

• used to Compare properties form the same objects using @PropertyTracker annotation return isChanged (true/false) and changedList if exist.

About

• We build CompareEngineTracker to suitable all php apps that need to keep track changing that happened to two objects (model, entities, documents ...etc).

Installing

• Via Composer

$ composer require ayman-mahgoub/Compare-engine-tracker

Getting Started

• add @propertyTracker annotation above your object property

    /**
    *@propertyTracker
    */
    private $name;

• pass the two models to compareEngineTracker.

     $reader        = new AnnotationReader();
     $compareEngine = new CompareEngineTracker($reader);
     $result        = $compareEngine->compare($oldObject, $newObject);

• result will contain isChanged index hold if the new object is changed or not and changedList index hold every property oldVal and newVal.

Running the tests

$ composer test

please note that

• For now compare works only for two object form the same type.

Contributing

• Please read CONTRIBUTING.md for details on our code of conduct, and the process for submitting pull requests to us.

Authors

• Ayman Mahgoub - Initial work - aymanMahgoub

• See also the list of contributors who participated in this project.

License

• This project is licensed under the MIT License - see the LICENSE.md file for details