- Added release notes.

- Added new documentation for Release [0.1.4]

Author: calvinalkan

CHANGELOG.md

@@ -0,0 +1,25 @@
+# Release Notes
+
+## [0.1.5](https://github.com/calvinalkan/better-wordpress-hooks/compare/0.1.4...0.1.5)
+
+### Added
+
+- Added release notes. 
+- Added new documentation for Release [0.1.4](#014httpsgithubcomcalvinalkanbetter-wordpress-hookscompare013014)
+
+## [0.1.4](https://github.com/calvinalkan/better-wordpress-hooks/compare/0.1.3...0.1.4)
+
+### Added
+
+- Smart default values - You can now typehint the return value on your event's `default()` method. If the typehint does not match with the filtered value the default() method will get called with the original and filtered value. ([Commit](https://github.com/calvinalkan/better-wordpress-hooks/commit/8d564babae2f448f607ceb1aea73edae487d2bfc#diff-6f76b222b1d42b154e0ca5f9cca9c766227cb56a75f7bff262e412a5f85a9378R182))
+- It's now possible to resolve mapped events from the service container ([Commit](https://github.com/calvinalkan/better-wordpress-hooks/commit/3b48f0b7951c28e1f1c8ff7ce94ce7e842e89ef6)). See example under [Bootstrapping](https://github.com/calvinalkan/better-wordpress-hooks/blob/master/README.md#bootstrapping).
+
+### Changed
+- It's now possible to dispatch event objects without having to pass an empty array for events without constructor arguments.([Commit](https://github.com/calvinalkan/better-wordpress-hooks/commit/6165c5b3b0c810839fa02c43ebec87e78d91c6f1))
+- the default() method now receives the original payload, and the filtered value. ([Commit](https://github.com/calvinalkan/better-wordpress-hooks/commit/8d564babae2f448f607ceb1aea73edae487d2bfc))
+
+### Fixed
+
+- Some docblocks mistakes that led to false positive errors in code editors.
+- Logic error. Removed code that attempted to map several custom events to a WordPress Hook.
+This should have never been possible. Only one custom event should be mapped to a WordPress Hook.

README.md

@@ -271,23 +271,21 @@ AcmeEvents::make($custom_container_adapter);
 **3. Map core and 3rd party hooks to custom event objects ( optional but recommended )**.
 
 All that this does is dispatching your custom event object when the WP Hooks is fired. We'll see why we do this in a
-minute.
+minute. By default, mapped events are not resolved from the service container as they should only be data classes. 
+However, if you pass `'resolve'` as the first key your mapped event will be resolved from the container and dispatched afterwards. 
 
 ```php
 $mapped = [
 
-'init' => [
+// Will fire on priority 10
+'init' =>  RegisterJobListingPostType::class,
 
-    RegisterJobListingPostType::class,
-    
-    // more events
-], 
-
-'save_post_job_listing' => [
+// Will fire on priority 99
+'save_post_job_listing' => [JobListingCreated::class, 99],
 
-    JobListingCreated::class
-    
-]
+// Will be resolved from the service container
+// and fire on priority 99.
+'booking_created' => ['resolve' ,BookingCreated::class, 99],
 
 ];
 
@@ -698,6 +696,43 @@ Default return values are evaluated in the following order:
 
 3. If #1 and #2 are not possible the first parameter passed into the ````dispatch()```` method will be returned.
 
+#### Return values for invalid callback
+
+A common pain point when offering filters is that users don't respect the API of your filter and return incompatible values. 
+If you are using object events you can typehint the expected return value on the `default()` method. 
+If the value returned from a filter is either:
+1. The same as the original payload or
+2. NOT of the same type as the typehint on `default()` the filtered value will be discarded, and your event`s default method will be called with both the payload, and the filtered value, giving you the option to fix things. 
+
+**Example**
+````php
+class MyEvent extends AcmeEvents {
+
+    public function default($original_payload, $filtered_value) :array {
+    
+          return [$filtered_value];  
+            
+    }
+
+}
+````
+Assuming a third party developer would hook into your filter like this:
+```php
+add_filter(MyEvent::class, function ( $event ) {
+    return 'foo';
+});
+```
+
+```php
+$value = MyEvent::dispatch();
+
+// without array typehint $value = 'foo', whoops.
+$do_stuff = $value[0];
+
+// with typehint on default()
+// $value = ['foo'];
+```
+
 ***
 
 ### Valid Listeners

src/Mappers/WordpressEventMapper.php

@@ -26,7 +26,9 @@ class WordpressEventMapper implements EventMapper {
          */
         private $container;
 
-        /** @var Dispatcher */
+        /**
+         * @var Dispatcher
+         */
         private $dispatcher;
 
         public function __construct( ContainerAdapter $container, Dispatcher $dispatcher, WordpressApi $wp_api = null ) {