Fix checkboxes field type

As the Profile module also supports a single checkbox only, I think option 1 is the best way to go.

Hey panthar,

Welcome back. I've changed a lot on the Extra Fields Pane module in the last couple of months. I've documented the changes in the changelog (short descriptions). You can read about big changes here #831134: New features and changes in 2.x version of Extra Fields Checkout Pane module, particular post #98.
You may also want to read post #90 in that thread, although some of the tasks written down there are already done.

Well, there were huge changes since the token stuff! :) Hope you can find your way out. If not, you can ask me about the changes (and/or read the posts I mentioned earlier).

Good luck with the checkboxes. :)
You will need to do most of the changes in the file ucxf_field.class.php. The method generate() should output the field (form API array), the method generate_value() returns what was filled in the fields' 'value'-field ('value' of the table 'uc_extra_fields', not 'uc_extra_fields_values') and formats it's in a way it can be used together with the field. For select fields this is a list of options, for textfields this is a default value. This method gets also called in the views handler 'uc_extra_fields_pane_handler_filter_selection'.

Other files that will need to be (little) adjusted are uc_extra_fields_pane.views.inc and checkout_pane.inc. I don't think order_pane.inc will need a change.

The reason I moved the constants is to keep everthing what is related to an ucxf field itself inside the class definition.

To point to a class constant, first include the file with the class definition (ucxf_field.class.php). Then you can point to a class constant using this syntax:
class::CONSTANT
So the code would look like this:

<?php
module_load_include('class.php', 'uc_extra_fields_pane', 'includes/ucxf_field');
$fieldtype = ucxf_field::UCXF_WIDGET_TYPE_CHECKBOXES;
?>

You can see an example of this in uc_extra_fields_pane.views.inc in the function uc_extra_fields_pane_views_fetch_field() (starts on line 151)

However, I'm not sure if it will be needed to check the field type in order_pane.inc and checkout_pane.inc. If we going to make use of a single checkbox I guess it won't be necessary to have an alternate way of displaying the value if the value will be a string. I saw that I made a little mistake in checkout_pane.inc. On line 71 there is this code:

if ($field->value_type == UCXF_WIDGET_TYPE_PHP_CHECKBOXES ||
$field->value_type == UCXF_WIDGET_TYPE_CHECKBOXES ) {

This should have been:

if ($field->value_type == ucxf_field::UCXF_WIDGET_TYPE_PHP_CHECKBOXES ||
$field->value_type == ucxf_field::UCXF_WIDGET_TYPE_CHECKBOXES ) {

I think these line can be removed now if the resulting value of the checkbox will become a string. I'm not completely sure of this yet though. If it still results in an array, we should convert it to a string before it will be added to the order object (this is when the order reaches the operation 'process').

The following lines in checkout_pane.inc (line 31 and 32) are also wrong:

case UCXF_WIDGET_TYPE_PHP:
case UCXF_WIDGET_TYPE_CONSTANT:

This should have been:

case ucxf_field::UCXF_WIDGET_TYPE_PHP:
case ucxf_field::UCXF_WIDGET_TYPE_CONSTANT:

Hope that this clears things up. :)

Hi panthar,

Are you still working on fixing the checkbox field type? Please let me know. If you have stopped working on it, can you send me the code of what you currently got?

Hey, blackice! Fine you want to implement this, but maybe you want to stick with just a single checkbox implementation (because the profile module also supports a single checkbox only)? I think things will be getting less complicated when only supporting a single checkbox.

Tell me what you think about this.

Hi blackice,

I was thinking to support only a limited amount of field types, as I was not planning to copy CCK.

Can you explain why these fields have to be a part of an address?

For non-address fields users also have the ability to use the Ubercart Webform Checkout Pane module, so I guess they should use that module if they want more field types. That module is not designed to add fields to existing panes, so we take care for the address fields.

Extra information pane
The information pane was already there before I joined this project. The pane had been requested in #751898: Additional fields unrelated to billing/delivery.
Initially, the idea was there to provide multiple information panes, but at a certain moment arski, maintainer of the module Ubercart Webform Checkout Pane, told us about that module and we realized supporting multiple panes was sort of copying functionality already provided by Ubercart Webform Checkout Pane. However, the information pane remained. I believe panthar did not want it to be removed, but I'm not sure. Maybe it just remained because we were not sure which direction to follow yet.
Currently, I am using the information pane in one of my projects, but only because I then don't need to install two extra modules.

Checkbox field type
Great you want to implement this!
I think you can drop the PHP checkbox field type. There is no PHP equivalent for a text field either.
But, there probably could be a use case for letting PHP generating the checkbox value, but I think it's a uncommon case. In those cases maybe users should be implementing a hook_form_alter().

I will test it tomorrow. Thanks, blackice!

Hi blackice,

Thanks for your work.

I tested the changes and this were the issues I had with it:
- Setting the field required has no effect.
- Checkboxes act differently in the information pane (review page displays '1'|'n/a' instead of 'Yes'|'No'). An update in checkout_pane.inc will be needed.

I have not yet tested the update for views integration.

Hi blackice,

I hope to test the patch tomorrow.

Regards,

MegaChriz

Hi blackice,

I tested the patch and I have found two small issues:

• The checkbox field type does not respect the display options at lines 69 to 82 in checkout_pane.inc. A custom order field is viewed even when the field may not be be displayed (see further).
• You added extra spaces at some places:
• Lines 73, 77, 126, 132, 133 and 136 in order_pane.inc
• 3/4 space indents instead of 2 at lines 358 to 376 in addressfields.inc
• Lines 451 and 502 in ucxf_field.class.php

<?php
// Display it as data, unless its a checkbox
if ($field->value_type == ucxf_field::UCXF_WIDGET_TYPE_CHECKBOX ) {
  $review[] = array(
    'title' => $field->output('label'),
    'data' => ($arg1->extra_fields[$field->db_name] == 1) ?  t('Yes') : t('No'),
  );
}
elseif ($field->may_display('review')) {
  // warning: user input --> check_plain
  $review[] = array(
    'title' => $field->output('label'),
    'data' => ($arg1->extra_fields[$field->db_name]) ? ' ' . check_plain($arg1->extra_fields[$field->db_name]) : t("n/a"),
  );
}
?>

Values of checkbox fields are shown even when $field->may_display('review') is false.

EDIT: typo

Great!