https://github.com/tishotm/eloquent-ci-relations
Eloquent Case Insensitive Relations
https://github.com/tishotm/eloquent-ci-relations
case-insensitive eloquent
Last synced: 6 months ago
JSON representation
Eloquent Case Insensitive Relations
- Host: GitHub
- URL: https://github.com/tishotm/eloquent-ci-relations
- Owner: TishoTM
- License: mit
- Created: 2019-06-12T04:32:21.000Z (about 7 years ago)
- Default Branch: master
- Last Pushed: 2025-05-30T11:17:03.000Z (about 1 year ago)
- Last Synced: 2025-10-20T00:12:49.168Z (9 months ago)
- Topics: case-insensitive, eloquent
- Language: PHP
- Homepage:
- Size: 52.7 KB
- Stars: 6
- Watchers: 1
- Forks: 6
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Eloquent case-insensitive relations
Using Eloquent out of the box on case-insensitive collation databases could potentially return incomplete collection of items
if the foreign keys are set as strings and they differ in terms of uppercase vs lowercase.
On eager loaded relations Eloquent builds a dictionary of the parent models and associates their related models by their keys.
PHP is case-sensitive and therefore if the keys are different, then some of the related models will not be returned.
This package simply normalizes the dictionary keys into lowercase.
Example:
**Items table**
| uuid | name |
| --- | --- |
| aaa | First |
| bbb | Second |
| ccc | Third |
**Tags table**
| id | label |
| --- | --- |
| 1 | tag 1 |
| 2 | tag 2 |
| 3 | tag 3 |
**item_tag table**
| item_uuid | tag_id |
| --- | --- |
| AAA | 1 |
| aaa | 2 |
| bbb | 3 |
`Item::with('tags')->find('aaa');`
The related tags would include only the "tag 2" even if the the DB collation is case-insensitive and the returned query data includes "tag 1".
**With case insensitive relations:** The related tags would include both "tag 1" and "tag 2".
## Requirements
- illuminate/database 5.5.33 and up, 5.6.\*, 5.7.\*, 5.8.\*, 6.20.26 and up, 7.30.4, 8.40.0 an up
## Installation
`composer require tishotm/eloquent-ci-relations`
## Usage
```PHP
use Illuminate\Database\Eloquent\Model;
class Item extends Model
{
use \TishoTM\Eloquent\Concerns\HasCiRelationships;
// ... relations
}
```
## License
[MIT license](https://opensource.org/licenses/MIT).