Download the PHP package elan-ev/opencast-api without Composer
On this page you can find all versions of the php package elan-ev/opencast-api. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download elan-ev/opencast-api
More information about elan-ev/opencast-api
Files in elan-ev/opencast-api
Package opencast-api
Short Description A comprehensive PHP library for Opencast
License GPL-3.0-or-later
Homepage https://docs.opencast.org/
Informations about the package opencast-api
opencast-php-library
This PHP composer package is meant to provide a unified easy-to-use Opencast RESTful API library. It has been designed to make most of commonly used REST Endpoints available to the developers of thirt-party applications mainly LMSes such as Stud.IP, Moodle and ILIAS. Please refer to the Change Log for more info.
Note
As of version 1.2.0 the main class name has been changed from OpenCast to Opencast. Please refer to Upgrade Log for more info.
Requisitions
PHP Version 7.2.5 or above as well as cURL are required. Additionaly, the requirements of guzzlehttp/guzzle must be fullfiled.
Note: Starting from version 2.x, the minimum required PHP version is 8.1.
Installation
composer require elan-ev/opencast-api
Basic Usage
There are 2 approaches to use the Opencast REST Endpoints from this library:
- The first one is via the generic
OpencastApi\Opencastwhich contains all available Opencast endpoints (which are capable with the API version defined in the config). The advantage of using this approach is a better control over all available endpoints. (Recommended)
NOTE: When using this library against a distributed Opencast setup with admin and presentation split, you can pass another set of configuration as the second parameter when instantiating the OpencastApi\Opencast. Initially, the presentation node only takes care of search endpoint.
- The second approach is to instantiate each REST endpoint class, which are located under
OpencastApi\Rest\namespace, when needed, but the down side of this is that it needs aOpencastApi\Rest\OcRestClientinstance as its parameter. The advantage of this approach might be the methods' definitions in the IDE.
Configuration
The configuration is type of Array and has to be defined as follows:
Update (v2.0.0): A new configuration parameter has been introduced to enable JWT authentication, allowing the JWT component to issue and validate tokens. For more details, see the JWT Authentication Mechanism.
UPDATE (v1.9.0): a new config parameter called "guzzle" is introduced, which is intended to pass additional guzzle request options to the call. These options will take precedence over the default configs like uri, auth and timeouts, but some other options like query, fome_params and json will be overwritten by the function if present.
UPDATE (v1.7.0): the new items called
featuresis added to the configuration array. As of now, it is meant to hanlde the toggle behavior to enable/disable Lucene search endpoint simply by adding'features' => ['lucene' => true]. Just keep in mind that this endpoint id off by default and won't work in Opencast 16 onwards. Therefore, developer must be very careful to use this feature and to toggle it!NOTE: the configuration for presentation (
engagenode) responsible for search has to follow the same definition as normal config. But in case any parameter is missing, the value will be taken from the main config param.
Extra: Dynamically loading the ingest endpoint class into Opencast instance.
As of v1.3 it is possible to enable (Default) or disable the ingest endpoint to be loaded into OpencastApi\Opencast by passing a boolean value as the last argument of the class as follows:
JWT Authentication Mechanism
Starting from version 2.0.0, the Opencast PHP library introduces a JWT-based authentication mechanism. This feature handles issuing and verifying access tokens, creating Opencast-specific claims, and validating these claims.
For details about Opencast's JWT configuration and claim standards, see the official documentation: 👉 Opencast Configuration for JWT-based Authentication and Authorization
Requirements
To support this feature, some version requirements apply:
- PHP: 8.1 or higher
- Opencast: 18.0 or higher (JWT and ACL support required)
Configuration
To enable JWT authentication in this library, add the jwt configuration array to your existing setup:
How to Use
Before performing authenticated requests, you need to create an Opencast-specific claim using OcJwtClaim.
Calling Endpoints with JWT
You can call API endpoints using JWT simply by chaining the withClaims() method before the desired service:
Token Generation and Validation
This approach is typically used when you only need to generate or validate JWT access tokens. You first need to call getJwtHandler() from the Opencast class to obtain an instance of OcJwtHandler - the library's core JWT component - which provides access to the validateToken() and issueToken() methods.
Response
The return result of each call is an Array containing the following information:
From v1.4 the 5th response parameter 'origin' is available!
Filters and Sorts
Filters and Sorts must be defined as associative Array, as follows:
NOTE: Sometimes a filter can occur multiple times for example in Series API /get, filters like subject and identifier can occur multiple times. Therefore, an Array should be passed as filter value like following:
runWithRoles([])
Sometimes it is needed to perform the request with a disposable header of X-RUN-WITH-ROLES containing some roles (e.g. user ids) in order for Opencast to assume that those users has special access right.
It is commonly used to get data with onlyWithWriteAccess parameter for example to perform getAll in OcSeriesApi and grab those series that only specified users have access to!
In order to perform such requests it is needed to call the runWithRoles method before calling the desired function in a class:
NOTE: This method accepts an Array defining the roles to check against!
NOTE: Roles can be either an Array including each role, or a comma separated string!
runAsUser($user)
Sometimes it is needed to perform the request with a disposable header of X-RUN-AS-USER containing the user id in order for Opencast to assume that this user has access right. This feature is added since v1.4.
NOTE: This method accepts an String defining the user id to check against!
noHeader()
In order to perform a request call to an endpoint without any request headers/options, you can use this method before calling the desired function in an endpoint class:
NOTE: This method accepts nothing (void).
setRequestTimeout($timeout = 0)
In order to perform a request call with a different timeout value other than the one set in the configuration, you can use this method before calling the desired function in an endpoint class:
NOTE: This method accepts integer defining a single use timeout in second.
setRequestConnectionTimeout($connectionTimeout = 0)
In order to perform a request call with a different connection timeout value other than the one set in the configuration, you can use this method before calling the desired function in an endpoint class:
NOTE: This method accepts integer defining a single use connection timeout in second.
Available Opencast REST Service Endpoint
-
/api/*: all known API endpoints of Opencast are available to be used in this library. API Endpoints definitions WiKi -
/ingest/*: all known Ingest endpoints are available. Ingest Endpoint definitions WiKi -
/services/services.json: only services.json is available. Services Endpoint definitions WiKi -
/search/{episode | lucene | series}.{json | xml}: only episode, lucene and series in JSON or XML format are available. Search Endpoint definitions WiKi -
/capture-admin/*: all known Capture Admin endpoints are available. Capture Admin Endpoint definitions WiKi -
/admin-ng/event/delete: only delete endpoint is available. Admin Ng Endpoint definitions WiKi -
/recordings/*: all known Recording endpoints are available. Recordings Endpoint definitions WiKi -
/series/*: all known Series endpoints are available. Series Endpoint definitions WiKi -
/workflow/*: all known Workflow endpoints are available. Workflow Endpoint definitions WiKi /sysinfo/bundles/version: (v1.1.1) only bundle version endpoint is available. Sysinfo Endpoint definitions WiKi
Utility Class
Starting from version v1.9.0, a new utility class has been introduced to provide additional functionality, making it easier to integrate and consume this library's output within applications.
How to use
To use the utility class, initialize it directly via its namespace and start calling its functions:
Mocking Responses
In order to conduct proper testing, a mocking mechanism is provided.
How to use
Step 1: Responses Array
As in the first step it is necessary to have all the responses in an array form, which has to have the following structure:
NOTE: In order to apply multiple calls to the same path, a unique parameter called unique_request_identifier in params array must be provided, for example you want to update a series's acl twice with the same path but different acl values: (The value of the unique identifier must be something within the body of the request)
Step 2: Creating a new MockHandler instance and passing to the configuration array.
In order to create a new MockHandler instance, you should use \OpencastApi\Mock\OcMockHanlder::getHandlerStackWithPath and pass that instance into the configuration array with handler key, like so:
Extra: Log requests uri
if you want to have a list of request uri, you can pass a file path variable as the second argument into the \OpencastApi\Mock\OcMockHanlder::getHandlerStackWithPath to write/append every uri into that file, like so;
Naming convention
Classes:
Apart from 'Opencast' class, all other classes under OpencastApi\Rest\ namespace start with Oc followed by the name and the endpoint category. For example:
OcEventsApicontains 3 parts including Oc + Endpoint Name (Events) + Endpoint Category (Api)OcServicescontains 2 parts including Oc + Endpoint Name/Category (Services)
Opencast class properties:
The naming convention to access the endpoint subclasses from OpencastApi\Opencast as its properties, includes the name of the class without Oc in camelCase format. For example: