API:EPrints/Const

From EPrints Documentation
Revision as of 15:26, 16 December 2011 by Tdb01r (Talk | contribs)

Jump to: navigation, search

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.3, 3.2) | Revision Log | Before editing this page please read Pod2Wiki


NAME

EPrints::Const - constants and enumerations

User Comments


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 );
 

User Comments


DESCRIPTION

This module contains EPrints constants and enumerations.

User Comments


CONSTANTS

User Comments


:namespace

User Comments


EP_NS_DATA

http://eprints.org/ep2/data/2.0

User Comments


EP_NS_XSLT

http://eprints.org/ep2/xslt/1.0

User Comments


EP_NS_OPENSEARCH

http://a9.com/-/spec/opensearch/1.1/

User Comments


:xml

User Comments


XML_ELEMENT_NODE

User Comments


XML_ATTRIBUTE_NODE

User Comments


XML_TEXT_NODE

User Comments


XML_CDATA_SECTION_NODE

User Comments


XML_ENTITY_REFERENCE_NODE

User Comments


XML_ENTITY_NODE

User Comments


XML_PROCESSING_INSTRUCTION_NODE

User Comments


XML_COMMENT_NODE

User Comments


XML_DOCUMENT_NODE

User Comments


XML_DOCUMENT_TYPE_NODE

User Comments


XML_DOCUMENT_FRAGMENT_NODE

User Comments


XML_NOTATION_NODE

User Comments


:http

User Comments


DONE

User Comments


DECLINED

User Comments


NOT_FOUND

User Comments


OK

User Comments


:trigger

User Comments


EP_TRIGGER_DONE

Stop processing triggers immediately and return.

User Comments


EP_TRIGGER_OK

Continue normal processing.

User Comments


EP_TRIGGER_GUESS_DOC_TYPE

User Comments


EP_TRIGGER_LOG

User Comments


EP_TRIGGER_BOILERPLATE_RDF

User Comments


EP_TRIGGER_REPOSITORY_RDF

User Comments


EP_TRIGGER_BEGIN

User Comments


EP_TRIGGER_BEGIN_REQUEST

User Comments


EP_TRIGGER_END_REQUEST

User Comments


EP_TRIGGER_END

User Comments


EP_TRIGGER_URL_REWRITE

User Comments


EP_TRIGGER_DOC_URL_REWRITE

User Comments


EP_TRIGGER_CREATED

Called after $dataset->create_dataobj( { ... } ).

 dataobj - the newly created dataobj
 

User Comments


EP_TRIGGER_REMOVED

Called just before the object is removed from the database.

 dataobj - the object being removed
 

User Comments


EP_TRIGGER_RDF

User Comments


EP_TRIGGER_DEFAULTS

User Comments


EP_TRIGGER_STATUS_CHANGE

User Comments


EP_TRIGGER_BEFORE_COMMIT

User Comments


EP_TRIGGER_AFTER_COMMIT

User Comments


EP_TRIGGER_VALIDATE

User Comments


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
 

User Comments


EP_TRIGGER_WARNINGS

User Comments


EP_TRIGGER_FILES_MODIFIED

User Comments


EP_TRIGGER_MEDIA_INFO

Populate a Document epdata structure with information about a file.

 epdata
 filename
 filepath
 

User Comments


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
 

User Comments


EP_TRIGGER_INDEX_REMOVED

An object was removed and should now be removed from the index engine(s).

 dataset = EPrints::DataSet
 id = object id
 

User Comments


:metafield

User Comments


EP_PROPERTY_FROM_CONFIG

Get the default value from field defaults in the config.

User Comments


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.

User Comments


EP_PROPERTY_REQUIRED

This field property must be explicitly set.

User Comments


EP_PROPERTY_UNDEF

This field property defaults to undef.

User Comments


EP_PROPERTY_TRUE

This field property defaults to true.

User Comments


EP_PROPERTY_FALSE

This field property defaults to false.

User Comments


COPYRIGHT

User Comments