API:EPrints/Const
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
NAME[edit]
EPrints::Const - Constants and enumerations.
DESCRIPTION[edit]
This module contains EPrints constants and enumerations.
SYNOPSIS[edit]
# 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[edit]
:namespace[edit]
EP_NS_CITATION[edit]
http://eprints.org/ep3/citation
EP_NS_DATA[edit]
http://eprints.org/ep2/data/2.0
EP_NS_XSLT[edit]
http://eprints.org/ep2/xslt/1.0
EP_NS_OPENSEARCH[edit]
http://a9.com/-/spec/opensearch/1.1/
:xml[edit]
XML_ELEMENT_NODE[edit]
XML_ATTRIBUTE_NODE[edit]
XML_TEXT_NODE[edit]
XML_CDATA_SECTION_NODE[edit]
XML_ENTITY_REFERENCE_NODE[edit]
XML_ENTITY_REF_NODE shares the same constant value.
XML_ENTITY_NODE[edit]
XML_PROCESSING_INSTRUCTION_NODE[edit]
XML_COMMENT_NODE[edit]
XML_DOCUMENT_NODE[edit]
XML_DOCUMENT_TYPE_NODE[edit]
XML_DOCUMENT_FRAGMENT_NODE[edit]
XML_NOTATION_NODE[edit]
:http[edit]
Also, all HTTP_* constants defined by Apache2::Const.
DONE[edit]
DECLINED[edit]
NOT_FOUND[edit]
OK[edit]
:trigger[edit]
See EPrints::RepositoryConfig/add_trigger and EPrints::RepositoryConfig/add_dataset_trigger.
EP_TRIGGER_DONE[edit]
Stop processing triggers immediately and return.
EP_TRIGGER_OK[edit]
Continue normal processing.
EP_TRIGGER_LOG[edit]
EP_TRIGGER_BOILERPLATE_RDF[edit]
EP_TRIGGER_REPOSITORY_RDF[edit]
EP_TRIGGER_BEGIN[edit]
EP_TRIGGER_BEGIN_REQUEST[edit]
Called after EPrints::Repository/init_from_request.
EP_TRIGGER_END_REQUEST[edit]
Called just before EPrints::Repository/cleanup in response to a mod_perl request.
EP_TRIGGER_END[edit]
EP_TRIGGER_URL_REWRITE[edit]
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[edit]
EP_TRIGGER_CREATED[edit]
Called after $dataset->create_dataobj( { ... } ).
dataobj - the newly created dataobj
EP_TRIGGER_REMOVED[edit]
Called just before the object is removed from the database.
dataobj - the object being removed
EP_TRIGGER_RDF[edit]
EP_TRIGGER_DEFAULTS[edit]
EP_TRIGGER_STATUS_CHANGE[edit]
EP_TRIGGER_BEFORE_COMMIT[edit]
EP_TRIGGER_AFTER_COMMIT[edit]
EP_TRIGGER_VALIDATE[edit]
EP_TRIGGER_VALIDATE_FIELD[edit]
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[edit]
EP_TRIGGER_FILES_MODIFIED[edit]
EP_TRIGGER_MEDIA_INFO[edit]
Populate a Document epdata structure with information about a file.
epdata filename filepath
EP_TRIGGER_THUMBNAIL_TYPES[edit]
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[edit]
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[edit]
An object was removed and should now be removed from the index engine(s).
dataset = EPrints::DataSet id = object id
EP_TRIGGER_DYNAMIC_TEMPLATE[edit]
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[edit]
Manipulate the URLs added to the local sitemaps.
urlset - the set of all URLs to include in the sitemap.
:metafield[edit]
EP_PROPERTY_FROM_CONFIG[edit]
Get the default value from field defaults in the config.
EP_PROPERTY_NO_CHANGE[edit]
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[edit]
This field property must be explicitly set.
EP_PROPERTY_UNDEF[edit]
This field property defaults to undef.
EP_PROPERTY_TRUE[edit]
This field property defaults to true.
EP_PROPERTY_FALSE[edit]
This field property defaults to false.
:crypt[edit]
One-way encryption methods for passwords, see EPrints::Utils/crypt.
EP_CRYPT_CRYPT[edit]
EP_CRYPT_SHA512[edit]
Digest::SHA sha512 with 2-byte salt and 10000 rounds.
COPYRIGHT[edit]
© Copyright 2000-2024 University of Southampton.
EPrints 3.4 is supplied by EPrints Services.
http://www.eprints.org/eprints-3.4/
LICENSE[edit]
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/.