FMDataAPI Ver.12

by Masayuki Nii (nii@msyk.net)

FMDataAPI is a class developed by PHP to access FileMaker database with FileMaker Data API.

At a Glance

The FileMaker database named "TestDB.fmp12" is hosted on localhost, and it set the "fmrest" as access privilege. The account to connect with REST API is "web" and "password". This database has the layout named "person_layout" and you can use the layout name as a property of the FMDataAPI instance. The return value of the "query" method is Iterator and can repeat in foreach statement with each record in the query result. This layout has the field named "FamilyName" and "GivenName," and also can use the field name as a property.

$fmdb = new FMDataAPI("TestDB", "web", "password");
$result = $fmdb->person_layout->query();
foreach ($result as $record) {
    echo "name: {$record->FamilyName}, {$record->GivenName}";
}

For more deitals, I'd like to read codes and comments in file samples/FMDataAPI_Sample.php.

API Document is here: http://inter-mediator.info/FMDataAPI/namespaces/INTERMediator.FileMakerServer.RESTAPI.html

What's This?

The FileMaker Data API is the new feature of FileMaker Server 16, and it's a API with REST-based database operations. Although the Custom Web Publishing is the way to access the database for a long while, FileMaker Inc. has introduced modern feature to operate database. Current version of FMDataAPI works on just FileMaker 17 platform.

For now I'm focusing to develop the web application framework "INTER-Mediator" (https://inter-mediator.org/ or https://github.com/INTER-Mediator/INTER-Mediator.git) which can develop the core features of database-driven web application with declarative descriptions. INTER-Mediator has already supported the Custom Web Publishing with FX.php, and I develop codes here for support REST APIs.

Bug reports and contribution are welcome.

Installing to Your Project

The file "FMDataAPI.php" contains all you need to access FileMaker Data API. You can download it or clone this repository.

FMDataAPI has "composer.json," so you can add your composer.json file in your project as below.

...
"require": {
  ...
  "inter-mediator/fmdataapi":"10"
} ...

About Files and Directories

FMDataAPI.php
- The core class, and you just use this for your application. This class and inner private classes are object-oriented REST API wrappers.
samlpes/FMDataAPI_Sample.php and cat.jpg
- This is the sample program of FMDataAPI class, and shows how to use FMDataAPI class. Rich comments are described.
README.md, .gitignore
- These are for GitHub.

What's Finished and To Do

Already Finished

Understand the FileMaker's REST API for me.
Support all API calls in FileMaker Data API.
OAuth integrations.
Supporting FileMaker 17.

What's To Do

Create unit test suite.
Check any layout and field names without variable friendly name.
Error handling for wider cases with exception based.

Licence

MIT License

Acknoledgement

Thanks to Atsushi Matsuo. Your script is quite helpful to implement the "localserver" feature. (https://gist.github.com/matsuo/ef5cb7c98bb494d507731886883bcbc1) Moreover thanks for updating and fixing bugs.
Thanks to Frank Gonzalez. Your bug report is brilliant and I could fix it quickly.
Thanks to base64bits for coding about container field.
Thanks to phpsa for bug fix.

History

April 2017: Start to create these classes and codes.
2017-05-05: Described README.md
2017-05-26: [Ver.2] Support the "localserver" as host name.
2017-05-31: [Ver.3] The query() method of FileMakerLayout class is fixed. 'Offset' and 'range' parameters could not set as an integer value.
2017-11-06: [Ver.4] The getFieldNames() and getPortalNames() methods are added.
2018-02-03: [Ver.5] Bug fix of sorting parameters in query method.
2018-02-18: [Ver.6] Bug fix of creating record with no default value.
2018-03-25: [Ver.7] getSessionToken method is added. OAuth handling is implemented but not well debugged.
2018-05-09: The Version 7 is the last version which supports FileMaker 16 based Data API.
2018-05-15: [Ver.8] Update for FileMaker 17. FileMaker Data API v1 is supported from this version. The preview version of FileMaker Data API is not supported anymore.
2018-05-27: [Ver.9] composer.json is added, and can install "inter-mediator/fmdataapi". FMDataAPITrial directory is deleted because it's already discontinued api. Add the "samples" directory and move sample files into it.
2018-06-22: [Ver.10] Added the getContainerData method (Thanks to base64bits!), bug fix (Thanks to phpsa!).
2018-07-22: [Ver.11] Global field methods bug fixed and were available in FMDataAPI class (Tanks to Mr.Matsuo). The script errors and results can get from methods in FMLayout class.
2018-07-29: [Ver.12] Bug fix for UUID Supporting (Thanks to Mr.Matsuo). Unit tests is implemented but now limited methods are tested, als integrating Travis CI.

API Differences between ver.8 and 7.

FMDataAPI class

The setAPIVersion method is added. This is for future update of FileMaker Data API. As far as FMDataAPI Ver.8 goes, This isn't requred.

public function __construct($solution, $user, $password, $host = NULL, $port = NULL, $protocol = NULL, [New]$fmDataSource = null)
[New]public function setAPIVersion($vNum)

FileMakerRelation class

The following methods are added script parameters. See the query method's document for specifying it. Twe methods are added portal parameter.

public function query($condition = NULL, $sort = NULL, $offset = -1, $range = -1, $portal = null, [New]$script = null)
public function getRecord($recordId, $portal = null, [New]$script = null)
public function create($data = null, [New]$portal = null, [New]$script = null)
public function delete($recordId, [New]$script = null)
public function update($recordId, $data, $modId = -1, [New]$portal = null, [New]$script = null)
[New]public function uploadFile($filePath, $recordId, $containerFieldName, $containerFieldRepetition = null, $fileName = null)

base64bits / FMDataAPI