Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update package to more modern standards #36

Open
wants to merge 16 commits into
base: master
Choose a base branch
from

Conversation

Rocksheep
Copy link

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 Indexable interface and after that must implement it's own methods for indexation and searching of data or they can use the HasIndexation trait to add the default methods which were in the Indexable trait 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-results can also no longer be null. Using a limit of 0 will 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 x in all the boxes that apply:

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to change)

Checklist:

Go over all the following points, and put an x in 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.

  • I have read the CONTRIBUTING document.
  • My pull request addresses exactly one patch/feature.
  • I have created a branch for this patch/feature.
  • Each individual commit in the pull request is meaningful.
  • I have added tests to cover my changes.
  • If my change requires a change to the documentation, I have updated it accordingly.

If you're unsure about any of these, don't hesitate to ask. We're here to help!

@Rocksheep Rocksheep self-assigned this Nov 15, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant