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

DOCSP-42818: wherelike and wherenotlike docs #3114

Merged
merged 5 commits into from
Aug 26, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
12 changes: 12 additions & 0 deletions docs/includes/query-builder/QueryBuilderTest.php
Original file line number Diff line number Diff line change
Expand Up @@ -374,6 +374,18 @@ public function testWhereRegex(): void
$this->assertInstanceOf(\Illuminate\Support\Collection::class, $result);
}

public function testWhereLike(): void
{
// begin query whereLike
$result = DB::connection('mongodb')
->table('movies')
->whereLike('title', 'Start%', true)
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Note: this is causing the test to fail because the feature (#3108 ) is not merged yet

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

#3108 is merged.

->get();
// end query whereLike

$this->assertInstanceOf(\Illuminate\Support\Collection::class, $result);
}

public function testWhereRaw(): void
{
// begin query raw
Expand Down
5 changes: 5 additions & 0 deletions docs/includes/query-builder/sample_mflix.movies.json
Original file line number Diff line number Diff line change
Expand Up @@ -148,6 +148,11 @@
}
}
},
{
"runtime": 120,
"directors": ["Alan Pakula"],
"title": "Starting Over"
},
{
"genres": ["Crime", "Drama"],
"runtime": 119,
Expand Down
36 changes: 36 additions & 0 deletions docs/query-builder.txt
Original file line number Diff line number Diff line change
Expand Up @@ -381,6 +381,42 @@ wildcard characters:
...
]

whereLike() and whereNotLike() Methods
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

The following methods provide the same functionality as using the
:ref:`like <laravel-query-builder-pattern>` query operator to match
patterns:

- ``whereLike()``: Matches a specified pattern. By default, this method
performs a case-insensitive match. You can enable case-sensitivity by
passing ``true`` as the last parameter to the method.
- ``whereNotLike()``: Matches documents in which the field
value does not contain the specified string pattern.

The following example shows how to use the ``whereLike()`` method to
match documents in which the ``title`` field has a value that matches the
pattern ``'Start%'`` with case-sensitivity enabled:

.. io-code-block::
:copyable: true

.. input:: /includes/query-builder/QueryBuilderTest.php
:language: php
:dedent:
:start-after: begin query whereLike
:end-before: end query whereLike

.. output::
:language: json
:visible: false

[
{ "title": "Start-Up", ... },
{ "title": "Start the Revolution Without Me", ... },
...
]

.. _laravel-query-builder-distinct:

Retrieve Distinct Values
Expand Down
Loading