Difference between revisions of "API:EPrints/BackCompatibility"

From EPrints Documentation
Jump to: navigation, search
(Removing all content from page)
 
(4 intermediate revisions by 2 users not shown)
Line 1: Line 1:
 +
<!-- Pod2Wiki=_preamble_
 +
This page has been automatically generated from the EPrints 3.4 source. Any wiki changes made between the 'Pod2Wiki=*' and 'Edit below this comment' comments will be lost.
 +
-->{{API}}{{Pod2Wiki}}{{API:Source|file=EPrints/BackCompatibility.pm|package_name=EPrints::BackCompatibility}}[[Category:API|BACKCOMPATIBILITY]]<div><!-- Edit below this comment -->
  
 +
 +
<!-- Pod2Wiki=_private_ --><!-- Pod2Wiki=head_name -->
 +
==NAME==
 +
'''EPrints::BackCompatibility''' - Provide compatibility for older versions of the API.
 +
 +
<div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce;  padding: 0em 1em 0em 1em; font-size: 80%; '>
 +
<span style='display:none'>User Comments</span>
 +
<!-- Edit below this comment -->
 +
 +
 +
<!-- Pod2Wiki= -->
 +
</div>
 +
<!-- Pod2Wiki=head_description -->
 +
==DESCRIPTION==
 +
A number of EPrints packages have been moved or renamed. This module provides stub versions of these packages under there old names so that existing code will require few or no changes.
 +
 +
It also sets a flag in Perl to think the packages have been loaded from their original locations. This causes calls such as:
 +
 +
use EPrints::Document;
 +
 
 +
to do nothing as they know the module is already loaded.
 +
 +
<div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce;  padding: 0em 1em 0em 1em; font-size: 80%; '>
 +
<span style='display:none'>User Comments</span>
 +
<!-- Edit below this comment -->
 +
 +
 +
<!-- Pod2Wiki= -->
 +
</div>
 +
<!-- Pod2Wiki=head_superseded_classes_or_methods -->
 +
===Superseded Classes or Methods===
 +
The following classes have been fully superseded or have methods that  have been superseded by methods for different classes.
 +
 +
<div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce;  padding: 0em 1em 0em 1em; font-size: 80%; '>
 +
<span style='display:none'>User Comments</span>
 +
<!-- Edit below this comment -->
 +
 +
 +
<!-- Pod2Wiki= -->
 +
</div>
 +
<!-- Pod2Wiki=item_l_eprints_document -->
 +
====[[API:EPrints/Document|EPrints::Document]]====
 +
 +
Superseded by [[API:EPrints/DataObj/Document|EPrints::DataObj::Document]].
 +
 +
<div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce;  padding: 0em 1em 0em 1em; font-size: 80%; '>
 +
<span style='display:none'>User Comments</span>
 +
<!-- Edit below this comment -->
 +
 +
 +
<!-- Pod2Wiki= -->
 +
</div>
 +
<!-- Pod2Wiki=item_l_eprints_eprint -->
 +
====[[API:EPrints/EPrint|EPrints::EPrint]]====
 +
 +
Superseded by [[API:EPrints/DataObj/EPrint|EPrints::DataObj::EPrint]].
 +
 +
<div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce;  padding: 0em 1em 0em 1em; font-size: 80%; '>
 +
<span style='display:none'>User Comments</span>
 +
<!-- Edit below this comment -->
 +
 +
 +
<!-- Pod2Wiki= -->
 +
</div>
 +
<!-- Pod2Wiki=item_l_eprints_subject -->
 +
====[[API:EPrints/Subject|EPrints::Subject]]====
 +
 +
Superseded by [[API:EPrints/DataObj/Subject|EPrints::DataObj::Subject]].
 +
 +
<div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce;  padding: 0em 1em 0em 1em; font-size: 80%; '>
 +
<span style='display:none'>User Comments</span>
 +
<!-- Edit below this comment -->
 +
 +
 +
<!-- Pod2Wiki= -->
 +
</div>
 +
<!-- Pod2Wiki=item_l_eprints_subscription -->
 +
====[[API:EPrints/Subscription|EPrints::Subscription]]====
 +
 +
