[Rt-commit] r4715 - in rt/branches/3.7-EXPERIMENTAL: .

[alexmv at bestpractical.com]

Author: alexmv
Date: Wed Mar  8 18:56:22 2006
New Revision: 4715

Modified:
   rt/branches/3.7-EXPERIMENTAL/   (props changed)
   rt/branches/3.7-EXPERIMENTAL/lib/RT/CustomFieldValues/External.pm

Log:
 r8455 at zoq-fot-pik:  chmrr | 2006-03-08 18:56:13 -0500
  * Doc the External interface


Modified: rt/branches/3.7-EXPERIMENTAL/lib/RT/CustomFieldValues/External.pm
==============================================================================
--- rt/branches/3.7-EXPERIMENTAL/lib/RT/CustomFieldValues/External.pm	(original)
+++ rt/branches/3.7-EXPERIMENTAL/lib/RT/CustomFieldValues/External.pm	Wed Mar  8 18:56:22 2006
@@ -5,6 +5,35 @@
 
 use base qw(RT::CustomFieldValues);
 
+=head1 NAME
+
+RT::CustomFieldValues::External - Pull possible values for a custom
+field from an arbitrary external data source.
+
+=head1 SYNOPSIS
+
+Custom field value lists can be produced by creating a class that
+inherits from C<RT::CustomFieldValues::External>, and overloading
+C<SourceDescription> and C<ExternalValues>.  See
+L<RT::CustomFieldValues::Groups> for a simple example.
+
+=head1 DESCRIPTION
+
+Subclasses should implement the following methods:
+
+=head2 SourceDescription
+
+This method should return a string describing the data source; this is
+the identifier by which the user will see the dropdown.
+
+=head2 ExternalValues
+
+This method should return an array reference of hash references.  The
+hash references should contain keys for C<name>, C<description>, and
+C<sortorder>.
+
+=cut
+
 sub _Init {
     my $self = shift;
     $self->Table( '' );