Difference between revisions of "Freeside:3:Documentation:Developer/FS/category Common"
From Freeside
m (Edit via perl MediaWiki framework (1.13)) |
m (Edit via perl MediaWiki framework (1.13)) |
||
| Line 1: | Line 1: | ||
| + | ==NAME== | ||
| + | FS::category_Common - Base class for category (group of classifications) classes | ||
| + | ==SYNOPSIS== | ||
| + | use base qw( FS::category_Common ); use FS::class_table; #should use this | ||
| + | |||
| + | #optional for non-standard names sub _class_table { 'table_name'; } #default is to replace s/category/class/ | ||
| + | |||
| + | ==DESCRIPTION== | ||
| + | FS::category_Common is a base class for classes which provide a categorization (group of classifications) for other classes, such as pkg_category or cust_category. | ||
| + | |||
| + | ; delete | ||
| + | :Deletes this category from the database. Only categories with no associated classifications can be deleted. If there is an error, returns the error, otherwise returns false. | ||
| + | ; check | ||
| + | :Checks all fields to make sure this is a valid package category. If there is an error, returns the error, otherwise returns false. Called by the insert and replace methods. | ||
| + | |||
| + | ==BUGS== | ||
| + | ==SEE ALSO== | ||
| + | [[Freeside:3:Documentation:Developer/FS/Record|FS::Record]] | ||
| + | |||
| + | ==POD ERRORS== | ||
| + | Hey! '''The above document had some coding errors, which are explained below:''' | ||
| + | |||
| + | ; Around line 25: | ||
| + | :'=item' outside of any '=over' | ||
Latest revision as of 05:29, 10 February 2015
NAME
FS::category_Common - Base class for category (group of classifications) classes
SYNOPSIS
use base qw( FS::category_Common ); use FS::class_table; #should use this
- optional for non-standard names sub _class_table { 'table_name'; } #default is to replace s/category/class/
DESCRIPTION
FS::category_Common is a base class for classes which provide a categorization (group of classifications) for other classes, such as pkg_category or cust_category.
- delete
- Deletes this category from the database. Only categories with no associated classifications can be deleted. If there is an error, returns the error, otherwise returns false.
- check
- Checks all fields to make sure this is a valid package category. If there is an error, returns the error, otherwise returns false. Called by the insert and replace methods.
BUGS
SEE ALSO
POD ERRORS
Hey! The above document had some coding errors, which are explained below:
- Around line 25:
- '=item' outside of any '=over'
