آموزش laravel eloquent با مثال

نحوه کارکرد laravel eloquent

ساخت و سفارشی سازی Model

ساخت Model

php artisan make:model Flight

php artisan make:model Flight --migration

php artisan make:model Flight -m

سفارشی سازی Model

<?php

namespace App;

use Illuminate\Database\Eloquent\Model;

class Flight extends Model
{
    //
}

نام جدول

<?php

namespace App;

use Illuminate\Database\Eloquent\Model;

class Flight extends Model
{
    /**
     * The table associated with the model.
     *
     * @var string
     */
    protected $table = 'My_Fflights';
}

Primary Keys

<?php

namespace App;

use Illuminate\Database\Eloquent\Model;

class Flight extends Model
{
    /**
     * The primary key associated with the table.
     *
     * @var string
     */
    protected $primaryKey = 'flight_id';
}

<?php

class Flight extends Model
{
    /**
     * The "type" of the auto-incrementing ID.
     *
     * @var string
     */
    protected $keyType = 'string';
}

<?php

class Flight extends Model
{
    /**
     * Indicates if the IDs are auto-incrementing.
     *
     * @var bool
     */
    public $incrementing = false;
}

Timestamps

<?php

namespace App;

use Illuminate\Database\Eloquent\Model;

class Flight extends Model
{
    /**
     * Indicates if the model should be timestamped.
     *
     * @var bool
     */
    public $timestamps = false;
}

<?php

namespace App;

use Illuminate\Database\Eloquent\Model;

class Flight extends Model
{
    /**
     * The storage format of the model's date columns.
     *
     * @var string
     */
    protected $dateFormat = 'U';
}

<?php

class Flight extends Model
{
    const CREATED_AT = 'creation_date';
    const UPDATED_AT = 'last_update';
}

ارتباط با Database

<?php

namespace App;

use Illuminate\Database\Eloquent\Model;

class Flight extends Model
{
    /**
     * The connection name for the model.
     *
     * @var string
     */
    protected $connection = 'connection-name';
}

تعیین مقدار پیش فرض Attribute ها

<?php

namespace App;

use Illuminate\Database\Eloquent\Model;

class Flight extends Model
{
    /**
     * The model's default values for attributes.
     *
     * @var array
     */
    protected $attributes = [
        'delayed' => false,
    ];
}

دریافت داده های Database توسط Model

<?php

$flights = App\Flight::all();

foreach ($flights as $flight) {
    echo $flight->name;
}

$flights = App\Flight::where('active', 1)
      ->orderBy('name', 'desc')
      ->take(10)
      ->get();

Refresh کردن Model

$flight = App\Flight::where('number', 'FR 900')->first();
$freshFlight = $flight->fresh();

$flight = App\Flight::where('number', 'FR 900')->first();

$flight->number = 'FR 456';

$flight->refresh();

$flight->number; // "FR 900"

Collection ها

Flight::chunk(200, function ($flights) {
    foreach ($flights as $flight) {
        //
    }
});

Query های پیشرفته

انتخاب داده ها

use App\Destination;
use App\Flight;

return Destination::addSelect(['last_flight' => Flight::select('name')
    ->whereColumn('destination_id', 'destinations.id')
    ->orderBy('arrived_at', 'desc')
])->get();

مرتب سازی داده ها

return Destination::orderByDesc(
    Flight::select('arrived_at')
        ->whereColumn('destination_id', 'destinations.id')
        ->orderBy('arrived_at', 'desc')
        ->limit(1)
)->get();

دریافت یک داده از Database

// Retrieve a model by its primary key...
$flight = App\Flight::find(1);

$flights = App\Flight::find([1, 2, 3]);

// Retrieve the first model matching the query constraints...
$flight = App\Flight::where('active', 1)->first();

// Shorthand for retrieving the first model matching the query constraints...
$flight = App\Flight::firstWhere('active', 1);

$model = App\Flight::where('legs', '>', 100)->firstOr(function () {
        // ...
});

$model = App\Flight::where('legs', '>', 100)
            ->firstOr(['id', 'legs'], function () {
                // ...
            });

نمایش Exception

$model = App\Flight::findOrFail(1);

$model = App\Flight::where('legs', '>', 100)->firstOrFail();

Collection های عددی

$count = App\Flight::where('active', 1)->count();

$max = App\Flight::where('active', 1)->max('price');

اضافه کردن داده ها به Database توسط Model

<?php

namespace App\Http\Controllers;

