wojtek77/phalcon.eager-loading

Solves N+1 query problem in Phalcon Model (for Phalcon 4)

dev-master 2022-04-21 09:11 UTC

Requires

• php: >=7.2
• ext-phalcon: ^4.0.0

Unlicense

• Óscar Enríquez
• Wojciech Brüggemann

• phalcon

README

This package provides eager-loading support for Phalcon 4.*, requires PHP 7.2.

For Phalcon 1.3.* - 2.0.* use phalcon_1-2 branch.

Installation

composer require wojtek77/phalcon.eager-loading:dev-master

Usage

The usage is similar to Laravel, I've implemented in a trait with and load methods, so within a model that uses that trait (Sb\Framework\Mvc\Model\EagerLoadingTrait) you can do:

<?php
use Sb\Framework\Mvc\Model\EagerLoading\Loader,
	Sb\Framework\Mvc\Model\EagerLoading\QueryBuilder;

$robotsAndParts = Robot::with('Parts');

// Equivalent to:

$robots = Robot::find();
foreach ($robots as $robot) {
	$robot->parts; // $robot->__get('parts')
}

// Or

$robot = Robot::findFirst()->load('Parts');

// Equivalent to:

$robot = Robot::findFirst();
$robots->parts; // $robot->__get('parts')

// Because Robot::find() returns a resultset, so in that case this is solved with:
$robots = Loader::fromResultset(Robot::find(), 'Parts'); # Equivalent to the second example

// Multiple and nested relations can be used too
$robots = Robot::with('Parts', 'Foo.Bar');

// And arguments can be passed to the find method
$robots = Robot::with('Parts', 'Foo.Bar', ['limit' => 5]);

// And constraints
$robots = Robot::with(
	[
		'Parts',
		'Foo.Bar' => function (QueryBuilder $builder) {
			// Limit Bar
			$builder->limit(5);
		}
	],
	[
		'limit' => 5
	]
);

// constraints with the Loader too
$robots = Loader::fromResultset(Robot::find(), [
        'Foo.Bar' => function (QueryBuilder $builder) {
			$builder->where('Bar.id > 10'); 
	             }
]); 

Usage with soft delete

By default eager load without soft deleted entries operates on 'delete_date' field, where NULL value represents not deleted records.

It is possible to change this behavior globally, by adding to config:

'eagerLoadingSoftDelete' => [
    'name' => 'delete_date', //name of flag column for "soft delete"
    'value' => null, //value of a flag column for not deleted record
]

Also, there is possibility, to change soft delete field-value only for specific model:

<?php
use Phalcon\Mvc\Model;

class Part extends Model
{
    private $__eagerLoadingSoftDeleteName = 'delete_date'; //name of flag column for "soft delete"
    private $__eagerLoadingSoftDeleteValue = null; //value of a flag column for not deleted record
}

The usage of soft delete:

<?php
use Sb\Framework\Mvc\Model\EagerLoading\Loader;

$robot = Robot::findFirst()->loadWithoutSoftDelete('Parts');


// Because Robot::find() returns a resultset, so in that case this is solved with:
$robots = Loader::fromResultsetWithoutSoftDelete(Robot::find(), 'Parts');

For more examples, return types etc visit the tests folder or take a look at the code, it's quite small.

License

The Unlicense