README

Mixin that extends Illuminate\Support\Str mainly for Japanese language use

Requirements

• PHP >= 8.3
• Laravel >= 12.0

Versioning

• v1.x is for Laravel 6 only.
• v2.x supports Laravel 7 and above only for Fluent Strings.

Installation

composer require revolution/laravel-str-mixins

Uninstall

composer remove revolution/laravel-str-mixins

Str

Str::textwrap(string $str, int $width = 10, string $break = PHP_EOL): string

Line breaks at specified number of characters. Simple line breaks without word-wrapping rules.

$text = Str::textwrap(str: 'abcde', width: 3);

// abc
// de

Originally intended for forcing line breaks to fit within OGP image width.

Changed to textwrap because Laravel 10.19.0 added a function with the same name Str::wordWrap(). Kept instead of removing because the behavior is different. Str::wordWrap() doesn't work as expected with Japanese text.

Str::kana(string $str, string $option = 'KV', string $encoding = 'UTF-8'): string

Same as mb_convert_kana().

$text = Str::kana(str: 'abｃあいうｱｲｳ', option: 'KVa');

// abcあいうアイウ

Str::truncate(string $str, int $limit = 100, string $end = '...'): string

Str::limit() counts half-width characters as 1 and full-width characters as 2 when truncating. It uses multibyte functions but counts by character width.

$text = Str::limit('abcあいうえお', 7);

// abcあい...

Str::truncate() counts by the number of characters for truncation, which works better for Japanese text.

$text = Str::truncate(str: 'abcあいうえお', limit: 7);

// abcあいうえ...

Fluent Strings

textwrap(int $width = 10, string $break = PHP_EOL): Stringable

$text = Str::of('abcde')->textwrap(width: 3)->value();

// abc
// de

kana(string $option = 'KV', string $encoding = 'UTF-8'): Stringable

$text = Str::of('abｃあいうｱｲｳ')->kana(option: 'KVa')->value();

// abcあいうアイウ

For chaining use:

$text = Str::of('abｃあいうｱｲｳ')->kana(option: 'KVa')->textwrap(3)->value();

// abc
// あいう
// アイウ

truncate(int $limit = 100, string $end = '...'): Stringable

$text = Str::of('abcあいうえお')->truncate(limit: 6, end: '___')->value();

// abcあいう___

LICENSE

MIT