use App\Http\Controllers\Controller;
use App\Flight;
use Illuminate\Http\Request;

class FlightController extends Controller
{
    /**
     * Create a new flight instance.
     *
     * @param  Request  $request
     * @return Response
     */
    public function store(Request $request)
    {
        // Validate the request...

        $flight = new Flight;

        $flight->name = $request->name;

        $flight->save();
    }
}

در صورتی که timestamps$ را false نکرده باشیم، پس از ()save یک داده در Database، به طور خودکار ستون های created_at و updated_at آن، مقداری برابر با زمان Server می گیرد.

$flight = App\Flight::create(['name' => 'Flight 10']);

بروزرسانی داده ها در Database توسط Model

$flight = App\Flight::find(1);

$flight->name = 'New Flight Name';

$flight->save();

App\Flight::where('active', 1)
          ->where('destination', 'San Diego')
          ->update(['delayed' => 1]);

بررسی Attribute ها

• isDirty : از این method زمانی استفاده می کنیم که بخواهیم بدانیم آیا هیچ کدام از Attribute های یک Model از زمان ایجاد آن یا بروزرسانی کامل آن یعنی save کردن، تغییری داشته است یا خیر.
• isClean : دقیقا برعکس isDirty عمل می کند.

$user = User::create([
    'first_name' => 'Taylor',
    'last_name' => 'Otwell',
    'title' => 'Developer',
]);

$user->title = 'Painter';

$user->isDirty(); // true
$user->isDirty('title'); // true
$user->isDirty('first_name'); // false

$user->isClean(); // false
$user->isClean('title'); // false
$user->isClean('first_name'); // true

$user->save();

$user->isDirty(); // false
$user->isClean(); // true

• wasChanged : معمولا از این method زمانی استفاده می کنیم که می خواهیم بدانیم آیا یک Attribute، پس از ارسال از طریق HTTP Request توسط کاربر، تغییر داده شده است یا خیر.

$user = User::create([
    'first_name' => 'Taylor',
    'last_name' => 'Otwell',
    'title' => 'Developer',
]);

$user->title = 'Painter';
$user->save();

$user->wasChanged(); // true
$user->wasChanged('title'); // true
$user->wasChanged('first_name'); // false

• getOriginal : این method تمام اطلاعات و Attribute های اولیه یک model را، حتی اگر مقدار آن ها را هزاران بار عوض کرده باشیم، بر می گرداند.

$user = User::find(1);

$user->name; // John
$user->email; // john@example.com

$user->name = "Jack";
$user->name; // Jack

$user->getOriginal('name'); // John
$user->getOriginal(); // Array of original attributes...

Mass Assignment

• fillable : در آرایه fillable تمام Attribute هایی که می خواهیم بتواند از طرف کاربر مقدار بگیرد را وارد می کنیم.
• guarded : در آرایه guarded تمام Attribute هایی که نمی خواهیم از طرف کاربر مقدار بگیرد را وارد می کنیم.

هنگامی که یک Attribute را در fillable وارد کنیم، به طور خودکار تمام Attribute های دیگر guarded می شوند. هم چنین اگر یک Attribute را در guarded وارد کنیم، به طور خودکار تمام Attribute های دیگر fillable می شوند.

<?php

namespace App;

use Illuminate\Database\Eloquent\Model;

class Flight extends Model
{
    /**
     * The attributes that are mass assignable.
     *
     * @var array
     */
    protected $fillable = ['name'];
}

<?php

namespace App;

use Illuminate\Database\Eloquent\Model;

class Flight extends Model
{
    /**
     * The attributes that aren't mass assignable.
     *
     * @var array
     */
    protected $guarded = ['price'];
}

اضافه کردن داده ها به Database همراه با Mass Assignment

• firstOrCreate: این method ابتدا تلاش می کند تا با توجه به مقداری که به آن دادیم یک record از Database و از طریق Model پیدا کند. در صورتی که این record در Database پیدا نشود، به صورت خودکار یک داده با همان اطلاعاتی که وارد کردیم، در Database ایجاد می شود.
• firstOrNew: این method همانند firstOrCreate عمل می کند، با فرق اینکه در صورت پیدا نشدن record، به جای ایجاد آن record، یک record از نمونه یا instance آن Model را برمی گرداند.

// Retrieve flight by name, or create it if it doesn't exist...
$flight = App\Flight::firstOrCreate(['name' => 'Flight 10']);

