ExtraField::addElements()

Complexity

Conditions	17
Paths	121

Size

Total Lines	104
Code Lines	55

Duplication

Lines	0
Ratio	0 %

Importance

Changes	1
Bugs	0	Features	0

<?php
    public function addElements(
        $form,
        $itemId = 0,
        $exclude = [],
        $filter = false,
        $useTagAsSelect = false,
        $showOnlyTheseFields = [],
        $orderFields = [],
        $extraData = [],
        $orderDependingDefaults = false,
        $adminPermissions = false,
        $separateExtraMultipleSelect = [],
        $customLabelsExtraMultipleSelect = [],
        $addEmptyOptionSelects = false,
        $introductionTextList = [],
        $requiredFields = [],
        $hideGeoLocalizationDetails = false,
        $help = false
    ) {
        if (empty($form)) {
            return false;
        }

        $itemId = (int) $itemId;
        $form->addHidden('item_id', $itemId);
        if (!empty($itemId)) {
            $extraData = $this->get_handler_extra_data($itemId);
            if (!empty($showOnlyTheseFields)) {
                $setData = [];
                foreach ($showOnlyTheseFields as $variable) {
                    $extraName = 'extra_'.$variable;
                    if (array_key_exists($extraName, $extraData)) {
                        $setData[$extraName] = $extraData[$extraName];
                    }
                }
                $form->setDefaults($setData);
            } else {
                $form->setDefaults($extraData);
            }
        }

        $conditions = [];
        if ($filter) {
            $conditions = ['filter = ?' => 1];
        }

        $extraFields = $this->get_all($conditions, 'option_order');
        $extra = $this->set_extra_fields_in_form(
            $form,
            $extraData,
            $adminPermissions,
            $extraFields,
            $itemId,
            $exclude,
            $useTagAsSelect,
            $showOnlyTheseFields,
            $orderFields,
            $orderDependingDefaults,
            $separateExtraMultipleSelect,
            $customLabelsExtraMultipleSelect,
            $addEmptyOptionSelects,
            $introductionTextList,
            $hideGeoLocalizationDetails,
            $help
        );

        // Ensure $requiredFields is an array
        $requiredFields = is_array($requiredFields) ? $requiredFields : [];
        // Fetch the configured “unique extra field” var
        $uniqueField = api_get_configuration_value('extra_field_to_validate_on_user_registration');
        // Determine if we’re editing an existing user (item_id present) or creating a new one
        $currentUserId = $form->getElementValue('item_id') ?: null;

        // Always mark the unique extra field as required on user forms
        if (
            $this->type === 'user'
            && !empty($uniqueField)
            && !in_array($uniqueField, $requiredFields, true)
        ) {
            $requiredFields[] = $uniqueField;
        }

        /** @var HTML_QuickForm_element $element */
        foreach ($form->getElements() as $element) {
            // Strip the “extra_” prefix to get the field name
            $name = str_replace('extra_', '', $element->getName());

            // 1) Mark as required if configured
            if (in_array($name, $requiredFields, true)) {
                $form->setRequired($element);
            }

            // 2) If this is the special extra field on a user form, add uniqueness validation
            if ($this->type === 'user' && !empty($uniqueField) && $name === $uniqueField) {
                $this->applyExtraFieldUniquenessRule(
                    $form,
                    $name,
                    $uniqueField,
                    $currentUserId
                );
            }
        }

        return $extra;
    }