https://github.com/reload/openplatform-client

https://github.com/reload/openplatform-client

Last synced: about 5 hours ago
JSON representation

• Host: GitHub
• URL: https://github.com/reload/openplatform-client
• Owner: reload
• Created: 2019-10-01T19:38:44.000Z (about 5 years ago)
• Default Branch: master
• Last Pushed: 2022-02-03T10:46:18.000Z (almost 3 years ago)
• Last Synced: 2023-03-11T02:34:42.839Z (over 1 year ago)
• Language: PHP
• Size: 51.8 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# OpenPlatform client lib.

[![](https://github.com/reload/openplatform-client/workflows/Build%20and%20test/badge.svg)](https://github.com/reload/openplatform-client/actions?query=workflow%3A%22Build+and+test%22)

[![](https://github.com/reload/openplatform-client/workflows/Code%20style%20review/badge.svg)](https://github.com/reload/openplatform-client/actions?query=workflow%3A%22Code+style+review%22)

[![codecov](https://codecov.io/gh/reload/openplatform-client/branch/master/graph/badge.svg)](https://codecov.io/gh/reload/openplatform-client)

This package provides a simple interface to

[OpenPlatform](https://openplatform.dbc.dk/v3/) provided by DBC.

## Installation

```shell

composer require danskernesdigitalebibliotek/openplatform

```

## Usage

A working example:

``` php

$op = new OpenPlatform($token);

$res = $op->search('harry AND potter')

    ->withFields(['pid', 'title'])

    ->execute();

foreach ($res->getData() as $material) {

    print $material['pid'][0] . ': ' . $material['title'][0] . "\n";

}

```

In short:

1. Create an OpenPlatform instance and supply it a token (see [How to

   obtain a token](#how-to-obtain-a-token)).

2. Call a method that returns a `*Request` object.

3. Chain with `with*` methods to set parameters.

4. End with `execute` to get a lazy loading result.

5. Get response data from getters on the response object.

### Generic requests

As this library is far from complete in regard to the amount of calls

implemented, there's also a generic request that'll work with any

OpenPlatform call that: a) takes an access token and b) has statusCode

in the reply (which should be all of them).

### Lazy loading

This library uses [Symfony

HttpClient](https://symfony.com/doc/current/components/http_client.html),

so responses only perform the request when you ask for the data. Also

means that you can create multiple responses, and the requests will be

performed in parallel when accessing data on any one.

## CLI command

The library includes a CLI command, `bin/openplatform`, which

functions both as a practical example, and as an exploratory tool. You

need to install dev dependence for the project in order to use it.

## How to obtain a token

You can get a token keyed to a user by authenticating the user with

[Adgangsplatformen](https://github.com/DBCDK/hejmdal). You can use

[oauth2-adgangsplatformen](https://github.com/reload/oauth2-adgangsplatformen)

for communicating with the service.

If you have a client id and secret, you can generate a token at

https://openplatform.dbc.dk/v3/ .