PHP download

Download the PHP package discoverygarden/flysystem_ocfl without Composer

On this page you can find all versions of the php package discoverygarden/flysystem_ocfl. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.

FAQ

After the download, you have to make one include require_once('vendor/autoload.php');. After that you have to import the classes with use statements.

Example:

If you use only one package a project is not needed. But if you use more then one package, without a project it is not possible to import the classes with use statements.

In general, it is recommended to use always a project to download your libraries. In an application normally there is more than one library needed.

Some PHP packages are not free to download and because of that hosted in private repositories. In this case some credentials are needed to access such packages. Please use the auth.json textarea to insert credentials, if a package is coming from a private repository. You can look here for more information.

Some hosting areas are not accessible by a terminal or SSH. Then it is not possible to use Composer.
To use Composer is sometimes complicated. Especially for beginners.
Composer needs much resources. Sometimes they are not available on a simple webspace.
If you are using private repositories you don't need to share your credentials. You can set up everything on our site and then you provide a simple download link to your team member.
Simplify your Composer build process. Use our own command line tool to download the vendor folder as binary. This makes your build process faster and you don't need to expose your credentials for private repositories.

Please rate this library. Is it a good library?

Informations about the package flysystem_ocfl

Flysystem OCFL

A Flysystem adapter implementation allowing access to within OCFL storage structures.

Presently, targeting read-only access to binaries in FCRepo 6 flavored storage, especially via the lens of Islandora which concerns primarily the storage of binaries.

Execution Overview

OCFL storage is extensible at multiple levels:

the layout proper, how objects are placed within the storage root, supporting:
the structure of objects themselves
- Mutable HEAD

The exact use of the OCFL storage is still up to the application proper, which may have different suggestions as to how objects should be structured, such as:

Fedora OCFL Object Structure; and,
- Fedora Header Files

To support these multiple points of extensibility, we have defined:

for layouts: the OCFLPlugin plugin type, with base implementations of those presently defined extensions.
- We expect the layout to be specified in the ocfl_layout.json file in the root of the OCFL storage.
- Strictly, per the OCFL spec, this file is optional; however, having it present greatly simplifies the loading of the layout plugin.
for object structures: Event evaluation based on the flysystem_ocfl.inventory_location event
- This allows the "Mutable HEAD" extension to inject its bit of indirection, but allows falling back to the base location of an inventory.json sitting in the objects' root directory.
for identifying target resources within objects: Event evaluation based on the flysystem_ocfl.resource_location event.
- This allows the targeting of resources in the object, especially in the Fedora Commons 6 instance of which Islandora makes extensive use, where the object is based off of a singular "binary" resource, where fetching the object in certain instances (such as ours) is best interpreted as acquiring the byte-stream of the file.

Usage

This should offer a similar parallel to the fedora driver shipped with islandora/islandora, which might be configured via your Drupal site's settings.php with something like:

To instead read directly from the OCFL storage layout, with something like:

Hypothetically, this could even be chained with another Flysystem implementation such as S3, such as:

NOTE: An additional prefix within the bucket (ocfl-root in the example above, but could be anything) is presently necessary, due to naive path normalization in Flysystem.

Configuration

See the Flysystem module documentation for more in-depth context on Flysystem adapter configuration.

There are presently two points of configuration for the ocfl driver:

Key	Description	Default
`root`	The base path targetting the OCFL root storage.	N/A (required)
`id_prefix`	Prefix to add to incoming IDs.	the empty string

Known Issues

Not strictly an issue with this module, but may rise relating to the use of non-public filesystems in Drupal: https://www.drupal.org/project/drupal/issues/2786735

Future Thoughts

allow for fragments to be passed via Flysystem URIs, to be interpreted as different resources within a container object
- no present use-case for this

Troubleshooting/Issues

Having problems or solved a problem? Contact discoverygarden.

Maintainers

Current maintainers:

discoverygarden

License

GPLv3

All versions of flysystem_ocfl with dependencies

PHP Build Version

Package Version

Version v1.1.1 Release 28. May 2026
create-project require 0 people chose require and
0 people chose create-project.

Download

Download latest version of flysystem_ocfl from vendor discoverygarden

Requires ext-json Version *
drupal/flysystem Version ^2

Composer command for our command line client (download client) This client runs in each environment. You don't need a specific PHP version etc. The first 20 API calls are free. Standard composer command

The package discoverygarden/flysystem_ocfl contains the following files

Loading the files please wait ...