Update package to more modern standards - #36
Open
Rocksheep wants to merge 16 commits into
Open
Conversation
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.
Description
The package needed some more love. So I made it adhere to the max phpstan level. I already discovered some strange magic which happened on the background which could result in errors when the package was not used properly.
I have added an interface for the code to be connected to. The model must now use the
Indexableinterface and after that must implement it's own methods for indexation and searching of data or they can use theHasIndexationtrait to add the default methods which were in theIndexabletrait before.The values in the config are now checked properly and can no longer result in errors when using wrong types. This results in having the title and content weights to actually be floats in the config.
limit-resultscan also no longer benull. Using a limit of0will now result in "infinite" results.Motivation and context
As stated I wanted to bring the package to more modern standards. There is still a lot which can be done to improve the package, but now it should be easier to do that.
How has this been tested?
I have tested this with a copy of one of the websites I worked on. I did a side by side comparison of the indexation and searching of content.
Screenshots (if appropriate)
Types of changes
What types of changes does your code introduce? Put an
xin all the boxes that apply:Checklist:
Go over all the following points, and put an
xin all the boxes that apply.Please, please, please, don't send your pull request until all of the boxes are ticked. Once your pull request is created, it will trigger a build on our continuous integration server to make sure your tests and code style pass.
If you're unsure about any of these, don't hesitate to ask. We're here to help!