|
|
| 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 -->
| |
