[10.x] Optional field definitions on model #812
Merged
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.
Check if field definitions has been added on the model and use if that is the case
Reasoning
Search engine would like to have a definition of fields and their type. According to documentation, this is done in a (potentially huge) array in scout config. I propose an optional alternative where you can define the fields alongside your toSearchableArray() method for a searchable model.
This has the benefit of colocation with the properties
I feel this data belongs on the model rather in the global config, just like the toSearchableArray
It opens the option to use php to generate some logic around the schema definition
Consider you want to generate the index with a loop over the toSearchableArray keys detecting the typesense type automatically.
Notes
I propose to replace the field definitions if they are in the model. This ensures there is no breaks with the base approach and the definitions are only used if they are specifically added
I will of course update the documentation accordingly.