Superseded by [[API:EPrints/DataObj/SavedSearch|EPrints::DataObj::SavedSearch]].
 +
 +
<div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce;  padding: 0em 1em 0em 1em; font-size: 80%; '>
 +
<span style='display:none'>User Comments</span>
 +
<!-- Edit below this comment -->
 +
 +
 +
<!-- Pod2Wiki= -->
 +
</div>
 +
<!-- Pod2Wiki=item_l_eprints_user -->
 +
====[[API:EPrints/User|EPrints::User]]====
 +
 +
Superseded by [[API:EPrints/DataObj/User|EPrints::DataObj::User]].
 +
 +
<div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce;  padding: 0em 1em 0em 1em; font-size: 80%; '>
 +
<span style='display:none'>User Comments</span>
 +
<!-- Edit below this comment -->
 +
 +
 +
<!-- Pod2Wiki= -->
 +
</div>
 +
<!-- Pod2Wiki=item_l_eprints_dataobj_user -->
 +
====[[API:EPrints/DataObj/User|EPrints::DataObj::User]]====
 +
 +
The following methods are deprecated and replaced by other methods in  the class:
 +
 +
can_edit
 +
get_owned_eprints
 +
get_editable_eprints
 +
get_eprints
 +
 
 +
<div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce;  padding: 0em 1em 0em 1em; font-size: 80%; '>
 +
<span style='display:none'>User Comments</span>
 +
<!-- Edit below this comment -->
 +
 +
 +
<!-- Pod2Wiki= -->
 +
</div>
 +
<!-- Pod2Wiki=item_l_eprints_utils -->
 +
====[[API:EPrints/Utils|EPrints::Utils]]====
 +
 +
The following methods are deprecated and replaced by other methods in the [[API:EPrints/Email|EPrints::Email]], [[API:EPrints/XML/EPC|EPrints::XML::EPC]], [[API:EPrints/Time|EPrints::Time]] and [[API:EPrints/Platform|EPrints::Platform]] (subsequently superseded by [[API:EPrints/System|EPrints::System]]):
 +
 +
send_mail
 +
send_mail_via_smtp
 +
send_mail_via_sendmail
 +
collapse_conditions
 +
render_date
 +
render_short_date
 +
datestring_to_timet
 +
gmt_off
 +
get_month_label
 +
get_month_label_short
 +
get_date
 +
get_date_array
 +
get_datestamp
 +
get_iso_date
 +
get_timestamp
 +
human_time
 +
human_delay
 +
get_iso_timestamp
 +
df_dir
 +
mkdir
 +
join_path
 +
 
 +
<div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce;  padding: 0em 1em 0em 1em; font-size: 80%; '>
 +
<span style='display:none'>User Comments</span>
 +
<!-- Edit below this comment -->
 +
 +
 +
<!-- Pod2Wiki= -->
 +
</div>
 +
<!-- Pod2Wiki=item_l_eprints_archive -->
 +
====[[API:EPrints/Archive|EPrints::Archive]]====
 +
 +
Superseded by [[API:EPrints/Repository|EPrints::Repository]].
 +
 +
<div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce;  padding: 0em 1em 0em 1em; font-size: 80%; '>
 +
<span style='display:none'>User Comments</span>
 +
<!-- Edit below this comment -->
 +
 +
 +
<!-- Pod2Wiki= -->
 +
</div>
 +
<!-- Pod2Wiki=item_l_eprints_searchexpression -->
 +
====[[API:EPrints/SearchExpression|EPrints::SearchExpression]]====
 +
 +
Superseded by [[API:EPrints/Search|EPrints::Search]].
 +
 +
<div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce;  padding: 0em 1em 0em 1em; font-size: 80%; '>
 +
<span style='display:none'>User Comments</span>
 +
<!-- Edit below this comment -->
 +
 +
 +
<!-- Pod2Wiki= -->
 +
</div>
 +
<!-- Pod2Wiki=item_l_eprints_searchfield -->
 +
====[[API:EPrints/SearchField|EPrints::SearchField]]====
 +
 +
Superseded by [[API:EPrints/Search/Field|EPrints::Search::Field]].
 +
 +
