PHPackages                             getpastthemonkey/db-link - PHPackages - PHPackages  [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register)

1. [Directory](/)
2. /
3. [Database & ORM](/categories/database)
4. /
5. getpastthemonkey/db-link

ActiveLibrary[Database & ORM](/categories/database)

getpastthemonkey/db-link
========================

A lightweight database abstraction layer for PHP

1.1.0(3y ago)012MITPHPPHP >=8.1

Since Jan 17Pushed 3y ago1 watchersCompare

[ Source](https://github.com/GetPastTheMonkey/db-link)[ Packagist](https://packagist.org/packages/getpastthemonkey/db-link)[ Docs](https://github.com/GetPastTheMonkey/db-link)[ RSS](/packages/getpastthemonkey-db-link/feed)WikiDiscussions master Synced 1mo ago

READMEChangelogDependenciesVersions (3)Used By (0)

DB Link
=======

[](#db-link)

*DB Link* is a lightweight database abstraction layer for PHP, partly inspired by [Django](https://www.djangoproject.com/).

Please note that *DB Link* does not manage the database structure for you. If you update a model class, you must update the database schema accordingly, and vice versa.

Configuration
-------------

[](#configuration)

For the database connection, *DB Link* will look for a function called `dblink_create_pdo()` that must be defined by the user. The function must have the following signature:

```
function dblink_create_pdo(): PDO
```

A basic usage might be the following implementation:

```
function dblink_create_pdo(): PDO
{
    $db_host = "127.0.0.1";
    $db_name = "my_database";
    $db_user = "my_user";
    $db_password = "this_is_top_secret";

    return new PDO(
        "mysql:dbname=$db_name;host=$db_host",
        $db_user,
        $db_password
    );
}
```

Make sure that this function is included before calling any *DB Link* functions. If the function is not found, a `LogicException` will be thrown.

Creating Models
---------------

[](#creating-models)

You can create your models by extending the `Model` class. The `get_table_name()` function should return the name of the relevant database table as a string. The `get_attributes()` function should return an array, where the keys are the database column names, and the values are instances of a `Field` subclass.

```
use \Getpastthemonkey\DbLink\Model;
use \Getpastthemonkey\DbLink\fields\IntegerField;
use \Getpastthemonkey\DbLink\fields\CharField;

class User extends Model
{
    protected static function get_table_name(): string
    {
        return "users";
    }

    protected static function get_attributes(): array
    {
        return array(
            "id" => new IntegerField(is_primary_key: true),
            "username" => new CharField(),
            "mail" => new CharField(),
            "is_admin" => new IntegerField(min: 0, max: 1, default: 0),
        );
    }
}
```

Currently, only the field types `IntegerField` and `CharField` are supported, but more field types are planned for future updates, such as `TextField`, `DateField`, or `DateTimeField`. In the meantime, use `CharField` for these purposes.

Run Queries
-----------

[](#run-queries)

Here is a showcase of the available query functionality.

```
// Example 1: Basic example
// Load all users (using the default ordering of the database)
$users = User::objects();

// Example 2: Filtering
// Only load users that have a Gmail address
use \Getpastthemonkey\DbLink\filters\F_LIKE;
$users = User::objects()->filter(new F_LIKE("mail", "%@gmail.com"));

// Example 3: Exclude
// Load all users that do not have a Gmail address
use \Getpastthemonkey\DbLink\filters\F_LIKE;
$users = User::objects()->exclude(new F_LIKE("mail", "%@gmail.com"));

// Example 4: Ordering
// Load all users sorted by increasing name
$users = User::objects()->order("name");

// Example 5: Reverse ordering
// Load all users sorted by decreasing ID
$users = User::objects()->order("id", false);

// Example 6: Limit
// Only load the first 10 users
$users = User::objects()->limit(10);

// Example 7: Limit and offset
// Load 10 users without loading the first 20 users
$users = User::objects()->limit(10, 20);
```

All of these examples return a `Query` object. The function calls may be chained arbitrarily. The `Query` class implements the `Countable` interface, so the `count()` function can be used to obtain the number of returned rows. The `Query` class also implements the `Iterator` interface, so the query results may be obtained by iterating over the `Query` instance.

### List of Filters

[](#list-of-filters)

The following table shows all available filter classes. All of them are in the `\Getpastthemonkey\DbLink\filters`namespace.

ClassSQL EquivalentDescriptionF\_ANDa AND bLogical AND of two filtersF\_BETWEENa BETWEEN b AND cChecks if the first operand is between the second and third operand (inclusive)F\_EQa = bChecks if the first operand is equal to the second operandF\_GTa > bChecks if the first operand is greater than the second operandF\_GTEa >= bChecks if the first operand is greater than or equal to the second operandF\_INa IN (b, c, d)Checks if the first operand is in the list of given subsequent operandsF\_LIKEa LIKE bChecks if the first operand is "like" the second operandF\_LTa < bChecks if the first operand is less than the second operandF\_LTEa <= bChecks if the first operand is less than or equal to the second operandF\_NEQa <> bChecks if the first operand is not equal to the second operandF\_NOTNOT aLogical NOT of a filterF\_ORa OR bLogical OR of two filters### Load Single Model Instance

[](#load-single-model-instance)

If you filter for a single instance, you can use the `get()` method of the `Query` class.

If the query does not return an entry, a `ObjectDoesNotExistException` will be thrown. If the query returns more than one entry, a `MultipleObjectsReturnedException` will be thrown.

Accessing Model Attributes
--------------------------

[](#accessing-model-attributes)

The `Model` class implements the `ArrayAccess` interface, and it overloads most magic methods. Thus, there are two ways of accessing model attributes.

The first way of accessing the model attributes is via the `ArrayAccess` interface, which allows array-style access.

```
$users = User::objects();

foreach ($users as $user) {
    echo "
        " . $user["id"] . "
        " . $user["username"] . "
        " . $user["mail"] . "
        " . $user["is_admin"] . "
    ";
}
```

The second option is to use the magic method overloads by accessing the attributes in a class-member style. Note that this option might give warnings in IDEs, as the attributes are not defined in the class.

```
$users = User::objects();

foreach ($users as $user) {
    echo "
        " . $user->id . "
        " . $user->username . "
        " . $user->mail . "
        " . $user->is_admin . "
    ";
}
```

Updating Model Attributes
-------------------------

[](#updating-model-attributes)

Updating model attributes is possible in the same two ways as accessing model attributes: Either through the `ArrayAccess` interface or the overloaded magic methods.

Here is an example that uses the `ArrayAccess` interface to update an attribute and save it back to the database. Saving internally also validated the current field values.

```
use \Getpastthemonkey\DbLink\exceptions\ValidationException;

$user = User::objects()->current();
$user["is_admin"] = 1;

try {
    $user->save();
} catch (ValidationException $e) {
    // The instance did not pass the validation checks
    // Use $e->children to get an array of validation exceptions with more details about the failed checks
}
```

To check if an instance is valid without saving it, call `validate()` instead of `save()`. If the instance is invalid, a `ValidationException` will be thrown. If it instead is valid, nothing will happen.

Creating New Instances
----------------------

[](#creating-new-instances)

By calling the constructor of a `Model` subclass, a new model instance is created. All fields hold the defined default value. If a field does not have a default value, it will be `NULL`. Note that the new instance only exists in the PHP runtime, but it is not saved in the database. To add the instance to the database, you must call `save()`.

Here is an example of how to create a new `User` and save it to the database.

```
use \Getpastthemonkey\DbLink\exceptions\ValidationException;

$user = new User();
$user["id"] = 123;
$user["username"] = "my_username";
$user["mail"] = "me@example.com";

try {
    $user->save();
} catch (ValidationException $e) {
    // The instance did not pass the validation checks
    // Use $e->children to get an array of validation exceptions with more details about the failed checks
}
```

Deleting Instances
------------------

[](#deleting-instances)

Single model instances can be deleted by calling the `delete()` function. Note that the database entry will be deleted, but the model instance still exists in the code.

Here is an example for how to delete a user with ID 123.

```
use \Getpastthemonkey\DbLink\filters\F_EQ;

$user = User::objects()->filter(new F_EQ("id", 123))->get();
$user->delete();
```

Bulk deletion is supported by calling `delete()` on a `Query` instance. All entries returned by the query will be deleted.

Here is an example for how to delete all users that are not administrators.

```
use \Getpastthemonkey\DbLink\filters\F_EQ;

User::objects()->filter(new F_EQ("is_admin", 0))->delete();
```

Troubleshooting
---------------

[](#troubleshooting)

As *DB Link* is a new project, there is not yet a complete guide to frequently asked questions or problems. If you have any questions or problems, do not hesitate to open a [GitHub issue](https://github.com/GetPastTheMonkey/db-link/issues).

###  Health Score

24

—

LowBetter than 32% of packages

Maintenance20

Infrequent updates — may be unmaintained

Popularity5

Limited adoption so far

Community7

Small or concentrated contributor base

Maturity55

Maturing project, gaining track record

 Bus Factor1

Top contributor holds 100% of commits — single point of failure

How is this calculated?**Maintenance (25%)** — Last commit recency, latest release date, and issue-to-star ratio. Uses a 2-year decay window.

**Popularity (30%)** — Total and monthly downloads, GitHub stars, and forks. Logarithmic scaling prevents top-heavy scores.

**Community (15%)** — Contributors, dependents, forks, watchers, and maintainers. Measures real ecosystem engagement.

**Maturity (30%)** — Project age, version count, PHP version support, and release stability.

###  Release Activity

Cadence

Every ~0 days

Total

2

Last Release

1208d ago

### Community

Maintainers

![](https://www.gravatar.com/avatar/ef38c0b3c7845d405f440db125375115b65d2d3ba32eb943c0c1d097811f51c8?d=identicon)[GetPastTheMonkey](/maintainers/GetPastTheMonkey)

---

Top Contributors

[![GetPastTheMonkey](https://avatars.githubusercontent.com/u/18332289?v=4)](https://github.com/GetPastTheMonkey "GetPastTheMonkey (44 commits)")

---

Tags

abstractiondatabaseormlayerdjango

### Embed Badge

![Health badge](/badges/getpastthemonkey-db-link/health.svg)

```
[![Health](https://phpackages.com/badges/getpastthemonkey-db-link/health.svg)](https://phpackages.com/packages/getpastthemonkey-db-link)
```

###  Alternatives

[adodb/adodb-php

ADOdb is a PHP database abstraction layer library

4553.9M28](/packages/adodb-adodb-php)

PHPackages © 2026

[Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)