Download the PHP package bcdh/exist-db-rest-client without Composer

Laravel eXist-db REST Client

A small Laravel-friendly client for querying eXist-db over its REST API, parsing XML responses, and applying XSLT transformations.

Version compatibility

• 1.1.x: Laravel 8
• 1.2.x (v1.2.0): Laravel 9
• 1.3.x: planned for Laravel 10
• 2.x: planned for Laravel 11+

The latest released bridge line is 1.2.x for Laravel 9.

The default branch, master, is the development branch. Use a tagged release when installing the package in an application.

Requirements

Current master branch requirements:

• PHP ^7.2|^8.0
• Laravel / illuminate/support ^5.5|^6.0|^7.0|^8.0
• PHP XSL extension for XSLT transformations
• An accessible eXist-db REST endpoint

Installation

Install the version that matches your Laravel line:

For Laravel 8, use:

Laravel package discovery will register the service provider automatically.

If you are integrating the package into an older Laravel application without package discovery, register the provider manually in config/app.php:

Publish the package configuration:

Then adjust config/exist-db.php:

Basic usage

getDocument() returns the parsed XML result. getRawResult() returns the raw XML string from eXist-db.

Using the client outside Laravel

You can also pass configuration directly:

Query helpers

Query supports:

• setQuery($xquery) for inline XQuery
• setStoredQuery($path) for stored XQuery resources
• setCollection($collection)
• setResource($resource)
• bindVariable($name, $value) for XQuery variable substitution
• bindParam($name, $value) for request parameters
• setBody($body) for request payloads
• get(), post(), put(), and delete()

Example with a stored query and request parameter:

Example uploading XML into a collection:

Result parsing

Results are parsed with sabre/xml. You can pass your own Sabre\Xml\Service instance to any request method:

Typical parsed output looks like this:

XSLT transformations

XMLResult::transform() applies an XSL stylesheet to either the full document or a selected fragment.

Transform a single result node:

Transform a collection of nodes with a custom root tag:

Running tests

The test suite expects a local eXist-db instance at http://localhost:8080/exist/rest/ with the default admin/admin credentials.

Run: