https://github.com/pdsinterop/flysystem-rdf
FlySystem plugin to transform RDF data between various serialization formats.
https://github.com/pdsinterop/flysystem-rdf
easyrdf flysystem flysystem-plugin pdsinterop php php-library php7 rdf
Last synced: about 1 month ago
JSON representation
FlySystem plugin to transform RDF data between various serialization formats.
- Host: GitHub
- URL: https://github.com/pdsinterop/flysystem-rdf
- Owner: pdsinterop
- License: mit
- Created: 2020-07-19T13:43:08.000Z (over 5 years ago)
- Default Branch: main
- Last Pushed: 2025-05-16T08:58:05.000Z (10 months ago)
- Last Synced: 2025-11-15T18:11:40.133Z (3 months ago)
- Topics: easyrdf, flysystem, flysystem-plugin, pdsinterop, php, php-library, php7, rdf
- Language: PHP
- Homepage: https://pdsinterop.org/flysystem-rdf/
- Size: 144 KB
- Stars: 3
- Watchers: 1
- Forks: 0
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# Flysystem RDF Converter Plugin
[![Project stage: Development][project-stage-badge: Development]][project-stage-page]
[![License][license-shield]][license-link]
[![Latest Version][version-shield]][version-link]
![Maintained][maintained-shield]
[![PDS Interop][pdsinterop-shield]][pdsinterop-site]
[![standard-readme compliant][standard-readme-shield]][standard-readme-link]
[![keep-a-changelog compliant][keep-a-changelog-shield]][keep-a-changelog-link]
_Flysystem plugin to transform RDF data between various serialization formats._
When using RDF, you will notice there are several different popular
serialization formats. Instead of having to store data in multiple formats, it
is easier to store the data in one format and convert it to others as needed.
This project contains a plugin to be used with Flysystem to do just that.
For the conversion EasyRDF is used. Any formats supported by EasyRDF are
available from this plugin.
Currently supported formats are:
- JSON-LD
- N-triples
- Notation 3 / N3
- RDF/XML
- Turtle
## Table of Contents
- [Background](#background)
- [Installation](#installation)
- [Usage](#usage)
- [Adapter](#adapter)
- [Plugin](#plugin)
- [Contribute](#contribute)
- [License](#license)
## Background
This project is part of the PHP stack of projects by PDS Interop. It is used by
both the Solid-Nextcloud app and the standalone PHP Solid server.
As the functionality seemed useful for other projects, it was implemented as a
separate package.
## Installation
The advised install method is through composer:
```sh
composer require pdsinterop/flysystem-rdf
```
PHP version 7.3 and higher is supported. The [`mbstring`](https://www.php.net/manual/en/book.mbstring.php)
extension needs to be enabled in order for this package to work.
## Usage
This package offers features to read files from a Filesystem that have been
stored in one RDF format as another format.
These features are provided by a plugin and an adapter.
The plugin is best suited for light-weight scenarios where all you want to do is
convert a file to another format.
The adapter is best suited for full-featured usage of Flysystem, as it also
handles calls to `has` and `getMimeType` correctly (which the plugin does not)
### Adapter
To use the adapter, instantiate it, add it to a Flysystem filesystem and add the
helper plugin.
```php
addPlugin(new \Pdsinterop\Rdf\Flysystem\Plugin\AsMime($formats));
// Read the contents of a file in the format it was stored in
$content = $filesystem->read('/foaf.rdf');
// Read the contents of a file in another format from what was stored in
$convertedContents = $filesystem
->asMime('text/turtle')
->read('/foaf.rdf');
// Get the MIME type of the format the requested mime-type would return
// This is especially useful for RDF formats that can be requested with several
// different MIME types.
$convertedMimeType = $filesystem
->asMime('text/turtle')
->getMimetype('/foaf.rdf');
// This also works for `has`
$hasConvertedContents = $filesystem
->asMime('text/turtle')
->has('/foaf.ttl');
// Without using the plugin, this will be false
$hasContents = $filesystem->has('/foaf.ttl');
```
The adapter adds any found `.meta` files that reference a file to that file's
metadata, which can be retrieved with `$filesystem->getMetadata($path)`.
### Plugin
To use the plugin, instantiate it and add it to a Flysystem filesystem.
The function `readRdf` can then be called to get RDF files in a specific format:
```php
addPlugin($plugin);
// Read the contents of a RDF file in another format from what was stored in
$content = $filesystem->readRdf('/foaf.rdf', \Pdsinterop\Rdf\Enum\Format::TURTLE);
```
## Develop
- Do not forget to install the required dependencies using `composer`.
- Most of the logic here involves EasyRdf and/or FlySystem. You'll want to familiarise yourself with their workings.
- Test are available in the `tests/` directory. They are run by GitHub actions for any pull request. To run them,call `./bin/phpunit`
- The changelog can be automatically generated using [`github_changelog_generator`](https://github.com/github-changelog-generator/github-changelog-generator) with the [provided configuration file](.github_changelog_generator)
## Contributing
Questions or feedback can be given by [opening an issue on GitHub][issues-link].
All PDS Interop projects are open source and community-friendly.
Any contribution is welcome!
For more details read the [contribution guidelines][contributing-link].
All PDS Interop projects adhere to [the Code Manifesto](http://codemanifesto.com)
as its [code-of-conduct][code-of-conduct]. Contributors are expected to abide by its terms.
There is [a list of all contributors on GitHub][contributors-page].
For a list of changes see the [CHANGELOG][changelog] or [the GitHub releases page][releases-page].
## License
All code created by PDS Interop is licensed under the [MIT License][license-link].
[changelog]: CHANGELOG.md
[code-of-conduct]: CODE_OF_CONDUCT.md
[contributing-link]: CONTRIBUTING.md
[contributors-page]: https://github.com/pdsinterop/flysystem-rdf/contributors
[issues-link]: https://github.com/pdsinterop/flysystem-rdf/issues
[releases-page]: https://github.com/pdsinterop/flysystem-rdf/releases
[keep-a-changelog-link]: https://keepachangelog.com/
[keep-a-changelog-shield]: https://img.shields.io/badge/Keep%20a%20Changelog-f15d30.svg?logo=data%3Aimage%2Fsvg%2Bxml%3Bbase64%2CPHN2ZyB4bWxucz0iaHR0cDovL3d3dy53My5vcmcvMjAwMC9zdmciIGZpbGw9IiNmZmYiIHZpZXdCb3g9IjAgMCAxODcgMTg1Ij48cGF0aCBkPSJNNjIgN2MtMTUgMy0yOCAxMC0zNyAyMmExMjIgMTIyIDAgMDAtMTggOTEgNzQgNzQgMCAwMDE2IDM4YzYgOSAxNCAxNSAyNCAxOGE4OSA4OSAwIDAwMjQgNCA0NSA0NSAwIDAwNiAwbDMtMSAxMy0xYTE1OCAxNTggMCAwMDU1LTE3IDYzIDYzIDAgMDAzNS01MiAzNCAzNCAwIDAwLTEtNWMtMy0xOC05LTMzLTE5LTQ3LTEyLTE3LTI0LTI4LTM4LTM3QTg1IDg1IDAgMDA2MiA3em0zMCA4YzIwIDQgMzggMTQgNTMgMzEgMTcgMTggMjYgMzcgMjkgNTh2MTJjLTMgMTctMTMgMzAtMjggMzhhMTU1IDE1NSAwIDAxLTUzIDE2bC0xMyAyaC0xYTUxIDUxIDAgMDEtMTItMWwtMTctMmMtMTMtNC0yMy0xMi0yOS0yNy01LTEyLTgtMjQtOC0zOWExMzMgMTMzIDAgMDE4LTUwYzUtMTMgMTEtMjYgMjYtMzMgMTQtNyAyOS05IDQ1LTV6TTQwIDQ1YTk0IDk0IDAgMDAtMTcgNTQgNzUgNzUgMCAwMDYgMzJjOCAxOSAyMiAzMSA0MiAzMiAyMSAyIDQxLTIgNjAtMTRhNjAgNjAgMCAwMDIxLTE5IDUzIDUzIDAgMDA5LTI5YzAtMTYtOC0zMy0yMy01MWE0NyA0NyAwIDAwLTUtNWMtMjMtMjAtNDUtMjYtNjctMTgtMTIgNC0yMCA5LTI2IDE4em0xMDggNzZhNTAgNTAgMCAwMS0yMSAyMmMtMTcgOS0zMiAxMy00OCAxMy0xMSAwLTIxLTMtMzAtOS01LTMtOS05LTEzLTE2YTgxIDgxIDAgMDEtNi0zMiA5NCA5NCAwIDAxOC0zNSA5MCA5MCAwIDAxNi0xMmwxLTJjNS05IDEzLTEzIDIzLTE2IDE2LTUgMzItMyA1MCA5IDEzIDggMjMgMjAgMzAgMzYgNyAxNSA3IDI5IDAgNDJ6bS00My03M2MtMTctOC0zMy02LTQ2IDUtMTAgOC0xNiAyMC0xOSAzN2E1NCA1NCAwIDAwNSAzNGM3IDE1IDIwIDIzIDM3IDIyIDIyLTEgMzgtOSA0OC0yNGE0MSA0MSAwIDAwOC0yNCA0MyA0MyAwIDAwLTEtMTJjLTYtMTgtMTYtMzEtMzItMzh6bS0yMyA5MWgtMWMtNyAwLTE0LTItMjEtN2EyNyAyNyAwIDAxLTEwLTEzIDU3IDU3IDAgMDEtNC0yMCA2MyA2MyAwIDAxNi0yNWM1LTEyIDEyLTE5IDI0LTIxIDktMyAxOC0yIDI3IDIgMTQgNiAyMyAxOCAyNyAzM3MtMiAzMS0xNiA0MGMtMTEgOC0yMSAxMS0zMiAxMXptMS0zNHYxNGgtOFY2OGg4djI4bDEwLTEwaDExbC0xNCAxNSAxNyAxOEg5NnoiLz48L3N2Zz4K
[license-link]: ./LICENSE
[license-shield]: https://img.shields.io/github/license/pdsinterop/flysystem-rdf.svg
[maintained-shield]: https://img.shields.io/maintenance/yes/2022.svg
[pdsinterop-shield]: https://img.shields.io/badge/-PDS%20Interop-7C4DFF.svg?logo=data%3Aimage%2Fsvg%2Bxml%3Bbase64%2CPHN2ZyB4bWxucz0iaHR0cDovL3d3dy53My5vcmcvMjAwMC9zdmciIHZpZXdCb3g9Ii01IC01IDExMCAxMTAiIGZpbGw9IiNGRkYiIHN0cm9rZS13aWR0aD0iMCI+CiAgICA8cGF0aCBkPSJNLTEgNTJoMTdhMzcuNSAzNC41IDAgMDAyNS41IDMxLjE1di0xMy43NWEyMC43NSAyMSAwIDAxOC41LTQwLjI1IDIwLjc1IDIxIDAgMDE4LjUgNDAuMjV2MTMuNzVhMzcgMzQuNSAwIDAwMjUuNS0zMS4xNWgxN2EyMiAyMS4xNSAwIDAxLTEwMiAweiIvPgogICAgPHBhdGggZD0iTSAxMDEgNDhhMi43NyAyLjY3IDAgMDAtMTAyIDBoIDE3YTIuOTcgMi44IDAgMDE2OCAweiIvPgo8L3N2Zz4K
[pdsinterop-site]: https://pdsinterop.org/
[project-stage-badge: Development]: https://img.shields.io/badge/Project%20Stage-Development-yellowgreen.svg
[project-stage-page]: https://blog.pother.ca/project-stages/
[standard-readme-link]: https://github.com/RichardLitt/standard-readme
[standard-readme-shield]: https://img.shields.io/badge/-Standard%20Readme-brightgreen.svg
[version-link]: https://packagist.org/packages/pdsinterop/flysystem-rdf
[version-shield]: https://img.shields.io/github/v/release/pdsinterop/flysystem-rdf?sort=semver