API:EPrints/Config

From EPrints Documentation
Revision as of 18:28, 11 August 2009 by Tdb01r (Talk | contribs)

(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to: navigation, search

Latest Source Code (3.3, 3.2) | Revision Log | Before editing this page please read Pod2Wiki

NAME

EPrints::Config - software configuration handler

DESCRIPTION

This module handles loading the main configuration for an instance of the eprints software - such as the list of language id's and the top level configurations for repositories - the XML files in /archives/

METHODS

Deprecated Methods

eprints_config_abort

 EPrints::Config::abort

Deprecated, use EPrints::abort.

eprints_config_get_archive_config_item_eprints_config_get_archive_ids_item_eprints_config_load_archive_config_module

 EPrints::Config::get_archive_config=item EPrints::Config::get_archive_ids=item EPrints::Config::load_archive_config_module

Deprecated, use *_repository_*.

Normal Methods

ensure_init

 EPrints::Config::ensure_init()

If the init() method has not yet been called then call it, otherwise do nothing.

init

 EPrints::Config::init()

Load all the EPrints configuration files, first the general files such as SystemSettings and then the configurations for each repository.

get_repository_config

 $repository = EPrints::Config::get_repository_config( $id )

Returns a hash of the basic configuration for the repository with the given id. This hash will include the properties from SystemSettings.

get_repository_ids

 @ids = EPrints::Config::get_repository_ids()

Return a list of ids of all repositories belonging to this instance of the eprints software.

load_repository_config_module

 $arc_conf = EPrints::Config::load_repository_config_module( $id )

Load the full configuration for the specified repository unless the it has already been loaded.

Return a reference to a hash containing the full repository configuration.

get

 $value = EPrints::Config::get( $confitem )

Return the value of a given eprints configuration item. These values are obtained from SystemSettings plus a few extras for paths.