Implement `findBetween()`, `findBetweenFirst()`, and `findBetweenLast()` Methods #118

salehhashemi1992 · 2023-10-30T09:26:35Z

Implement findBetween(), findBetweenFirst() and findBetweenLast() methods to StringHelper to retrieve a substring that lies between two strings in different scenarios.

findBetween() method retrieves a substring that lies between the first occurrence of a specified start string and the last occurrence of a specified end string in the input string.

Tests are included.

Usage

$htmlContent = "<div class='content'>Hello World</div>";
$content = StringHelper::findBetween($htmlContent, "<div class='content'>", "</div>");

$logData = "INFO: Start --- debug data --- End";
$debugData = StringHelper::findBetween($logData, "Start ---", "--- End");

$htmlData = "<html><body><a href="https://example.com">Link</a></body></html>";
$link= StringHelper::findBetween($htmlData, '<a href="', '">');

findBetweenFirst(): Retrieves the first substring that lies between the specified start and end strings in the input string.
findBetweenLast(): Retrieves the last substring that lies between the specified start and end strings in the input string.

$input = "[a][b][c]";
StringHelper::findBetween($input, "[", "]"); // Output: "a][b][c"
StringHelper::findBetweenFirst($input, "[", "]"); // Output: "a"
StringHelper::findBetweenLast($input, "[", "]"); // Output: "c"

what-the-diff · 2023-10-30T09:27:11Z

PR Summary

New Feature Added to StringHelper Class
A new method called findBetween has been added to the StringHelper class. This function allows the retrieval of a specific portion of a text string based on the first occurrence of a specified starting string and the last occurrence of an indicated ending string thereafter.
Test Case Added for New Feature
To assure the correct functionality of the new findBetween method, a test case named testFindBetween has been created in the StringHelperTest class. This test will validate the method against various inputs and expected results, making sure it works as intended.

codecov · 2023-10-30T09:29:26Z

Codecov Report

All modified and coverable lines are covered by tests ✅

Comparison is base (980a5bc) 99.74% compared to head (24f6bbb) 99.76%.
Report is 1 commits behind head on master.

Additional details and impacted files

@@             Coverage Diff              @@
##             master     #118      +/-   ##
============================================
+ Coverage     99.74%   99.76%   +0.01%     
- Complexity      135      147      +12     
============================================
  Files             7        7              
  Lines           391      424      +33     
============================================
+ Hits            390      423      +33     
  Misses            1        1

Files	Coverage Δ
src/StringHelper.php	`100.00% <100.00%> (ø)`

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

vjik

Looks good 👍

Can you also add new method to readme and add line to changelog?

salehhashemi1992 · 2023-10-31T18:50:24Z

@vjik Done

Tigrov

It looks should be 2 ways to find a string between two strings:

find to the first position.
find to the last last position.

$htmlContent = "<div class='content'>Hello World</div><div class='content'>It's me</div>";
$content = StringHelper::findBetween($htmlContent, "<div class='content'>", "</div>");

What will be the result?

salehhashemi1992 · 2023-11-01T05:58:29Z

It looks should be 2 ways to find a string between two strings:

find to the first position.

find to the last last position.
$htmlContent = "<div class='content'>Hello World</div><div class='content'>It's me</div>";
$content = StringHelper::findBetween($htmlContent, "<div class='content'>", "</div>");
What will be the result?
Duo to the description, it will find the string between the first occurrence of a specified start string and the last occurrence of a specified end string in the input string.
There could be more methods like findBetweenLast and findBetweenFirst that I wanna implement next.
@Tigrov

Tigrov · 2023-11-01T06:39:13Z

It looks should be 2 ways to find a string between two strings:

find to the first position.

find to the last last position.
$htmlContent = "<div class='content'>Hello World</div><div class='content'>It's me</div>";
$content = StringHelper::findBetween($htmlContent, "<div class='content'>", "</div>");
What will be the result?
Duo to the description, it will find the string between the first occurrence of a specified start string and the last occurrence of a specified end string in the input string.
There could be more methods like findBetweenLast and findBetweenFirst that I wanna implement next.
@Tigrov

Seems findBetweenLast() will be the same as the current findBetween()?

My suggestion to implement both methods in one PR to avoid naming problems.

It could be findBetween() for the first found position and findBetweenLast() for the last found position of argument $end.

salehhashemi1992 · 2023-11-01T06:45:36Z

@Tigrov no, they are not the same.
we have three situations:
Consider this: "[a][b][c]"
and the start and end are "[" and "]"

findBetween will return "a][b][c"
findBetweenFirst will return "a"
findBetweenLast will return "c"

src/StringHelper.php

salehhashemi1992 · 2023-11-01T08:56:06Z

@Tigrov Thank you. so I add the two other methods in this PR? or a separate one?

Tigrov · 2023-11-01T09:10:48Z

@Tigrov Thank you. so I add the two other methods in this PR? or a separate one?

👍

Better to add them to this PR to get them together

salehhashemi1992 · 2023-11-01T12:26:18Z

@Tigrov Done

vjik

Also suggest make $end argument optional (?string $end = null) in all new methods. If $end is null, then $end = $start.

CHANGELOG.md

tests/StringHelperTest.php

src/StringHelper.php

CHANGELOG.md

vjik · 2023-11-02T10:15:26Z

@salehhashemi1992 Thank you for PR 👍

salehhashemi1992 force-pushed the feature/string-helper-find-between branch from 533b58d to a0da80e Compare October 30, 2023 09:28

vjik requested changes Oct 31, 2023

View reviewed changes

