PHPackages                             ngyuki/doctrine-table-gateway - 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. ngyuki/doctrine-table-gateway

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

ngyuki/doctrine-table-gateway
=============================

Simple TableGateway for doctrine-dbal

v0.0.1(8y ago)01.5kMITPHP

Since Jan 15Pushed 5y ago2 watchersCompare

[ Source](https://github.com/ngyuki/doctrine-table-gateway)[ Packagist](https://packagist.org/packages/ngyuki/doctrine-table-gateway)[ Docs](https://github.com/ngyuki/doctrine-table-gateway)[ RSS](/packages/ngyuki-doctrine-table-gateway/feed)WikiDiscussions master Synced 2w ago

READMEChangelogDependencies (4)Versions (3)Used By (0)

doctrine-table-gateway
======================

[](#doctrine-table-gateway)

doctrine/dbal をバックエンドにしたシンプルなテーブルゲートウェイ。

インストール
------

[](#インストール)

```
composer require ngyuki/doctrine-table-gateway:dev-master
```

使用例
---

[](#使用例)

```
use ngyuki\DoctrineTableGateway\TableGateway;

// Connection のインスタンスとテーブル名をコンストラクタに指定してインスタンスを生成する
$t = new TableGateway($connection, 'example');

// find($id) で主キーで 1 件の行を array で返す
$t->find(1);

// find() は行が見つからない場合は null を返す
$t->find(9999);

// all() ですべての行のイテレーターが返る
$t->all();
```

スコープ
----

[](#スコープ)

`scope()` で `find()` や `all()` の結果の範囲を絞ることができます。

```
// `scope()` でテーブルにスコープを適用する
$t->scope('a = 1')->all();
// => WHERE (a = 1)

// スコープは連想配列でも指定できる
$t->scope(['a' => 1])->all();
// => WHERE (a = 1)

// スコープの整数キーの値は SQL の式としてそのまま使用される
$t->scope(['a = 1', 'b = 2', 'c' => 3])->all();
// => WHERE (a = 1) AND (b = 2) AND (c = 3)

// スコープはチェインできる
$t->scope(['a' => 1])->scope(['b' => 0])->all();
// => WHERE (a = 1) AND (b = 2)

// チェインや配列で複数指定されたスコープは AND で連結される
$t->scope('a = 1 OR b = 2')->scope(['c = 3', 'd' => 4])->all();
// => WHERE (a = 1 OR b = 2) AND (c = 3) AND (d = 4)

// スコープを適用したオブジェクトは使いまわすことができる
$a = $t->scope('a = 1');
$b = $a->scope('b = 2');
$c = $a->scope('c = 3');

$a->all(); // => WHERE (a = 1)
$b->all(); // => WHERE (a = 1) AND (b = 2)
$c->all(); // => WHERE (a = 1) AND (c = 3)

// orderBy() で並び順を指定する
$t->scope('a = 1')->orderBy('b', 'DESC')->all();
// => WHERE (a = 1) ORDER BY b DESC
```

スコープにはクロージャーが指定できます。クロージャーの引数の `Doctrine\DBAL\Query\QueryBuilder` を用いて自由にクエリをカスタマイズできます。

```
$t->scope(function (\Doctrine\DBAL\Query\QueryBuilder $q) {
    return $q->where('a = 1')->andWhere('b = 2')->orderBy('c', 'desc');
}); // => WHERE (a = 1) AND (b = 1) ORDER BY c DESC
```

イテレータ
-----

[](#イテレータ)

`all()` メソッドが返すイテレータにはいくつかの便利メソッドが定義されています。

```
// 指定された列値のみのイテレーターを返す
$t->all()->asColumn('col');

// 配列なら指定した列値の配列が返る
$t->all()->asColumn(['col1', 'col2']);

// 指定された列値がキー値となるイテレーターを返す
$t->all()->asUnique('col');

// 指定された 2 つの列値がキーと値となるイテレーターを返す
$t->all()->asPair('key', 'val');

// 値の方は asColumn と同じように指定できる
$t->all()->asPair('key', ['col1', 'col2']);

// 複数の列値で多次元連想配列を返す ... `$array[$key1][$key2][$key2] = $val `のような連想配列が返る
$t->all()->asGroup(['key1', 'key2', 'key2'], 'val');

// 値の方は asColumn と同じように指定できる
$t->all()->asGroup(['key1', 'key2', 'key2'], ['col1', 'col2']);

// 値を NULL にすると行がそのまま返る
$t->all()->asGroup(['key1', 'key2', 'key2'], null);

// イテレーターを配列化する
$t->all()->toArray();
```

例えば次のようなテーブルがあるとき、

idnameage1aaa162bbb243ccc32それぞれ次のように返ります。

```
$t->all()->asColumn('name')->toArray();
//  [aaa, bbb, ccc]

$t->all()->asColumn(['id', 'age'])->toArray();
//  [[1, 16], [2, 24], [3, 32]]

$t->all()->asUnique('id')->toArray();
//  [
//      1 => [id => 1, name => aaa, age => 16],
//      2 => [id => 2, name => bbb, age => 24],
//      3 => [id => 3, name => ccc, age => 32],
//  ]

$t->all()->asPair('id', 'name');
//  [
//      1 => aaa,
//      2 => bbb,
//      3 => ccc,
//  ]

$t->all()->asGroup(['id', 'age'], 'name');
//  [
//      1 => [
//          16 => aaa
//      ],
//      2 => [
//          24 => bbb,
//      ],
//      3 => [
//          32 => ccc,
//      ],
//  ]
```

INSERT
------

[](#insert)

```
$t->insert(['a' => 1, 'b' => 2, 'c' => 3]);
#=> INSERT INTO ... (a, b, c) VALUES (1, 2, 3)
```

INSERT で存在しない列名を指定しても無視されます。

```
$t->insert(['a' => 1, 'xxx' => 2]);
#=> INSERT INTO ... (a) VALUES (1)
```

スコープの第２引数で INSERT のデフォルト値を指定できます。

```
$t->scope('a = 1', ['a' => 1])->insert(['b' => 2, 'c' => 3]);
#=> INSERT INTO ... (a, b, c) VALUES (1, 2, 3)
```

スコープの第２引数が省略された場合は、第１引数の `key => value` の形式の値のみがデフォルト値として使用されます。

```
$t->scope('a = 1', ['b' => 2])->insert(['c' => 3]);
#=> INSERT INTO ... (b, c) VALUES (2, 3)
```

UPDATE/DELETE
-------------

[](#updatedelete)

`update($data)` で指定したデータで、スコープのすべての行を UPDATE します。

```
$t->scope('a = 1')->update(['b' => 2, 'c' => 3]);
#=> UPDATE ... SET b = 2, c = 3 WHERE a = 1
```

`update($data)` で存在しない列を指定しても無視されます。

```
$t->scope('a = 1')->update(['b' => 2, 'xxx' => 9]);
#=> UPDATE ... SET b = 2 WHERE a = 1
```

`update($data)` でスコープのすべての行を DELETE します。

```
$t->scope('a = 1')->delete();
#=> DELETE FROM ... WHERE a = 1
```

主キーを指定したいときは `by($id)` でスコープを適用してください。

```
$t->by(1)->update(['a' => 1, 'b' => 2, 'c' => 3]);
#=> UPDATE ... SET a = 1, b = 2, c = 3 WHERE id = 1

$t->by(1)->delete();
#=> DELETE FROM ... WHERE id = 1
```

スコープが適用されていないときはすべての行が対象になります。

```
$t->update(['a' => 1, 'b' => 2, 'c' => 3]);
#=> UPDATE ... SET a = 1, b = 2, c = 3

$t->delete();
#=> DELETE FROM ...
```

メタデータキャッシュ
----------

[](#メタデータキャッシュ)

デフォルトでは TableGateway がインスタンス化されるたびにテーブル定義のメタデータをデータベースから取得しますが、次のようにキャッシュを使うことができます。

```
use ngyuki\DoctrineTableGateway\TableGateway;
use ngyuki\DoctrineTableGateway\Metadata;

$t = new TableGateway($connection, 't_user', new Metadata($connection, $cache));
```

`$cache` には PSR-16 の `Psr\SimpleCache\CacheInterface` をインプリメントしたオブジェクトが指定できます。

`cache/doctrine-adapter`doctorine のキャッシュを使う場合はは [cache/doctrine-adapter](https://packagist.org/packages/cache/doctrine-adapter) が使えます。

```
composer require cache/doctrine-adapter
```

```
use ngyuki\DoctrineTableGateway\TableGateway;
use ngyuki\DoctrineTableGateway\Metadata;
use Doctrine\Common\Cache\ApcuCache;
use Cache\Adapter\Doctrine\DoctrineCachePool;

$cache = new DoctrineCachePool(new ApcuCache());
$t = new TableGateway($connection, 't_user', new Metadata($connection, $cache));
```

テーブル結合
------

[](#テーブル結合)

そういうのはできない。

OneToMany/ManyToOne/ManyToMany のような関係でどのようにテーブルを走査すればいいかは機械的に判断できるものではないと思うので。

どうしてもやりたければ `scope()` にクロージャーを渡してクエリビルダをごちゃごちゃすればできると思います。

アンドドキュメンテッド
-----------

[](#アンドドキュメンテッド)

README.md にかかれていない機能

- query
    - 指定した SQL をそのまま実行して結果セットを得る
- transactional
    - コールバック関数をトランザクションの中で実行する
- ExpressionBuilder
    - scope の表現が少し豊かになった

###  Health Score

27

—

LowBetter than 47% of packages

Maintenance20

Infrequent updates — may be unmaintained

Popularity14

Limited adoption so far

Community8

Small or concentrated contributor base

Maturity54

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

Unknown

Total

1

Last Release

3088d ago

### Community

Maintainers

![](https://avatars.githubusercontent.com/u/1871654?v=4)[Toshiyuki Goto](/maintainers/ngyuki)[@ngyuki](https://github.com/ngyuki)

---

Top Contributors

[![ngyuki](https://avatars.githubusercontent.com/u/1871654?v=4)](https://github.com/ngyuki "ngyuki (47 commits)")

---

Tags

databasedoctrine

### Embed Badge

![Health badge](/badges/ngyuki-doctrine-table-gateway/health.svg)

```
[![Health](https://phpackages.com/badges/ngyuki-doctrine-table-gateway/health.svg)](https://phpackages.com/packages/ngyuki-doctrine-table-gateway)
```

###  Alternatives

[scienta/doctrine-json-functions

A set of extensions to Doctrine that add support for json query functions.

58825.2M48](/packages/scienta-doctrine-json-functions)[martin-georgiev/postgresql-for-doctrine

Extends Doctrine with native PostgreSQL support for arrays, JSONB, ranges, PostGIS geometries, text search, ltree, uuid, and 100+ PostgreSQL-specific functions.

4535.7M4](/packages/martin-georgiev-postgresql-for-doctrine)[laravel-doctrine/migrations

Doctrine Migrations for Laravel

782.8M17](/packages/laravel-doctrine-migrations)[flow-php/doctrine-dbal-bulk

Bulk inserts and updates for Doctrine DBAL

14361.1k3](/packages/flow-php-doctrine-dbal-bulk)[williarin/wordpress-interop

Interoperability library to work with WordPress database in third party apps

6611.3k2](/packages/williarin-wordpress-interop)

PHPackages © 2026

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