http://www.freeside.biz/mediawiki/index.php?title=Freeside:4:Documentation:Developer/FS/part_pkg_report_option&feed=atom&action=historyFreeside:4:Documentation:Developer/FS/part pkg report option - Revision history2024-03-28T10:58:48ZRevision history for this page on the wikiMediaWiki 1.27.7http://www.freeside.biz/mediawiki/index.php?title=Freeside:4:Documentation:Developer/FS/part_pkg_report_option&diff=9257&oldid=prevJeremyd: Edit via perl MediaWiki framework (1.13)2015-11-18T15:26:11Z<p>Edit via perl MediaWiki framework (1.13)</p>
<p><b>New page</b></p><div>==NAME==<br />
FS::part_pkg_report_option - Object methods for part_pkg_report_option records<br />
<br />
==SYNOPSIS==<br />
<code><br />
use FS::part_pkg_report_option;<br />
<br />
$record = new FS::part_pkg_report_option \%hash;<br />
$record = new FS::part_pkg_report_option { 'column' => 'value' };<br />
<br />
$error = $record->insert;<br />
<br />
$error = $new_record->replace($old_record);<br />
<br />
$error = $record->delete;<br />
<br />
$error = $record->check;<br />
</code><br />
==DESCRIPTION==<br />
An FS::part_pkg_report_option object represents a package definition optional reporting classification. FS::part_pkg_report_option inherits from FS::Record. The following fields are currently supported:<br />
<br />
; num<br />
:primary key<br />
; name<br />
:name - The name associated with the reporting option<br />
; disabled<br />
:disabled - set to 'Y' to prevent addition to new packages<br />
<br />
==METHODS==<br />
; new HASHREF<br />
:Creates a new report option. To add the option to the database, see [[#insert|"insert"]].<br />
<br />
:Note that this stores the hash reference, not a distinct copy of the hash it points to. You can ask the object for a copy with the ''hash'' method.<br />
; insert<br />
:Adds this record to the database. If there is an error, returns the error, otherwise returns false.<br />
; delete<br />
:Delete this record from the database.<br />
; replace OLD_RECORD<br />
:Replaces the OLD_RECORD with this one in the database. If there is an error, returns the error, otherwise returns false.<br />
; check<br />
:Checks all fields to make sure this is a valid example. If there is an error, returns the error, otherwise returns false. Called by the insert and replace methods.<br />
<br />
==CLASS METHODS==<br />
; subsets OPTIONNUM, ...<br />
:Given a list of report_option numbers, determines all combinations of those numbers that exist on actual package definitions. For each such combination, returns an arrayref of report_option numbers, followed by an arrayref of corresponding report class names. This is used for a search optimization.<br />
<br />
==BUGS==<br />
Overlaps somewhat with pkg_class and pkg_category<br />
<br />
==SEE ALSO==<br />
[[Freeside:4:Documentation:Developer/FS/Record|FS::Record]], schema.html from the base documentation.</div>Jeremyd