https://github.com/mjordan/islandora_background_process

Background Process Integration Framework for Islandora
https://github.com/mjordan/islandora_background_process

Last synced: 29 days ago
JSON representation

Background Process Integration Framework for Islandora

• Host: GitHub
• URL: https://github.com/mjordan/islandora_background_process
• Owner: mjordan
• License: gpl-3.0
• Created: 2014-07-14T20:05:29.000Z (over 10 years ago)
• Default Branch: 7.x
• Last Pushed: 2014-07-22T02:47:56.000Z (over 10 years ago)
• Last Synced: 2024-10-08T08:45:26.738Z (about 1 month ago)
• Language: PHP
• Homepage:
• Size: 191 KB
• Stars: 1
• Watchers: 3
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE.txt

Awesome Lists containing this project

README

        
## Introduction

Proof of concept module illustrating the use of the [Background Process](https://www.drupal.org/project/background_process) contrib module to execute long-running tasks such as derivative creation.

See https://github.com/Islandora/Islandora-Preservation-Interest-Group/tree/master/background_services_discussion_paper for background.

## Dependencies

Islandora and the Background Process module.

## Installation

Install as usual, see [this](https://drupal.org/documentation/install/modules-themes/modules-7) for further information.

## Configuration

None. This module only provides a framework and does not have a user interface or optional configuration settings. 

## Customizing / extending this module

This module provides an abstract class, IslandoraBackgroundProcess, that can be extended by modules that manage an external service. All child objects must implement a public $hook property (see the top of includes/IslandoraBackgroundProcess.inc for a list of allowed values) and a public work() method that integrates with the external service. See the [Islandora Background Process OCR Service integration module](https://github.com/mjordan/islandora_bprocess_ocr) for an example. The $hook property and the work() method are called within the Islandora hooks implemented by this module. Modules that extend IslandoraBackgroundProcess should autoload the extending classes using the normal Drupal method of registering the class file(s) in the module .info file.

The .module file will need to instantiate the object that manages the background process and provide an admin settings form if any configuration settingsare required by the integration code. See the Islandora Background Process OCR Service integration .module file for an example.

An example module, which adds a datastream comprised of a robots.txt retrieved from a configurable URL to objects when they are first ingested into Islandora, and when they are updated, is available at https://github.com/mjordan/islandora_bprocess_example.