Difference between revisions of "API:EPrints/Const"

From EPrints Documentation
Jump to: navigation, search
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_synopsis -->
 
==SYNOPSIS==
 
==SYNOPSIS==
  # don't import any constants
+
<source lang="perl"># don't import any constants
  use EPrints::Const qw();
+
use EPrints::Const qw();
 
+
 
  # import trigger and http constants
+
# import trigger and http constants
  use EPrints::Const qw( :trigger :http );
+
use EPrints::Const qw( :trigger :http );
 
+
 
  # import only the OK DONE DECLINED constants
+
# import only the OK DONE DECLINED constants
  use EPrints::Const qw( OK DONE DECLINED );
+
use EPrints::Const qw( OK DONE DECLINED );</source>
 
+
 
<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_description -->
 
==DESCRIPTION==
 
==DESCRIPTION==
 
This module contains EPrints constants and enumerations.
 
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 -->
 
<!-- Edit below this comment -->
  
  
 
<!-- Pod2Wiki= -->
 
<!-- Pod2Wiki= -->
</div>
 
 
<!-- Pod2Wiki=head_constants -->
 
<!-- Pod2Wiki=head_constants -->
 
==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_namespace -->
 
<!-- Pod2Wiki=head_namespace -->
 
===:namespace===
 
===:namespace===
<div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce;  padding: 0em 1em 0em 1em; font-size: 80%; '>
+
* EP_NS_CITATION
<span style='display:none'>User Comments</span>
+
*: http://eprints.org/ep3/citation
<!-- 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_ns_data -->
+
====EP_NS_DATA====
+
  
http://eprints.org/ep2/data/2.0
+
* 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=item_ep_ns_xslt -->
 
====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=item_ep_ns_opensearch -->
 
====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 -->
 
 
 
<!-- Pod2Wiki= -->
 
</div>
 
 
<!-- Pod2Wiki=head_xml -->
 
<!-- Pod2Wiki=head_xml -->
 
===:xml===
 
===:xml===
<div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce;  padding: 0em 1em 0em 1em; font-size: 80%; '>
+
* XML_ELEMENT_NODE
<span style='display:none'>User Comments</span>
+
* 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
 
<!-- Edit below this comment -->
 
<!-- Edit below this comment -->
  
  
 
<!-- Pod2Wiki= -->
 
<!-- Pod2Wiki= -->
</div>
 
<!-- Pod2Wiki=item_xml_element_node -->
 
====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%; '>
 
<span style='display:none'>User Comments</span>
 
<!-- Edit below this comment -->
 
 
 
<!-- Pod2Wiki= -->
 
</div>
 
<!-- Pod2Wiki=item_xml_attribute_node -->
 
====XML_ATTRIBUTE_NODE====
 
 
<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_xml_text_node -->
 
====XML_TEXT_NODE====
 
 
<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_xml_cdata_section_node -->
 
====XML_CDATA_SECTION_NODE====
 
 
<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_xml_entity_reference_node -->
 
====XML_ENTITY_REFERENCE_NODE====
 
 
<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_xml_entity_node -->
 
====XML_ENTITY_NODE====
 
 
<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_xml_processing_instruction_node -->
 
====XML_PROCESSING_INSTRUCTION_NODE====
 
 
<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_xml_comment_node -->
 
====XML_COMMENT_NODE====
 
 
<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_xml_document_node -->
 
====XML_DOCUMENT_NODE====
 
 
<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_xml_document_type_node -->
 
====XML_DOCUMENT_TYPE_NODE====
 
 
<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_xml_document_fragment_node -->
 
====XML_DOCUMENT_FRAGMENT_NODE====
 
 
<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_xml_notation_node -->
 
====XML_NOTATION_NODE====
 
 
<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_http -->
 
<!-- Pod2Wiki=head_http -->
 
===:http===
 
===:http===
<div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce;  padding: 0em 1em 0em 1em; font-size: 80%; '>
+
* DONE
<span style='display:none'>User Comments</span>
+
* DECLINED
<!-- Edit below this comment -->
+
* NOT_FOUND
 +
* OK
 +
And all HTTP_* constants defined by {{API:PodLink|file=Apache2/Const|package_name=Apache2::Const|section=|text=Apache2::Const}}.
  
 
<!-- Pod2Wiki= -->
 
</div>
 
<!-- Pod2Wiki=item_done -->
 
====DONE====
 
 
<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=item_declined -->
 
====DECLINED====
 
 
<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_not_found -->
 
====NOT_FOUND====
 
 
<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_ok -->
 
====OK====
 
 
<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 -->
 
<!-- Pod2Wiki=head_trigger -->
 
===:trigger===
 