// Retrieve flight by name, or create it with the name, delayed, and arrival_time attributes...
$flight = App\Flight::firstOrCreate(
    ['name' => 'Flight 10'],
    ['delayed' => 1, 'arrival_time' => '11:30']
);

// Retrieve by name, or instantiate...
$flight = App\Flight::firstOrNew(['name' => 'Flight 10']);

// Retrieve by name, or instantiate with the name, delayed, and arrival_time attributes...
$flight = App\Flight::firstOrNew(
    ['name' => 'Flight 10'],
    ['delayed' => 1, 'arrival_time' => '11:30']
);

• updateOrCreate : این method زمانی برای بروزرسانی یک داده استفاده می شود که بخواهیم در صورت وجود نداشتن آن داده برای بروزرسانی، به صورت خودکار همان داده در Database ایجاد شود.

// If there's a flight from Oakland to San Diego, set the price to $99.
// If no matching model exists, create one.
$flight = App\Flight::updateOrCreate(
    ['departure' => 'Oakland', 'destination' => 'San Diego'],
    ['price' => 99, 'discounted' => 1]
);

حذف Model

$flight = App\Flight::find(1);

$flight->delete();

حذف تنها یک یا چند داده ی Model

App\Flight::destroy(1);

App\Flight::destroy(1, 2, 3);

App\Flight::destroy([1, 2, 3]);

App\Flight::destroy(collect([1, 2, 3]));

حذف یک یا چند داده ی خاص از Model توسط Query

$deletedRows = App\Flight::where('active', 0)->delete();

Soft Deleting

<?php

namespace App;

use Illuminate\Database\Eloquent\Model;
use Illuminate\Database\Eloquent\SoftDeletes;

class Flight extends Model
{
    use SoftDeletes;
}

Schema::table('flights', function (Blueprint $table) {
    $table->softDeletes();
});

if ($flight->trashed()) {
    //
}

Query زدن برروی Model های Soft Delete شده

$flights = App\Flight::withTrashed()
                ->where('account_id', 1)
                ->get();

$flight->history()->withTrashed()->get();

Restore کردن Model های Soft Delete شده

$flight->restore();

App\Flight::withTrashed()
        ->where('airline_id', 1)
        ->restore();

حذف کردن دائم Model های Soft Delete شده

// Force deleting a single model instance...
$flight->forceDelete();

// Force deleting all related models...
$flight->history()->forceDelete();

کپی برداری از Model ها

$shipping = App\Address::create([
    'type' => 'shipping',
    'line_1' => '123 Example Street',
    'city' => 'Victorville',
    'state' => 'CA',
    'postcode' => '90001',
]);

$billing = $shipping->replicate()->fill([
    'type' => 'billing'
]);

$billing->save();

Scope Queries

Global Scopes

ایجاد Global Scope ها :

<?php

namespace App\Scopes;

use Illuminate\Database\Eloquent\Builder;
use Illuminate\Database\Eloquent\Model;
use Illuminate\Database\Eloquent\Scope;

class AgeScope implements Scope
{
    /**
     * Apply the scope to a given Eloquent query builder.
     *
     * @param  \Illuminate\Database\Eloquent\Builder  $builder
     * @param  \Illuminate\Database\Eloquent\Model  $model
     * @return void
     */
    public function apply(Builder $builder, Model $model)
    {
        $builder->where('age', '>', 200);
    }
}

استفاده از Global Scope ها

<?php

namespace App;

use App\Scopes\AgeScope;
use Illuminate\Database\Eloquent\Model;

class User extends Model
{
    /**
     * The "booted" method of the model.
     *
     * @return void
     */
    protected static function booted()
    {
        static::addGlobalScope(new AgeScope);
    }
}

select * from `users` where `age` > 200

Global Scope های ناشناس :

<?php

namespace App;

use Illuminate\Database\Eloquent\Builder;
use Illuminate\Database\Eloquent\Model;

class User extends Model
{
    /**
     * The "booted" method of the model.
     *
     * @return void
     */
    protected static function booted()
    {
        static::addGlobalScope('age', function (Builder $builder) {
            $builder->where('age', '>', 200);
        });
    }
}

حذف Global Scope ها

User::withoutGlobalScope(AgeScope::class)->get();

User::withoutGlobalScope('age')->get();

// Remove all of the global scopes...
User::withoutGlobalScopes()->get();

// Remove some of the global scopes...
User::withoutGlobalScopes([
    FirstScope::class, SecondScope::class
])->get();

Local Scopes

Scope ها همیشه باید یک instance از query builder را return کنند.

