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

Jump to bottom

Document the Str::subsrReplace() and Str::of($string)->substrReplace() methods #7563

Merged
merged 4 commits into from
Jan 10, 2022
Merged

Document the Str::subsrReplace() and Str::of($string)->substrReplace() methods #7563

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
c11cb0a
Document Str::substrReplace() methods
ralphjsmit Jan 8, 2022
b6f9453
Update index
ralphjsmit Jan 8, 2022
062fb5f
Remove a black line too much
ralphjsmit Jan 8, 2022
1d1077e
Update helpers.md
taylorotwell Jan 10, 2022
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
30 changes: 30 additions & 0 deletions helpers.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -132,6 +132,7 @@ Laravel includes a variety of global "helper" PHP functions. Many of these funct
[Str::studly](#method-studly-case)
[Str::substr](#method-str-substr)
[Str::substrCount](#method-str-substrcount)
[Str::substrReplace](#method-str-substrreplace)
[Str::title](#method-title-case)
[Str::toHtmlString](#method-to-html-string)
[Str::ucfirst](#method-str-ucfirst)
Expand Down Expand Up @@ -199,6 +200,7 @@ Laravel includes a variety of global "helper" PHP functions. Many of these funct
[startsWith](#method-fluent-str-starts-with)
[studly](#method-fluent-str-studly)
[substr](#method-fluent-str-substr)
[substrReplace](#method-fluent-str-substrreplace)
[tap](#method-fluent-str-tap)
[test](#method-fluent-str-test)
[title](#method-fluent-str-title)
Expand Down Expand Up @@ -1697,6 +1699,19 @@ The `Str::substrCount` method returns the number of occurrences of a given value

// 2

<a name="method-str-substrreplace"></a>
#### `Str::substrReplace()` {.collection-method}

The `Str::substrReplace` method replaces text within a portion of a string, starting at the position specified by the third argument and replacing the number of characters specified by the fourth argument. Passing `0` to the method's fourth argument will insert the string at the specified position without replacing any of the existing characters in the string:

use Illuminate\Support\Str;

$result = Str::substrReplace('1300', ':', 2);
// 13:

$result = Str::substrReplace('1300', ':', 2, 0);
// 13:00

<a name="method-title-case"></a>
#### `Str::title()` {.collection-method}

Expand Down Expand Up @@ -2506,6 +2521,21 @@ The `substr` method returns the portion of the string specified by the given sta

// Frame

<a name="method-fluent-str-substrreplace"></a>
#### `substrReplace` {.collection-method}

The `substrReplace` method replaces text within a portion of a string, starting at the position specified by the third argument and replacing the number of characters specified by the fourth argument. Passing `0` to the method's fourth argument will insert the string at the specified position without replacing any of the existing characters in the string:

use Illuminate\Support\Str;

$string = Str::of('1300')->substrReplace(':', 2);

// 13:

$string = Str::of('The Framework')->substrReplace(' Laravel', 3, 0);

// The Laravel Framework

<a name="method-fluent-str-tap"></a>
#### `tap` {.collection-method}

Expand Down