Difference between revisions of "API:EPrints/Const"

From EPrints Documentation
Jump to: navigation, search
(Created page with '<!-- 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' com…')
 
(5 intermediate revisions by the same user not shown)
Line 1: Line 1:
 
<!-- Pod2Wiki=_preamble_  
 
<!-- 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.
 
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=EPrints/Const.pm|package_name=EPrints::Const}}[[Category:API|CONST]][[Category:API:EPrints/Const|CONST]]<div><!-- Edit below this comment -->
+
  -->{{API}}{{Pod2Wiki}}{{API:Source|file=perl_lib/EPrints/Const.pm|package_name=EPrints::Const}}[[Category:API|CONST]][[Category:API:EPrints/Const|CONST]]<div><!-- Edit below this comment -->
  
  
Line 8: Line 8:
 
'''EPrints::Const''' - constants and enumerations
 
'''EPrints::Const''' - constants and enumerations
  
−
<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 -->
 
<!-- Edit below this comment -->
  
  
 
<!-- Pod2Wiki= -->
 
<!-- Pod2Wiki= -->
−
</div>
+
<!-- Pod2Wiki=head_synopsis -->
−
<!-- Pod2Wiki=head_description -->
+
==SYNOPSIS==
−
==DESCRIPTION==
+
<source lang="perl"># don't import any constants
−
This module contains EPrints constants and enumerations.
+
use EPrints::Const qw();
  
−
<div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce;  padding: 0em 1em 0em 1em; font-size: 80%; '>
+
# import trigger and http constants
−
<span style='display:none'>User Comments</span>
+
use EPrints::Const qw( :trigger :http );
−
<!-- Edit below this comment -->
 
  
 +
# import only the OK DONE DECLINED constants
 +
use EPrints::Const qw( OK DONE DECLINED );</source>
  
−
<!-- Pod2Wiki= -->
 
−
</div>
 
−
<!-- Pod2Wiki=head_constants -->
 
−
==CONSTANTS==
 
−
<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 -->
 
<!-- Edit below this comment -->
  
  
 
<!-- Pod2Wiki= -->
 
<!-- Pod2Wiki= -->
−
</div>
+
<!-- Pod2Wiki=head_description -->
−
<!-- Pod2Wiki=head_namespaces -->
+
==DESCRIPTION==
−
===Namespaces===
+
This module contains EPrints constants and enumerations.
−
<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_ep_ns_data -->
 
−
====EP_NS_DATA====
 
−
 
 
−
http://eprints.org/ep2/data/2.0
 
  
−
<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 -->
 
<!-- Edit below this comment -->
  
  
 
<!-- Pod2Wiki= -->
 
<!-- Pod2Wiki= -->
−
</div>
+
<!-- Pod2Wiki=head_constants -->
−
<!-- Pod2Wiki=item_ep_ns_xslt -->
+
==CONSTANTS==
−
====EP_NS_XSLT====
 
−
 
 
−
http://eprints.org/ep2/xslt/1.0
 
−
 
 
−
<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_trigger_result_codes -->
 
−
===Trigger Result Codes===
 
−
<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 -->
 
<!-- Edit below this comment -->
  
  
 
<!-- Pod2Wiki= -->
 
<!-- Pod2Wiki= -->
−
</div>
+
<!-- Pod2Wiki=head_namespace -->
−
<!-- Pod2Wiki=item_ep_trigger_done -->
+
===:namespace===
−
====EP_TRIGGER_DONE====
+
* EP_NS_CITATION
−
 
+
: http://eprints.org/ep3/citation
−
Stop processing triggers immediately and return.
 
−
 
 
−
<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 -->
 
  
 +
* EP_NS_DATA
 +
: http://eprints.org/ep2/data/2.0
  
−
<!-- Pod2Wiki= -->
+
* EP_NS_XSLT
−
</div>
+
: http://eprints.org/ep2/xslt/1.0
−
<!-- Pod2Wiki=item_ep_trigger_ok -->
 
−
====EP_TRIGGER_OK====
 
  
−
Continue normal processing.
+
* EP_NS_OPENSEARCH
 +
