Add initially and finally lifecycle hooks to Filters + Update Stub Generation#33
Merged
Add initially and finally lifecycle hooks to Filters + Update Stub Generation#33
initially and finally lifecycle hooks to Filters + Update Stub Generation#33Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
This PR introduces two protected methods within the Filterable class:
initially(): Executes before any filters are applied, allowing pre-filter modifications to the query builder.finally(): Executes after all filters are applied, allowing post-filter adjustments or cleanup.These hooks provide users with simple lifecycle entry points without the need for implementing an interface.
🧱 Stub Update
When generating a new filter via the CLI command, the stub now includes the
initiallyandfinallymethods by default:This ensures developers are aware of the available lifecycle hooks and can easily customize pre/post filtering behavior.
💡 Example
✅ Changes
initiallyandfinallylifecycle hooks toFilterableclass.initiallyandfinallymethods.🧪 Testing
Added unit tests to verify:
initiallyis executed before filters are applied.finallyis executed after all filters are applied.The
initiallymethod runs before applying filters, andfinallyruns right after.