よく使用される 15 個の Laravel コレクション (コレクション)

Laravel Eloquent は通常、多くの便利で強力なメソッドを含むコレクションを結果として返します。コレクションを簡単にフィルタリングおよび変更できます。このチュートリアルでは、コレクションの一般的なメソッドと関数を見てみましょう。
コレクションは雄弁に限定されず、単独で使用することもできます。しかし、Eloquent の結果はコレクションです。ヘルパー関数 collect を使用して、配列をコレクションに変換できます。以下に挙げる収集方法は、雄弁な結果と収集自体の両方に適用されます。

Post モデルがあるとします。 php カテゴリのすべての投稿が見つかりました。

$posts = App\Post::where('category', 'php')->get();

上記のコマンドはコレクションを返します。 Collectionは、内部で配列関数を使用し、それらに多くの機能を追加するlaravelクラスです。

次のように、collect メソッドを使用してコレクションを簡単に作成できます。

$collection = collect([
    [
        'user_id' => '1',
        'title' => 'Helpers in Laravel',
        'content' => 'Create custom helpers in Laravel',
        'category' => 'php'
    ],
    [
        'user_id' => '2',
        'title' => 'Testing in Laravel',
        'content' => 'Testing File Uploads in Laravel',
        'category' => 'php'
    ],
    [
        'user_id' => '3',
        'title' => 'Telegram Bot',
        'content' => 'Crypto Telegram Bot in Laravel',
        'category' => 'php'
    ],
]);

上記の配列は、実際には Post モデルの値です。このチュートリアルでは、簡略化のためにこの配列を使用します。すべては同じように雄弁に基づいていることを忘れないでください。

雄弁なコレクションに対してヘルパー メソッドを使用すると、データベースが再度クエリされることはありません。まずデータベースからすべての結果を取得し、次に収集メソッドを使用して、データベースにクエリを実行せずに結果をフィルタリングおよび変更します。

filter()

filter は、laravel の最も便利なコレクション メソッドの 1 つであり、コールバックを使用してコレクションをフィルタリングできます。 true を返す項目のみを渡します。他の項目はすべて削除されます。 filter 元のインスタンスを変更せずに新しいインスタンスを返します。コールバックの 2 つのパラメーターとして value と key を受け入れます。

$filter = $collection->filter(function($value, $key) {
    if ($value['user_id'] == 2) {
        return true;
    }
});

$filter->all();

all メソッドは基になる配列を返します。上記のコードは次の応答を返します。

[
    1 => [
        "user_id" => 2,
        "title" => "Testing in Laravel",
        "content" => "Testing File Uploads in Laravel",
        "category" => "php"
    ]
]

search()

search メソッドは、指定された値を使用してコレクションを検索します。値がコレクション内にある場合は、対応するキーが返されます。対応する値と一致するデータ項目がない場合は、false が返されます。

$names = collect(['Alex', 'John', 'Jason', 'Martyn', 'Hanlin']);

$names->search('Jason');

// 2

search メソッドは、デフォルトで緩い比較を使用します。 2 番目のパラメータに true を渡すと、厳密な比較を使用できます。

独自のコールバック関数を search メソッドに渡すこともできます。コールバックの真偽テストに合格した最初の項目のキーを返します。

$names = collect(['Alex', 'John', 'Jason', 'Martyn', 'Hanlin']);

$names->search(function($value, $key) {
    return strlen($value) == 6;
});

// 3

chunk()

chunk メソッドは、コレクションを指定されたサイズの複数の小さなコレクションに分割します。コレクションをグリッドに表示するのに非常に便利です。

$prices = collect([18, 23, 65, 36, 97, 43, 81]);

$prices = $prices->chunk(3);

$prices->toArray();

上記のコードはエフェクトを生成します。

[
    0 => [
        0 => 18,
        1 => 23,
        2 => 65
    ],
    1 => [
        3 => 36,
        4 => 97,
        5 => 43
    ],
    2 => [
        6 => 81
    ]
]

