PHPackages                             matatirosoln/doctrine-fm-data-api-driver - 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. matatirosoln/doctrine-fm-data-api-driver

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

matatirosoln/doctrine-fm-data-api-driver
========================================

Use FileMaker via the v17+ Data API as your backend database

0.10.11(1y ago)31.2k↓100%1MITPHPPHP >=7.2.0

Since Aug 17Pushed 1y ago1 watchersCompare

[ Source](https://github.com/matatirosolutions/doctrine-fm-data-api-driver)[ Packagist](https://packagist.org/packages/matatirosoln/doctrine-fm-data-api-driver)[ RSS](/packages/matatirosoln-doctrine-fm-data-api-driver/feed)WikiDiscussions master Synced 1mo ago

READMEChangelogDependencies (10)Versions (53)Used By (0)

Doctrine FileMaker Data API driver
==================================

[](#doctrine-filemaker-data-api-driver)

A Doctrine driver to interact with FileMaker using the v17+ Data API v1.

Installation
------------

[](#installation)

```
composer require matatirosoln/doctrine-fm-data-api-driver

```

**Note**: We recently update the version of Guzzle used by this library to v7 which requires PHP >= 7.2. If you are still working with an earlier version of PHP then require version `^0.7.5` of this library.

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

[](#configuration)

In your Doctrine configuration comment out

```
driver: xxxx

```

and replace it with

```
driver_class: MSDev\DoctrineFMDataAPIDriver\FMDriver

```

Conventions
-----------

[](#conventions)

1. Create a model to represent a FileMaker **layout**. Set the name of the layout as the model table.

    ```
     /**
      * Keyword
      *
      * @Table(name="Keyword")
      * @Entity(repositoryClass="Repository\KeywordRepository")
      */
      class Keyword

    ```
2. In your model create an id field which is mapped to the special rec\_id pseudo field

    ```
     /**
      * @var int
      *
      * @Column(name="rec_id", type="integer")
      */
     private $id;

    ```
3. Create your 'actual' ID field, as used for relationships, as a separate property of your model. Set its GeneratedValue strategy to be `Custom` which will mean that Doctrie will wait for FM to assign that value - the assumption being that this is an auto-enter calc field (probaby Get(UUID)). You then need to specifiy the CustomIdGenerator and set this to `MSDev\DoctrineFMDataAPIDriver\FMIdentityGenerator` so that the value is returned as a string.

    ```
    /**
     * @var string
     *
     * @Column(name="__pk_ClientID", type="string" length=255)
     * @Id
     * @GeneratedValue(strategy="CUSTOM")
     * @CustomIdGenerator(class="MSDev\DoctrineFMDataAPIDriver\FMIdentityGenerator")
     */
    private $uuid;

    ```

    Alternatively you could generate the UUIDs in your model constructor (using for example [ramsey/uuid](https://github.com/ramsey/uuid)). In this case you'd end up with something like

    ```
     /**
      * @var string
      *
      * @Column(name="__pk_CanvasID", type="string", length=255)
      * @Id
      */
      private $uuid;

      public function __construct()
      {
          $this->uuid = Uuid::uuid4()->toString();
      }

    ```
4. Add other properties as required. To access related fields on your layout enclose the field name in single quotes in the column mapping.

    ```
      /**
       * @var string
       *
       * @Column(name="'absCon::email'", type="string", length=255)
       */
      private $contactEmail;

    ```
5. If you need access to the record modification ID you can add the special mod\_id pseudo property

    ```
     /**
      * @var int
      *
      * @Column(name="mod_id", type="integer")
      */
     private $modId;

    ```

Considerations
--------------

[](#considerations)

1. Because of the way in which more 'conventional' databases handle relationships, there is no concept of a portal. To access related data create a corresponding model for that table (layout) and create standard Doctrine relationships (OneToOne, OneToMany, ManyToOne etc).
2. If your model contains calculation fields you will run into issues when trying to create a new record, since Doctrine will try and set those fields to null. One 'solution' to this is to create a 'stub' of your model which contains only the fields which are necessary to create a new record and to instantiate that for record creation. If you head down this route you'll likely want to create an interface which both your stub and your real entity implement so that you can typehint appropriately.
3. If you wish to perform an IN query, then it needs to be the last `andWhere` set in the query builder so that the previous conditions will be applied to all of the query objects which the Data API requires to simulate an IN query.

See also
--------

[](#see-also)

This driver has been developed for use within Symfony applications (because that's what we do). The [Doctrine FileMaker bundle](https://github.com/matatirosolutions/doctrine-filemaker-driver-bundle "Doctrine FileMaker bundle") creates services to access scripts, containers, etc.

###  Health Score

37

—

LowBetter than 83% of packages

Maintenance43

Moderate activity, may be stable

Popularity22

Limited adoption so far

Community8

Small or concentrated contributor base

Maturity60

Established project with proven stability

 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 ~45 days

Recently: every ~147 days

Total

50

Last Release

619d ago

PHP version history (2 changes)0.1.0PHP >=7.0.0

0.6.0PHP >=7.2.0

### Community

Maintainers

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

---

Top Contributors

[![steveWinter](https://avatars.githubusercontent.com/u/1171712?v=4)](https://github.com/steveWinter "steveWinter (69 commits)")

---

Tags

doctrinedbalFileMaker

###  Code Quality

TestsPHPUnit

### Embed Badge

![Health badge](/badges/matatirosoln-doctrine-fm-data-api-driver/health.svg)

```
[![Health](https://phpackages.com/badges/matatirosoln-doctrine-fm-data-api-driver/health.svg)](https://phpackages.com/packages/matatirosoln-doctrine-fm-data-api-driver)
```

###  Alternatives

[scienta/doctrine-json-functions

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

58523.9M35](/packages/scienta-doctrine-json-functions)[laravel-doctrine/orm

An integration library for Laravel and Doctrine ORM

8425.3M87](/packages/laravel-doctrine-orm)[fresh/doctrine-enum-bundle

Provides support of ENUM type for Doctrine2 in Symfony applications.

4636.8M12](/packages/fresh-doctrine-enum-bundle)[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.

4485.3M4](/packages/martin-georgiev-postgresql-for-doctrine)[damienharper/auditor-bundle

Integrate auditor library in your Symfony projects.

4542.8M](/packages/damienharper-auditor-bundle)[kdyby/doctrine

Doctrine integration into Nette Framework

1091.0M86](/packages/kdyby-doctrine)

PHPackages © 2026

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