Difference between revisions of "API:EPrints/Const"
| Line 6: | Line 6: | ||
<!-- Pod2Wiki=_private_ --><!-- Pod2Wiki=head_name --> | <!-- Pod2Wiki=_private_ --><!-- Pod2Wiki=head_name --> | ||
==NAME== | ==NAME== | ||
| − | '''EPrints::Const''' - | + | '''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%; '> | <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: | ||
<!-- Pod2Wiki= --> | <!-- Pod2Wiki= --> | ||
</div> | </div> | ||
| − | <!-- Pod2Wiki= | + | <!-- Pod2Wiki=head_description --> |
| − | == | + | ==DESCRIPTION== |
| − | + | 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%; '> | <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> | <span style='display:none'>User Comments</span> | ||
| Line 33: | Line 26: | ||
<!-- Pod2Wiki= --> | <!-- Pod2Wiki= --> | ||
</div> | </div> | ||
| − | <!-- Pod2Wiki= | + | <!-- Pod2Wiki=head_synopsis --> |
| − | == | + | ===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 ); | ||
| + | |||
<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%; '> | ||
<span style='display:none'>User Comments</span> | <span style='display:none'>User Comments</span> | ||
Latest revision as of 12:57, 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
Contents
- 1 NAME
- 2 DESCRIPTION
- 3 CONSTANTS
- 3.1 :namespace
- 3.2 :xml
- 3.2.1 XML_ELEMENT_NODE
- 3.2.2 XML_ATTRIBUTE_NODE
- 3.2.3 XML_TEXT_NODE
- 3.2.4 XML_CDATA_SECTION_NODE
- 3.2.5 XML_ENTITY_REFERENCE_NODE
- 3.2.6 XML_ENTITY_NODE
- 3.2.7 XML_PROCESSING_INSTRUCTION_NODE
- 3.2.8 XML_COMMENT_NODE
- 3.2.9 XML_DOCUMENT_NODE
- 3.2.10 XML_DOCUMENT_TYPE_NODE
- 3.2.11 XML_DOCUMENT_FRAGMENT_NODE
- 3.2.12 XML_NOTATION_NODE
- 3.3 :http
- 3.4 :trigger
- 3.4.1 EP_TRIGGER_DONE
- 3.4.2 EP_TRIGGER_OK
- 3.4.3 EP_TRIGGER_LOG
- 3.4.4 EP_TRIGGER_BOILERPLATE_RDF
- 3.4.5 EP_TRIGGER_REPOSITORY_RDF
- 3.4.6 EP_TRIGGER_BEGIN
- 3.4.7 EP_TRIGGER_BEGIN_REQUEST
- 3.4.8 EP_TRIGGER_END_REQUEST
- 3.4.9 EP_TRIGGER_END
- 3.4.10 EP_TRIGGER_URL_REWRITE
- 3.4.11 EP_TRIGGER_DOC_URL_REWRITE
- 3.4.12 EP_TRIGGER_CREATED
- 3.4.13 EP_TRIGGER_REMOVED
- 3.4.14 EP_TRIGGER_RDF
- 3.4.15 EP_TRIGGER_DEFAULTS
- 3.4.16 EP_TRIGGER_STATUS_CHANGE
- 3.4.17 EP_TRIGGER_BEFORE_COMMIT
- 3.4.18 EP_TRIGGER_AFTER_COMMIT
- 3.4.19 EP_TRIGGER_VALIDATE
- 3.4.20 EP_TRIGGER_VALIDATE_FIELD
- 3.4.21 EP_TRIGGER_WARNINGS
- 3.4.22 EP_TRIGGER_FILES_MODIFIED
- 3.4.23 EP_TRIGGER_MEDIA_INFO
- 3.4.24 EP_TRIGGER_THUMBNAIL_TYPES
- 3.4.25 EP_TRIGGER_INDEX_FIELDS
- 3.4.26 EP_TRIGGER_INDEX_REMOVED
- 3.4.27 EP_TRIGGER_DYNAMIC_TEMPLATE
- 3.4.28 EP_TRIGGER_LOCAL_SITEMAP_URLS
- 3.5 :metafield
- 3.6 :crypt
- 4 COPYRIGHT
NAME
EPrints::Const - Constants and enumerations.
DESCRIPTION
This module contains EPrints 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 );
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_REF_NODE shares the same constant value.
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
Also, all HTTP_* constants defined by Apache2::Const.
DONE
DECLINED
NOT_FOUND
OK
: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_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
EP_TRIGGER_LOCAL_SITEMAP_URLS
Manipulate the URLs added to the local sitemaps.
urlset - the set of all URLs to include in the sitemap.
: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
EP_CRYPT_SHA512
Digest::SHA sha512 with 2-byte salt and 10000 rounds.
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/.
