Download the PHP package thomas-institut/apm-publication-api without Composer

On this page you can find all versions of the php package thomas-institut/apm-publication-api. 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?

Example code of thomas-institut/apm-publication-api

Informations about the package apm-publication-api

APM Publication API

This repo provides the official definition of APM's publication API in PHP and a client implementation.

This repo is still alpha. DO NOT assume any information or code here will stay as it is right now.

API Description

The Publication API is how APM publishes its data to external clients, most notably APE. APM users determine which resources they want to make available to specific clients, and the clients call the API to get a listing of these resources and to get the data.

There are two calls:

A publication listing consists of general information about a publication:

The data for a publication contains this same information together with all required resource's data according to the publication type.

Publication Types

Text

A text string without any formatting.

Transcription

The transcription of a document, normally a manuscript. It consists of an array of pages, each one with a number of columns, with each column containing a transcription. A column transcription consists of an array of elements (main text, marginal additions, etc.). Each element in turn consists of an array of transcription items: simple text, abbreviations, additions, etc.

Edition

TBD

Api Client

The PublicationApiClient requires a PSR-18 HTTP Client and a PSR-17 Request Factory. Below is an example of how to use it with Guzzle.

Installation

If you don't have an HTTP client yet, you can install Guzzle:

Usage Example

Key Components

All versions of apm-publication-api with dependencies

PHP Build Version
Package Version
Requires php Version ^8.3
thomas-institut/standard-api Version 1.0.0
psr/log Version ^3.0.2
psr/http-client Version ^1.0
psr/http-factory Version ^1.0
cuyz/valinor Version ^2.4
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 thomas-institut/apm-publication-api contains the following files

Loading the files please wait ...