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.

Sign up for GitHub

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 docs for whereJsonOverlaps and correct behaviour of whereJsonContains #1547

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Update docs for whereJsonOverlaps and correct behaviour of whereJsonContains #1547

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 14 additions & 2 deletions content/collections/docs/content-queries.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -310,20 +310,32 @@ Entry::query()
->get();
```

Or can pass an array of values. This will match if any of the values are found in the field.
Or can pass an array of values. This will match if **all** of the values are found in the field.

```php
Entry::query()
->whereJsonContains('my_array_field->sub_field', ['statamic', 'is', 'rad']) // [tl! ~~]
->get();
```

You can use `whereJsonDoesntContain()` to query the absence of a value or values in a JSON array:
If you want to check for **any** value being present, use whereJsonOverlaps.

```php
Entry::query()
->whereJsonOverlaps('my_array_field->sub_field', ['statamic', 'is', 'rad']) // [tl! ~~]
->get();
```

You can use `whereJsonDoesntContain()` and `whereJsonDoesntOverlap()` to query the absence of a value or values in a JSON array:

```php
Entry::query()
->whereJsonDoesntContain('my_array_field->sub_field', 'statamic') // [tl! ~~]
->get();

Entry::query()
->whereJsonDoesntOverlap('my_array_field->sub_field', 'statamic') // [tl! ~~]
->get();
```

You can use whereJsonLength method to query JSON arrays by their length:
Expand Down