airmoi/yii2-fmconnector

FileMaker ODBC and PHP-API integration

2.5 2020-06-29 13:31 UTC

Requires

• airmoi/filemaker: ^2.3.0
• yiisoft/yii2: *@stable

MIT

• Romain Dunand

• extension
• odbc
• FileMaker
• yii2
• FileMaker API-PHP

README

FileMaker ODBC connector and PHP-API integration

Installation

The preferred way to install this extension is through composer.

Either run

php composer.phar require --prefer-dist airmoi/yii2-fmconnector "*"

or add

"airmoi/yii2-fmconnector": "*"

to the require section of your composer.json file.

Usage

1. ODBC connection

Once plugin installed using composer, and ODBC driver configured on the server, Create/Edit your db config file using this lines

return [
    'class' => 'airmoi\yii2fmconnector\db\Connection',
    'dsn' => 'fmp:<odbc_connection_name>',
    'username' => '<odbc_username>',
    'password' => '<odbc_username>',
    'charset' => 'utf8',
    'pdoClass' => 'airmoi\yii2fmconnector\db\PDO',
    //'enableSchemaCache' => true,
    //'schemaCacheDuration' => 86400,
    //'enableQueryCache' => true,
    //'queryCacheDuration' => 1000,
    'schemaMap' => ['fmp' => [
            'class' => 'airmoi\yii2fmconnector\db\Schema',
            /* 
             * Customize this option to ignore specific fields (like global/utils fields) which you don't want to get access
             * Ignore theses fields improve query performences
             */
            'ignoreFields' => [
                'FieldType' => ['global%'],
                'FieldClass' => ['Summary'],
                'FieldName' => ['zkk_%',
                    'zgi_%',
                    'zg_%',
                    'zz_%',
                    'zzz_%',
                    'zlg_%',
                    'z_foundCount_cU',
                    'z_listOf_eval_cU',
                ]
            ],
            /* 
             * Regexp pattern used to detect if a field is a primary key
             * this pattern while be used against fields names
             */
            'primaryKeyPattern' => '/^zkp(_)?/',
            /* 
             * pattern used to detect if a field is a foreign key
             * this pattern while be used against fields names
             * Second match of the pattern must return the foreign key trigram (XXX)
             */
            'foreignKeyPattern' => '/^(zkf|zkp)_([^_]*).*/', //pattern used to detect if a field is a foreign key
        ]
    ]
];

1. PHP-API

You may also configure a connection using PHP-API this way

[
    'class' => 'airmoi\yii2fmconnector\api\Connection',
    'dsn' => 'fmpapi:host=your_host_ip;dbname=your_db_name',
    'username' => 'db username',
    'password' => 'db passwod',
    'charset' => 'utf8',
    //'schemaCache' => 'cache',
    //'enableSchemaCache' => true,
    //'schemaCacheDuration' => 3600,
    'options' => [ //Specific connector options
        'dateFormat' => 'd/m/Y',
        'emptyAsNull' => true,
    ],
    'schemaMap' => [
        'fmpapi' => [
            'class' => 'airmoi\yii2fmconnector\api\Schema',
            //'layoutFiltterPattern' =>  '/^PHP_/' //Regex pattern to filter layout's list
        ]
    ]
]

1. Customize gii

Add these lines to gii module config to enhance model and CRUD generators

'generators' => [
        'model' => [
        'class' => 'yii\gii\generators\model\Generator',
        'templates' => [
            'FileMakerAPI' => '@app/vendor/airmoi/yii2-fmconnector/gii/api/templates/',
            'FileMakerODBC' => '@app/vendor/airmoi/yii2-fmconnector/gii/odbc/templates/',
        ]
    ],
     'crud' => [ // generator name
        'class' => 'airmoi\yii2fmconnector\gii\api\crud\Generator', // generator class
        /*'templates' => [ //setting for out templates
            'myCrud' => '@app/myTemplates/crud/default', // template name => path to template
        ]*/
    ]
],