Laravel Eloquent renvoie généralement une collection en conséquence, et la collection contient de nombreuses méthodes utiles et puissantes. Vous pouvez facilement filtrer et modifier la collection. Dans ce didacticiel, examinons les méthodes et fonctions courantes des collections.
Les collections ne se limitent pas à l'éloquence et peuvent également être utilisées individuellement. Mais le résultat d’Eloquent est une collection. Vous pouvez utiliser la fonction d'assistance collect
pour convertir un tableau en collection. Les méthodes de collecte énumérées ci-dessous s'appliquent à la fois aux résultats éloquents et à la collection elle-même.
Disons que vous avez un modèle de poste. Vous retrouvez tous les posts dans la catégorie php
.
$posts = App\Post::where('category', 'php')->get();
La commande ci-dessus renvoie une collection. Collection est une classe Laravel qui utilise des fonctions de tableau en interne et leur ajoute de nombreuses fonctionnalités.
Vous pouvez simplement créer une collection en utilisant la méthode collect
, comme suit :
$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' ], ]);
Le tableau ci-dessus est en fait la valeur du modèle Post. Dans ce tutoriel, nous utiliserons ce tableau à des fins de simplification. N'oubliez pas que tout sera basé sur l'éloquence de la même manière.
Lorsque nous utilisons des méthodes d'assistance sur la collection éloquente, la base de données n'est plus interrogée. Nous voulons d'abord obtenir tous les résultats de la base de données, puis nous utilisons des méthodes de collecte pour les filtrer et les modifier sans interroger la base de données.
filter, l'une des méthodes de collecte Laravel les plus utiles, vous permet de filtrer la collection à l'aide de rappels. Il ne transmet que les éléments qui renvoient vrai. Tous les autres éléments sont supprimés. filter
Renvoie une nouvelle instance sans modifier l'instance d'origine. Il accepte value
et key
comme deux paramètres dans le rappel. La méthode
$filter = $collection->filter(function($value, $key) { if ($value['user_id'] == 2) { return true; } }); $filter->all();
all
renvoie le tableau sous-jacent. Le code ci-dessus renvoie la réponse suivante. La méthode
[ 1 => [ "user_id" => 2, "title" => "Testing in Laravel", "content" => "Testing File Uploads in Laravel", "category" => "php" ] ]
search
peut rechercher une collection avec une valeur donnée. Si la valeur est dans la collection, la clé correspondante sera renvoyée. Si aucun élément de données ne correspond à la valeur correspondante, false
sera renvoyé. La méthode
$names = collect(['Alex', 'John', 'Jason', 'Martyn', 'Hanlin']); $names->search('Jason'); // 2
search
utilise une comparaison lâche par défaut. Vous pouvez utiliser une comparaison stricte en passant true
dans son deuxième paramètre.
Vous pouvez également transmettre votre propre fonction de rappel à la méthode search
. Renvoie la clé du premier élément qui réussit le test de vérité du rappel. La méthode
$names = collect(['Alex', 'John', 'Jason', 'Martyn', 'Hanlin']); $names->search(function($value, $key) { return strlen($value) == 6; }); // 3
chunk
divise une collection en plusieurs collections plus petites d'une taille donnée. Très utile pour afficher les collections dans une grille.
$prices = collect([18, 23, 65, 36, 97, 43, 81]); $prices = $prices->chunk(3); $prices->toArray();
Le code ci-dessus génère l'effet.
[ 0 => [ 0 => 18, 1 => 23, 2 => 65 ], 1 => [ 3 => 36, 4 => 97, 5 => 43 ], 2 => [ 6 => 81 ] ]
dump
Méthode pour imprimer une collection. Il peut être utilisé pour déboguer et rechercher du contenu dans une collection à n’importe quel emplacement.
$collection->whereIn('user_id', [1, 2]) ->dump() ->where('user_id', 1);
dump
Le résultat du code ci-dessus. La méthode
map
est utilisée pour parcourir toute la collection. Il accepte le rappel comme paramètre. value
et key
sont transmis au rappel. Les rappels peuvent modifier les valeurs et les renvoyer. Enfin, une nouvelle instance de collection de l'élément modifié est renvoyée.
$changed = $collection->map(function ($value, $key) { $value['user_id'] += 1; return $value; }); return $changed->all();
En gros, ça va augmenter user_id
de 1.
La réponse au code ci-dessus est affichée ci-dessous.
[ [ "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" ] ];
La méthode Zip fusionne les valeurs du tableau donné avec les valeurs de la collection. Les valeurs avec le même indice sont additionnées, ce qui signifie que la première valeur du tableau est fusionnée avec la première valeur de la collection. Ici, je vais utiliser la collection que nous venons de créer ci-dessus. Cela fonctionne également pour les collections Eloquent.
$zipped = $collection->zip([1, 2, 3]); $zipped->all();
La réponse JSON ressemblera à ceci.
Donc, c'est essentiellement ça. Si la longueur du tableau est inférieure à la longueur de la collection, Laravel ajoutera Collection
à la fin des éléments de type null
restants. De même, si la longueur du tableau est supérieure à la longueur de la collection, Laravel ajoutera Collection
aux éléments de type null
, suivi de la valeur du tableau.
Vous pouvez utiliser la méthode whereNotIn
pour filtrer simplement la collection par valeurs clés qui ne sont pas contenues dans le tableau donné. C'est fondamentalement le contraire de whereIn
. De plus, cette méthode utilise des comparaisons détendues ==
lors de la mise en correspondance des valeurs.
Filtrons $collection
où user_id
n'est ni 1
ni 2
.
$collection->whereNotIn('user_id', [1, 2]);
L'instruction ci-dessus ne renverra que le dernier élément de $collection
. Le premier paramètre est la clé et le deuxième paramètre est le tableau de valeurs. Dans le cas d'éloquent, le premier paramètre sera le nom de la colonne et le deuxième paramètre sera un tableau de valeurs. La méthode
max
renvoie la valeur maximale pour une clé donnée. Vous pouvez trouver le plus grand user_id
en appelant max. Il est généralement utilisé pour des comparaisons comme les prix ou tout autre chiffre, mais par souci de démonstration, utilisons user_id
. Il peut également être utilisé avec des cordes, dans ce cas, Z> a
.
$collection->max('user_id');
上面的语句将返回最大的 user_id
,在我们的例子中是 3
。
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
是一种迭代整个集合的简单方法。 它接受一个带有两个参数的回调:它正在迭代的项和键。 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来加入集合,而不会改变集合。
$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
方法非常类似于 tap
方法,因为它们都在集合管道中使用。 pipe
方法将集合传递给回调并返回结果。
$collection->pipe(function($collection) { return $collection->min('user_id'); });
上述命令的响应是 1
。 如果从 pipe
回调中返回集合实例,也可以链接其他方法。
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>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
方法返回平均值。 你也可以使用 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教程栏目进行学习!
Ce qui précède est le contenu détaillé de. pour plus d'informations, suivez d'autres articles connexes sur le site Web de PHP en chinois!