Fünfzehn häufig verwendete Laravel-Sammlungen (Sammlung)

Laravel Eloquent gibt als Ergebnis normalerweise eine Sammlung zurück, und die Sammlung enthält viele nützliche und leistungsstarke Methoden. Sie können die Sammlung einfach filtern und ändern. Werfen wir in diesem Tutorial einen Blick auf die gängigen Methoden und Funktionen von Sammlungen.
Sammlungen sind nicht auf eloquente beschränkt und können auch einzeln verwendet werden. Aber das Ergebnis von Eloquent ist eine Sammlung. Mit der Hilfsfunktion collect können Sie ein Array in eine Sammlung umwandeln. Die unten aufgeführten Erhebungsmethoden gelten sowohl für aussagekräftige Ergebnisse als auch für die Erhebung selbst.

Angenommen, Sie haben ein Post-Modell. Alle Beiträge finden Sie in der Kategorie php.

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

Der obige Befehl gibt eine Sammlung zurück. Collection ist eine Laravel-Klasse, die intern Array-Funktionen verwendet und ihnen viele Funktionalitäten hinzufügt.

Sie können einfach eine Sammlung mit der Methode collect wie folgt erstellen:

$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'
    ],
]);

Das Array oben ist eigentlich der Wert des Post-Modells. In diesem Tutorial verwenden wir dieses Array zur Vereinfachung. Denken Sie daran, dass alles auf die gleiche Weise auf Eloquent basieren wird.

Wenn wir Hilfsmethoden für die eloquente Sammlung verwenden, wird die Datenbank nicht mehr abgefragt. Wir möchten zunächst alle Ergebnisse aus der Datenbank abrufen und verwenden dann Sammlungsmethoden, um sie zu filtern und zu ändern, ohne die Datenbank abzufragen.

filter()

filter, eine der nützlichsten Laravel-Sammlungsmethoden, ermöglicht es Ihnen, die Sammlung mithilfe von Rückrufen zu filtern. Es werden nur die Elemente übergeben, die „true“ zurückgeben. Alle anderen Elemente werden gelöscht. filter Gibt eine neue Instanz zurück, ohne die ursprüngliche Instanz zu ändern. Es akzeptiert value und key als zwei Parameter im Rückruf. Die Methode

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

$filter->all();

all gibt das zugrunde liegende Array zurück. Der obige Code gibt die folgende Antwort zurück. Die Methode

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

search()

search kann eine Sammlung mit einem bestimmten Wert durchsuchen. Befindet sich der Wert in der Sammlung, wird der entsprechende Schlüssel zurückgegeben. Wenn kein Datenelement mit dem entsprechenden Wert übereinstimmt, wird false zurückgegeben. Die Methode

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

$names->search('Jason');

// 2

search verwendet standardmäßig einen losen Vergleich. Sie können einen strikten Vergleich verwenden, indem Sie true im zweiten Parameter übergeben.

Sie können auch Ihre eigene Callback-Funktion an die search-Methode übergeben. Gibt den Schlüssel des ersten Elements zurück, das den Wahrheitstest des Rückrufs besteht. Die Methode

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

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

// 3

chunk()

chunk teilt eine Sammlung in mehrere kleinere Sammlungen einer bestimmten Größe auf. Sehr nützlich für die Anzeige von Sammlungen in einem Raster.

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

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

$prices->toArray();

Der obige Code generiert den Effekt.

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

dump()

dump Methode zum Drucken einer Sammlung. Es kann zum Debuggen und Suchen von Inhalten innerhalb einer Sammlung an jedem beliebigen Ort verwendet werden.

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

dump Das Ergebnis des obigen Codes. Die Methode

map()

map wird zum Durchlaufen der gesamten Sammlung verwendet. Es akzeptiert einen Rückruf als Parameter. value und key werden an den Rückruf übergeben. Rückrufe können Werte ändern und zurückgeben. Schließlich wird eine neue Sammlungsinstanz des geänderten Elements zurückgegeben.

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

return $changed->all();

Grundsätzlich wird es user_id um 1 erhöht.

Die Antwort auf den obigen Code wird unten angezeigt.

[
    [
        "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()

Die Zip-Methode führt die Werte des angegebenen Arrays mit den Werten der Sammlung zusammen. Werte mit demselben Index werden addiert, was bedeutet, dass der erste Wert des Arrays mit dem ersten Wert der Sammlung zusammengeführt wird. Hier verwende ich die Sammlung, die wir gerade oben erstellt haben. Dies funktioniert auch für Eloquent-Sammlungen.

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

$zipped->all();

Die JSON-Antwort sieht folgendermaßen aus.

Das ist also im Grunde alles. Wenn die Länge des Arrays kleiner als die Länge der Sammlung ist, fügt Laravel Collection am Ende der verbleibenden Elemente vom Typ null hinzu. Wenn die Länge des Arrays größer als die Länge der Sammlung ist, fügt Laravel in ähnlicher Weise Collection zu Elementen vom Typ null hinzu, gefolgt vom Array-Wert.

whereNotIn()

Sie können die whereNotIn-Methode verwenden, um die Sammlung einfach nach Schlüsselwerten zu filtern, die nicht im angegebenen Array enthalten sind. Es ist im Grunde das Gegenteil von whereIn. Darüber hinaus verwendet diese Methode beim Abgleichen von Werten entspannte Vergleiche ==.

Filtern wir $collection, wobei user_id weder 1 noch 2 ist.

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

Die obige Anweisung gibt nur das letzte Element in $collection zurück. Der erste Parameter ist der Schlüssel und der zweite Parameter ist ein Wertearray. Im Fall von Eloquent ist der erste Parameter der Name der Spalte und der zweite Parameter ein Array von Werten. Die Methode

max()

max gibt den Maximalwert für einen bestimmten Schlüssel zurück. Den größten user_id finden Sie unter max. Es wird normalerweise für Vergleiche wie Preise oder andere Zahlen verwendet, aber zur Demonstration verwenden wir user_id. Es kann auch mit Zeichenfolgen verwendet werden, in diesem Fall 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>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教程栏目进行学习！

Das obige ist der detaillierte Inhalt vonFünfzehn häufig verwendete Laravel-Sammlungen (Sammlung). Für weitere Informationen folgen Sie bitte anderen verwandten Artikeln auf der PHP chinesischen Website!