MySource Matrix Developer

Content Tools

Main Content

Asset External Requirements

Summary

This document proposes a new feature for the installation process that will check external requirements like PEAR modules before installing an asset.

Status: Draft
Key: draft -> approved proposal -> scheduled -> in development -> in testing -> complete -> released

Estimated Start Date: Wed, 10 May 2006
Estimated End Date: Wed, 10 May 2006

This feature is not scheduled for release

Problem Definition

Some of the MySource Matrix assets have external requirements and currently Matrix installation step does not check if the required external packages are installed on server. The proposed functionality will be able to check these requirements during step 3 of the Matrix installation process.

Such requirements may include required PEAR packages (eg. HTTP_Client for Remote Content), PHP extensions (LDAP support is required for the LDAP package to work), or possibly external tools such as HTML Tidy.

Technical Specification

Asset XML Changes

Every asset type in MySource Matrix has its own XML file which defines its name, description, etc. There is already a requirements list in the asset.xml. A new requirement type external will be added to the requirements types list. Each of these external type requirements will need to have the name of the package and the version. If a required package is not installed then the installation should display a warning message but it should not stop the installation process.

Optional:

External requirements should have a link to the package.