CakeText

class CakeText

CakeText クラスは文字列の作成や走査に関する便利なクラスです。また、スタティックにアクセスすることが可能です。例： CakeText::uuid() 。

Piece of Cake 2 fork

2.7 で非推奨になった String クラスは、 PHP 7 以降 String が予約語であるため削除されました。String:: の呼び出しは CakeText:: に置き換えてください。

もし、 View 以外で TextHelper が必要な場合、 CakeText クラスを使ってください。

class UsersController extends AppController
{
    public $components = ['Auth'];

    public function afterLogin()
    {
        $message = $this->User->find('new_message');
        if (!empty($message)) {
            // 新しいメッセージをユーザへ通知
            $this->Session->setFlash(__('You have a new message: %s', CakeText::truncate($message['Message']['body'], 255, ['html' => true])));
        }
    }
}

Changed in version 2.1

TextHelper のいくつかのメソッドは CakeText クラスへ移動しています。

static CakeText::uuid()

uuid メソッドは、4122 で規定されているようなユニーク ID を生成するために利用します。 UUID とは、485fc381-e790-47a3-9794-1337c0a8fe68 のようなフォーマットの 128 ビットの文字列のことです。

CakeText::uuid(); // 485fc381-e790-47a3-9794-1337c0a8fe68

static CakeText::tokenize($data, $separator = ',', $leftBound = '(', $rightBound = ')')

$separator を利用して文字列をトークン化します。この際に $leftBound と $rightBound の間に現れる $separator は無視します。

このメソッドは、タグリストのような定形フォーマットのデータを分割するのに便利です。

$data = "cakephp 'great framework' php";
$result = CakeText::tokenize($data, ' ', "'", "'");
// 結果
['cakephp', "'great framework'", 'php'];

static CakeText::insert($string, $data, $options = [])

insert メソッドは、テンプレートとキー・バリューの組み合わせから文字列を作成できます。

CakeText::insert('My name is :name and I am :age years old.', ['name' => 'Bob', 'age' => '65']);
// 生成される文字列: "My name is Bob and I am 65 years old."

static CakeText::cleanInsert($string, $options = [])

与えられた $options に 'clean' キーが存在した場合、その指定に従って CakeText::insert をクリーンアップします。デフォルトでは text を利用しますが、html も用意されています。この機能の目的は、 CakeText::insert() では取り除けなかったホワイトスペース、および、プレースホルダー周辺で必要がないマークアップを取り除くことにあります。

オプションは次のように指定します。

$options = [
    'clean' => [
        'method' => 'text', // or html
    ],
    'before' => '',
    'after' => '',
];

static CakeText::wrap($text, $options = [])

テキストのブロックを決められた幅や折り返し、インデントにも対応します。単語の途中で改行されたりしないように、賢く折り返しの処理を行います。

$text = 'This is the song that never ends.';
$result = CakeText::wrap($text, 22);

// 出力
This is the song
that never ends.

どのように折り返し処理を行うか、オプションの配列で指定することができます。サポートされているオプションは次のとおりです。

width 折り返す幅。デフォルトは 72。
wordWrap 単語の途中で折り返すか否かのフラグ。デフォルトは true 。
indent インデントの文字数。デフォルトは '' 。
indentAt インデントを開始する数。デフォルトは 0 。

method CakeText::highlight(string $haystack, string $needle, array $options = [] )

method CakeText::stripLinks($text)

method CakeText::truncate(string $text, int $length=100, array $options)

Changed in version 2.3

ending は、 ellipsis に置き換えられました。 ending は、 2.2.1 まで使用されました。

method CakeText::tail(string $text, int $length=100, array $options)

method CakeText::excerpt(string $haystack, string $needle, integer $radius=100, string $ellipsis="...")

method CakeText::toList(array $list, $and='and')

CakeText ​

CakeText