salehhashemi1992 force-pushed the feature/string-helper-find-between branch from a0da80e to 15c821b Compare October 31, 2023 18:50

salehhashemi1992 requested a review from vjik October 31, 2023 18:50

Tigrov reviewed Nov 1, 2023

View reviewed changes

Tigrov requested changes Nov 1, 2023

View reviewed changes

src/StringHelper.php Outdated Show resolved Hide resolved

Tigrov approved these changes Nov 1, 2023

View reviewed changes

vjik added the status:under development Someone is working on a pull request. label Nov 1, 2023

salehhashemi1992 added 2 commits November 1, 2023 14:58

implement findBetween method in StringHelper

af6886f

refactor findBetween method to remove calling function mb_substr()

c544d77

salehhashemi1992 force-pushed the feature/string-helper-find-between branch from ad29228 to c544d77 Compare November 1, 2023 11:28

salehhashemi1992 changed the title ~~Implement StringHelper::findBetween Method~~ Implement findBetween, findBetweenFirst(), and findBetweenLast() Methods Nov 1, 2023

salehhashemi1992 changed the title ~~Implement findBetween, findBetweenFirst(), and findBetweenLast() Methods~~ Implement findBetween(), findBetweenFirst(), and findBetweenLast() Methods Nov 1, 2023

salehhashemi1992 requested a review from Tigrov November 1, 2023 12:51

vjik requested changes Nov 1, 2023

View reviewed changes

CHANGELOG.md Outdated Show resolved Hide resolved

tests/StringHelperTest.php Show resolved Hide resolved

Tigrov requested changes Nov 2, 2023

View reviewed changes

src/StringHelper.php Outdated Show resolved Hide resolved

Tigrov reviewed Nov 2, 2023

View reviewed changes

src/StringHelper.php Outdated Show resolved Hide resolved

implement findBetweenFirst and findBetweenLast methods

b50d84a

salehhashemi1992 force-pushed the feature/string-helper-find-between branch from 11d4bfd to b50d84a Compare November 2, 2023 07:32

salehhashemi1992 requested review from Tigrov and vjik November 2, 2023 07:39

Tigrov reviewed Nov 2, 2023

View reviewed changes

src/StringHelper.php Show resolved Hide resolved

salehhashemi1992 force-pushed the feature/string-helper-find-between branch from 075d69b to a3329c1 Compare November 2, 2023 09:27

make end nullable in findBetween methods and php doc enhancements

8227316

salehhashemi1992 force-pushed the feature/string-helper-find-between branch from a3329c1 to 8227316 Compare November 2, 2023 09:27

vjik approved these changes Nov 2, 2023

View reviewed changes

CHANGELOG.md Outdated Show resolved Hide resolved

Update CHANGELOG.md

1cbf9d3

vjik reviewed Nov 2, 2023

View reviewed changes

CHANGELOG.md Outdated Show resolved Hide resolved

vjik and others added 2 commits November 2, 2023 13:12

Update CHANGELOG.md

d6f5169

Update CHANGELOG.md

24f6bbb

vjik merged commit 4507541 into yiisoft:master Nov 2, 2023
17 of 19 checks passed

salehhashemi1992 mentioned this pull request Nov 3, 2023

Make $end parameter nullable in findBetween Method yiisoft/yii2#20062

Open

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Implement `findBetween()`, `findBetweenFirst()`, and `findBetweenLast()` Methods #118

Implement `findBetween()`, `findBetweenFirst()`, and `findBetweenLast()` Methods #118

salehhashemi1992 commented Oct 30, 2023 •

edited

Loading

what-the-diff bot commented Oct 30, 2023

codecov bot commented Oct 30, 2023 •

edited

Loading

vjik left a comment

salehhashemi1992 commented Oct 31, 2023

Tigrov left a comment

salehhashemi1992 commented Nov 1, 2023 •

edited

Loading

Tigrov commented Nov 1, 2023

salehhashemi1992 commented Nov 1, 2023 •

edited

Loading

salehhashemi1992 commented Nov 1, 2023

Tigrov commented Nov 1, 2023

salehhashemi1992 commented Nov 1, 2023

vjik left a comment

vjik commented Nov 2, 2023

Implement findBetween(), findBetweenFirst(), and findBetweenLast() Methods #118

Implement findBetween(), findBetweenFirst(), and findBetweenLast() Methods #118

Conversation

salehhashemi1992 commented Oct 30, 2023 • edited Loading

Usage

what-the-diff bot commented Oct 30, 2023

PR Summary

codecov bot commented Oct 30, 2023 • edited Loading

Codecov Report

vjik left a comment

Choose a reason for hiding this comment

salehhashemi1992 commented Oct 31, 2023

Tigrov left a comment

Choose a reason for hiding this comment

salehhashemi1992 commented Nov 1, 2023 • edited Loading

Tigrov commented Nov 1, 2023

salehhashemi1992 commented Nov 1, 2023 • edited Loading

salehhashemi1992 commented Nov 1, 2023

Tigrov commented Nov 1, 2023

salehhashemi1992 commented Nov 1, 2023

vjik left a comment

Choose a reason for hiding this comment

vjik commented Nov 2, 2023

Implement `findBetween()`, `findBetweenFirst()`, and `findBetweenLast()` Methods #118

Implement `findBetween()`, `findBetweenFirst()`, and `findBetweenLast()` Methods #118

salehhashemi1992 commented Oct 30, 2023 •

edited

Loading

codecov bot commented Oct 30, 2023 •

edited

Loading

salehhashemi1992 commented Nov 1, 2023 •

edited

Loading

salehhashemi1992 commented Nov 1, 2023 •

edited

Loading