Difference between revisions of "Freeside:1.9:Documentation:Developer/FS/part event/Action"
From Freeside
(import from POD) |
m (Edit via perl MediaWiki framework (1.13)) |
||
Line 30: | Line 30: | ||
:This method should return a list of option names and option descriptions. Each option description can be a scalar description, for simple options, or a hashref with the following values: | :This method should return a list of option names and option descriptions. Each option description can be a scalar description, for simple options, or a hashref with the following values: | ||
− | ; label - Description; type - Currently text, money, checkbox, checkbox-multiple, select, select-agent, select-pkg_class, select-part_referral, select-table, fixed, hidden, (others can be implemented as httemplate/elements/tr-TYPE.html mason components). Defaults to text.; size - Size for text fields; options - For checkbox-multiple and select, a list reference of available option values.; option_labels - For select, a hash reference of availble option values and labels.; value - for checkbox, fixed, hidden; table - for select-table; name_col - for select-table; NOTE: See httemplate/elements/select-table.html for a full list of the optinal options for the select-table type | + | :; label - Description:; type - Currently text, money, checkbox, checkbox-multiple, select, select-agent, select-pkg_class, select-part_referral, select-table, fixed, hidden, (others can be implemented as httemplate/elements/tr-TYPE.html mason components). Defaults to text.:; size - Size for text fields:; options - For checkbox-multiple and select, a list reference of available option values.:; option_labels - For select, a hash reference of availble option values and labels.:; value - for checkbox, fixed, hidden:; table - for select-table:; name_col - for select-table:; NOTE: See httemplate/elements/select-table.html for a full list of the optinal options for the select-table type |
− | NOTE: A database connection is '''not''' yet available when this subroutine is executed. | + | :NOTE: A database connection is '''not''' yet available when this subroutine is executed. |
− | |||
− | |||
+ | :Example: | ||
<code> | <code> | ||
sub option_fields { | sub option_fields { | ||
Line 81: | Line 80: | ||
; option_fields_listref | ; option_fields_listref | ||
:Returns just the option field names as a list reference. | :Returns just the option field names as a list reference. | ||
− | |||
− | |||
− | |||
− | |||
− | |||
− |
Latest revision as of 18:16, 6 February 2009
Contents
NAME
FS::part_event::Action - Base class for event actions
SYNOPSIS
package FS::part_event::Action::myaction;
use base FS::part_event::Action;
DESCRIPTION
FS::part_event::Action is a base class for event action classes.
METHODS
These methods are implemented in each action class.
- description
- Action classes must define a description method. This method should return a scalar description of the action.
- eventtable_hashref
- Action classes must define a eventtable_hashref method if they can only be triggered against some kinds of tables. This method should return a hash reference of eventtables (values set true indicate the action can be performed):
sub eventtable_hashref { { 'cust_main' => 1, 'cust_bill' => 1, 'cust_pkg' => 0, 'cust_pay_batch' => 0, }; }
- option_fields
- Action classes may define an option_fields method to indicate that they accept one or more options.
- This method should return a list of option names and option descriptions. Each option description can be a scalar description, for simple options, or a hashref with the following values:
- label - Description
- ; type - Currently text, money, checkbox, checkbox-multiple, select, select-agent, select-pkg_class, select-part_referral, select-table, fixed, hidden, (others can be implemented as httemplate/elements/tr-TYPE.html mason components). Defaults to text.:; size - Size for text fields:; options - For checkbox-multiple and select, a list reference of available option values.:; option_labels - For select, a hash reference of availble option values and labels.:; value - for checkbox, fixed, hidden:; table - for select-table:; name_col - for select-table:; NOTE: See httemplate/elements/select-table.html for a full list of the optinal options for the select-table type
- NOTE: A database connection is not yet available when this subroutine is executed.
- Example:
sub option_fields { ( 'field' => 'description', 'another_field' => { 'label'=>'Amount', 'type'=>'money', }, 'third_field' => { 'label' => 'Types', 'type' => 'select', 'options' => [ 'h', 's' ], 'option_labels' => { 'h' => 'Happy', 's' => 'Sad', }, ); }
- default_weight
- Action classes may define a default weighting. Weights control execution order relative to other actions (that are triggered at the same time).
- deprecated
- Action classes may define a deprecated method that returns true, indicating that this action is deprecated.
- do_action CUSTOMER_EVENT_OBJECT
- Action classes must define an action method. This method is triggered if all conditions have been met.
- The object which triggered the event (an FS::cust_main, FS::cust_bill or FS::cust_pkg object) is passed as an argument.
- To retreive option values, call the option method on the desired option, i.e.:
my( $self, $cust_object ) = @_; $value_of_field = $self->option('field');
- To indicate sucessful completion, simply return. Optionally, you can return a string of information status information about the sucessful completion, or simply return the empty string.
- To indicate a failure and that this event should retry, die with the desired error message.
BASE METHODS
These methods are defined in the base class for use in action classes.
- cust_main CUST_OBJECT
- Return the customer object (see FS::cust_main) associated with the provided object (the object itself if it is already a customer object).
- option_label OPTIONNAME
- Returns the label for the specified option name.
- option_fields_hashref
- Returns the option fields as an (ordered) hash reference.
- option_fields_listref
- Returns just the option field names as a list reference.