<div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce;  padding: 0em 1em 0em 1em; font-size: 80%; '>
 +
<span style='display:none'>User Comments</span>
 +
<!-- Edit below this comment -->
 +
 +
 +
<!-- Pod2Wiki= -->
 +
</div>
 +
<!-- Pod2Wiki=item_l_eprints_searchcondition -->
 +
====[[API:EPrints/SearchCondition|EPrints::SearchCondition]]====
 +
 +
Superseded by [[API:EPrints/Search/Condition|EPrints::Search::Condition]].
 +
 +
<div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce;  padding: 0em 1em 0em 1em; font-size: 80%; '>
 +
<span style='display:none'>User Comments</span>
 +
<!-- Edit below this comment -->
 +
 +
 +
<!-- Pod2Wiki= -->
 +
</div>
 +
<!-- Pod2Wiki=item_l_eprints_anapache -->
 +
====[[API:EPrints/AnApache|EPrints::AnApache]]====
 +
 +
Superseded by [[API:EPrints/Apache/AnApache|EPrints::Apache::AnApache]].
 +
 +
<div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce;  padding: 0em 1em 0em 1em; font-size: 80%; '>
 +
<span style='display:none'>User Comments</span>
 +
<!-- Edit below this comment -->
 +
 +
 +
<!-- Pod2Wiki= -->
 +
</div>
 +
<!-- Pod2Wiki=item_l_eprints_auth -->
 +
====[[API:EPrints/Auth|EPrints::Auth]]====
 +
 +
Superseded by [[API:EPrints/Apache/Auth|EPrints::Apache::Auth]].
 +
 +
<div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce;  padding: 0em 1em 0em 1em; font-size: 80%; '>
 +
<span style='display:none'>User Comments</span>
 +
<!-- Edit below this comment -->
 +
 +
 +
<!-- Pod2Wiki= -->
 +
</div>
 +
<!-- Pod2Wiki=item_l_eprints_dataset -->
 +
====[[API:EPrints/DataSet|EPrints::DataSet]]====
 +
 +
The following methods are deprecated:
 +
 +
get_page_fields
 +
get_type_pages
 +
get_type_fields
 +
get_required_type_fields
 +
is_valid_type
 +
get_types
 +
get_type_names
 +
get_type_name
 +
render_type_name
 +
load_workflows
 +
 
 +
<div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce;  padding: 0em 1em 0em 1em; font-size: 80%; '>
 +
<span style='display:none'>User Comments</span>
 +
<!-- Edit below this comment -->
 +
 +
 +
<!-- Pod2Wiki= -->
 +
</div>
 +
<!-- Pod2Wiki=item_l_eprints_index -->
 +
====[[API:EPrints/Index|EPrints::Index]]====
 +
 +
The following methods are superseded by methods in [[API:EPrints/Index/Tokenizer|EPrints::Index::Tokenizer]]:
 +
 +
split_words
 +
apply_mapping
 +
 
 +
<div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce;  padding: 0em 1em 0em 1em; font-size: 80%; '>
 +
<span style='display:none'>User Comments</span>
 +
<!-- Edit below this comment -->
 +
 +
 +
<!-- Pod2Wiki= -->
 +
</div>
 +
<!-- Pod2Wiki=item_l_eprints_session -->
 +
====[[API:EPrints/Session|EPrints::Session]]====
 +
 +
Superseded by [[API:EPrints/Repository|EPrints::Repository]].
 +
 +
<div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce;  padding: 0em 1em 0em 1em; font-size: 80%; '>
 +
<span style='display:none'>User Comments</span>
 +
<!-- Edit below this comment -->
 +
 +
 +
<!-- Pod2Wiki= -->
 +
</div>
 +
<!-- Pod2Wiki=item_l_eprints_platform -->
 +
====[[API:EPrints/Platform|EPrints::Platform]]====
 +
 +
Superseded by [[API:EPrints/System|EPrints::System]].
 +
 +
<div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce;  padding: 0em 1em 0em 1em; font-size: 80%; '>
 +
<span style='display:none'>User Comments</span>
 +
<!-- Edit below this comment -->
 +
 +
 +
<!-- Pod2Wiki= -->
 +
