• NAME
• VERSION
• DATE
• SYNOPSIS
• DESCRIPTION
• INTERFACE
  • Constructors
  • Destructors
  • Public Class Methods
  • Public Instance Methods
  • Private Methods
  • Private Class Methods
  • Private Instance Methods
• NOTES
• AUTHOR
• SEE ALSO
• POD ERRORS

NAME

Bric::Util::Class - A module to provide access to the class table

VERSION

$Revision: 1.1.1.1.2.2 $

DATE

$Date: 2001/11/06 23:18:34 $

SYNOPSIS

use Bric::Util::Class;

DESCRIPTION

Provides access to the class table that maps package names to a display name and description.

INTERFACE

Constructors

$obj = Bric::Util::Class->new($init);

Keys for $init are:

• key_name

  A lowercase unique key name for the class with no spaces or punctuation, such as 'user_grp'.

• pkg_name

  The full package name of this class, such as 'Bric::Util::Grp::User'.

• disp_name

  The way the package name (usually shortened) should be displayed on the UI, such as 'User Group'.

• plural_name

  The plural form of disp_name.

• description

  A description of this package.

Throws: NONE.

Side Effects: NONE.

Notes: NONE.

$obj = Bric::Util::Class->lookup({ id => $id });

$obj = Bric::Util::Class->lookup({ pkg_name => $pkg_name });

$obj = Bric::Util::Class->lookup({ key_name => $key_name });

Retrieves an existing class record from the database.

Throws:

NONE

Side Effects:

NONE

Notes:

NONE

@objs = Bric::Util::Class->list($param);

The possible keys to $param are the following:

disp_name

plural_name

description

Throws:

NONE

Side Effects:

NONE

Notes:

NONE

$objs_href = Bric::Util::Class->pkg_href();

Returns an anonymous hash of all the class objects in Bricolage. The hash keys are the lower-cased package names for each class, and the values are the Bric::Util::Class objects themselves.

Throws:

NONE

Side Effects:

NONE

Notes:

NONE

$objs_href = Bric::Util::Class->id_href();

Returns an anonymous hash of all the class objects in Bricolage. The hash keys are the object IDs for each class, and the values are the Bric::Util::Class objects themselves.

Throws:

NONE

Side Effects:

NONE

Notes:

NONE

$objs_href = Bric::Util::Class->key_href();

Returns an anonymous hash of all the class objects in Bricolage. The hash keys are the lower-cased key names for each class, and the values are the Bric::Util::Class objects themselves.

Throws:

NONE

Side Effects:

NONE

Notes:

NONE

Destructors

Public Class Methods

$val = my_meths->{$key}->[0]->($obj);

Introspect this object.

Throws:

NONE

Side Effects:

NONE

Notes:

NONE

Public Instance Methods

$success = $key->save;

Save changes to the database.

Throws:

NONE

Side Effects:

NONE

Notes:

NONE

Private Methods

Private Class Methods

NONE

Private Instance Methods

NONE

NOTES

NONE

AUTHOR

"Garth Webb" <garth@perijove.com> Bricolage Engineering

SEE ALSO

perl, Bric

POD ERRORS

Hey! The above document had some coding errors, which are explained below:

Around line 364:

You forgot a '=back' before '=head2'

Around line 381:

'=item' outside of any '=over'

Around line 483:

You forgot a '=back' before '=head2'

Around line 522:

You forgot a '=back' before '=head2'

Around line 599:

=back without =over