dump()

dump コレクションを出力するメソッド。これは、任意の場所にあるコレクション内のコンテンツのデバッグや検索に使用できます。

$collection->whereIn('user_id', [1, 2])
    ->dump()
    ->where('user_id', 1);

dump 上記のコードの結果。

map()

map メソッドは、コレクション全体を走査するために使用されます。コールバックをパラメータとして受け取ります。 value と key がコールバックに渡されます。コールバックは値を変更して返すことができます。最後に、変更された項目の新しいコレクション インスタンスが返されます。

$changed = $collection->map(function ($value, $key) {
    $value['user_id'] += 1;
    return $value;
});

return $changed->all();

基本的には、user_id を 1 ずつ増やします。

上記のコードに対する応答は次のとおりです。

[
    [
        "user_id" => 2,
        "title" => "Helpers in Laravel",
        "content" => "Create custom helpers in Laravel",
        "category" => "php"
    ],
    [
        "user_id" => 3,
        "title" => "Testing in Laravel",
        "content" => "Testing File Uploads in Laravel",
        "category" => "php"
    ],
    [
        "user_id" => 4,
        "title" => "Telegram Bot",
        "content" => "Crypto Telegram Bot in Laravel",
        "category" => "php"
    ]
];

zip()

Zip メソッドは、指定された配列の値をコレクションの値とマージします。同じインデックスを持つ値は一緒に追加されます。これは、配列の最初の値がコレクションの最初の値とマージされることを意味します。ここでは、上で作成したコレクションを使用します。これは Eloquent コレクションでも機能します。

$zipped = $collection->zip([1, 2, 3]);

$zipped->all();

JSON 応答は次のようになります。

つまり、基本的にはそれだけです。配列の長さがコレクションの長さより短い場合、Laravel は Collection 型の残りの要素の末尾に null を追加します。同様に、配列の長さがコレクションの長さより大きい場合、Laravel は null を型 Collection の要素に追加し、その後に配列値を追加します。

whereNotIn()

whereNotIn メソッドを使用すると、指定された配列に含まれないキー値によってコレクションを単純にフィルターできます。基本的に whereIn の逆です。さらに、このメソッドは値を照合するときに緩和比較 == を使用します。

user_id が 1 でも 2 でもない $collection をフィルタリングしましょう。

$collection->whereNotIn('user_id', [1, 2]);

上記のステートメントは、$collection の最後の項目のみを返します。最初のパラメータはキーで、2 番目のパラメータは値の配列です。 eloquent の場合、最初のパラメータは列の名前になり、2 番目のパラメータは値の配列になります。

max()

max メソッドは、指定されたキーの最大値を返します。 max を呼び出すと、最大の user_id を見つけることができます。通常、価格やその他の数値の比較に使用されますが、デモの目的で user_id を使用してみましょう。文字列でも使用できます (この場合は Z> a)。

$collection->max('user_id');

上面的语句将返回最大的 user_id，在我们的例子中是 3。

pluck()

pluck 方法返回指定键的所有值。 它对于提取一列的值很有用。

$title = $collection->pluck('title');
$title->all();

结果看起来像这样。

[
  "Helpers in Laravel",
  "Testing in Laravel",
  "Telegram Bot"
]

使用 eloquent 时，可以将列名作为参数传递以提取值。 pluck 也接受第二个参数，对于 eloquent 的集合，它可以是另一个列名。 它将导致由第二个参数的值作为键的集合。

$title = $collection->pluck('user_id', 'title');
$title->all();

结果如下：

[
    "Helpers in Laravel" => 1,
    "Testing in Laravel" => 2,
    "Telegram Bot" => 3
]

each()

each 是一种迭代整个集合的简单方法。 它接受一个带有两个参数的回调：它正在迭代的项和键。 Key 是基于 0 的索引。

$collection->each(function ($item, $key) {
    info($item['user_id']);
});

上面代码，只是记录每个项的 user_id。