: http://a9.com/-/spec/opensearch/1.1/
  
−
<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 -->
 
<!-- Edit below this comment -->
  
  
 
<!-- Pod2Wiki= -->
 
<!-- Pod2Wiki= -->
−
</div>
+
<!-- Pod2Wiki=head_xml -->
−
<!-- Pod2Wiki=head_trigger_types -->
+
===:xml===
−
===Trigger Types===
+
* XML_ELEMENT_NODE
−
<div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce;  padding: 0em 1em 0em 1em; font-size: 80%; '>
+
* XML_ATTRIBUTE_NODE
−
<span style='display:none'>User Comments</span>
+
* XML_TEXT_NODE
 +
* XML_CDATA_SECTION_NODE
 +
* XML_ENTITY_REFERENCE_NODE
 +
* XML_ENTITY_NODE
 +
* XML_PROCESSING_INSTRUCTION_NODE
 +
* XML_COMMENT_NODE
 +
* XML_DOCUMENT_NODE
 +
* XML_DOCUMENT_TYPE_NODE
 +
* XML_DOCUMENT_FRAGMENT_NODE
 +
* XML_NOTATION_NODE
 
<!-- Edit below this comment -->
 
<!-- Edit below this comment -->
  
  
 
<!-- Pod2Wiki= -->
 
<!-- Pod2Wiki= -->
−
</div>
+
<!-- Pod2Wiki=head_http -->
−
<!-- Pod2Wiki=item_ep_trigger_guess_doc_type -->
+
===:http===
−
====EP_TRIGGER_GUESS_DOC_TYPE====
+
* DONE
 +
* DECLINED
 +
* NOT_FOUND
 +
* OK
 +
And all HTTP_* constants defined by {{API:PodLink|file=Apache2/Const|package_name=Apache2::Const|section=|text=Apache2::Const}}.
  
−
<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 -->
 
<!-- Edit below this comment -->
  
  
 
<!-- Pod2Wiki= -->
 