===:trigger===
<div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce;  padding: 0em 1em 0em 1em; font-size: 80%; '>
+
See [[API:EPrints/RepositoryConfig#add_trigger|EPrints::RepositoryConfig/add_trigger]] and [[API:EPrints/RepositoryConfig#add_dataset_trigger|EPrints::RepositoryConfig/add_dataset_trigger]].
<span style='display:none'>User Comments</span>
+
<!-- Edit below this comment -->
+
  
 +
* EP_TRIGGER_DONE
 +
*: Stop processing triggers immediately and return.
  
<!-- Pod2Wiki= -->
+
* EP_TRIGGER_OK
</div>
+
*: Continue normal processing.
<!-- Pod2Wiki=item_ep_trigger_done -->
+
====EP_TRIGGER_DONE====
+
  
Stop processing triggers immediately and return.
+
* EP_TRIGGER_LOG
 +
* EP_TRIGGER_BOILERPLATE_RDF
 +
* EP_TRIGGER_REPOSITORY_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
 +
* EP_TRIGGER_DOC_URL_REWRITE
 +
* EP_TRIGGER_CREATED
 +
*: Called after $dataset-&gt;create_dataobj( { ... } ).
  
<!-- Pod2Wiki= -->
+
<pre>  dataobj - the newly created dataobj</pre>
</div>
+
<!-- Pod2Wiki=item_ep_trigger_ok -->
+
====EP_TRIGGER_OK====
+
  
Continue normal processing.
+
* EP_TRIGGER_REMOVED
 +
*: Called just before the object is removed from the database.
  
<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_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.
  
<!-- Pod2Wiki= -->
+
<pre>  field - field to validate
</div>
+
<!-- Pod2Wiki=item_ep_trigger_guess_doc_type -->
+
====EP_TRIGGER_GUESS_DOC_TYPE====
+
 
+
<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_trigger_log -->
+
====EP_TRIGGER_LOG====
+
 
+
<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_trigger_boilerplate_rdf -->
+
====EP_TRIGGER_BOILERPLATE_RDF====
+
 
+
<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_trigger_repository_rdf -->
+
====EP_TRIGGER_REPOSITORY_RDF====
+
 
+
<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_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%; '>
+
<span style='display:none'>User Comments</span>
+
<!-- Edit below this comment -->
+
 
+
 
+
<!-- Pod2Wiki= -->
+
</div>
+
<!-- Pod2Wiki=item_ep_trigger_begin_request -->
+
====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%; '>
+
<span style='display:none'>User Comments</span>
+
<!-- Edit below this comment -->
+
 
+
 
+
<!-- Pod2Wiki= -->
+
</div>
+
<!-- Pod2Wiki=item_ep_trigger_end_request -->
+
====EP_TRIGGER_END_REQUEST====
+
 
+
<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_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%; '>
+
<span style='display:none'>User Comments</span>
+
<!-- Edit below this comment -->
+
 
+
 
+
<!-- Pod2Wiki= -->
+
</div>
+
<!-- Pod2Wiki=item_ep_trigger_url_rewrite -->
+
====EP_TRIGGER_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%; '>
+
<span style='display:none'>User Comments</span>
+
<!-- Edit below this comment -->
+
 
+
 
+
<!-- Pod2Wiki= -->
+
</div>
+
<!-- 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%; '>
+
<span style='display:none'>User Comments</span>
+
<!-- Edit below this comment -->
+
 
+
 
+
<!-- Pod2Wiki= -->
+
</div>
+
<!-- Pod2Wiki=item_ep_trigger_created -->
+
====EP_TRIGGER_CREATED====
+
 
+
Called after $dataset-&gt;create_dataobj( { ... } ).
+
 
+
  dataobj - the newly created dataobj
+
 
+
<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_trigger_removed -->
+
====EP_TRIGGER_REMOVED====
+
 
+
Called just before the object is removed from the database.
+
 
+
  dataobj - the object being removed
+
 
+
<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_trigger_rdf -->
+
====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%; '>
+
<span style='display:none'>User Comments</span>
+
<!-- Edit below this comment -->
+
 
+
 
+
<!-- Pod2Wiki= -->
+
</div>
+
<!-- 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%; '>
+
<span style='display:none'>User Comments</span>
+
<!-- Edit below this comment -->
+
 
+
 
+
<!-- Pod2Wiki= -->
+
</div>
+
<!-- Pod2Wiki=item_ep_trigger_status_change -->
+
====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 -->
+
 
+
 
+
<!-- Pod2Wiki= -->
+
</div>
+
<!-- Pod2Wiki=item_ep_trigger_before_commit -->
+
====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= -->
+
</div>
+
<!-- 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 -->
+
 
+
 
+
<!-- Pod2Wiki= -->
+
</div>
+
<!-- Pod2Wiki=item_ep_trigger_validate -->
+
====EP_TRIGGER_VALIDATE====
+
 
+
<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_trigger_validate_field -->
+
====EP_TRIGGER_VALIDATE_FIELD====
+
 
+
Validate a field's value.
+
 
+
  field - field to validate
+
 
   value - value to validate
 
   value - value to validate
 
   dataobj - parent dataobj (if available)
 
   dataobj - parent dataobj (if available)
   problems - ARRAYREF of DOM problems encountered
+
   problems - ARRAYREF of DOM problems encountered</pre>
 
+
<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_TRIGGER_WARNINGS
 +
* EP_TRIGGER_FILES_MODIFIED
 +
* EP_TRIGGER_MEDIA_INFO
 +
*: Populate a Document epdata structure with information about a file.
  
<!-- Pod2Wiki= -->
+
<pre>  epdata
</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%; '>
+
<span style='display:none'>User Comments</span>
+
<!-- Edit below this comment -->
+
 
+
 
+
<!-- Pod2Wiki= -->
+
</div>
+
<!-- Pod2Wiki=item_ep_trigger_files_modified -->
+
====EP_TRIGGER_FILES_MODIFIED====
+
 
+
<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_trigger_media_info -->
+
====EP_TRIGGER_MEDIA_INFO====
+
 
+
Populate a Document epdata structure with information about a file.
+
 
+
  epdata
+
 
   filename
 
   filename
   filepath
+
   filepath</pre>
 
+
<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_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_index_fields -->
+
====EP_TRIGGER_INDEX_FIELDS====
+
  
Add the changed fields for the given data object to the index engine(s).
+
* EP_TRIGGER_INDEX_FIELDS
 +
*: Add the changed fields for the given data object to the index engine(s).
  
  dataobj = EPrints::DataObj
+
<pre>  dataobj = EPrints::DataObj
   fields = ARRAYREF of field objects
+
   fields = ARRAYREF of field objects</pre>
 
+
<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_TRIGGER_INDEX_REMOVED
 +
*: An object was removed and should now be removed from the index engine(s).
  
<!-- Pod2Wiki= -->
+
<pre>  dataset = EPrints::DataSet
</div>
+
  id = object id</pre>
<!-- Pod2Wiki=item_ep_trigger_index_removed -->
+
====EP_TRIGGER_INDEX_REMOVED====
+
  
An object was removed and should now be removed from the index engine(s).
+
* 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.
  
  dataset = EPrints::DataSet
+
<pre> pins - hash ref of template pins</pre>
  id = object id
+
 
+
<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_metafield -->
 
<!-- Pod2Wiki=head_metafield -->
 
===:metafield===
 
===:metafield===
<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_PROPERTY_FROM_CONFIG
<!-- Pod2Wiki=item_ep_property_from_config -->
+
*: Get the default value from field defaults in the config.
====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.
  
<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_REQUIRED
<span style='display:none'>User Comments</span>
+
*: This field property must be explicitly set.
<!-- Edit below this comment -->
+
  
 +
* EP_PROPERTY_UNDEF
 +
*: This field property defaults to undef.
  
<!-- Pod2Wiki= -->
+
* EP_PROPERTY_TRUE
</div>
+
*: This field property defaults to true.
<!-- Pod2Wiki=item_ep_property_no_change -->
+
====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_FALSE
 
+
*: This field property defaults to false.
<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_property_required -->
+
====EP_PROPERTY_REQUIRED====
+
  
This field property must be explicitly set.
+
<!-- Pod2Wiki=head_crypt -->
 +
===:crypt===
 +
: One-way encryption methods for passwords, see [[API:EPrints/Utils#crypt|EPrints::Utils/crypt]].
  
<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_property_undef -->
+
*: {{API:PodLink|file=perlfunc|package_name=perlfunc|section=crypt|text=perlfunc/crypt}}.
====EP_PROPERTY_UNDEF====
+
  
This field property defaults to undef.
+
* EP_CRYPT_SHA512
 +
*: {{API:PodLink|file=Digest/SHA|package_name=Digest::SHA|section=|text=Digest::SHA}} sha512 with 2-byte salt and 10000 rounds.
  
<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_property_true -->
+
==COPYRIGHT==
====EP_PROPERTY_TRUE====
+
Copyright 2000-2011 University of Southampton.
  
This field property defaults to true.
+
This file is part of EPrints http://www.eprints.org/.
  
<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_property_false -->
+
====EP_PROPERTY_FALSE====
+
 
+
This field property defaults to false.
+
  
<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=head_copyright -->
+
==COPYRIGHT==
+
<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 15:48, 15 March 2012

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


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


: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_END
  • EP_TRIGGER_URL_REWRITE
  • 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

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