在迭代 eloquent 集合时，您可以将所有列值作为项属性进行访问。 以下是我们如何迭代所有帖子。

$posts = App\Post::all();

$posts->each(function ($item, $key) {
    // Do something
});

如果回调中返回 false，它将停止迭代项目。

$collection->each(function ($item, $key) {
    // Tasks
    if ($key == 1) {
        return false;
    }
});

tap()

tap() 方法允许你随时加入集合。 它接受回调并传递并将集合传递给它。 您可以对项目执行任何操作，而无需更改集合本身。 因此，您可以在任何时候使用tap来加入集合，而不会改变集合。

$collection->whereNotIn('user_id', 3)
    ->tap(function ($collection) {
        $collection = $collection->where('user_id', 1);
        info($collection->values());
    })
    ->all();

在上面使用的 tap 方法中，我们修改了集合，然后记录了值。 您可以对 tap 中的集合做任何您想做的事情。 上面命令的响应是：

[
    [
        "user_id" => "1",
        "title" => "Helpers in Laravel",
        "content" => "Create custom helpers in Laravel",
        "category" => "php"
    ],
    [
        "user_id" => "2",
        "title" => "Testing in Laravel",
        "content" => "Testing File Uploads in Laravel",
        "category" => "php"
    ]
]

你可以看到 tap 不会修改集合实例。

pipe()

pipe 方法非常类似于 tap 方法，因为它们都在集合管道中使用。 pipe 方法将集合传递给回调并返回结果。

$collection->pipe(function($collection) {
    return $collection->min('user_id');
});

上述命令的响应是 1。 如果从 pipe回调中返回集合实例，也可以链接其他方法。

contains()

contains 方法只检查集合是否包含给定值。 只传递一个参数时才会出现这种情况。

$contains = collect(['country' => 'USA', 'state' => 'NY']);

$contains->contains('USA');
// true

$contains->contains('UK');
// false

如果将 键 / 值 对传递给 contains 方法，它将检查给定的键值对是否存在。

$collection->contains('user_id', '1');
// true

$collection->contains('title', 'Not Found Title');
// false

您还可以将回调作为参数传递给回调方法。 将对集合中的每个项目运行回调，如果其中任何一个项目通过了真值测试，它将返回 true 否则返回 false。

$collection->contains(function ($value, $key) {
    return strlen($value['title']) <p>回调函数接受当前迭代项和键的两个参数值。 这里我们只是检查标题的长度是否小于13。在 <code>Telegram Bot</code> 中它是12，所以它返回 <code>true</code>。</p><h2 id="forget">forget()</h2><p><code>forget</code> 只是从集合中删除该项。 您只需传递一个键，它就会从集合中删除该项目。</p><pre class="brush:php;toolbar:false">$forget = collect(['country' => 'usa', 'state' => 'ny']);

$forget->forget('country')->all();

上面代码响应如下：

[
    "state" => "ny"
]

forget 不适用于多维数组。

avg()

avg 方法返回平均值。 你只需传递一个键作为参数，avg 方法返回平均值。 你也可以使用 average 方法，它基本上是 avg 的别名。

$avg = collect([
    ['shoes' => 10],
    ['shoes' => 35],
    ['shoes' => 7],
    ['shoes' => 68],
])->avg('shoes');

上面的代码返回 30 ，这是所有四个数字的平均值。 如果你没有将任何键传递给avg 方法并且所有项都是数字，它将返回所有数字的平均值。 如果键未作为参数传递且集合包含键/值对，则 avg 方法返回 0。

$avg = collect([12, 32, 54, 92, 37]);

$avg->avg();

上面的代码返回 45.4，这是所有五个数字的平均值。

您可以使用这些 laravel 集合方法在您自己的项目中处理集合。

更多Laravel相关技术文章，请访问Laravel教程栏目进行学习！

以上がよく使用される 15 個の Laravel コレクション (コレクション)の詳細内容です。詳細については、PHP 中国語 Web サイトの他の関連記事を参照してください。