summaryrefslogtreecommitdiff
path: root/FS/FS/svc_Common.pm
diff options
context:
space:
mode:
authorIvan Kohler <ivan@freeside.biz>2018-02-09 19:10:00 -0800
committerIvan Kohler <ivan@freeside.biz>2018-02-09 19:10:00 -0800
commitd45dd4a826f314fb5459747590d3e11cd80c211f (patch)
treec1dd2edd4bc42b12cc9a995e95dd7fb630da925e /FS/FS/svc_Common.pm
parent4b67c9f8cfc9f944b7758e7e69ac1f9f188ffa47 (diff)
parent15d596e3090f3bde642917b56563736cd1ee2e90 (diff)
Merge branch 'master' of git.freeside.biz:/home/git/freeside
Diffstat (limited to 'FS/FS/svc_Common.pm')
-rw-r--r--FS/FS/svc_Common.pm10
1 files changed, 9 insertions, 1 deletions
diff --git a/FS/FS/svc_Common.pm b/FS/FS/svc_Common.pm
index f2456a56f..afd5db64f 100644
--- a/FS/FS/svc_Common.pm
+++ b/FS/FS/svc_Common.pm
@@ -122,6 +122,15 @@ sub virtual_fields {
=item label
+Returns a label to identify a record of this service.
+Label may be displayed on freeside screens, and within customer bills.
+
+For example, $obj->label may return:
+
+ - A provisioned phone number for svc_phone
+ - The mailing list name and e-mail address for svc_mailinglist
+ - The address of a rental property svc_realestate
+
svc_Common provides a fallback label subroutine that just returns the svcnum.
=cut
@@ -1586,4 +1595,3 @@ from the base documentation.
=cut
1;
-