UNIVERSAL::moniker (3)

Leading comments

Automatically generated by Pod::Man 2.25 (Pod::Simple 3.16)

Standard preamble:
========================================================================

(The comments found at the beginning of the groff file "man3/UNIVERSAL::moniker.3pm".)

NAME

UNIVERSAL::moniker - Nicer names for your Perl modules/classes

SYNOPSIS

  use UNIVERSAL::moniker;

DESCRIPTION

Class names in Perl often don't sound great when spoken, or look good when written in prose. For this reason, we tend to say things like ``customer'' or ``basket'' when we are referring to "My::Site::User::Customer" or "My::Site::Shop::Basket". We thought it would be nice if our classes knew what we would prefer to call them.

This module will add a "moniker" (and "plural_moniker") method to "UNIVERSAL", and so to every class or module.

moniker

  $ob->moniker;

Returns the moniker for $ob. So, if $ob->isa(``Big::Scary::Animal''), "moniker" will return ``animal''.

plural_moniker

  $ob->plural_moniker;

Returns the plural moniker for $ob. So, if $ob->isa(``Cephalopod::Octopus''), "plural_moniker" will return ``octopuses''.

(You need to install Lingua::EN::Inflect for this to work.)

AUTHORS

Marty Pauley <marty+perl@kasei.com>, Tony Bowden <tony@kasei.com>, Elizabeth Mattijsen <liz@dijkmat.nl>

(Yes, 3 authors for such a small module!)

COPYRIGHT

  Copyright (C) 2004 Kasei

  This program is free software; you can redistribute it under the same terms as
  Perl.

  This program is distributed in the hope that it will be useful, but WITHOUT
  ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
  FOR A PARTICULAR PURPOSE.