Add support for events, listeners, and dispatchers by JoelAlphonso · Pull Request #64 · charcoalphp/charcoal

JoelAlphonso · 2022-09-12T18:17:11Z

Provide league\event\dispatcher as a pimple container dependency in app package

Changes

Features

app: add event dispatcher provided by league/event (258be3f)
app: add EventDispatcherTrait (01fa79f)
app: add PropertyEvent for Property related events (9588d07)
elfinder: dispatch FileWasUploaded on elfinder upload.presave (85bc7a3)
event: add a base event and a (wip) generic event (c14167e)
event: add a charcoal EventDispatcher which extends League\Event\EventDispatcher to add logging (e18846a)
event: add a FileWasUploaded event (a5ab5c6)
event: add an AbstractEventListener and EventListenerInterface (1025394)
event: Add an event service provider and improve listeners registration (78bf487)
event: add events related to object (8080cb7)
event: add interruptable contract for events which provides events with a mean to interrupt the event chain and provide a reason for it (4c4d5b3)
event: add support for ListenerSubscriber through config files and add AbstractListenerSubscriber.php (84f8911)
object: add an ObjectServiceProvider for object package services (a122ba4)
property-event: add data and fix event const for PropertyEvent (d8ad508)
property: (wip) add EventDispatcherTrait to AbstractProperty (8ad2ce7)
property: dispatch events for pre-save and save event for ImageProperty (2a03032)
proxies: implement static proxies system using the facade model (e9ffdcf)
revision: add properties and propertyBlacklist options for Revisions (baafa78)
revision: add a listener to hook revision generation (6e5155f)
revision: add a revision service to handle all revision related operations (07c37c3)
revision: add RevisionConfig.php to cast revisions config nodes to (e4d2429)
revision: remove revision generation from Content.php (6f561de)
revision: use the revisions service everywhere and refactor it to require setting a model on the service (61c19f3)
translation-parser: add translation-parser script tag to default.admin.config (df684f1)

Bug Fixes

event: fix bad references to event package (3d9c4a2)
event: fix missing renaming (4cc8bf7)
event: rename event services container keys to be prefixed with app/ (a8f639c)
exception: fix missing sprintf context (d69a37b)
image-property: remove event dispatch for property for now (886532b)
psr4: fix some namespacing issues (70a7757)
revision: fix included properties and properties options (ff0bd59)
revisions: fix remaining revisionService renaming (2336a50)
translation-parser: fix paths related problems with translation-parser script (29349dc)

Todo

Update the pull request description to reflect the latest scope.
Update README.md to inclulde charcoal/event.
Remove dependency on charcoal/object from charcoal/app and move registration of RevisionServiceProvider from AppServiceProvider to AdminServiceProvider and the charcoal/boilerplate's service provider.

composer.json

packages/app/README.md

packages/app/src/Charcoal/App/ServiceProvider/AppServiceProvider.php

packages/property/src/Charcoal/Property/Event/PropertyEvent.php

mcaskill

Hard-coded references to the cache and www directories should be replaced with paths in This should use AppConfig.

For the Static Website, the static directory path should be defined from a configuration option (something like static_website.path or whatever matches similar options for Cache, View, and Metadata options).

I'm unfamiliar with the Static Website feature, what's the difference between cache/static and www/static?

packages/admin/src/Charcoal/Admin/Config.php

packages/admin/src/Charcoal/Admin/Script/Translation/TranslateScript.php

packages/app/tests/Charcoal/App/ServiceProvider/FilesystemServiceProviderTest.php

packages/app/src/Charcoal/App/Event/Event.php

packages/app/src/Charcoal/App/Event/AbstractEventListener.php

packages/app/src/Charcoal/App/Event/EventDispatcher.php

packages/app/src/Charcoal/App/Event/FileWasUploaded.php

packages/app/src/Charcoal/App/Event/GenericEvent.php

packages/app/src/Charcoal/App/ServiceProvider/EventServiceProvider.php

packages/app/src/Charcoal/App/Event/AbstractEventListener.php

packages/app/src/Charcoal/App/ServiceProvider/EventServiceProvider.php

packages/event/src/Charcoal/Event/ServiceProvider/EventServiceProvider.php

packages/event/src/Charcoal/Event/GenericEvent.php

packages/event/src/Charcoal/Event/EventDispatcher.php

packages/event/composer.json

packages/event/README.md

mcaskill

For the Object events, should we use Model instead?

packages/event/src/Charcoal/Event/EventDispatcherBuilder.php

packages/event/src/Charcoal/Event/InterruptableEventInterface.php

packages/object/src/Charcoal/Object/GenerateRevisionListener.php

packages/object/src/Charcoal/Object/RevisionsManager.php

packages/admin/src/Charcoal/Admin/Action/ElfinderConnectorAction.php

…nts with a mean to interrupt the event chain and provide a reason for it

…rait

Co-authored-by: Chauncey McAskill <chauncey@locomotive.ca>

- add a simple bootstrapping mechanic - add Facade - add Event Facade

Co-authored-by: Chauncey McAskill <chauncey@locomotive.ca>

…g the app itself

…`app/`

…ions, event and facade

Changed: - Replaced ArrayAccess with Pimple Container as resolver for stricter binding and future transition to PSR-11. - Added missing types `void` and `object` to various methods. - Moved `RuntimeException` if instance is not an object from `__callStatic()` to `resolveFacadeInstance`

Moved anonymous function on "upload.presave" event to a method, `dispatchEventOnUploadPreSave`, for easier customization.

packages/property/src/Charcoal/Property/ImageProperty.php

packages/object/src/Charcoal/Object/RevisionServiceProvider.php

packages/admin/src/Charcoal/Admin/Action/Object/SaveAction.php

