FileMaker OData API Client (ifresh/filemaker-odata-api)

Lightweight PHP client for interacting with FileMaker's OData endpoint using Saloon.

Overview

• Connector: IFresh\FileMakerODataApi\FileMakerODataConnector — builds the base URL, provides authentication and resources.
• Resources:
  • IFresh\FileMakerODataApi\Resources\Resources\MetadataResource — metadata endpoints.
  • IFresh\FileMakerODataApi\Resources\Resources\RecordsResource — CRUD operations for entity sets.
• Request classes live under src/Requests (metadata and records). Examples:
  • IFresh\FileMakerODataApi\Requests\Metadata\GetDatabaseNamesRequest
  • IFresh\FileMakerODataApi\Requests\Metadata\GetTableListRequest
  • IFresh\FileMakerODataApi\Requests\Metadata\GetDatabaseMetadataRequest
  • IFresh\FileMakerODataApi\Requests\Records\CreateRecordRequest
  • IFresh\FileMakerODataApi\Requests\Records\UpdateRecordRequest
  • IFresh\FileMakerODataApi\Requests\Records\DeleteRecordRequest
  • IFresh\FileMakerODataApi\Requests\Records\FetchRecordsRequest
  • IFresh\FileMakerODataApi\Requests\Records\FetchSingleRecordRequest
• Query helpers: IFresh\FileMakerODataApi\QueryOptions
• Custom pending request to merge query params: IFresh\FileMakerODataApi\Requests\PendingFileMakerRequest

Installation

composer require ifresh/filemaker-odata-api

Copy environment template and set values:

• .env.example
  • FM_HOST
  • FM_USERNAME
  • FM_PASSWORD

Basic Usage

use IFresh\FileMakerODataApi\FileMakerODataConnector;

$connector = new FileMakerODataConnector(
    host: 'https://example.com',
    username: 'user',
    password: 'pass',
    database: 'Tasks' // optional default database
);

// Metadata
$databases = $connector->metadata()->getDatabaseNames();

// Records
$recordsResource = $connector->records('Assignees');
$new = $recordsResource->createRecord(['First Name' => 'John', 'Last Name' => 'Doe']);
$single = $recordsResource->fetchSingleRecord($new['PrimaryKey']);

See src/FileMakerODataConnector.php and resources for more methods.

Querying

Use IFresh\FileMakerODataApi\QueryOptions to supply OData query options (filter, orderby, top, skip, select, count).

Tests

This package is tested with Pest. See the test bootstrap and helpers:

• tests/Pest.php
• tests/TestCase.php
• Fixtures for faking HTTP responses: tests/Fixtures/ODataFixture.php and JSON fixtures in tests/Fixtures/Saloon

Run tests:

composer install --dev
./vendor/bin/pest

Notes for Contributors

• Coding standards via Laravel Pint (dev).
• Static analysis: phpstan.neon (level 6).
• The connector uses Saloon's BasicAuthenticator by default (see test: tests/Feature/FileMakerODataConnectorTest.php).

License

See composer.json for package metadata: composer.json