biigle / ifdo
iFDO Parser Package to parse and validate the iFDO JSON Schema
v1.0.1
2024-11-07 13:46 UTC
Requires
- php: ^8.1
- justinrainbow/json-schema: ^5.2
Requires (Dev)
- phpunit/phpunit: ^10.0 || ^11.0
README
A PHP package to read and validate iFDO v2 files.
Installation
composer require biigle/ifdo
Usage
use Biigle\Ifdo\Ifdo; $path = __DIR__ . '/fixtures/ifdo-test-v2.0.0.json'; $obj = Ifdo::fromFile($path); // print errors to console if document is no valid $obj->setDebug(true); // check if document is valid $obj->isValid(); // get list of errors if there are any $obj->getErrors(); // get full json as array $obj->getJsonData(); // shorthands to safely access info $obj->getImageSetHeader(); $obj->getImageSetItems(); // use strict mode trigger exceptions for invalid files $obj = Ifdo::fromString('{"some": "json"}', true); // get json encoded string $obj->toString();
Testing
composer test