</div>
 +
<!-- Pod2Wiki=item_l_eprints_repository -->
 +
====[[API:EPrints/Repository|EPrints::Repository]]====
 +
 +
The following methods are superseded by methods in other classes:
 +
 +
render_toolbar
 +
freshen_citation
 +
get_citation_spec
 +
get_citation_type
 +
 
 +
<div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce;  padding: 0em 1em 0em 1em; font-size: 80%; '>
 +
<span style='display:none'>User Comments</span>
 +
<!-- Edit below this comment -->
 +
 +
 +
<!-- Pod2Wiki= -->
 +
</div>
 +
<!-- Pod2Wiki=head_copyright -->
 +
==COPYRIGHT==
 +
{{API:Copyright}}
 +
<div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce;  padding: 0em 1em 0em 1em; font-size: 80%; '>
 +
<span style='display:none'>User Comments</span>
 +
<!-- Edit below this comment -->
 +
 +
 +
<!-- Pod2Wiki= -->
 +
</div>
 +
<!-- Pod2Wiki=_postamble_ --><!-- Edit below this comment -->

Latest revision as of 00:52, 10 January 2022

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::BackCompatibility - Provide compatibility for older versions of the API.

User Comments


DESCRIPTION

A number of EPrints packages have been moved or renamed. This module provides stub versions of these packages under there old names so that existing code will require few or no changes.

It also sets a flag in Perl to think the packages have been loaded from their original locations. This causes calls such as: 

use EPrints::Document;

to do nothing as they know the module is already loaded.

User Comments


Superseded Classes or Methods

The following classes have been fully superseded or have methods that have been superseded by methods for different classes.

User Comments


EPrints::Document

Superseded by EPrints::DataObj::Document.

User Comments


EPrints::EPrint

Superseded by EPrints::DataObj::EPrint.

User Comments


EPrints::Subject

Superseded by EPrints::DataObj::Subject.

User Comments


EPrints::Subscription

Superseded by EPrints::DataObj::SavedSearch.

User Comments


EPrints::User

Superseded by EPrints::DataObj::User.

User Comments


EPrints::DataObj::User

The following methods are deprecated and replaced by other methods in the class: 

can_edit
get_owned_eprints
get_editable_eprints
get_eprints

User Comments


EPrints::Utils

The following methods are deprecated and replaced by other methods in the EPrints::Email, EPrints::XML::EPC, EPrints::Time and EPrints::Platform (subsequently superseded by EPrints::System): 

send_mail 
send_mail_via_smtp 
send_mail_via_sendmail 
collapse_conditions 
render_date 
render_short_date 
datestring_to_timet 
gmt_off 
get_month_label 
get_month_label_short 
get_date 
get_date_array 
get_datestamp 
get_iso_date 
get_timestamp 
human_time 
human_delay 
get_iso_timestamp
df_dir
mkdir
join_path

User Comments


EPrints::Archive

Superseded by EPrints::Repository.

User Comments


EPrints::SearchExpression

Superseded by EPrints::Search.

User Comments


EPrints::SearchField

Superseded by EPrints::Search::Field.

User Comments


EPrints::SearchCondition

Superseded by EPrints::Search::Condition.

User Comments


EPrints::AnApache

Superseded by EPrints::Apache::AnApache.

User Comments


EPrints::Auth

Superseded by EPrints::Apache::Auth.

User Comments


EPrints::DataSet

The following methods are deprecated: 

get_page_fields
get_type_pages
get_type_fields
get_required_type_fields
is_valid_type
get_types
get_type_names
get_type_name
render_type_name
load_workflows

User Comments


EPrints::Index

The following methods are superseded by methods in EPrints::Index::Tokenizer: 

split_words
apply_mapping

User Comments


EPrints::Session

Superseded by EPrints::Repository.

User Comments


EPrints::Platform

Superseded by EPrints::System.

User Comments


EPrints::Repository

The following methods are superseded by methods in other classes: 

render_toolbar
freshen_citation
get_citation_spec
get_citation_type

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


Retrieved from ‘https://wiki.eprints.org/w/index.php?title=API:EPrints/BackCompatibility&oldid=14125’