Difference between revisions of "API:EPrints/CLIProcessor"

From EPrints Documentation
Jump to: navigation, search
(New page: <!-- Pod2Wiki=_preamble_ This page has been automatically generated from the EPrints source. Any wiki changes made between the 'Pod2Wiki=*' and 'End of Pod2Wiki' comments will be lost. -...)
 
(Removing all content from page)
Line 1: Line 1:
<!-- Pod2Wiki=_preamble_
 
This page has been automatically generated from the EPrints source. Any wiki changes made between the 'Pod2Wiki=*' and 'End of Pod2Wiki' comments will be lost.
 
-->{{Pod2Wiki}}{{API:Source|file=EPrints/CLIProcessor.pm|package_name=EPrints::CLIProcessor}}[[Category:API|CLIProcessor]]<!-- End of Pod2Wiki -->
 
<!-- Pod2Wiki=head_name -->=NAME=
 
EPrints::CLIProcessor - utility module supporting command-line scripts
 
  
<!-- End of Pod2Wiki -->
 
<!-- Pod2Wiki=head_description -->=DESCRIPTION=
 
Currently this module is just a 'handler' for import scripts. In future it may do more things to support the CLI (Command-Line Interface) to EPrints.
 
 
<!-- End of Pod2Wiki -->
 
<!-- Pod2Wiki=head_methods -->=METHODS=
 
<!-- End of Pod2Wiki -->
 
<!-- Pod2Wiki=item_new -->==new==
 
 
  $processor = EPrints::CLIProcessor-&gt;new( session =&gt; $session, %opts )
 
 
Create a new processor object. Supported options:
 
 
  scripted - backwards compatibility for import scripted interface
 
 
 
<!-- End of Pod2Wiki -->
 
<!-- Pod2Wiki=item_add_message -->==add_message==
 
 
  $processor-&gt;add_message( TYPE, MESSAGE )
 
 
Add a message for the user. TYPE is 'error', 'warning' or 'message'. MESSAGE is an XHTML fragment.
 
 
<!-- End of Pod2Wiki -->
 
<!-- Pod2Wiki=item_parsed -->==parsed==
 
 
  $processor-&gt;parsed( [ $epdata ] )
 
 
Register a parsed event, optionally with $epdata.
 
 
<!-- End of Pod2Wiki -->
 
<!-- Pod2Wiki=item_object -->==object==
 
 
  $processor-&gt;object( DATASET, DATAOBJ )
 
 
Register a new object event in DATASET with new object DATAOBJ.
 
 
<!-- End of Pod2Wiki -->
 
<!-- Pod2Wiki=head_undocumented_methods -->=UNDOCUMENTED METHODS=
 
{{API:Undocumented Methods}}<!-- End of Pod2Wiki -->
 
<!-- Pod2Wiki=item_color -->==color==
 
 
<!-- End of Pod2Wiki -->
 
<!-- Pod2Wiki=item_message -->==message==
 
 
<!-- End of Pod2Wiki -->
 
<!-- Pod2Wiki=_postamble_ --><!-- End of Pod2Wiki -->
 

Revision as of 15:40, 12 August 2009