class::errorhandler(3pm) [debian man page]

Class::ErrorHandler(3pm)				User Contributed Perl Documentation				  Class::ErrorHandler(3pm)

NAME

       Class::ErrorHandler - Base class for error handling

SYNOPSIS

	   package Foo;
	   use base qw( Class::ErrorHandler );

	   sub class_method {
	       my $class = shift;
	       ...
	       return $class->error("Help!")
		   unless $continue;
	   }

	   sub object_method {
	       my $obj = shift;
	       ...
	       return $obj->error("I am no more")
		   unless $continue;
	   }

	   package main;
	   use Foo;

	   Foo->class_method or die Foo->errstr;

	   my $foo = Foo->new;
	   $foo->object_method or die $foo->errstr;

DESCRIPTION

       Class::ErrorHandler provides an error-handling mechanism that's generic enough to be used as the base class for a variety of OO classes.
       Subclasses inherit its two error-handling methods, error and errstr, to communicate error messages back to the calling program.

       On failure (for whatever reason), a subclass should call error and return to the caller; error itself sets the error message internally,
       then returns "undef". This has the effect of the method that failed returning "undef" to the caller. The caller should check for errors by
       checking for a return value of "undef", and calling errstr to get the value of the error message on an error.

       As demonstrated in the SYNOPSIS, error and errstr work as both class methods and object methods.

USAGE

       Class->error($message)

       $object->error($message)

       Sets the error message for either the class Class or the object $object to the message $message. Returns "undef".

       Class->errstr

       $object->errstr

       Accesses the last error message set in the class Class or the object $object, respectively, and returns that error message.

LICENSE

       Class::ErrorHandler is free software; you may redistribute it and/or modify it under the same terms as Perl itself.

AUTHOR &; COPYRIGHT
       Except where otherwise noted, Class::ErrorHandler is Copyright 2004 Benjamin Trott, cpan@stupidfool.org. All rights reserved.

perl v5.8.7							    2005-07-20						  Class::ErrorHandler(3pm)

Class::Accessor::Class(3pm)				User Contributed Perl Documentation			       Class::Accessor::Class(3pm)

NAME

       Class::Accessor::Class - simple class variable accessors

VERSION

       version 0.501

	$Id: /my/cs/projects/claccl/trunk/lib/Class/Accessor/Class.pm 27922 2006-11-13T16:05:47.533928Z rjbs  $

SYNOPSIS

       Set up a module with class accessors:

	package Text::Fortune;

	use base qw(Class::Accessor::Class Exporter);
	Robot->mk_class_accessors(qw(language offensive collection));

	sub fortune {
	  if (__PACKAGE__->offensive) {
		..

       Then, when using the module:

	use Text::Fortune;

	Text::Fortune->offensive(1);

	print fortune; # prints an offensive fortune

	Text::Fortune->language('EO');

	print fortune; # prints an offensive fortune in Esperanto

DESCRIPTION

       Class::Accessor::Class provides a simple way to create accessor and mutator methods for class variables, just as Class::Accessor provides
       for objects.  It can use either an enclosed lexical variable, or a package variable.

       This module was once implemented in terms of Class::Accessor, but changes to that module broke this relationship.  Class::Accessor::Class
       is still a subclass of Class::Accessor, strictly for historical reasons.  As a side benefit, a class that isa Class::Accessor::Class is
       also a Class::Accessor and can use its methods.

METHODS

   mk_class_accessors
	package Foo;
	use base qw(Class::Accessor::Class);
	Foo->mk_class_accessors(qw(foo bar baz));

	Foo->foo(10);
	my $obj = new Foo;
	print $obj->foo;   # 10

       This method adds accessors for the named class variables.  The accessor will get or set a lexical variable to which the accessor is the
       only access.

   mk_package_accessors
	package Foo;
	use base qw(Class::Accessor::Class);
	Foo->mk_package_accessors(qw(foo bar baz));

	Foo->foo(10);
	my $obj = new Foo;
	print $obj->foo;   # 10
	print $Foo::foo;    # 10

       This method adds accessors for the named class variables.  The accessor will get or set the named variable in the package's symbol table.

DETAILS

   make_class_accessor
	$accessor = Class->make_class_accessor($field);

       This method generates a subroutine reference which acts as an accessor for the named field.

   make_package_accessor
	$accessor = Class->make_package_accessor($field);

       This method generates a subroutine reference which acts as an accessor for the named field, which is stored in the scalar named "field" in
       "Class"'s symbol table.

       This can be useful for dealing with legacy code, but using package variables is almost never a good idea for new code.  Use this with care.

AUTHOR

       Ricardo SIGNES, "<rjbs@cpan.org>"

BUGS

       Please report any bugs or feature requests to "bug-class-accessor-class@rt.cpan.org", or through the web interface at <http://rt.cpan.org>.
       I will be notified, and then you'll automatically be notified of progress on your bug as I make changes.

COPYRIGHT

       Copyright 2004-2006 Ricardo Signes, All Rights Reserved.

       This program is free software; you can redistribute it and/or modify it under the same terms as Perl itself.

perl v5.12.3							    2006-11-13					       Class::Accessor::Class(3pm)