<?php

namespace App;

use Illuminate\Database\Eloquent\Model;

class User extends Model
{
    /**
     * Scope a query to only include popular users.
     *
     * @param  \Illuminate\Database\Eloquent\Builder  $query
     * @return \Illuminate\Database\Eloquent\Builder
     */
    public function scopePopular($query)
    {
        return $query->where('votes', '>', 100);
    }

    /**
     * Scope a query to only include active users.
     *
     * @param  \Illuminate\Database\Eloquent\Builder  $query
     * @return \Illuminate\Database\Eloquent\Builder
     */
    public function scopeActive($query)
    {
        return $query->where('active', 1);
    }
}

استفاده از Local Scope ها

$users = App\User::popular()->active()->orderBy('created_at')->get();

$users = App\User::popular()->orWhere(function (Builder $query) {
    $query->active();
})->get();

$users = App\User::popular()->orWhere->active()->get();

Dynamic Scopes

<?php

namespace App;

use Illuminate\Database\Eloquent\Model;

class User extends Model
{
    /**
     * Scope a query to only include users of a given type.
     *
     * @param  \Illuminate\Database\Eloquent\Builder  $query
     * @param  mixed  $type
     * @return \Illuminate\Database\Eloquent\Builder
     */
    public function scopeOfType($query, $type)
    {
        return $query->where('type', $type);
    }
}

$users = App\User::ofType('admin')->get();

مقایسه Model ها

if ($post->is($anotherPost)) {
    //
}

Events

• Event : retrieved یا رویداد retrieved زمانی اجرا می شود که Model از Database بازیابی یا همان retrieved شود.
• creating / created:  زمانی که یک Model جدید برای اولین بار Save می شود، Event های creating و created اجرا می شوند.
• updating / updated : اگر یک Model از قبل در Database وجود داشته باشد و برای آن Model متد save فرا خوانده شود، Event های updating و updated اجرا می شوند. هم چنین برای هر دوی این Event ها، saving و saved نیز اجرا می شوند.

<?php

namespace App;

use App\Events\UserDeleted;
use App\Events\UserSaved;
use Illuminate\Foundation\Auth\User as Authenticatable;

class User extends Authenticatable
{
    use Notifiable;

    /**
     * The event map for the model.
     *
     * @var array
     */
    protected $dispatchesEvents = [
        'saved' => UserSaved::class,
        'deleted' => UserDeleted::class,
    ];
}

استفاده از Closure ها

<?php

namespace App;

use App\Scopes\AgeScope;
use Illuminate\Database\Eloquent\Model;

class User extends Model
{
    /**
     * The "booted" method of the model.
     *
     * @return void
     */
    protected static function booted()
    {
        static::created(function ($user) {
            //
        });
    }
}

ناظران (Observers)

ایجاد Observer ها

php artisan make:observer UserObserver --model=User

<?php

namespace App\Observers;

use App\User;

class UserObserver
{
    /**
     * Handle the User "created" event.
     *
     * @param  \App\User  $user
     * @return void
     */
    public function created(User $user)
    {
        //
    }

    /**
     * Handle the User "updated" event.
     *
     * @param  \App\User  $user
     * @return void
     */
    public function updated(User $user)
    {
        //
    }

    /**
     * Handle the User "deleted" event.
     *
     * @param  \App\User  $user
     * @return void
     */
    public function deleted(User $user)
    {
        //
    }

    /**
     * Handle the User "forceDeleted" event.
     *
     * @param  \App\User  $user
     * @return void
     */
    public function forceDeleted(User $user)
    {
        //
    }
}

<?php

namespace App\Providers;

use App\Observers\UserObserver;
use App\User;
use Illuminate\Support\ServiceProvider;

class AppServiceProvider extends ServiceProvider
{
    /**
     * Register any application services.
     *
     * @return void
     */
    public function register()
    {
        //
    }

    /**
     * Bootstrap any application services.
     *
     * @return void
     */
    public function boot()
    {
        User::observe(UserObserver::class);
    }
}

اگر به یادگیری بیشتر لاراول علاقه داری می تونی در دوره آموزش لاراول کاربردی (بسته پروژه محور) شرکت کنی، این دوره شامل ۱۲ پروژه کاربردی و پر استفاده در دنیای واقعی است، که تمامی پروژه ها به صورت کامل برنامه نویسی خواهند شد، تا دانشجو بتواند با روند ایجاد و تکمیل پروژه به صورت کامل آشنا شود.