API:EPrints/Config

From EPrints Documentation
Jump to: navigation, search

EPrints 3 Reference: Directory Structure - Metadata Fields - Repository Configuration - XML Config Files - XML Export Format - EPrints data structure - Core API - Data Objects


API: Core API

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


NAME

EPrints::Config - Software configuration handler.

User Comments


DESCRIPTION

This module handles loading the main configuration for an instance of the EPrints repository software. Such as the list of language IDs and the top level configurations for repositories and the XML files for the archives.

User Comments


METHODS

User Comments


Deprecated Methods

User Comments


eprints_config_abort

EPrints::Config::abort

Deprecated, use EPrints::abort.

User Comments


eprints_config_get_archive_config

EPrints::Config::get_archive_config

Deprecated, use get_repository_config.

User Comments


eprints_config_get_archive_ids

EPrints::Config::get_archive_ids

Deprecated, use get_repository_ids.

User Comments


eprints_config_load_archive_config_module

EPrints::Config::load_archive_config_module

Deprecated, use get_repository_config_module.

User Comments


Normal Methods

User Comments


init

EPrints::Config::init()

Load the EPrints configuration.

Do not use this method directly, it will be automatically called when using EPrints.

User Comments


load_system_config

EPrints::Config::load_system_config()

Load the system configuration files.

User Comments


system_config

$conf = EPrints::Config::system_config()

Returns the system configuration variable. To access a specific configuration option use get.

User Comments


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.

User Comments


get_repository_ids

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

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

User Comments


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.

User Comments


get

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

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

User Comments


COPYRIGHT

© Copyright 2000-2024 University of Southampton.

EPrints 3.4 is supplied by EPrints Services.

http://www.eprints.org/eprints-3.4/

LICENSE

This file is part of EPrints 3.4 http://www.eprints.org/.

EPrints 3.4 and this file are released under the terms of the GNU Lesser General Public License version 3 as published by the Free Software Foundation unless otherwise stated.

EPrints 3.4 is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more details.

You should have received a copy of the GNU Lesser General Public License along with EPrints 3.4. If not, see http://www.gnu.org/licenses/.

User Comments