<!-- Pod2Wiki= -->
−
</div>
+
<!-- Pod2Wiki=head_trigger -->
−
<!-- Pod2Wiki=item_ep_trigger_log -->
+
===:trigger===
−
====EP_TRIGGER_LOG====
+
See [[API:EPrints/RepositoryConfig#add_trigger|EPrints::RepositoryConfig/add_trigger]] and [[API:EPrints/RepositoryConfig#add_dataset_trigger|EPrints::RepositoryConfig/add_dataset_trigger]].
  
−
<div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce;  padding: 0em 1em 0em 1em; font-size: 80%; '>
+
* EP_TRIGGER_DONE
−
<span style='display:none'>User Comments</span>
+
: Stop processing triggers immediately and return.
−
<!-- Edit below this comment -->
 
  
 +
* EP_TRIGGER_OK
 +
: Continue normal processing.
  
−
<!-- Pod2Wiki= -->
+
* EP_TRIGGER_LOG
−
</div>
+
* EP_TRIGGER_BOILERPLATE_RDF
−
<!-- Pod2Wiki=item_ep_trigger_boilerplate_rdf -->
+
* EP_TRIGGER_REPOSITORY_RDF
−
====EP_TRIGGER_BOILERPLATE_RDF====
+
* EP_TRIGGER_BEGIN
 +
* EP_TRIGGER_BEGIN_REQUEST
 +
: Called after [[API:EPrints/Repository#init_from_request|EPrints::Repository/init_from_request]].
  
−
<div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce;  padding: 0em 1em 0em 1em; font-size: 80%; '>
+
* EP_TRIGGER_END_REQUEST
−
<span style='display:none'>User Comments</span>
+
: Called just before [[API:EPrints/Repository#cleanup|EPrints::Repository/cleanup]] in response to a mod_perl request.
−
<!-- Edit below this comment -->
 
  
 +
* EP_TRIGGER_END
 +
* EP_TRIGGER_URL_REWRITE
 +
: Called for every request that is within the repository's path. Use this to redirect the user to a different location. <code>return_code</code> is a scalar reference, therefore you must deference when assigning a new value <code>${$rc} = CODE</code>.
  
−
<!-- Pod2Wiki= -->
+
<pre>  request - mod_perl request object
−
</div>
+
  lang - current language id
−
<!-- Pod2Wiki=item_ep_trigger_repository_rdf -->
+
  args - request arguments "?..."
−
====EP_TRIGGER_REPOSITORY_RDF====
+
  urlpath - EPrint's HTTP root
 +
  cgipath - EPrints's HTTP cgi root
 +
  uri - request uri "/eprints/12/"
 +
  secure - whether under HTTPS
 +
  return_code - reference to return code</pre>
  
−
<div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce;  padding: 0em 1em 0em 1em; font-size: 80%; '>
+
* EP_TRIGGER_DOC_URL_REWRITE
−
<span style='display:none'>User Comments</span>
+
* EP_TRIGGER_CREATED
−
<!-- Edit below this comment -->
+
: Called after $dataset-&gt;create_dataobj( { ... } ).
  
 +
<pre>  dataobj - the newly created dataobj</pre>
  
−
<!-- Pod2Wiki= -->
+
* EP_TRIGGER_REMOVED
−
</div>
+
: Called just before the object is removed from the database.
−
<!-- Pod2Wiki=item_ep_trigger_begin -->
 
−
====EP_TRIGGER_BEGIN====
 
  
−
<div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '>
+
<pre> dataobj - the object being removed</pre>
−
<span style='display:none'>User Comments</span>
 
−
<!-- Edit below this comment -->
 
  
 +
* EP_TRIGGER_DUPLICATE_SEARCH
 +
: Search for duplicate entries of the given data object. Triggers must be quick and conservative i.e. only return duplicates that are very likely candidates. '''ids''' is a list of object identifiers of the duplicate records.
  
−
<!-- Pod2Wiki= -->
+
<pre>  dataset = EPrints::DataSet
−
</div>
+
  dataobj = EPrints::DataObj
−
<!-- Pod2Wiki=item_ep_trigger_begin_request -->
+
  ids = ARRAY</pre>
−
====EP_TRIGGER_BEGIN_REQUEST====
 
  
−
<div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce;  padding: 0em 1em 0em 1em; font-size: 80%; '>
+
* EP_TRIGGER_RDF
−
<span style='display:none'>User Comments</span>
+
* EP_TRIGGER_DEFAULTS
−
<!-- Edit below this comment -->
+
* EP_TRIGGER_STATUS_CHANGE
 +
* EP_TRIGGER_BEFORE_COMMIT
 +
* EP_TRIGGER_AFTER_COMMIT
 +
* EP_TRIGGER_VALIDATE
 +
* EP_TRIGGER_VALIDATE_FIELD
 +
: Validate a field's value.
  
 +
<pre>  field - field to validate
 +
  value - value to validate
 +
  dataobj - parent dataobj (if available)
 +
  problems - ARRAYREF of DOM problems encountered</pre>
  
−
<!-- Pod2Wiki= -->
+
* EP_TRIGGER_WARNINGS
−
</div>
+
* EP_TRIGGER_FILES_MODIFIED
−
<!-- Pod2Wiki=item_ep_trigger_end_request -->
+
* EP_TRIGGER_MEDIA_INFO
−
====EP_TRIGGER_END_REQUEST====
+
: Populate a Document epdata structure with information about a file.
  
−
<div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '>
+
<pre> epdata
−
<span style='display:none'>User Comments</span>
+
  filename
−
<!-- Edit below this comment -->
+
  filepath</pre>
  
 +
* EP_TRIGGER_THUMBNAIL_TYPES
 +
: Manipulate the list of thumbnail types that will be generated for a given user-uploaded document.
  
−
<!-- Pod2Wiki= -->
+
<pre>  types - array reference of types (strings)
−
</div>
+
  dataobj - document object</pre>
−
<!-- Pod2Wiki=item_ep_trigger_end -->
 
−
====EP_TRIGGER_END====
 
  
−
<div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce;  padding: 0em 1em 0em 1em; font-size: 80%; '>
+
* EP_TRIGGER_INDEX_FIELDS
−
<span style='display:none'>User Comments</span>
+
: Add the changed fields for the given data object to the index engine(s).
−
<!-- Edit below this comment -->
 
  
 +
<pre>  dataobj = EPrints::DataObj
 +
  fields = ARRAYREF of field objects</pre>
  
−
<!-- Pod2Wiki= -->
+
* EP_TRIGGER_INDEX_REMOVED
−
</div>
+
: An object was removed and should now be removed from the index engine(s).
−
<!-- Pod2Wiki=item_ep_trigger_doc_url_rewrite -->
 
−
====EP_TRIGGER_DOC_URL_REWRITE====
 
  
−
<div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce;  padding: 0em 1em 0em 1em; font-size: 80%; '>
+
<pre>  dataset = EPrints::DataSet
−
<span style='display:none'>User Comments</span>
+
  id = object id</pre>
−
<!-- Edit below this comment -->
 
  
 +
* EP_TRIGGER_DYNAMIC_TEMPLATE
 +
: Manipulate parts included in the template. These will be called for every page impression, so don't do anything heavyweight in here.
  
−
<!-- Pod2Wiki= -->
+
<pre>  pins - hash ref of template pins</pre>
−
</div>
 
−
<!-- Pod2Wiki=item_ep_trigger_created -->
 
−
====EP_TRIGGER_CREATED====
 
  
−
<div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce;  padding: 0em 1em 0em 1em; font-size: 80%; '>
+
<!-- Pod2Wiki=head_metafield -->
−
<span style='display:none'>User Comments</span>
+
===:metafield===
 
<!-- Edit below this comment -->
 
<!-- Edit below this comment -->
  
  
 
<!-- Pod2Wiki= -->
 
<!-- Pod2Wiki= -->
−
</div>
+
* EP_PROPERTY_FROM_CONFIG
−
<!-- Pod2Wiki=item_ep_trigger_rdf -->
+
: Get the default value from field defaults in the config.
−
====EP_TRIGGER_RDF====
 
  
−
<div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce;  padding: 0em 1em 0em 1em; font-size: 80%; '>
+
* EP_PROPERTY_NO_CHANGE
−
<span style='display:none'>User Comments</span>
+
: Don't use a default, the code may have already set this value. setting it to undef has no effect rather than setting it to default value.
−
<!-- Edit below this comment -->
 
  
 +
* EP_PROPERTY_REQUIRED
 +
: This field property must be explicitly set.
  
−
<!-- Pod2Wiki= -->
+
* EP_PROPERTY_UNDEF
−
</div>
+
: This field property defaults to undef.
−
<!-- Pod2Wiki=item_ep_trigger_defaults -->
 
−
====EP_TRIGGER_DEFAULTS====
 
  
−
<div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce;  padding: 0em 1em 0em 1em; font-size: 80%; '>
+
* EP_PROPERTY_TRUE
−
<span style='display:none'>User Comments</span>
+
: This field property defaults to true.
−
<!-- Edit below this comment -->
 
  
 +
* EP_PROPERTY_FALSE
 +
: This field property defaults to false.
  
−
<!-- Pod2Wiki= -->
+
<!-- Pod2Wiki=head_crypt -->
−
</div>
+
===:crypt===
−
<!-- Pod2Wiki=item_ep_trigger_status_change -->
+
: One-way encryption methods for passwords, see [[API:EPrints/Utils#crypt|EPrints::Utils/crypt]].
−
====EP_TRIGGER_STATUS_CHANGE====
 
  
−
<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 -->
 
<!-- Edit below this comment -->
  
  
 
<!-- Pod2Wiki= -->
 
<!-- Pod2Wiki= -->
−
</div>
+
* EP_CRYPT_CRYPT
−
<!-- Pod2Wiki=item_ep_trigger_before_commit -->
+
: {{API:PodLink|file=perlfunc|package_name=perlfunc|section=crypt|text=perlfunc/crypt}}.
−
====EP_TRIGGER_BEFORE_COMMIT====
 
−
 
 
−
<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= -->
+
* EP_CRYPT_SHA512
−
</div>
+
: {{API:PodLink|file=Digest/SHA|package_name=Digest::SHA|section=|text=Digest::SHA}} sha512 with 2-byte salt and 10000 rounds.
−
<!-- Pod2Wiki=item_ep_trigger_after_commit -->
 
−
====EP_TRIGGER_AFTER_COMMIT====
 
  
−
<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 -->
 
<!-- Edit below this comment -->
  
  
 
<!-- Pod2Wiki= -->
 
<!-- Pod2Wiki= -->
−
</div>
+
<!-- Pod2Wiki=head_copyright -->
−
<!-- Pod2Wiki=item_ep_trigger_validate -->
+
==COPYRIGHT==
−
====EP_TRIGGER_VALIDATE====
+
Copyright 2000-2011 University of Southampton.
−
 
 
−
<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= -->
+
This file is part of EPrints http://www.eprints.org/.
−
</div>
 
−
<!-- Pod2Wiki=item_ep_trigger_warnings -->
 
−
====EP_TRIGGER_WARNINGS====
 
  
−
<div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce;  padding: 0em 1em 0em 1em; font-size: 80%; '>
+
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.
−
<span style='display:none'>User Comments</span>
 
−
<!-- Edit below this comment -->
 
  
 +
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.
  
−
<!-- Pod2Wiki= -->
+
You should have received a copy of the GNU Lesser General Public License along with EPrints.  If not, see http://www.gnu.org/licenses/.
−
</div>
 
−
<!-- Pod2Wiki=item_ep_trigger_files_modifed -->
 
−
====EP_TRIGGER_FILES_MODIFED====
 
  
−
<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 -->
 
<!-- Edit below this comment -->
  
  
 
<!-- Pod2Wiki= -->
 
<!-- Pod2Wiki= -->
−
</div>
+
<!-- Pod2Wiki=_postamble_ -->
−
<!-- Pod2Wiki=item_ep_trigger_media_info -->
 
−
====EP_TRIGGER_MEDIA_INFO====
 
−
 
 
−
Populate a Document epdata structure with information about a file.
 
−
 
 
−
  epdata
 
−
  filename
 
−
  filepath
 
−
 
 
−
<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 -->
 
<!-- Edit below this comment -->
−
 
−
 
−
<!-- Pod2Wiki= -->
 
−
</div>
 
−
<!-- Pod2Wiki=_postamble_ --><!-- Edit below this comment -->
 

Revision as of 09:56, 22 January 2013

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::Const - constants and enumerations


SYNOPSIS

# don't import any constants
use EPrints::Const qw();

# import trigger and http constants
use EPrints::Const qw( :trigger :http );

# import only the OK DONE DECLINED constants
use EPrints::Const qw( OK DONE DECLINED );


DESCRIPTION

This module contains EPrints constants and enumerations.


CONSTANTS

:namespace

  • EP_NS_CITATION
http://eprints.org/ep3/citation
  • EP_NS_DATA
http://eprints.org/ep2/data/2.0
  • EP_NS_XSLT
http://eprints.org/ep2/xslt/1.0
  • EP_NS_OPENSEARCH
http://a9.com/-/spec/opensearch/1.1/


:xml

  • XML_ELEMENT_NODE
  • XML_ATTRIBUTE_NODE
  • XML_TEXT_NODE
  • XML_CDATA_SECTION_NODE
  • XML_ENTITY_REFERENCE_NODE
  • XML_ENTITY_NODE
  • XML_PROCESSING_INSTRUCTION_NODE
  • XML_COMMENT_NODE
  • XML_DOCUMENT_NODE
  • XML_DOCUMENT_TYPE_NODE
  • XML_DOCUMENT_FRAGMENT_NODE
  • XML_NOTATION_NODE


:http

  • DONE
  • DECLINED
  • NOT_FOUND
  • OK

And all HTTP_* constants defined by Apache2::Const.


:trigger

See EPrints::RepositoryConfig/add_trigger and EPrints::RepositoryConfig/add_dataset_trigger.

  • EP_TRIGGER_DONE
Stop processing triggers immediately and return.
  • EP_TRIGGER_OK
Continue normal processing.
  • EP_TRIGGER_LOG
  • EP_TRIGGER_BOILERPLATE_RDF
  • EP_TRIGGER_REPOSITORY_RDF
  • EP_TRIGGER_BEGIN
  • EP_TRIGGER_BEGIN_REQUEST
Called after EPrints::Repository/init_from_request.
  • EP_TRIGGER_END_REQUEST
Called just before EPrints::Repository/cleanup in response to a mod_perl request.
  • EP_TRIGGER_END
  • EP_TRIGGER_URL_REWRITE
Called for every request that is within the repository's path. Use this to redirect the user to a different location. return_code is a scalar reference, therefore you must deference when assigning a new value ${$rc} = CODE.
  request - mod_perl request object
  lang - current language id
  args - request arguments "?..."
  urlpath - EPrint's HTTP root
  cgipath - EPrints's HTTP cgi root
  uri - request uri "/eprints/12/"
  secure - whether under HTTPS
  return_code - reference to return code
  • EP_TRIGGER_DOC_URL_REWRITE
  • EP_TRIGGER_CREATED
Called after $dataset->create_dataobj( { ... } ).
  dataobj - the newly created dataobj
  • EP_TRIGGER_REMOVED
Called just before the object is removed from the database.
  dataobj - the object being removed
  • EP_TRIGGER_DUPLICATE_SEARCH
Search for duplicate entries of the given data object. Triggers must be quick and conservative i.e. only return duplicates that are very likely candidates. ids is a list of object identifiers of the duplicate records.
  dataset = EPrints::DataSet
  dataobj = EPrints::DataObj
  ids = ARRAY
  • EP_TRIGGER_RDF
  • EP_TRIGGER_DEFAULTS
  • EP_TRIGGER_STATUS_CHANGE
  • EP_TRIGGER_BEFORE_COMMIT
  • EP_TRIGGER_AFTER_COMMIT
  • EP_TRIGGER_VALIDATE
  • EP_TRIGGER_VALIDATE_FIELD
Validate a field's value.
  field - field to validate
  value - value to validate
  dataobj - parent dataobj (if available)
  problems - ARRAYREF of DOM problems encountered
  • EP_TRIGGER_WARNINGS
  • EP_TRIGGER_FILES_MODIFIED
  • EP_TRIGGER_MEDIA_INFO
Populate a Document epdata structure with information about a file.
  epdata
  filename
  filepath
  • EP_TRIGGER_THUMBNAIL_TYPES
Manipulate the list of thumbnail types that will be generated for a given user-uploaded document.
  types - array reference of types (strings)
  dataobj - document object
  • EP_TRIGGER_INDEX_FIELDS
Add the changed fields for the given data object to the index engine(s).
  dataobj = EPrints::DataObj
  fields = ARRAYREF of field objects
  • EP_TRIGGER_INDEX_REMOVED
An object was removed and should now be removed from the index engine(s).
  dataset = EPrints::DataSet
  id = object id
  • EP_TRIGGER_DYNAMIC_TEMPLATE
Manipulate parts included in the template. These will be called for every page impression, so don't do anything heavyweight in here.
  pins - hash ref of template pins

:metafield

  • EP_PROPERTY_FROM_CONFIG
Get the default value from field defaults in the config.
  • EP_PROPERTY_NO_CHANGE
Don't use a default, the code may have already set this value. setting it to undef has no effect rather than setting it to default value.
  • EP_PROPERTY_REQUIRED
This field property must be explicitly set.
  • EP_PROPERTY_UNDEF
This field property defaults to undef.
  • EP_PROPERTY_TRUE
This field property defaults to true.
  • EP_PROPERTY_FALSE
This field property defaults to false.

:crypt

One-way encryption methods for passwords, see EPrints::Utils/crypt.


  • EP_CRYPT_CRYPT
perlfunc/crypt.
  • EP_CRYPT_SHA512
Digest::SHA sha512 with 2-byte salt and 10000 rounds.


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



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