elcreator/phalcon.eager-loading

Solves N+1 query problem in Phalcon Model

dev-master 2021-12-05 20:19 UTC

Requires

• php: >=7.2
• ext-phalcon: >=4

Unlicense

• Óscar Enríquez
• Artur Kyryliuk

• phalcon

README

This package provides eager-loading support for Phalcon 4.* - 5.*. Requires PHP 7.2

Usage

Autoload the trait as it's described in the https://github.com/phalcon/incubator#autoloading-from-the-incubator

The usage is similar to Laravel. Implemented in a trait with and load methods, so within a model that uses that trait (\Phalcon\Mvc\Model\EagerLoadingTrait) you can do:

<?php
use \Phalcon\Mvc\Model\EagerLoading\Loader,
	\Phalcon\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'); 
	             }
]); 

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

License

The Unlicense