API:EPrints/CLIProcessor

From EPrints Documentation
Revision as of 18:28, 11 August 2009 by Tdb01r (Talk | contribs)

(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to: navigation, search

Latest Source Code (3.3, 3.2) | Revision Log | Before editing this page please read Pod2Wiki

NAME

EPrints::CLIProcessor - utility module supporting command-line scripts

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.

METHODS

new

 $processor = EPrints::CLIProcessor->new( session => $session, %opts )

Create a new processor object. Supported options:

 scripted - backwards compatibility for import scripted interface
 

add_message

 $processor->add_message( TYPE, MESSAGE )

Add a message for the user. TYPE is 'error', 'warning' or 'message'. MESSAGE is an XHTML fragment.

parsed

 $processor->parsed( [ $epdata ] )

Register a parsed event, optionally with $epdata.

object

 $processor->object( DATASET, DATAOBJ )

Register a new object event in DATASET with new object DATAOBJ.

UNDOCUMENTED METHODS

Warning These methods were found in the source code but didn't have any POD associated with them. This may be because we haven't got around to documenting them yet or it could be because they are internal to the API and not intended for use by other parts of EPrints.

color

message