1 package FS::part_event::Action;
4 use base qw( FS::part_event );
9 FS::part_event::Action - Base class for event actions
13 package FS::part_event::Action::myaction;
15 use base FS::part_event::Action;
19 FS::part_event::Action is a base class for event action classes.
23 These methods are implemented in each action class.
29 Action classes must define a description method. This method should return a
30 scalar description of the action.
32 =item eventtable_hashref
34 Action classes must define a eventtable_hashref method if they can only be
35 triggered against some kinds of tables. This method should return a hash
36 reference of eventtables (values set true indicate the action can be performed):
38 sub eventtable_hashref {
42 'cust_pay_batch' => 0,
49 sub eventtable_hashref {
53 'cust_pay_batch' => 1,
59 Action classes may define an event_stage method to indicate a preference
60 for being run at a non-standard stage of the billing and collection process.
62 This method may currently return "collect" (the default) or "pre-bill".
72 Action classes may define an option_fields method to indicate that they
73 accept one or more options.
75 This method should return a list of option names and option descriptions.
76 Each option description can be a scalar description, for simple options, or a
77 hashref with the following values:
81 =item label - Description
83 =item 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.
85 =item size - Size for text fields
87 =item options - For checkbox-multiple and select, a list reference of available option values.
89 =item option_labels - For select, a hash reference of availble option values and labels.
91 =item value - for checkbox, fixed, hidden
93 =item table - for select-table
95 =item name_col - for select-table
97 =item NOTE: See httemplate/elements/select-table.html for a full list of the optinal options for the select-table type
101 NOTE: A database connection is B<not> yet available when this subroutine is
108 'field' => 'description',
110 'another_field' => { 'label'=>'Amount', 'type'=>'money', },
112 'third_field' => { 'label' => 'Types',
114 'options' => [ 'h', 's' ],
115 'option_labels' => { 'h' => 'Happy',
130 Action classes may define a default weighting. Weights control execution order
131 relative to other actions (that are triggered at the same time).
142 Action classes may define a deprecated method that returns true, indicating
143 that this action is deprecated.
152 =item do_action CUSTOMER_EVENT_OBJECT
154 Action classes must define an action method. This method is triggered if
155 all conditions have been met.
157 The object which triggered the event (an FS::cust_main, FS::cust_bill or
158 FS::cust_pkg object) is passed as an argument.
160 To retreive option values, call the option method on the desired option, i.e.:
162 my( $self, $cust_object ) = @_;
163 $value_of_field = $self->option('field');
165 To indicate sucessful completion, simply return. Optionally, you can return a
166 string of information status information about the sucessful completion, or
167 simply return the empty string.
169 To indicate a failure and that this event should retry, die with the desired
176 These methods are defined in the base class for use in action classes.
180 =item cust_main CUST_OBJECT
182 Return the customer object (see L<FS::cust_main>) associated with the provided
183 object (the object itself if it is already a customer object).
188 my( $self, $cust_object ) = @_;
190 $cust_object->isa('FS::cust_main') ? $cust_object : $cust_object->cust_main;
194 =item option_label OPTIONNAME
196 Returns the label for the specified option name.
201 my( $self, $optionname ) = @_;
203 my %option_fields = $self->option_fields;
205 ref( $option_fields{$optionname} )
206 ? $option_fields{$optionname}->{'label'}
207 : $option_fields{$optionname}
211 =item option_fields_hashref
213 Returns the option fields as an (ordered) hash reference.
217 sub option_fields_hashref {
219 tie my %hash, 'Tie::IxHash', $self->option_fields;
223 =item option_fields_listref
225 Returns just the option field names as a list reference.
229 sub option_fields_listref {
231 my $hashref = $self->option_fields_hashref;