Introduction to Extensions

Table of Contents

About extensions

SimpleID has the ability to support "extensions". Extensions are PHP files containing code which extends the functionality of SimpleID. The code within extensions follow a set of conventions which allows SimpleID to call them during key parts of the OpenID authentication process.

The main purpose of SimpleID extensions is to provide a way in which to implement OpenID extensions. However, the system is flexible enough for SimpleID extensions to function in other ways.

Extensions are named name.extension.inc, where name is the name of the extension.

Installing and uninstalling extensions

To install an extension:

  1. If the extension is not included in the default SimpleID distribution:
    1. Extract the archive containing the extension into a temporary directory
    2. Move the contents of the www directory (including any subdirectories) into the web directory.
  2. To enable the extension, edit the SIMPLEID_EXTENSIONS configuration option in the config.inc file and add the name of the extension. Separate multiple extensions with commas. For more information on how to edit this configuration option, see the Configuration Options Reference

If the version of SimpleID you originally installed was before 0.5, the SIMPLEID_EXTENSIONS configuration option may not exist in your config.inc file. You can add it in manually.

To uninstall an extension

  1. Edit the SIMPLEID_EXTENSIONS configuration option in the config.inc file and delete the name of the extension. For more information on how to edit this configuration option, see the Configuration Options Reference
  2. You can also delete the extension file from the web directory. This is an optional process.

Bundled extensions

The following extensions are bundled with the default SimpleID distribution.