packages/admin/src/Charcoal/Admin/Action/Object/UpdateAction.php

Co-authored-by: Xavier Aymond <xavier.aymond@hotmail.fr>

Despite `$pimple` being the correct parameter name [1], using `$container` falls in line with all other occurrences in service providers and elsewhere. The inconsistent parameter can pose problems with PHP 8's named arguments and for static analysis tools like PHPStan and Psalm which will flag this as an error. This can be corrected in a future changeset that replaces all type-hints of Pimple's Container with the PSR-11 Container interface. [1]: https://github.com/silexphp/Pimple/blob/v3.5.0/src/Pimple/ServiceProviderInterface.php#L43 Co-authored-by: Xavier Aymond <xavier.aymond@hotmail.fr>

mcaskill requested changes Sep 12, 2022

View reviewed changes

mcaskill changed the title ~~Pulling joel_feat_event-dispatcher into main~~ Add support for events, listeners, and dispatchers Sep 12, 2022

JoelAlphonso force-pushed the joel_feat_event-dispatcher branch 3 times, most recently from 64b146f to 48006be Compare September 14, 2022 14:56

JoelAlphonso requested review from BeneRoch and mducharme September 14, 2022 15:03

mcaskill requested changes Sep 14, 2022

View reviewed changes

JoelAlphonso force-pushed the joel_feat_event-dispatcher branch from 4981649 to 6e38d70 Compare September 16, 2022 14:00

mcaskill requested changes Sep 20, 2022

View reviewed changes

mcaskill reviewed Sep 22, 2022

View reviewed changes

mcaskill approved these changes Sep 22, 2022

View reviewed changes

JoelAlphonso force-pushed the joel_feat_event-dispatcher branch from e56a5cb to 78b8f03 Compare September 22, 2022 19:43

mcaskill requested changes Sep 22, 2022

View reviewed changes

packages/event/src/Charcoal/Event/EventDispatcherBuilder.php Show resolved Hide resolved

packages/event/src/Charcoal/Event/EventDispatcherBuilder.php Outdated Show resolved Hide resolved

packages/event/src/Charcoal/Event/EventDispatcherBuilder.php Outdated Show resolved Hide resolved

mcaskill approved these changes Sep 23, 2022

View reviewed changes

mcaskill mentioned this pull request Sep 29, 2022

Integrate revisions with event dispatcher #69

Merged

mcaskill requested changes Nov 3, 2022

View reviewed changes

packages/event/src/Charcoal/Event/InterruptableEventInterface.php Outdated Show resolved Hide resolved

mcaskill requested changes Nov 3, 2022

View reviewed changes

JoelAlphonso force-pushed the joel_feat_event-dispatcher branch from 2a4bc4b to ab03bdc Compare November 4, 2022 15:30

mcaskill approved these changes Nov 4, 2022

View reviewed changes

mducharme approved these changes Nov 8, 2022

View reviewed changes

JoelAlphonso force-pushed the joel_feat_event-dispatcher branch from 71430ec to a8f639c Compare November 8, 2022 20:37

mcaskill requested changes Nov 8, 2022

View reviewed changes

packages/admin/src/Charcoal/Admin/Action/ElfinderConnectorAction.php Outdated Show resolved Hide resolved

JoelAlphonso added 6 commits November 11, 2022 15:08

feat(app): add event dispatcher provided by league/event

dbcd400

feat(app): add PropertyEvent for Property related events

af9de97

feat(app): add EventDispatcherTrait

35590ee

feat(property): (wip) add EventDispatcherTrait to AbstractProperty

0ba9b24

docs(event): add event dispatcher documentation

243ae4d

feat(property-event): add data and fix event const for PropertyEvent

2a9a401

JoelAlphonso and others added 19 commits November 11, 2022 15:11

refactor(revision): remove unnecessary exception

2277955

fix(revisions): fix remaining revisionService renaming

3cce5e4

refactor(event): add StoppableEventTrait and refactor Event with it

6915a21

feat(event): add interruptable contract for events which provides eve…

de71935

…nts with a mean to interrupt the event chain and provide a reason for it

refactor(event): move model related events to the core package

2d6f132

refactor(event): move model events dispatch from actions to StorableT…

2e4db81

…rait

docs(revision): add some documentation for the reformed revision system

7d7c47e

Apply suggestions from code review

ad160f4

Co-authored-by: Chauncey McAskill <chauncey@locomotive.ca>

feat(proxies): implement static proxies system using the facade model

5ad2122

- add a simple bootstrapping mechanic - add Facade - add Event Facade

Apply suggestions from code review

2f13ddd

Co-authored-by: Chauncey McAskill <chauncey@locomotive.ca>

refactor(facade): improve facade terminology

bac3557

Apply suggestions from code review

7fa1eb0

Co-authored-by: Chauncey McAskill <chauncey@locomotive.ca>

refactor(facade): make facade abstract

df78a3b

refactor(facade): use the container as resolver instead of the passin…

773938a

…g the app itself

fix(event): fix missing renaming

b48dd17

fix(event): rename event services container keys to be prefixed with …

eb3699b

…`app/`

chore(composer): update composer lock file

e1e57d3

tests(app): fixing phpunit tests failures caused be refactoring revis…

4e3eecd

…ions, event and facade

chore(composer): update composer lock file

d20153e

JoelAlphonso force-pushed the joel_feat_event-dispatcher branch from e62ebff to d20153e Compare November 11, 2022 20:13

JoelAlphonso and others added 3 commits November 11, 2022 15:17

tests(event): add test placeholder

cc2d8c8

refactor(elfinder): Improve FileWasUploaded integration

ff5e12e

Moved anonymous function on "upload.presave" event to a method, `dispatchEventOnUploadPreSave`, for easier customization.