Skip to content

Commit ab04786

Browse files
committed
updated readme
1 parent 21e68fa commit ab04786

File tree

1 file changed

+29
-3
lines changed

1 file changed

+29
-3
lines changed

README.md

Lines changed: 29 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -24,12 +24,38 @@ This package is built and maintained by [Gearbox Solutions](https://gearboxgo.co
2424
* Running scripts
2525
* And more!
2626

27-
## Requirements
28-
Laravel 9.0+
27+
## What's new in 2.0
28+
* Added support for Laravel 11
29+
* Dropped support for Laravel 9
30+
* FileMaker Sessions only last for the duration of a single request to Laravel instead of being reused for 15 minutes - Cache is no longer required
31+
* Improvements to whereNot logic and implementation to make it behave more closely to what it should be
32+
33+
### Upgrading from 1.x to 2.x
34+
Run `composer require gearbox-solutions/eloquent-filemaker:^2.0` to upgrade to the latest version of the package.
35+
36+
#### Potential changes to your code
37+
38+
The upgrade to 2.0 should be pretty seamless for most use cases.
39+
40+
41+
##### Changes to session management
42+
In version 1.0 the same FileMaker Data API session was used for all requests for about 15 minutes at a time, until the token expired. This token was stored in the Laravel Cache between requests. This behavior has been changed in version 2.0.
43+
44+
In this version 2.0, a Data API session lasts for only the duration of one request to your Laravel app. Login is performed the first time you use request data from the Data API. The session is ended and a logout is performed after the response has been sent to the browser through the use of [terminable middleware](https://laravel.com/docs/11.x/middleware#terminable-middleware).
2945

30-
PHP 8.0+
46+
If you have any code which relies on the Data API session being reused between requests to your Laravel app, such as setting a global field once and then reading it across multiple page loads of your Laravel app, you will need to refactor your code to work with the new behavior.
47+
48+
49+
##### Improvements to whereNot logic
50+
There were some cases where whereNot may return results that were probably not correct or expected. This has been fixed in version 2.0. If you have any code which relies on the old, incorrect behavior of whereNot, you may need to refactor your code to work with the new corrected behavior.
51+
52+
53+
54+
## Requirements
55+
Laravel 10.0+
3156

3257
For Laravel versions greater than 7.3 and less than 9.0, use version [0.2.10](https://github.com/gearbox-solutions/eloquent-filemaker/blob/0.2.10)
58+
For Laravel 9 use version [1.](https://github.com/gearbox-solutions/eloquent-filemaker/tree/1.x)
3359

3460
# Installation
3561
Install `gearbox-solutions/eloquent-filemaker` in your project using Composer.

0 commit comments

Comments
 (0)