Add isParentOf, isChildOf, depthRelatedTo

[PaperTurtle]

This merge request add three new methods mentioned in (#179) to the HasRecursiveRelationships Trait.

I've tried to create a test for the depthRelatedTo, but I cannot get it to work.

However, I have created a Laravel Project to test if the methods work accordingly. I've created an example Model:

class Category extends Model
{
    use HasFactory, HasRecursiveRelationships;

    protected $fillable = ['name', 'parent_id'];
}

and then tried the methods out:

Route::get('/setup-multi-level-categories', function () {
    $rootCategory = Category::create(['name' => 'Root Category']);

    $firstLevelCategory = Category::create([
        'name' => 'First Level Category',
        'parent_id' => $rootCategory->id
    ]);

    $secondLevelCategory = Category::create([
        'name' => 'Second Level Category',
        'parent_id' => $firstLevelCategory->id
    ]);

    $thirdLevelCategory = Category::create([
        'name' => 'Third Level Category',
        'parent_id' => $secondLevelCategory->id
    ]);

    return 'Multi-level categories setup completed.';
});

Route::get('/is-parent-of/{parentId}/{childId}', function ($parentId, $childId) {
    $parent = Category::findOrFail($parentId);
    $child = Category::findOrFail($childId);

    return response()->json([
        'isParentOf' => $parent->isParentOf($child)
    ]);
});

Route::get('/is-child-of/{childId}/{parentId}', function ($childId, $parentId) {
    $child = Category::findOrFail($childId);
    $parent = Category::findOrFail($parentId);

    return response()->json([
        'isChildOf' => $child->isChildOf($parent)
    ]);
});

Route::get('/depth-related-to/{categoryId}/{relatedCategoryId}', function ($categoryId, $relatedCategoryId) {
    $category = Category::findOrFail($categoryId);
    $relatedCategory = Category::findOrFail($relatedCategoryId);

    return response()->json([
        'depthRelatedTo' => $category->depthRelatedTo($relatedCategory)
    ]);
});

Everything seems to work correctly. Feedback is welcome.

Thanks in advance.

[staudenmeir]

Hi @PaperTurtle,
Thanks, I'll take a look.

[PaperTurtle]

Thanks @staudenmeir,
I'm looking forward to your review!

[staudenmeir]

The if {} here (and in the other methods) is not necessary. $this->children automatically loads the relationship if necessary.

[PaperTurtle]

@staudenmeir Thanks for the feedback, I've implemented your suggestions.

[staudenmeir]

Thanks! I've renamed the third method to getDepthRelatedTo() and will release a new version soon.

[staudenmeir]

I've released a new version.