API:EPrints/Config - Revision history

Pod2wiki at 12:53, 4 March 2022

2022-03-04T12:53:43Z

Pod2wiki at 10:20, 20 December 2021

2021-12-20T10:20:26Z

Pod2wiki at 10:19, 20 December 2021

2021-12-20T10:19:32Z

Pod2wiki at 10:18, 20 December 2021

2021-12-20T10:18:23Z

Pod2wiki at 10:15, 20 December 2021

2021-12-20T10:15:28Z

Show changes

Tdb01r at 14:59, 30 July 2013

2013-07-30T14:59:48Z

Tdb01r at 14:58, 30 July 2013

2013-07-30T14:58:22Z

Tdb01r at 14:56, 30 July 2013

2013-07-30T14:56:43Z

Tdb01r: Removing all content from page

2009-08-12T15:39:39Z

Removing all content from page

@@ Line 6: / Line 6: @@
 <!-- Pod2Wiki=_private_ --><!-- Pod2Wiki=head_name -->
 ==NAME==
-'''EPrints::Config''' - software configuration handler
+'''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%; '>
@@ Line 17: / Line 17: @@
 <!-- Pod2Wiki=head_description -->
 ==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/
+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%; '>
@@ Line 137: / Line 137: @@
   $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%; '>
@@ Line 163: / Line 163: @@
   @ids = EPrints::Config::get_repository_ids()
-Return a list of ids of all repositories belonging to this instance of the eprints software.
+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%; '>
@@ Line 178: / Line 178: @@
 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%; '>
@@ Line 191: / Line 191: @@
   $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%; '>

@@ Line 61: / Line 61: @@
   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%; '>
@@ Line 74: / Line 74: @@
   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%; '>
@@ Line 87: / Line 87: @@
   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%; '>

@@ Line 61: / Line 61: @@
   EPrints::Config::get_archive_config
-Deprecated, use [[API:EPrints/Config|EPrints/Config]]::get_repository_config.
+Deprecated, use get_repository_config.
 <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
-Deprecated, use [[API:EPrints/Config|EPrints/Config]]::get_repository_ids.
+Deprecated, use get_repository_ids.
 <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
-Deprecated, use [[API:EPrints/Config|EPrints/Config]]::get_repository_config_module.
+Deprecated, use get_repository_config_module.
 <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce;  padding: 0em 1em 0em 1em; font-size: 80%; '>

@@ Line 57: / Line 57: @@
 <!-- Pod2Wiki= -->
 </div>
-<!-- Pod2Wiki=item_eprints_config_get_archive_config_item_eprints_config_get_archive_ids_item_eprints_config_load_archive_config_module -->
+<!-- Pod2Wiki=item_eprints_config_get_archive_config -->
-====eprints_config_get_archive_config_item_eprints_config_get_archive_ids_item_eprints_config_load_archive_config_module====
+====eprints_config_get_archive_config====
-  EPrints::Config::get_archive_config=item EPrints::Config::get_archive_ids=item EPrints::Config::load_archive_config_module
+  EPrints::Config::get_archive_config
-Deprecated, use *_repository_*.
+Deprecated, use [[API:EPrints/Config|EPrints/Config]]::get_repository_config.
 <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce;  padding: 0em 1em 0em 1em; font-size: 80%; '>

@@ Line 15: / Line 15: @@
 ==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/
 <!-- Edit below this comment -->
@@ Line 23: / Line 25: @@
 ===Deprecated Methods===
 * EPrints::Config::abort
-: Deprecated, use [[API:EPrints|EPrints]]::abort.
+: Deprecated, use [[API:EPrints#abort|EPrints/abort]].
 * EPrints::Config::get_archive_config

@@ Line 16: / Line 16: @@
 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/
 <!-- Edit below this comment -->
@@ Line 28: / Line 22: @@
 <!-- Pod2Wiki=head_deprecated_methods -->
 ===Deprecated Methods===
- EPrints::Config::abort
+* EPrints::Config::abort
-Deprecated, use [[API:EPrints|EPrints]]::abort.
+: Deprecated, use [[API:EPrints|EPrints]]::abort.
- EPrints::Config::get_archive_config
+* EPrints::Config::get_archive_config
- EPrints::Config::get_archive_ids
+* EPrints::Config::get_archive_ids
- EPrints::Config::load_archive_config_module
+* EPrints::Config::load_archive_config_module
-Deprecated, use *_repository_*.
+: Deprecated, use *_repository_*.
 <!-- Edit below this comment -->
@@ Line 40: / Line 34: @@
 <!-- Pod2Wiki= -->
-<!-- Pod2Wiki=head_normal_methods -->
+<!-- Pod2Wiki=head_methods -->
-===Normal Methods===
+==METHODS==
- EPrints::Config::init()
+<!-- Pod2Wiki=head_init -->
 Load the EPrints configuration.
@@ Line 56: / Line 55: @@
    var_path /var</pre>
- EPrints::Config::load_system_config()
+<!-- Edit below this comment -->
 Load the system configuration files.
@@ Line 64: / Line 72: @@
    /lib/syscfg.d</pre>
- $conf = EPrints::Config::system_config()
+<!-- Edit below this comment -->
 Returns the system configuration variable. To access a specific configuration option use [[API:EPrints/Config#get|get]].
- $repository = EPrints::Config::get_repository_config( $id )
+<!-- Edit below this comment -->
 Returns a hash of the basic configuration for the repository with the given id. This hash will include the properties from SystemSettings.
- @ids = EPrints::Config::get_repository_ids()
+<!-- Edit below this comment -->
 Return a list of ids of all repositories belonging to this instance of the eprints software.
- $arc_conf = EPrints::Config::load_repository_config_module( $id )
+<!-- Edit below this comment -->
 Load the full configuration for the specified repository.
@@ Line 92: / Line 136: @@
    cgi_path       archives/[archiveid]/cgi</pre>
- $value = EPrints::Config::get( $confitem )
+<!-- Edit below this comment -->
 Return the value of a given eprints configuration item. These values are obtained from SystemSettings plus a few extras for paths.
- $ok = EPrints::Config::write_config( $dest, $names, $values )
+<!-- Edit below this comment -->
 Write name-value pairs to a configuration file $dest (overwriting any existing data). This uses [[API:EPrints/Dumper|EPrints::Dumper]] to serialise the passed Perl structures.

← Older revision	Revision as of 14:56, 30 July 2013
Line 1:	Line 1:
	+	<!-- Pod2Wiki=_preamble_
	+	This page has been automatically generated from the EPrints 3.2 source. Any wiki changes made between the 'Pod2Wiki=*' and 'Edit below this comment' comments will be lost.
	+	-->{{API}}{{Pod2Wiki}}{{API:Source\|file=perl_lib/EPrints/Config.pm\|package_name=EPrints::Config}}[[Category:API\|CONFIG]][[Category:API:EPrints/Config\|CONFIG]]<div><!-- Edit below this comment -->

	+
	+	<!-- Pod2Wiki=_private_ --><!-- Pod2Wiki=head_name -->
	+	==NAME==
	+	'''EPrints::Config''' - software configuration handler
	+
	+	<!-- Edit below this comment -->
	+
	+
	+	<!-- Pod2Wiki= -->
	+	<!-- Pod2Wiki=head_description -->
	+	==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/
	+
	+	<!-- Edit below this comment -->
	+
	+
	+	<!-- Pod2Wiki= -->
	+	<!-- Pod2Wiki=head_methods -->
	+	==METHODS==
	+	<!-- Edit below this comment -->
	+
	+
	+	<!-- Pod2Wiki= -->
	+	<!-- Pod2Wiki=head_deprecated_methods -->
	+	===Deprecated Methods===
	+	EPrints::Config::abort
	+	Deprecated, use [[API:EPrints\|EPrints]]::abort.
	+
	+	EPrints::Config::get_archive_config
	+	EPrints::Config::get_archive_ids
	+	EPrints::Config::load_archive_config_module
	+	Deprecated, use _repository_.
	+
	+	<!-- Edit below this comment -->
	+
	+
	+	<!-- Pod2Wiki= -->
	+	<!-- Pod2Wiki=head_normal_methods -->
	+	===Normal Methods===
	+	EPrints::Config::init()
	+	Load the EPrints configuration.
	+
	+	Do not use this method directly, it will be automatically called when using EPrints.
	+
	+	Defines the following configuration properties:
	+
	+	<pre> cgi_path /cgi
	+	cfg_path /cfg
	+	lib_path /lib
	+	arc_path /archives
	+	bin_path /bin
	+	var_path /var</pre>
	+
	+	EPrints::Config::load_system_config()
	+	Load the system configuration files.
	+
	+	Configuration files are loaded in order from (later files with the same name will be ignored):
	+
	+	<pre> /cfg/cfg.d
	+	/lib/syscfg.d</pre>
	+
	+	$conf = EPrints::Config::system_config()
	+	Returns the system configuration variable. To access a specific configuration option use [[API:EPrints/Config#get\|get]].
	+
	+	$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.
	+
	+	@ids = EPrints::Config::get_repository_ids()
	+	Return a list of ids of all repositories belonging to this instance of the eprints software.
	+
	+	$arc_conf = EPrints::Config::load_repository_config_module( $id )
	+	Load the full configuration for the specified repository.
	+
	+	Returns a reference to a hash containing the full repository configuration.
	+
	+	Configuration files are loaded in order from (later files with the same name will be ignored):
	+
	+	<pre> archives/[archiveid]/cfg/cfg.d
	+	site_lib/cfg.d
	+	lib/cfg.d</pre>
	+
	+	Defines the following configuration properties:
	+
	+	<pre> archiveroot archives/[archiveid]
	+	documents_path archives/[archiveid]/documents
	+	config_path archives/[archiveid]/cfg
	+	htdocs_path archives/[archiveid]/html
	+	cgi_path archives/[archiveid]/cgi</pre>
	+
	+	$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.
	+
	+	$ok = EPrints::Config::write_config( $dest, $names, $values )
	+	Write name-value pairs to a configuration file $dest (overwriting any existing data). This uses [[API:EPrints/Dumper\|EPrints::Dumper]] to serialise the passed Perl structures.
	+
	+	<!-- Edit below this comment -->
	+
	+
	+	<!-- Pod2Wiki= -->
	+	<!-- Pod2Wiki=head_copyright -->
	+	==COPYRIGHT==
	+	Copyright 2000-2011 University of Southampton.
	+
	+	This file is part of EPrints http://www.eprints.org/.
	+
	+	EPrints is free software: you can redistribute it and/or modify it under the terms of the GNU Lesser General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.
	+
	+	EPrints 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. If not, see http://www.gnu.org/licenses/.
	+
	+	<!-- Edit below this comment -->
	+
	+
	+	<!-- Pod2Wiki= -->
	+	<!-- Pod2Wiki=_postamble_ -->
	+	<!-- Edit below this comment -->

← Older revision		Revision as of 15:39, 12 August 2009
Line 1:		Line 1:
−	~~<!-- Pod2Wiki=_preamble_~~
−	~~This page has been automatically generated from the EPrints source. Any wiki changes made between the 'Pod2Wiki=*' and 'End of Pod2Wiki' comments will be lost.~~
−	~~-->{{Pod2Wiki}}{{API:Source\|file=EPrints/Config.pm\|package_name=EPrints::Config}}[[Category:API\|Config]]<!-- End of Pod2Wiki -->~~
−	~~<!-- Pod2Wiki=head_name -->=NAME=~~
−	~~'''EPrints::Config''' - software configuration handler~~

−	~~<!-- End of Pod2Wiki -->~~
−	~~<!-- Pod2Wiki=head_description -->=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/
−
−	~~<!-- End of Pod2Wiki -->~~
−	~~<!-- Pod2Wiki=head_methods -->=METHODS=~~
−	~~<!-- End of Pod2Wiki -->~~
−	~~<!-- Pod2Wiki=head_deprecated_methods -->==Deprecated Methods==~~
−	~~<!-- End of Pod2Wiki -->~~
−	~~<!-- Pod2Wiki=item_eprints_config_abort -->===eprints_config_abort===~~
−
−	~~EPrints::Config::abort~~
−
−	~~Deprecated, use [[API:EPrints\|EPrints]]::abort.~~
−
−	~~<!-- End of Pod2Wiki -->~~
−	<!-- Pod2Wiki=item_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===
−
−	~~EPrints::Config::get_archive_config=item EPrints::Config::get_archive_ids=item EPrints::Config::load_archive_config_module~~
−
−	~~Deprecated, use _repository_.~~
−
−	~~<!-- End of Pod2Wiki -->~~
−	~~<!-- Pod2Wiki=head_normal_methods -->==Normal Methods==~~
−	~~<!-- End of Pod2Wiki -->~~
−	~~<!-- Pod2Wiki=item_ensure_init -->===ensure_init===~~
−
−	~~EPrints::Config::ensure_init()~~
−
−	~~If the init() method has not yet been called then call it, otherwise do nothing.~~
−
−	~~<!-- End of Pod2Wiki -->~~
−	~~<!-- Pod2Wiki=item_init -->===init===~~
−
−	~~EPrints::Config::init()~~
−
−	~~Load all the EPrints configuration files, first the general files such as SystemSettings and then the configurations for each repository.~~
−
−	~~<!-- End of Pod2Wiki -->~~
−	~~<!-- Pod2Wiki=item_get_repository_config -->===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.~~
−
−	~~<!-- End of Pod2Wiki -->~~
−	~~<!-- Pod2Wiki=item_get_repository_ids -->===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.~~
−
−	~~<!-- End of Pod2Wiki -->~~
−	~~<!-- Pod2Wiki=item_load_repository_config_module -->===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.~~
−
−	~~<!-- End of Pod2Wiki -->~~
−	~~<!-- Pod2Wiki=item_get -->===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.~~
−
−	~~<!-- End of Pod2Wiki -->~~
−	~~<!-- Pod2Wiki=_postamble_ --><!-- End of Pod2Wiki -->~~