Removed references to Exception::Class::Base from the documentation. This is
because it's really an internal class, and search.cpan.org tries to point to
it, but fails, since there's no documentation for it.
David Wheeler
21 years ago
| 0 | 0 | package Exception::Class::DBI; |
| 1 | 1 | |
| 2 | # $Id: DBI.pm,v 1.6 2002/08/23 20:11:01 david Exp $ | |
| 2 | # $Id: DBI.pm,v 1.7 2002/09/15 17:52:53 david Exp $ | |
| 3 | 3 | |
| 4 | 4 | use 5.00500; |
| 5 | 5 | use strict; |
| 158 | 158 | =head1 DESCRIPTION |
| 159 | 159 | |
| 160 | 160 | This module offers a set of DBI-specific exception classes. They inherit from |
| 161 | Exception::Class::Base, the base class for all exception objects created by | |
| 162 | the Exception::Class module from the CPAN. Exception::Class::DBI itself offers | |
| 163 | a single class method, C<handler()>, that returns a code reference appropriate | |
| 161 | Exception::Class, the base class for all exception objects created by the | |
| 162 | Exception::Class module from the CPAN. Exception::Class::DBI itself offers a | |
| 163 | single class method, C<handler()>, that returns a code reference appropriate | |
| 164 | 164 | for passing the DBI C<HandleError> attribute. |
| 165 | 165 | |
| 166 | 166 | The exception classes created by Exception::Class::DBI are designed to be |
| 169 | 169 | assembles the necessary metadata, and throws the apopropriate exception. |
| 170 | 170 | |
| 171 | 171 | Each of the Exception::Class::DBI classes offers a set of object accessor |
| 172 | methods in addition to those provided by Exception::Class::Base. These can be | |
| 173 | used to output detailed output in the event of an exception. | |
| 172 | methods in addition to those provided by Exception::Class. These can be used | |
| 173 | to output detailed output in the event of an exception. | |
| 174 | 174 | |
| 175 | 175 | =head1 INTERFACE |
| 176 | 176 | |
| 177 | Exception::Class::DBI inherits from Exception::Class::Base, and thus its | |
| 178 | entire interface. Refer to the Exception::Class documentation for details. | |
| 177 | Exception::Class::DBI inherits from Exception::Class, and thus its entire | |
| 178 | interface. Refer to the Exception::Class documentation for details. | |
| 179 | 179 | |
| 180 | 180 | =head2 Class Method |
| 181 | 181 | |
| 215 | 215 | |
| 216 | 216 | All of the Exception::Class::DBI classes documented below inherit from |
| 217 | 217 | Exception::Class::DBI. It offers the several object methods in addition to |
| 218 | those it inherits from I<its> parent, Exception::Class::Base. These methods | |
| 218 | those it inherits from I<its> parent, Exception::Class. These methods | |
| 219 | 219 | correspond to the L<DBI dynamic attributes|DBI/"DBI Dynamic Attributes">, as |
| 220 | 220 | well as to the values passed to the C<handler()> exception handler via the DBI |
| 221 | 221 | C<HandleError> attribute. Exceptions of this base class are only thrown when |
| 230 | 230 | |
| 231 | 231 | my $error = $ex->error; |
| 232 | 232 | |
| 233 | Exception::Class::DBI actually inherits this method from | |
| 234 | Exception::Class::Base. It contains the error string that DBI prints when its | |
| 235 | C<PrintError> attribute is enabled, or C<die>s with when its <RaiseError> | |
| 236 | attribute is enabled. | |
| 233 | Exception::Class::DBI actually inherits this method from Exception::Class. It | |
| 234 | contains the error string that DBI prints when its C<PrintError> attribute is | |
| 235 | enabled, or C<die>s with when its <RaiseError> attribute is enabled. | |
| 237 | 236 | |
| 238 | 237 | =item C<err> |
| 239 | 238 | |
| 548 | 547 | |
| 549 | 548 | See the documentation for Dave Rolsky's L<Exception::Class|Exception::Class> |
| 550 | 549 | module for details on the methods this module's classes inherit from |
| 551 | Exception::Class::Base. There's lots more information in these exception | |
| 552 | objects, so use them! | |
| 550 | it. There's lots more information in these exception objects, so use them! | |
| 553 | 551 | |
| 554 | 552 | =head1 COPYRIGHT AND LICENSE |
| 555 | 553 | |