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

---

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