matatirosoln/doctrine-filemaker-driver-bundle

Symfony bundle to implement one of the FileMaker Doctrine drivers

1.10.2 2023-12-19 21:22 UTC

README

A Symfony bundle to implement one of the FileMaker Doctrine drivers to allow the use of either FileMaker CWP API or the FileMaker Data API in a Symfony application.

Installation

Install through composer. If you're working in SF from 5.4 onwards use.

composer require matatirosoln/doctrine-filemaker-driver-bundle

If you need to support SF prior to 5.4 you need the (still maintained) 1.7 version.

composer require matatirosoln/doctrine-filemaker-driver-bundle "^1.7"

Important Note: You will also need to install the appropriate driver now that we have also released a driver for the Data API (this is a breaking change in v1.0. Originally the CWP driver was automatically installed by this bundle, however that doesn't now happen because you may not want it ;-).

If you wish to interact with FileMaker using the CWP PHP API

composer require matatirosoln/doctrine-filemaker-driver

Alternatively to use the Data API

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

Configuration

For symfony less than v4.0 add the bundle to AppKernal.php

    new MSDev\DoctrineFileMakerDriverBundle\DoctrineFileMakerDriverBundle()

For Symfony v4+ add the bundle to bundles.php

    MSDev\DoctrineFileMakerDriverBundle\DoctrineFileMakerDriverBundle::class => ['all' => true],

Configure Doctrine to use the FileMaker driver. In your Doctrine configuration comment out

driver: xxxx

and replace it with

driver_class: MSDev\DoctrineFileMakerDriver\FMDriver

    or

driver_class: MSDev\DoctrineFMDataAPIDriver\FMDriver

If you wish to make use of the value lists functionality add the following to 'config.yaml' (or your chosen config file)

doctrine_file_maker_driver:
   valuelist_layout: 'ValueLists'

See the notes on 'conventions' with regard to creating entities for use with FileMaker in the Doctrine FileMaker driver readme.

Services

There are a number of useful services etc which this bundle adds to your project.

  1. Access to scripts within your FileMaker solution
  2. Interaction with containers
  3. Using valuelists through a twig extension.
  4. Storing translations in your FileMaker database.