Download the PHP package codrasil/closurable without Composer

Closurable

Closure Table relational database implementation in PHP for any hierarchical data.

Requirements

• PHP: ^7.x
• MySQL: any version should be fine.

Installation

This package is originally built for Laravel, but can also be used in any PHP project.

Read more about integration in the docs.

via composer:

Publishing Configuration

Pass in the artisan command the package's service provider:

Setup

Generating Migration File

First, run the console command to generate a nested migration table.

Format:

Example:

We will be using the users model to generate a nested relationship of users.

The command accepts an argument of referenced table. This will be the table to be "closured".

It will generate a table named userstree that comes pre-populated with the necessary columns.

The generated file should look something like below:

Note that you should generate the migration file of the referenced table yourself before running the command (in the above example, you should generate the migration for the users table yourself).

Note to change the table name of the closure table, pass in an option --table or --create:

Run php artisan make:closurable --help for more information on configuring the command.

Model usage

Next, use either of the two options on the model to be closure nested.

Following our example above, the User model should either implement:

• the trait, Closurable:

  or

• via extending the abstract class, Codrasil\Closurable\Model, instead of the default Illuminate Model class:

Usage

Saving a Branch Node

Let's say we have the following data on our users table:

And we need the following relationship:

To save the relationships described above, we need to use the closurables() from the User model to access the attach(Model $model) method.

The relationship will be saved in the familytree table as:

Visual representation:

Displaying Root Nodes

• Root

  To display resources without parents, use the roots scope:

Querying for Adjacent Relations

By default, sorting is handled via the sort column found in the reference table. If the sort column is unavailable, it will default to id or whatever $this->getKeyName() will return.

• Siblings

  To retrieve all siblings of a child, use siblings() method:

  • A helper method ->hasSiblings() for checking emptiness is available.
  • An accessor method getSiblingsAttribute is available.

  ---

• Next Sibling

  To display the next sibling in the $user->children, use next() method:

  • A helper method ->hasNext() for checking nullness is available.
  • An accessor method getNextAttribute is available.

  ---

• Previous Sibling

  To display the previous sibling, use previous() method:

  • A helper method ->hasPrevious() for checking nullness is available.
  • An accessor method getPreviousAttribute is available.

Querying for Lineal Relations

• Parent

  To retrieve the immediate parent of the child, use parent() method:

  • A helper method ->hasParent() for checking nullness is available.
  • An accessor method getParentAttribute is available.

• Children

  To display the children nodes of a specific resource, use the children() method:

  • A helper method ->hasChildren() for checking emptiness is available.
  • An accessor method getChildrenAttribute is available.

  ---

• Ancestors

  To retrieve all parents of the child (and the parent of the child's parent, and so on), use ancestors() method:

  • A helper method ->hasAncestors() for checking emptiness is available.
  • An accessor method getAncestorsAttribute is available.

  ---

• Descendants

  To retrieve all children of the parent (and the children of the parent's children, and so on), use descendants() method:

  • A helper method ->hasDescendants() for checking emptiness is available.
  • An accessor method getDescendantsAttribute is available.

For more use cases of adjacent and lineal relations, checkout Relations section in the docs.

Documentation & Examples

To learn more about the API, visit the docs folder.

For more example implementation, checkout Family Trees, and more.

License

The library is open-source software licensed under the MIT license.