docs: add detailed explanation about paginate()
and beforeFind
model event
#9618
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.
Description
This PR adds a note explaining the potential inconsistency when using the
Model::paginate()
method in combination with thebeforeFind
event. It aims to help prevent confusion whenpaginate()
is used alongside query-modifying events.Resolving this issue is non-trivial, as it would require a careful redesign of the pagination logic or parts of the model to ensure consistent behavior across both data retrieval and counting queries.
Due to this complexity, we are not applying a framework-level fix at this time. Instead, this note provides clear guidance so that developers are aware of the behavior and can plan accordingly.
This note will remain in place to support users until a long-term solution is identified and adopted.
Closes #9617
Checklist: