Difference between revisions of "API:EPrints/Config"
| (One intermediate revision by the same user not shown) | |||
| Line 6: | Line 6: | ||
<!-- Pod2Wiki=_private_ --><!-- Pod2Wiki=head_name --> | <!-- Pod2Wiki=_private_ --><!-- Pod2Wiki=head_name --> | ||
==NAME== | ==NAME== | ||
| − | '''EPrints::Config''' - | + | '''EPrints::Config''' - Software configuration handler. |
<div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '> | <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '> | ||
| Line 17: | Line 17: | ||
<!-- Pod2Wiki=head_description --> | <!-- Pod2Wiki=head_description --> | ||
==DESCRIPTION== | ==DESCRIPTION== | ||
| − | This module handles loading the main configuration for an instance of the | + | 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. |
<div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '> | <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '> | ||
| Line 61: | Line 61: | ||
EPrints::Config::get_archive_config | EPrints::Config::get_archive_config | ||
| − | Deprecated, use get_repository_config. | + | Deprecated, use <em>get_repository_config</em>. |
<div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '> | <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '> | ||
| Line 74: | Line 74: | ||
EPrints::Config::get_archive_ids | EPrints::Config::get_archive_ids | ||
| − | Deprecated, use get_repository_ids. | + | Deprecated, use <em>get_repository_ids</em>. |
<div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '> | <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '> | ||
| Line 87: | Line 87: | ||
EPrints::Config::load_archive_config_module | EPrints::Config::load_archive_config_module | ||
| − | Deprecated, use get_repository_config_module. | + | Deprecated, use <em>get_repository_config_module</em>. |
<div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '> | <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '> | ||
| Line 137: | Line 137: | ||
$conf = EPrints::Config::system_config() | $conf = EPrints::Config::system_config() | ||
| − | Returns the system configuration variable. To access a specific configuration option use [[API:EPrints/Config#get|get]]. | + | Returns the system configuration variable. To access a specific configuration option use [[API:EPrints/Config#get|get]]. |
<div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '> | <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '> | ||
| Line 163: | Line 163: | ||
@ids = EPrints::Config::get_repository_ids() | @ids = EPrints::Config::get_repository_ids() | ||
| − | Return a list of ids of all repositories belonging to this instance of the | + | Return a list of ids of all repositories belonging to this instance of the EPrints repository software. |
<div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '> | <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '> | ||
| Line 178: | Line 178: | ||
Load the full configuration for the specified repository unless the it has already been loaded. | 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. | + | Return a reference to a hash containing the full repository configuration. |
<div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '> | <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '> | ||
| Line 191: | Line 191: | ||
$value = EPrints::Config::get( $confitem ) | $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. | + | Return the value of a given eprints configuration item. These values are obtained from [[API:EPrints/SystemSettings|EPrints::SystemSettings]] plus a few extras for paths. |
<div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '> | <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '> | ||
Latest revision as of 12:53, 4 March 2022
EPrints 3 Reference: Directory Structure - Metadata Fields - Repository Configuration - XML Config Files - XML Export Format - EPrints data structure - Core API - Data Objects
Latest Source Code (3.4, 3.3) | 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 repository software. Such as the list of language IDs and the top level configurations for repositories and the XML files for the archives.
METHODS
Deprecated Methods
eprints_config_abort
EPrints::Config::abort
Deprecated, use EPrints::abort.
eprints_config_get_archive_config
EPrints::Config::get_archive_config
Deprecated, use get_repository_config.
eprints_config_get_archive_ids
EPrints::Config::get_archive_ids
Deprecated, use get_repository_ids.
eprints_config_load_archive_config_module
EPrints::Config::load_archive_config_module
Deprecated, use get_repository_config_module.
Normal Methods
init
EPrints::Config::init()
Load the EPrints configuration.
Do not use this method directly, it will be automatically called when using EPrints.
load_system_config
EPrints::Config::load_system_config()
Load the system configuration files.
system_config
$conf = EPrints::Config::system_config()
Returns the system configuration variable. To access a specific configuration option use get.
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 repository 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 EPrints::SystemSettings plus a few extras for paths.
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/.
