PHPackages                             mjordan/irc - PHPackages - PHPackages  [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register)

1. [Directory](/)
2. /
3. [API Development](/categories/api)
4. /
5. mjordan/irc

ActiveLibrary[API Development](/categories/api)

mjordan/irc
===========

PHP Library for building clients for Islandora's REST interface.

1411[2 issues](https://github.com/mjordan/irc/issues)PHP

Since Aug 29Pushed 7y ago1 watchersCompare

[ Source](https://github.com/mjordan/irc)[ Packagist](https://packagist.org/packages/mjordan/irc)[ RSS](/packages/mjordan-irc/feed)WikiDiscussions master Synced today

READMEChangelogDependenciesVersions (1)Used By (0)

Islandora REST Client [![Build Status](https://camo.githubusercontent.com/6c47b473972cf2c278479763bf17393294838301a5989cfcee22c9d56c892077/68747470733a2f2f7472617669732d63692e6f72672f6d6a6f7264616e2f6972632e7376673f6272616e63683d6d6173746572)](https://travis-ci.org/mjordan/irc)
======================================================================================================================================================================================================================================================================================

[](#islandora-rest-client-)

PHP library for building clients for Islandora's REST interface, applying a simple pattern of CRUD (Create, Read, Update, Delete) operations to Islandora 7.x objects, relationships, and datastreams. Also provides access to the Islandora REST module's Solr endpoint. The library's goal is to hide the details of intreacting with a REST interface while providing access to the full HTTP responses.

Requirements
------------

[](#requirements)

- On the system where REST client applications/scripts are run
    - PHP 5.5.0 or higher. Tested with PHP 5.5, 5.6, 7.0, 7.1.
    - [Composer](https://getcomposer.org)
- On the Islandora instance
    - [Islandora REST](https://github.com/discoverygarden/islandora_rest)
    - Optionally, [Islandora REST Authen](https://github.com/mjordan/islandora_rest_authen)
    - Optionally, [Islandora REST Extras](https://github.com/mjordan/islandora_rest_extras) (see "Generating DC XML" below for more information).

Installation
------------

[](#installation)

1. `git https://github.com/mjordan/irc.git`
2. `cd irc`
3. `php composer.phar install` (or equivalent on your system, e.g., `./composer install`)

Or, use composer:

```
composer require mjordan/irc

```

and within a composer.json file:

```
    "require": {
        "mjordan/irc": "dev-master"
    }
```

Usage
-----

[](#usage)

Islandora objects, relationships, and datastreams are instantiated using a set of client defaults. In general, you only need to provide a default `base_uri` and any headers you need, e.g. for authentication. For most requests, the appropriate `Content-Type` headers are provided for you. Guzzle's `http_errors` request optin is always set to `false`.

```