Merge pull request #99 from ycs77/add-trait-for-model

Static call from model

Author: mavinoo

README.md

@@ -161,7 +161,32 @@ Array
 )
 ```
 
+# Example called from model
 
+Add `HasBatch` trait into model:
+
+```php
+namespace App\Models;
+
+use Mavinoo\Batch\Traits\HasBatch;
+
+class User extends Model
+{
+    use HasBatch;
+}
+```
+
+And call `batchUpdate()` or `batchInsert()` from model:
+
+```php
+use App\Models\User;
+
+// ex: update
+User::batchUpdate($value, $index);
+
+// ex: insert
+User::batchInsert($columns, $values, $batchSize);
+```
 
 # Helper batch()
 

src/Traits/HasBatch.php

@@ -0,0 +1,98 @@
+<?php declare(strict_types=1);
+
+namespace Mavinoo\Batch\Traits;
+
+use Mavinoo\Batch\Batch;
+
+trait HasBatch
+{
+    /**
+     * Update multiple rows.
+     *
+     * Example:
+     * ```
+     * use App\Models\User;
+     *
+     * $values = [
+     *     [
+     *         'id' => 1,
+     *         'status' => 'active',
+     *         'nickname' => 'Mohammad',
+     *     ],
+     *     [
+     *         'id' => 5,
+     *         'status' => 'deactive',
+     *         'nickname' => 'Ghanbari',
+     *     ],
+     *     [
+     *         'id' => 7,
+     *         'balance' => ['+', 500],
+     *     ],
+     * ];
+     *
+     * User::batchUpdate($values, 'id');
+     * ```
+     *
+     * @param  array  $values
+     * @param  string|null  $index
+     * @param  bool  $raw
+     * @return bool|int
+     */
+    public static function batchUpdate(array $values, string $index = null, bool $raw = false)
+    {
+        return app(Batch::class)->update(new static, $values, $index, $raw);
+    }
+
+    /**
+     * Insert multiple rows.
+     *
+     * Example:
+     * ```
+     * use App\Models\User;
+     *
+     * $columns = [
+     *     'firstName',
+     *     'lastName',
+     *     'email',
+     *     'isActive',
+     *     'status',
+     * ];
+     * $values = [
+     *     [
+     *         'Mohammad',
+     *         'Ghanbari',
+     *         '[email protected]',
+     *         '1',
+     *         '0',
+     *     ] ,
+     *     [
+     *         'Saeed',
+     *         'Mohammadi',
+     *         '[email protected]',
+     *         '1',
+     *         '0',
+     *     ] ,
+     *     [
+     *         'Avin',
+     *         'Ghanbari',
+     *         '[email protected]',
+     *         '1',
+     *         '0',
+     *     ] ,
+     * ];
+     * $batchSize = 500; // insert 500 (default), 100 minimum rows in one query
+     *
+     * User::batchInsert($columns, $values, $batchSize);
+     * ```
+     *
+     * @param  array  $columns
+     * @param  array  $values
+     * @param  int  $batchSize
+     * @param  bool  $insertIgnore
+     * @return bool|array
+     */
+    public static function batchInsert(array $columns, array $values, int $batchSize = 500, bool $insertIgnore = false)
+    {
+        return app(Batch::class)->insert(new static, $columns, $values, $batchSize, $insertIgnore);
+    }
+}