OpenPlugin::Exception::Template - Sample template for creating Exception Plugin drivers.


OpenPlugin documentation  | view source Contained in the OpenPlugin distribution.

Index


NAME

Top

OpenPlugin::Exception::Template - Sample template for creating Exception Plugin drivers.

DESCRIPTION

Top

This is a template for creating additional Exception drivers (subclasses). Most people do this to provide additional fields for certain types of exceptions. Exceptions which occur in the Datasource Plugin might contain a field called sql, for capturing the SQL statement which was used when the exception occurred.

Of course, if you add a new Exception plugin, you'll need to add it to both the OpenPlugin-drivermap.conf and OpenPlugin.conf files.

Adding this driver to OpenPlugin-drivermap.conf would look like:

 <drivermap exception>
    built-in = OpenPlugin::Exception
    template = OpenPlugin::Exception::Template
 </drivermap>

And you'd do the following to add this to the OpenPlugin.conf file:

 <plugin exception>
     load    = Startup

     <driver built-in>
     </driver>

     <driver template>
     </driver>

 </plugin>

PARAMETERS

Top

No parameters can be passed in to OpenPlugin's new() method for this driver. The following parameters are accepted via the throw() and log_throw() methods:

* field1

This example field would contain data of your choice.

* field2

This example field would contain data of your choice.

* field3

This example field would contain data of your choice.

TO DO

Top

Nothing known.

BUGS

Top

None known.

COPYRIGHT

Top

AUTHORS

Top

Eric Andreychek <eric@openthought.net>


OpenPlugin documentation  | view source Contained in the OpenPlugin distribution.