diff --git a/.editorconfig b/.editorconfig new file mode 100644 index 0000000..f5f7003 --- /dev/null +++ b/.editorconfig @@ -0,0 +1,240 @@ +[*] +charset = utf-8 +end_of_line = lf +indent_size = 2 +indent_style = space +insert_final_newline = true +max_line_length = 120 +tab_width = 2 +ij_continuation_indent_size = 2 +ij_visual_guides = 80,120 + +[{*.php}] +ij_php_align_assignments = false +ij_php_align_class_constants = false +ij_php_align_enum_cases = false +ij_php_align_group_field_declarations = false +ij_php_align_inline_comments = false +ij_php_align_key_value_pairs = false +ij_php_align_match_arm_bodies = false +ij_php_align_multiline_array_initializer_expression = false +ij_php_align_multiline_binary_operation = false +ij_php_align_multiline_chained_methods = false +ij_php_align_multiline_extends_list = false +ij_php_align_multiline_for = true +ij_php_align_multiline_parameters = false +ij_php_align_multiline_parameters_in_calls = false +ij_php_align_multiline_ternary_operation = false +ij_php_align_named_arguments = false +ij_php_align_phpdoc_comments = false +ij_php_align_phpdoc_param_names = false +ij_php_anonymous_brace_style = end_of_line +ij_php_api_weight = 28 +ij_php_array_initializer_new_line_after_left_brace = true +ij_php_array_initializer_right_brace_on_new_line = true +ij_php_array_initializer_wrap = on_every_item +ij_php_assignment_wrap = normal +ij_php_attributes_wrap = normal +ij_php_author_weight = 28 +ij_php_binary_operation_sign_on_next_line = false +ij_php_binary_operation_wrap = normal +ij_php_blank_lines_after_class_header = 1 +ij_php_blank_lines_after_function = 1 +ij_php_blank_lines_after_imports = 1 +ij_php_blank_lines_after_opening_tag = 0 +ij_php_blank_lines_after_package = 1 +ij_php_blank_lines_around_class = 1 +ij_php_blank_lines_around_constants = 1 +ij_php_blank_lines_around_enum_cases = 0 +ij_php_blank_lines_around_field = 1 +ij_php_blank_lines_around_method = 1 +ij_php_blank_lines_before_class_end = 1 +ij_php_blank_lines_before_imports = 1 +ij_php_blank_lines_before_method_body = 0 +ij_php_blank_lines_before_package = 1 +ij_php_blank_lines_before_return_statement = 1 +ij_php_blank_lines_between_imports = 0 +ij_php_block_brace_style = end_of_line +ij_php_call_parameters_new_line_after_left_paren = true +ij_php_call_parameters_right_paren_on_new_line = true +ij_php_call_parameters_wrap = on_every_item +ij_php_catch_on_new_line = true +ij_php_category_weight = 28 +ij_php_class_brace_style = end_of_line +ij_php_comma_after_last_argument = false +ij_php_comma_after_last_array_element = true +ij_php_comma_after_last_closure_use_var = false +ij_php_comma_after_last_match_arm = false +ij_php_comma_after_last_parameter = false +ij_php_concat_spaces = true +ij_php_copyright_weight = 28 +ij_php_deprecated_weight = 4 +ij_php_do_while_brace_force = always +ij_php_else_if_style = as_is +ij_php_else_on_new_line = true +ij_php_example_weight = 28 +ij_php_extends_keyword_wrap = off +ij_php_extends_list_wrap = off +ij_php_fields_default_visibility = private +ij_php_filesource_weight = 28 +ij_php_finally_on_new_line = true +ij_php_for_brace_force = always +ij_php_for_statement_new_line_after_left_paren = false +ij_php_for_statement_right_paren_on_new_line = false +ij_php_for_statement_wrap = off +ij_php_force_empty_methods_in_one_line = false +ij_php_force_short_declaration_array_style = true +ij_php_getters_setters_naming_style = camel_case +ij_php_getters_setters_order_style = getters_first +ij_php_global_weight = 28 +ij_php_group_use_wrap = on_every_item +ij_php_if_brace_force = always +ij_php_if_lparen_on_next_line = false +ij_php_if_rparen_on_next_line = false +ij_php_ignore_weight = 28 +ij_php_import_sorting = alphabetic +ij_php_indent_break_from_case = true +ij_php_indent_case_from_switch = true +ij_php_indent_code_in_php_tags = false +ij_php_internal_weight = 28 +ij_php_keep_blank_lines_after_lbrace = 1 +ij_php_keep_blank_lines_before_right_brace = 1 +ij_php_keep_blank_lines_in_code = 1 +ij_php_keep_blank_lines_in_declarations = 1 +ij_php_keep_control_statement_in_one_line = false +ij_php_keep_first_column_comment = false +ij_php_keep_indents_on_empty_lines = false +ij_php_keep_line_breaks = false +ij_php_keep_rparen_and_lbrace_on_one_line = true +ij_php_keep_simple_classes_in_one_line = false +ij_php_keep_simple_methods_in_one_line = false +ij_php_lambda_brace_style = end_of_line +ij_php_license_weight = 28 +ij_php_line_comment_add_space = false +ij_php_line_comment_at_first_column = true +ij_php_link_weight = 28 +ij_php_lower_case_boolean_const = false +ij_php_lower_case_keywords = true +ij_php_lower_case_null_const = false +ij_php_method_brace_style = end_of_line +ij_php_method_call_chain_wrap = on_every_item +ij_php_method_parameters_new_line_after_left_paren = true +ij_php_method_parameters_right_paren_on_new_line = true +ij_php_method_parameters_wrap = on_every_item +ij_php_method_weight = 28 +ij_php_modifier_list_wrap = false +ij_php_multiline_chained_calls_semicolon_on_new_line = true +ij_php_namespace_brace_style = 1 +ij_php_new_line_after_php_opening_tag = true +ij_php_null_type_position = in_the_end +ij_php_package_weight = 28 +ij_php_param_weight = 1 +ij_php_parameters_attributes_wrap = normal +ij_php_parentheses_expression_new_line_after_left_paren = false +ij_php_parentheses_expression_right_paren_on_new_line = false +ij_php_phpdoc_blank_line_before_tags = true +ij_php_phpdoc_blank_lines_around_parameters = true +ij_php_phpdoc_keep_blank_lines = true +ij_php_phpdoc_param_spaces_between_name_and_description = 1 +ij_php_phpdoc_param_spaces_between_tag_and_type = 1 +ij_php_phpdoc_param_spaces_between_type_and_name = 1 +ij_php_phpdoc_use_fqcn = true +ij_php_phpdoc_wrap_long_lines = true +ij_php_place_assignment_sign_on_next_line = false +ij_php_place_parens_for_constructor = 1 +ij_php_property_read_weight = 28 +ij_php_property_weight = 28 +ij_php_property_write_weight = 28 +ij_php_return_type_on_new_line = false +ij_php_return_weight = 2 +ij_php_see_weight = 5 +ij_php_since_weight = 28 +ij_php_sort_phpdoc_elements = true +ij_php_space_after_colon = true +ij_php_space_after_colon_in_enum_backed_type = true +ij_php_space_after_colon_in_named_argument = true +ij_php_space_after_colon_in_return_type = true +ij_php_space_after_comma = true +ij_php_space_after_for_semicolon = true +ij_php_space_after_quest = true +ij_php_space_after_type_cast = true +ij_php_space_after_unary_not = false +ij_php_space_before_array_initializer_left_brace = false +ij_php_space_before_catch_keyword = true +ij_php_space_before_catch_left_brace = true +ij_php_space_before_catch_parentheses = true +ij_php_space_before_class_left_brace = true +ij_php_space_before_closure_left_parenthesis = true +ij_php_space_before_colon = true +ij_php_space_before_colon_in_enum_backed_type = false +ij_php_space_before_colon_in_named_argument = false +ij_php_space_before_colon_in_return_type = false +ij_php_space_before_comma = false +ij_php_space_before_do_left_brace = true +ij_php_space_before_else_keyword = true +ij_php_space_before_else_left_brace = true +ij_php_space_before_finally_keyword = true +ij_php_space_before_finally_left_brace = true +ij_php_space_before_for_left_brace = true +ij_php_space_before_for_parentheses = true +ij_php_space_before_for_semicolon = false +ij_php_space_before_if_left_brace = true +ij_php_space_before_if_parentheses = true +ij_php_space_before_method_call_parentheses = false +ij_php_space_before_method_left_brace = true +ij_php_space_before_method_parentheses = false +ij_php_space_before_quest = true +ij_php_space_before_short_closure_left_parenthesis = false +ij_php_space_before_switch_left_brace = true +ij_php_space_before_switch_parentheses = true +ij_php_space_before_try_left_brace = true +ij_php_space_before_unary_not = false +ij_php_space_before_while_keyword = true +ij_php_space_before_while_left_brace = true +ij_php_space_before_while_parentheses = true +ij_php_space_between_ternary_quest_and_colon = false +ij_php_spaces_around_additive_operators = true +ij_php_spaces_around_arrow = false +ij_php_spaces_around_assignment_in_declare = true +ij_php_spaces_around_assignment_operators = true +ij_php_spaces_around_bitwise_operators = true +ij_php_spaces_around_equality_operators = true +ij_php_spaces_around_logical_operators = true +ij_php_spaces_around_multiplicative_operators = true +ij_php_spaces_around_null_coalesce_operator = true +ij_php_spaces_around_pipe_in_union_type = false +ij_php_spaces_around_relational_operators = true +ij_php_spaces_around_shift_operators = true +ij_php_spaces_around_unary_operator = false +ij_php_spaces_around_var_within_brackets = false +ij_php_spaces_within_array_initializer_braces = false +ij_php_spaces_within_brackets = false +ij_php_spaces_within_catch_parentheses = false +ij_php_spaces_within_for_parentheses = false +ij_php_spaces_within_if_parentheses = false +ij_php_spaces_within_method_call_parentheses = false +ij_php_spaces_within_method_parentheses = false +ij_php_spaces_within_parentheses = false +ij_php_spaces_within_short_echo_tags = true +ij_php_spaces_within_switch_parentheses = false +ij_php_spaces_within_while_parentheses = false +ij_php_special_else_if_treatment = false +ij_php_subpackage_weight = 28 +ij_php_ternary_operation_signs_on_next_line = true +ij_php_ternary_operation_wrap = on_every_item +ij_php_throws_weight = 3 +ij_php_todo_weight = 6 +ij_php_treat_multiline_arrays_and_lambdas_multiline = false +ij_php_unknown_tag_weight = 28 +ij_php_upper_case_boolean_const = true +ij_php_upper_case_null_const = true +ij_php_uses_weight = 28 +ij_php_var_weight = 0 +ij_php_variable_naming_style = camel_case +ij_php_version_weight = 28 +ij_php_while_brace_force = always +ij_php_while_on_new_line = false + +[{*.neon,*.neon.dist,*neon.template}] +indent_style = tab +tab_width = 4 diff --git a/.github/workflows/phpcs.yml b/.github/workflows/phpcs.yml new file mode 100644 index 0000000..395cf22 --- /dev/null +++ b/.github/workflows/phpcs.yml @@ -0,0 +1,42 @@ +name: PHP_CodeSniffer + +on: + pull_request: + paths: + - '**.php' + - tools/phpcs/composer.json + - phpcs.xml.dist + +jobs: + phpcs: + runs-on: ubuntu-latest + name: PHP_CodeSniffer + + steps: + - uses: actions/checkout@v3 + + - name: Setup PHP + uses: shivammathur/setup-php@v2 + with: + php-version: 8.1 + coverage: none + tools: cs2pr + env: + fail-fast: true + + - name: Get composer cache directory + id: composer-cache + run: echo "dir=$(composer config cache-files-dir)" >> $GITHUB_OUTPUT + + - name: Cache dependencies + uses: actions/cache@v3 + with: + path: ${{ steps.composer-cache.outputs.dir }} + key: ${{ runner.os }}-composer-${{ hashFiles('tools/phpcs/composer.json') }} + restore-keys: ${{ runner.os }}-composer- + + - name: Install dependencies + run: composer composer-phpcs -- update --no-progress --prefer-dist + + - name: Run PHP_CodeSniffer + run: composer phpcs -- -q --report=checkstyle | cs2pr diff --git a/.github/workflows/phpstan.yml b/.github/workflows/phpstan.yml new file mode 100644 index 0000000..33c30f5 --- /dev/null +++ b/.github/workflows/phpstan.yml @@ -0,0 +1,52 @@ +name: PHPStan + +on: + pull_request: + paths: + - '**.php' + - composer.json + - tools/phpstan/composer.json + - ci/composer.json + - phpstan.ci.neon + - phpstan.neon.dist + +jobs: + phpstan: + runs-on: ubuntu-latest + strategy: + matrix: + php-versions: ['7.4', '8.0', '8.1'] + prefer: ['prefer-stable', 'prefer-lowest'] + name: PHPStan with PHP ${{ matrix.php-versions }} ${{ matrix.prefer }} + + steps: + - uses: actions/checkout@v3 + + - name: Setup PHP + uses: shivammathur/setup-php@v2 + with: + php-version: ${{ matrix.php-versions }} + coverage: none + env: + fail-fast: true + + - name: Get composer cache directory + id: composer-cache + run: echo "dir=$(composer config cache-files-dir)" >> $GITHUB_OUTPUT + + - name: Cache dependencies + uses: actions/cache@v3 + with: + path: ${{ steps.composer-cache.outputs.dir }} + key: ${{ runner.os }}-composer-${{ matrix.prefer }}-${{ hashFiles('**/composer.json') }} + restore-keys: ${{ runner.os }}-composer-${{ matrix.prefer }}- + + - name: Install dependencies + run: | + composer update --no-progress --prefer-dist --${{ matrix.prefer }} && + composer composer-phpunit -- update --no-progress --prefer-dist && + composer composer-phpstan -- update --no-progress --prefer-dist --optimize-autoloader && + composer --working-dir=ci update --no-progress --prefer-dist --${{ matrix.prefer }} --optimize-autoloader --ignore-platform-req=ext-gd + + - name: Run PHPStan + run: composer phpstan -- analyse -c phpstan.ci.neon diff --git a/.github/workflows/phpunit.yml b/.github/workflows/phpunit.yml new file mode 100644 index 0000000..a30e116 --- /dev/null +++ b/.github/workflows/phpunit.yml @@ -0,0 +1,37 @@ +name: PHPUnit + +on: + pull_request: + paths: + - '**.php' + - composer.json + - tools/phpunit/composer.json + - phpunit.xml.dist + - tests/docker-prepare.sh + +env: + # On github CI machine creating the "/vendor" volume fails otherwise with: read-only file system: unknown + BIND_VOLUME_PERMISSIONS: rw + +jobs: + phpunit: + runs-on: ubuntu-latest + strategy: + matrix: + civicrm-image-tags: [ '5-drupal-php8.1', '5-drupal-php7.4', '5.56-drupal-php7.4' ] + name: PHPUnit with Docker image michaelmcandrew/civicrm:${{ matrix.civicrm-image-tags }} + env: + CIVICRM_IMAGE_TAG: ${{ matrix.civicrm-image-tags }} + + steps: + - uses: actions/checkout@v3 + - name: Pull images + run: docker compose -f tests/docker-compose.yml pull --quiet + - name: Start containers + run: docker compose -f tests/docker-compose.yml up -d + - name: Prepare environment + run: docker compose -f tests/docker-compose.yml exec civicrm sites/default/files/civicrm/ext/de.systopia.twingle/tests/docker-prepare.sh + - name: Run PHPUnit + run: docker compose -f tests/docker-compose.yml exec civicrm sites/default/files/civicrm/ext/de.systopia.twingle/tests/docker-phpunit.sh + - name: Remove containers + run: docker compose -f tests/docker-compose.yml down -v diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..62dffec --- /dev/null +++ b/.gitignore @@ -0,0 +1,10 @@ +/.phpcs.cache +/.phpunit.result.cache +/.phpstan/ +/ci/composer.lock +/ci/vendor/ +/composer.lock +/phpstan.neon +/tools/*/vendor/ +/tools/*/composer.lock +/vendor/ diff --git a/CRM/Twingle/BAO/TwingleProduct.php b/CRM/Twingle/BAO/TwingleProduct.php new file mode 100644 index 0000000..c782314 --- /dev/null +++ b/CRM/Twingle/BAO/TwingleProduct.php @@ -0,0 +1,676 @@ + CRM_Utils_Type::T_INT, + "external_id" => CRM_Utils_Type::T_INT, + "name" => CRM_Utils_Type::T_STRING, + "is_active" => CRM_Utils_Type::T_BOOLEAN, + "description" => CRM_Utils_Type::T_STRING, + "price" => CRM_Utils_Type::T_INT, + "created_at" => CRM_Utils_Type::T_INT, + "tw_created_at" => CRM_Utils_Type::T_INT, + "updated_at" => CRM_Utils_Type::T_INT, + "tw_updated_at" => CRM_Utils_Type::T_INT, + "is_orphaned" => CRM_Utils_Type::T_BOOLEAN, + "is_outdated" => CRM_Utils_Type::T_BOOLEAN, + "project_id" => CRM_Utils_Type::T_INT, + "sort" => CRM_Utils_Type::T_INT, + "financial_type_id" => CRM_Utils_Type::T_INT, + "twingle_shop_id" => CRM_Utils_Type::T_INT, + "price_field_id" => CRM_Utils_Type::T_INT, + # "text" => \CRM_Utils_Type::T_STRING, + # "images" => \CRM_Utils_Type::T_STRING, + # "categories" = \CRM_Utils_Type::T_STRING, + # "internal_id" => \CRM_Utils_Type::T_STRING, + # "has_zero_price" => \CRM_Utils_Type::T_BOOLEAN, + # "name_plural" => \CRM_Utils_Type::T_STRING, + # "max_count" => \CRM_Utils_Type::T_INT, + # "has_textinput" => \CRM_Utils_Type::T_BOOLEAN, + # "count" => \CRM_Utils_Type::T_INT, + ]; + + /** + * Change attribute names to match the database column names. + * + * @param array $values + * Array with product data from Twingle API + * + * @return array + */ + public static function renameTwingleAttrs(array $values) { + $new_values = []; + foreach ($values as $key => $value) { + // replace 'id' with 'external_id' + if ($key == 'id') { + $key = 'external_id'; + } + // replace 'updated_at' with 'tw_updated_at' + if ($key == 'updated_at') { + $key = 'tw_updated_at'; + } + // replace 'created_at' with 'tw_created_at' + if ($key == 'created_at') { + $key = 'tw_created_at'; + } + $new_values[$key] = $value; + } + return $new_values; + } + + /** + * Load product data. + * + * @param array $product_data + * Array with product data + * + * @return void + * + * @throws ProductException + * @throws \Exception + */ + public function load(array $product_data): void { + // Filter for allowed attributes + filter_attributes( + $product_data, + self::ALLOWED_ATTRIBUTES, + self::CAN_BE_ZERO, + ); + + // Does this product allow to enter a custom price? + $custom_price = array_key_exists('price', $product_data) && $product_data['price'] === Null; + if (!$custom_price && isset($product_data['price_field_id'])) { + try { + $price_field = civicrm_api3('PriceField', 'getsingle', [ + 'id' => $product_data['price_field_id'], + 'return' => 'is_enter_qty', + ]); + $custom_price = (bool) $price_field['is_enter_qty']; + } + catch (CRM_Core_Exception $e) { + throw new ProductException( + E::ts("Could not find PriceField for Twingle Product ['id': %1, 'external_id': %2]: %3", + [ + 1 => $product_data['id'], + 2 => $product_data['external_id'], + 3 => $e->getMessage(), + ]), + ProductException::ERROR_CODE_PRICE_FIELD_NOT_FOUND); + } + } + + // Amend data from corresponding PriceFieldValue + if (isset($product_data['price_field_id'])) { + try { + $price_field_value = civicrm_api3('PriceFieldValue', 'getsingle', [ + 'price_field_id' => $product_data['price_field_id'], + ]); + } + catch (CRM_Core_Exception $e) { + throw new ProductException( + E::ts("Could not find PriceFieldValue for Twingle Product ['id': %1, 'external_id': %2]: %3", + [ + 1 => $product_data['id'], + 2 => $product_data['external_id'], + 3 => $e->getMessage(), + ]), + ProductException::ERROR_CODE_PRICE_FIELD_VALUE_NOT_FOUND); + } + $product_data['name'] = $product_data['name'] ?? $price_field_value['label']; + $product_data['price'] = $custom_price ? Null : $product_data['price'] ?? $price_field_value['amount']; + $product_data['financial_type_id'] = $product_data['financial_type_id'] ?? $price_field_value['financial_type_id']; + $product_data['is_active'] = $product_data['is_active'] ?? $price_field_value['is_active']; + $product_data['sort'] = $product_data['sort'] ?? $price_field_value['weight']; + $product_data['description'] = $product_data['description'] ?? $price_field_value['description']; + } + + // Change data types + try { + convert_str_to_int($product_data, self::STR_TO_INT_CONVERSION); + convert_int_to_bool($product_data, self::INT_TO_BOOL_CONVERSION); + convert_str_to_date($product_data, self::STR_TO_DATE_CONVERSION); + convert_empty_string_to_null($product_data, self::EMPTY_STRING_TO_NULL); + } + catch (\Exception $e) { + throw new ProductException($e->getMessage(), ProductException::ERROR_CODE_ATTRIBUTE_WRONG_DATA_TYPE); + } + + // Validate data types + try { + validate_data_types($product_data, self::ALLOWED_ATTRIBUTES); + } + catch (\Exception $e) { + throw new ProductException($e->getMessage(), ProductException::ERROR_CODE_ATTRIBUTE_WRONG_DATA_TYPE); + } + + // Set attributes + foreach ($product_data as $key => $value) { + $this->$key = $value; + } + } + + /** + * Creates a price field to represents this product in CiviCRM. + * + * @param string $mode + * 'create' or 'edit' + * @throws \Civi\Twingle\Shop\Exceptions\ProductException + */ + public function createPriceField() { + // Define mode for PriceField + $mode = $this->price_field_id ? 'edit' : 'create'; + $action = $mode == 'create' ? 'create' : 'update'; + + // Check if PriceSet for this Shop already exists + try { + $price_field = civicrm_api3('PriceField', 'get', [ + 'name' => 'tw_product_' . $this->external_id, + ]); + if ($price_field['count'] > 0 && $mode == 'create') { + throw new ProductException( + E::ts('PriceField for this Twingle Product already exists.'), + ProductException::ERROR_CODE_PRICE_FIELD_ALREADY_EXISTS, + ); + } elseif ($price_field['count'] == 0 && $mode == 'edit') { + throw new ProductException( + E::ts('PriceField for this Twingle Product does not exist and cannot be edited.'), + ProductException::ERROR_CODE_PRICE_FIELD_NOT_FOUND, + ); + } + } + catch (CRM_Core_Exception $e) { + throw new ProductException( + E::ts('Could not check if PriceField for this Twingle Product already exists.'), + ProductException::ERROR_CODE_PRICE_FIELD_NOT_FOUND, + ); + } + + // Try to find corresponding price set via TwingleShop + try { + $shop = civicrm_api3('TwingleShop', 'getsingle', [ + 'id' => $this->twingle_shop_id, + ]); + $this->price_set_id = (int) $shop['price_set_id']; + } + catch (CRM_Core_Exception $e) { + throw new ProductException( + E::ts('Could not find PriceSet for this Twingle Product.'), + ProductException::ERROR_CODE_PRICE_SET_NOT_FOUND, + ); + } + + // Create PriceField + $price_field_data = [ + 'price_set_id' => $this->price_set_id, + 'name' => 'tw_product_' . $this->external_id, + 'label' => $this->name, + 'is_active' => $this->is_active, + 'weight' => $this->sort, + 'html_type' => 'Text', + 'is_required' => false, + ]; + + // If the product has no fixed price, allow the user to enter a custom price + if ($this->price === Null) { + $price_field_data['is_enter_qty'] = true; + $price_field_data['is_display_amounts'] = false; + } + + // Add id if in edit mode + if ($mode == 'edit') { + $price_field_data['id'] = $this->price_field_id; + } + try { + $price_field = civicrm_api4( + 'PriceField', + $action, + ['values' => $price_field_data], + )->first(); + $this->price_field_id = (int) $price_field['id']; + } + catch (CRM_Core_Exception $e) { + throw new ProductException( + E::ts('Could not create PriceField for this Twingle Product: %1', + [1 => $e->getMessage()]), + ProductException::ERROR_CODE_COULD_NOT_CREATE_PRICE_FIELD); + } + + // Try to find existing PriceFieldValue if in edit mode + $price_field_value = NULL; + if ($mode == 'edit') { + try { + $price_field_value = civicrm_api3('PriceFieldValue', 'getsingle', [ + 'price_field_id' => $this->price_field_id, + ]); + } + catch (CRM_Core_Exception $e) { + throw new ProductException( + E::ts('Could not find PriceFieldValue for this Twingle Product: %1', + [1 => $e->getMessage()]), + ProductException::ERROR_CODE_PRICE_FIELD_VALUE_NOT_FOUND); + } + } + + // Create PriceFieldValue + $price_field_value_data = [ + 'price_field_id' => $this->price_field_id, + 'financial_type_id' => $this->financial_type_id, + 'label' => $this->name, + 'amount' => $this->price === Null ? 1 : $this->price, + 'is_active' => $this->is_active, + 'description' => $this->description, + ]; + // Add id if in edit mode + if ($mode == 'edit' && $price_field_value) { + $price_field_value_data['id'] = $price_field_value['id']; + } + try { + civicrm_api4( + 'PriceFieldValue', + $action, + ['values' => $price_field_value_data], + ); + } + catch (CRM_Core_Exception $e) { + throw new ProductException( + E::ts('Could not create PriceFieldValue for this Twingle Product: %1', + [1 => $e->getMessage()]), + ProductException::ERROR_CODE_COULD_NOT_CREATE_PRICE_FIELD_VALUE); + } + } + + /** + * Returns this TwingleProduct's attributes. + * + * @return array + * @throws \CRM_Core_Exception + */ + public function getAttributes() { + // Filter for allowed attributes + return array_intersect_key( + get_object_vars($this), + $this::ALLOWED_ATTRIBUTES + ) // Add financial type id of this product if it exists + + ['financial_type_id' => $this->getFinancialTypeId()]; + } + + /** + * Find TwingleProduct by its external ID. + * + * @param int $external_id + * External id of the product (by Twingle) + * + * @return CRM_Twingle_BAO_TwingleProduct|null + * TwingleProduct object or NULL if not found + * + * @throws \Civi\Twingle\Shop\Exceptions\ProductException + * @throws \Civi\Core\Exception\DBQueryException + */ + public static function findByExternalId($external_id) { + $dao = CRM_Twingle_BAO_TwingleShop::executeQuery("SELECT * FROM civicrm_twingle_product WHERE external_id = %1", + [1 => [$external_id, 'String']]); + if ($dao->fetch()) { + $product = new self(); + $product->load($dao->toArray()); + return $product; + } + return NULL; + } + + /** + * Add Twingle Product + * + * @param string $mode + * 'create' or 'edit' + * @return array + * @throws \Civi\Twingle\Shop\Exceptions\ProductException + * @throws \Exception + */ + public function add($mode = 'create') { + + $tx = new CRM_Core_Transaction(); + + // Define mode + $mode = $this->id ? 'edit' : 'create'; + + // Try to lookup object in database + try { + $dao = CRM_Twingle_BAO_TwingleShop::executeQuery("SELECT * FROM civicrm_twingle_product WHERE external_id = %1", + [1 => [$this->external_id, 'String']]); + if ($dao->fetch()) { + $this->copyValues(array_merge($dao->toArray(), $this->getAttributes())); + } + } + catch (\Civi\Core\Exception\DBQueryException $e) { + throw new ProductException( + E::ts('Could not find TwingleProduct in database: %1', [1 => $e->getMessage()]), + ShopException::ERROR_CODE_COULD_NOT_FIND_SHOP_IN_DB); + } + + // Register pre-hook + $twingle_product_values = $this->getAttributes(); + try { + \CRM_Utils_Hook::pre($mode, 'TwingleProduct', $this->id, $twingle_product_values); + } + catch (\Exception $e) { + $tx->rollback(); + throw $e; + } + $this->load($twingle_product_values); + + // Set latest tw_updated_at as new updated_at + $this->updated_at = \CRM_Utils_Time::date('Y-m-d H:i:s', $this->tw_updated_at); + + // Convert created_at to date string + $this->created_at = \CRM_Utils_Time::date('Y-m-d H:i:s', $this->created_at); + + // Save object to database + try { + $this->save(); + } + catch (\Exception $e) { + $tx->rollback(); + throw new ProductException( + E::ts('Could not save TwingleProduct to database: %1', [1 => $e->getMessage()]), + ProductException::ERROR_CODE_COULD_NOT_CREATE_PRODUCT); + } + $result = self::findById($this->id); + /** @var self $result */ + $this->load($result->getAttributes()); + + // Register post-hook + $twingle_product_values = $this->getAttributes(); + try { + \CRM_Utils_Hook::post($mode, 'TwingleProduct', $this->id, $twingle_product_values); + } + catch (\Exception $e) { + $tx->rollback(); + throw $e; + } + $this->load($twingle_product_values); + + return $result->toArray(); + } + + /** + * Delete TwingleProduct along with associated PriceField and PriceFieldValue. + * + * @override \CRM_Twingle_DAO_TwingleProduct::delete + * @throws \CRM_Core_Exception + * @throws \Civi\Twingle\Shop\Exceptions\ProductException + */ + function delete($useWhere = FALSE) { + // Register post-hook + $twingle_product_values = $this->getAttributes(); + \CRM_Utils_Hook::pre('delete', 'TwingleProduct', $this->id, $twingle_product_values); + $this->load($twingle_product_values); + + // Delete TwingleProduct + parent::delete($useWhere); + + // Register post-hook + \CRM_Utils_Hook::post('delete', 'TwingleProduct', $this->id, $instance); + + // Free global arrays associated with this object + $this->free(); + + return true; + } + + /** + * Complements the data with the data that was fetched from Twingle. + * + * @throws \Civi\Twingle\Shop\Exceptions\ProductException + */ + public function complementWithDataFromTwingle($product_from_twingle) { + // Complement with data from Twingle + $this->load([ + 'project_id' => $product_from_twingle['project_id'], + 'tw_updated_at' => $product_from_twingle['updated_at'], + 'tw_created_at' => $product_from_twingle['created_at'], + ]); + } + + /** + * Check if the product is outdated. + * + * @param $product_from_twingle + * + * @return void + * @throws \Civi\Twingle\Shop\Exceptions\ProductException + */ + public function checkOutdated($product_from_twingle) { + // Mark outdated products which have a newer timestamp in Twingle + if ($this->updated_at < intval($product_from_twingle['updated_at'])) { + // Overwrite the product with the data from Twingle + $this->load(self::renameTwingleAttrs($product_from_twingle)); + $this->is_outdated = TRUE; + } + } + + /** + * Compare two products + * + * @param CRM_Twingle_BAO_TwingleProduct $product_to_compare_with + * Product from database + * + * @return bool + */ + public function equals($product_to_compare_with) { + return + $this->name === $product_to_compare_with->name && + $this->description === $product_to_compare_with->description && + $this->text === $product_to_compare_with->text && + $this->price === $product_to_compare_with->price && + $this->external_id === $product_to_compare_with->external_id; + } + + /** + * Returns the financial type id of this product. + * + * @return int|null + * @throws \CRM_Core_Exception + */ + public function getFinancialTypeId(): ?int { + if (!empty($this->price_field_id)) { + $price_set = PriceField::get() + ->addSelect('financial_type_id') + ->addWhere('id', '=', $this->price_field_id) + ->execute() + ->first(); + return $price_set['financial_type_id']; + } + return NULL; + } + + /** + * Returns the price field value id of this product. + * + * @return int|null + * @throws \CRM_Core_Exception + */ + public function getPriceFieldValueId() { + if (!empty($this->price_field_id)) { + $price_field_value = PriceFieldValue::get() + ->addSelect('id') + ->addWhere('price_field_id', '=', $this->price_field_id) + ->execute() + ->first(); + return $price_field_value['id']; + } + return NULL; + } + + /** + * Delete PriceField and PriceFieldValue of this TwingleProduct if they exist. + * + * @return void + * @throws \Civi\Twingle\Shop\Exceptions\ProductException + */ + public function deletePriceField(): void { + // Before we can delete the PriceField we need to delete the associated + // PriceFieldValue + try { + $result = civicrm_api3('PriceFieldValue', 'getsingle', + ['price_field_id' => $this->price_field_id]); + } + catch (CRM_Core_Exception $e) { + throw new ProductException( + E::ts('An Error occurred while searching for the associated PriceFieldValue: %1', [1 => $e->getMessage()]), + ProductException::ERROR_CODE_PRICE_FIELD_VALUE_NOT_FOUND); + } + try { + civicrm_api3('PriceFieldValue', 'delete', ['id' => $result['id']]); + } + catch (CRM_Core_Exception $e) { + throw new ProductException( + E::ts('Could not delete associated PriceFieldValue: %1', [1 => $e->getMessage()]), + ProductException::ERROR_CODE_COULD_NOT_DELETE_PRICE_FIELD_VALUE); + } + + // Try to delete PriceField + // If no PriceField is found, we assume that it has already been deleted + try { + civicrm_api3('PriceField', 'delete', + ['id' => $this->price_field_id]); + } + catch (CRM_Core_Exception $e) { + // Check if PriceField yet exists + try { + $result = civicrm_api3('PriceField', 'get', + ['id' => $this->price_field_id]); + // Throw exception if PriceField still exists + if ($result['count'] > 0) { + throw new ProductException( + E::ts('PriceField for this Twingle Product still exists.'), + ProductException::ERROR_CODE_PRICE_FIELD_STILL_EXISTS); + } + } + catch (CRM_Core_Exception $e) { + throw new ProductException( + E::ts('An Error occurred while searching for the associated PriceField: %1', [1 => $e->getMessage()]), + ProductException::ERROR_CODE_PRICE_FIELD_NOT_FOUND); + } + throw new ProductException( + E::ts('Could not delete associated PriceField: %1', [1 => $e->getMessage()]), + ProductException::ERROR_CODE_COULD_NOT_DELETE_PRICE_FIELD); + } + $this->price_field_id = NULL; + } + +} diff --git a/CRM/Twingle/BAO/TwingleShop.php b/CRM/Twingle/BAO/TwingleShop.php new file mode 100644 index 0000000..27ae3b8 --- /dev/null +++ b/CRM/Twingle/BAO/TwingleShop.php @@ -0,0 +1,475 @@ + \CRM_Utils_Type::T_INT, + 'project_identifier' => \CRM_Utils_Type::T_STRING, + 'numerical_project_id' => \CRM_Utils_Type::T_INT, + 'name' => \CRM_Utils_Type::T_STRING, + 'price_set_id' => \CRM_Utils_Type::T_INT, + 'financial_type_id' => \CRM_Utils_Type::T_INT, + ]; + + public const STR_TO_INT_CONVERSION = [ + 'id', + 'numerical_project_id', + 'price_set_id', + 'financial_type_id', + ]; + + /** + * @var array $products + * Array of Twingle Shop products (Cache) + */ + public $products; + + /** + * FK to Financial Type + * + * @var int + */ + public $financial_type_id; + + /** + * TwingleShop constructor + */ + public function __construct() { + parent::__construct(); + // Get TwingleApiCall singleton + $this->twingleApi = ApiCall::singleton(); + } + + /** + * Get Twingle Shop from database by its project identifier + * (like 'tw620214349ac97') + * + * @param string $project_identifier + * Twingle project identifier + * + * @return CRM_Twingle_BAO_TwingleShop + * + * @throws ShopException + * @throws \Civi\Twingle\Shop\Exceptions\ApiCallError + * @throws \CRM_Core_Exception + */ + public static function findByProjectIdentifier(string $project_identifier) { + $shop = new CRM_Twingle_BAO_TwingleShop(); + $shop->get('project_identifier', $project_identifier); + if (!$shop->id) { + $shop->fetchDataFromTwingle($project_identifier); + } + else { + $shop->price_set_id = civicrm_api3('PriceSet', 'getvalue', + ['return' => 'id', 'name' => $project_identifier]); + } + return $shop; + } + + /** + * Load Twingle Shop data + * + * @param array $shop_data + * Array with shop data + * + * @return void + * + * @throws ShopException + */ + public function load(array $shop_data): void { + // Filter for allowed attributes + filter_attributes($shop_data, self::ALLOWED_ATTRIBUTES); + + // Convert string to int + try { + convert_str_to_int($shop_data, self::STR_TO_INT_CONVERSION); + } + catch (Exception $e) { + throw new ShopException($e->getMessage(), ShopException::ERROR_CODE_ATTRIBUTE_WRONG_DATA_TYPE); + } + + // Validate data types + try { + validate_data_types($shop_data, self::ALLOWED_ATTRIBUTES); + } + catch (Exception $e) { + throw new ShopException($e->getMessage(), ShopException::ERROR_CODE_ATTRIBUTE_WRONG_DATA_TYPE); + } + + // Set attributes + foreach ($shop_data as $key => $value) { + $this->$key = $value; + } + } + + /** + * Get attributes + * + * @return array + */ + function getAttributes(): array { + return [ + 'id' => $this->id, + 'project_identifier' => $this->project_identifier, + 'numerical_project_id' => $this->numerical_project_id, + 'name' => $this->name, + 'price_set_id' => $this->price_set_id, + 'financial_type_id' => $this->financial_type_id, + ]; + } + + /** + * Add Twingle Shop + * + * @param string $mode + * 'create' or 'edit' + * @return array + * @throws \Civi\Twingle\Shop\Exceptions\ShopException + */ + public function add($mode = 'create') { + + // Try to lookup object in database + try { + $dao = self::executeQuery("SELECT * FROM civicrm_twingle_shop WHERE project_identifier = %1", + [1 => [$this->project_identifier, 'String']]); + if ($dao->fetch()) { + $this->load($dao->toArray()); + } + } + catch (\Civi\Core\Exception\DBQueryException $e) { + throw new ShopException( + E::ts('Could not find TwingleShop in database: %1', [1 => $e->getMessage()]), + ShopException::ERROR_CODE_COULD_NOT_FIND_SHOP_IN_DB); + } + + // Register pre-hook + $twingle_shop_values = $this->getAttributes(); + \CRM_Utils_Hook::pre($mode, 'TwingleShop', $this->id, $twingle_shop_values); + $this->load($twingle_shop_values); + + // Save object to database + $result = $this->save(); + + // Register post-hook + \CRM_Utils_Hook::post($mode, 'TwingleShop', $this->id, $instance); + + return $result->toArray(); + } + + /** + * Delete object by deleting the associated PriceSet and letting the foreign + * key constraint do the rest. + * + * @throws \Civi\Twingle\Shop\Exceptions\ShopException* + * @throws \Civi\Twingle\Shop\Exceptions\ProductException + */ + function deleteByConstraint() { + // Register post-hook + $twingle_shop_values = $this->getAttributes(); + \CRM_Utils_Hook::pre('delete', 'TwingleShop', $this->id, $twingle_shop_values); + $this->load($twingle_shop_values); + + // Delete associated products + $this->deleteProducts(); + + // Try to get single PriceSet + try { + civicrm_api3('PriceSet', 'getsingle', + ['id' => $this->price_set_id]); + } + catch (\CRM_Core_Exception $e) { + if ($e->getMessage() != 'Expected one PriceSet but found 0') { + throw new ShopException( + E::ts('Could not find associated PriceSet: %1', [1 => $e->getMessage()]), + ShopException::ERROR_CODE_PRICE_SET_NOT_FOUND); + } + else { + // If no PriceSet is found, we can simply delete the TwingleShop + return $this->delete(); + } + } + + // Deleting the associated PriceSet will also lead to the deletion of this + // TwingleShop because of the foreign key constraint and cascading. + try { + $result = civicrm_api3('PriceSet', 'delete', + ['id' => $this->price_set_id]); + } catch (\CRM_Core_Exception $e) { + throw new ShopException( + E::ts('Could not delete associated PriceSet: %1', [1 => $e->getMessage()]), + ShopException::ERROR_CODE_COULD_NOT_DELETE_PRICE_SET); + } + + // Register post-hook + \CRM_Utils_Hook::post('delete', 'TwingleShop', $this->id, $instance); + + // Free global arrays associated with this object + $this->free(); + + return $result['is_error'] == 0; + } + + /** + * Fetch Twingle Shop products from Twingle + * + * @return array + * array of CRM_Twingle_Shop_BAO_Product + * + * @throws \Civi\Twingle\Shop\Exceptions\ApiCallError; + * @throws \Civi\Twingle\Shop\Exceptions\ProductException; + * @throws \Civi\Core\Exception\DBQueryException + * @throws \CRM_Core_Exception + */ + public function fetchProducts(): array { + // Establish connection, if not already connected + if (!$this->twingleApi->isConnected) { + $this->twingleApi->connect(); + } + + // Fetch products from Twingle API + $products_from_twingle = $this->twingleApi->get( + 'project', + $this->numerical_project_id, + 'products', + ); + + // Fetch products from database + if ($this->id) { + $products_from_db = $this->getProducts(); + + $products_from_twingle = array_reduce($products_from_twingle, function($carry, $product) { + $carry[$product['id']] = $product; + return $carry; + }, []); + + foreach ($products_from_db as $product) { + /* @var CRM_Twingle_BAO_TwingleProduct $product */ + + // Find orphaned products which are in the database but not in Twingle + $found = array_key_exists($product->external_id, $products_from_twingle); + if (!$found) { + $product->is_orphaned = TRUE; + } + else { + // Complement with data from Twingle + $product->complementWithDataFromTwingle($products_from_twingle[$product->external_id]); + // Mark outdated products which have a newer version in Twingle + $product->checkOutdated($products_from_twingle[$product->external_id]); + } + $this->products[] = $product; + } + } + + // Create array with external_id as key + $products = array_reduce($this->products ?? [], function($carry, $product) { + $carry[$product->external_id] = $product; + return $carry; + }, []); + + // Add new products from Twingle + foreach ($products_from_twingle as $product_from_twingle) { + $found = array_key_exists($product_from_twingle['id'], $products); + if (!$found) { + $product = new CRM_Twingle_BAO_TwingleProduct(); + $product->load(CRM_Twingle_BAO_TwingleProduct::renameTwingleAttrs($product_from_twingle)); + $product->twingle_shop_id = $this->id; + $this->products[] = $product; + } + } + return $this->products; + } + + /** + * Get associated products. + * + * @return list + * @throws \Civi\Core\Exception\DBQueryException + * @throws \Civi\Twingle\Shop\Exceptions\ProductException + */ + public function getProducts() { + $products = []; + + $result = CRM_Twingle_BAO_TwingleProduct::executeQuery( + "SELECT * FROM civicrm_twingle_product WHERE twingle_shop_id = %1", + [1 => [$this->id, 'Integer']] + ); + + while ($result->fetch()) { + $product = new CRM_Twingle_BAO_TwingleProduct(); + $product->load($result->toArray()); + $products[] = $product; + } + + return $products; + } + + /** + * Creates Twingle Shop as a price set in CiviCRM. + * + * @param string $mode + * 'create' or 'edit' + * @throws \Civi\Twingle\Shop\Exceptions\ShopException + */ + public function createPriceSet($mode = 'create') { + + // Define mode + $mode = $this->price_set_id ? 'edit' : 'create'; + + // Check if PriceSet for this Shop already exists + try { + $price_set = civicrm_api3('PriceSet', 'get', [ + 'name' => $this->project_identifier, + ]); + if ($price_set['count'] > 0 && $mode == 'create') { + throw new ShopException( + E::ts('PriceSet for this Twingle Shop already exists.'), + ShopException::ERROR_CODE_PRICE_SET_ALREADY_EXISTS, + ); + } + elseif ($price_set['count'] == 0 && $mode == 'edit') { + throw new ShopException( + E::ts('PriceSet for this Twingle Shop does not exist and cannot be edited.'), + ShopException::ERROR_CODE_PRICE_SET_NOT_FOUND, + ); + } + } catch (\CRM_Core_Exception $e) { + throw new ShopException( + E::ts('Could not check if PriceSet for this TwingleShop already exists.'), + ShopException::ERROR_CODE_PRICE_SET_NOT_FOUND, + ); + } + + // Create PriceSet + $price_set_data = [ + 'name' => $this->project_identifier, + 'title' => "$this->name ($this->project_identifier)", + 'is_active' => 1, + 'extends' => 2, + 'financial_type_id' => $this->financial_type_id, + ]; + // Set id if in edit mode + if ($mode == 'edit') { + $price_set_data['id'] = $this->price_set_id; + } + try { + $price_set = civicrm_api4('PriceSet', 'create', + ['values' => $price_set_data])->first(); + $this->price_set_id = (int) $price_set['id']; + } catch (\CRM_Core_Exception $e) { + throw new ShopException( + E::ts('Could not create PriceSet for this TwingleShop.'), + ShopException::ERROR_CODE_COULD_NOT_CREATE_PRICE_SET, + ); + } + } + + /** + * Retrieves the numerical project ID and the name of this shop from Twingle. + * + * @throws \Civi\Twingle\Shop\Exceptions\ShopException + * @throws \Civi\Twingle\Shop\Exceptions\ApiCallError + */ + private function fetchDataFromTwingle() { + + // Establish connection, if not already connected + if (!$this->twingleApi->isConnected) { + $this->twingleApi->connect(); + } + + // Get shops from Twingle if not cached + $shops = \Civi::cache('long')->get('twingle_shops'); + if (empty($shops)) { + $this::fetchShops($this->twingleApi); + $shops = \Civi::cache('long')->get('twingle_shops'); + } + + // Set Shop ID and name + foreach ($shops as $shop) { + if (isset($shop['identifier']) && $shop['identifier'] == $this->project_identifier) { + $this->numerical_project_id = $shop['id']; + $this->name = $shop['name']; + } + } + + // Throw an Exception if this Twingle Project is not of type 'shop' + if (!isset($this->numerical_project_id)) { + throw new ShopException( + E::ts('This Twingle Project is not a shop.'), + ShopException::ERROR_CODE_NOT_A_SHOP, + ); + } + } + + /** + * Retrieves all Twingle projects of the type 'shop'. + * + * @throws \Civi\Twingle\Shop\Exceptions\ShopException + */ + static private function fetchShops(ApiCall $api): void { + $organisationId = $api->organisationId; + try { + $projects = $api->get( + 'project', + NULL, + 'by-organisation', + $organisationId, + ); + $shops = array_filter( + $projects, + function($project) { + return isset($project['type']) && $project['type'] == 'shop'; + } + ); + \Civi::cache('long')->set('twingle_shops', $shops); + } + catch (Exception $e) { + throw new ShopException( + E::ts('Could not retrieve Twingle projects from API. + Please check your API credentials.'), + ShopException::ERROR_CODE_COULD_NOT_GET_PROJECTS, + ); + } + } + + /** + * Deletes all associated products. + * + * @return void + * @throws \Civi\Twingle\Shop\Exceptions\ProductException + */ + public function deleteProducts() { + try { + $products = $this->getProducts(); + } + catch (\Civi\Core\Exception\DBQueryException $e) { + throw new ProductException( + E::ts('Could not retrieve associated products: %1', [1 => $e->getMessage()]), + ProductException::ERROR_CODE_COULD_NOT_GET_PRODUCTS + ); + } + try { + foreach ($products as $product) { + $product->delete(); + } + } + catch (ProductException $e) { + throw new ProductException( + E::ts('Could not delete associated products: %1', [1 => $e->getMessage()]), + ProductException::ERROR_CODE_COULD_NOT_DELETE_PRICE_SET, + ); + } + } + +} diff --git a/CRM/Twingle/Config.php b/CRM/Twingle/Config.php new file mode 100644 index 0000000..29acf82 --- /dev/null +++ b/CRM/Twingle/Config.php @@ -0,0 +1,40 @@ + + */ + public static function getRecurringProtectionOptions() { + return [ + self::RCUR_PROTECTION_OFF => E::ts('No'), + self::RCUR_PROTECTION_EXCEPTION => E::ts('Raise Exception'), + self::RCUR_PROTECTION_ACTIVITY => E::ts('Create Activity'), + ]; + } + +} diff --git a/CRM/Twingle/DAO/TwingleProduct.php b/CRM/Twingle/DAO/TwingleProduct.php new file mode 100644 index 0000000..3adeae7 --- /dev/null +++ b/CRM/Twingle/DAO/TwingleProduct.php @@ -0,0 +1,325 @@ +__table = 'civicrm_twingle_product'; + parent::__construct(); + } + + /** + * Returns localized title of this entity. + * + * @param bool $plural + * Whether to return the plural version of the title. + */ + public static function getEntityTitle($plural = FALSE) { + return $plural ? E::ts('Twingle Products') : E::ts('Twingle Product'); + } + + /** + * Returns foreign keys and entity references. + * + * @return array + * [CRM_Core_Reference_Interface] + */ + public static function getReferenceColumns() { + if (!isset(\Civi::$statics[__CLASS__]['links'])) { + \Civi::$statics[__CLASS__]['links'] = static::createReferenceColumns(__CLASS__); + \Civi::$statics[__CLASS__]['links'][] = new \CRM_Core_Reference_Basic(self::getTableName(), 'price_field_id', 'civicrm_contact', 'id'); + \Civi::$statics[__CLASS__]['links'][] = new \CRM_Core_Reference_Basic(self::getTableName(), 'twingle_shop_id', 'civicrm_twingle_shop', 'id'); + \CRM_Core_DAO_AllCoreTables::invoke(__CLASS__, 'links_callback', \Civi::$statics[__CLASS__]['links']); + } + return \Civi::$statics[__CLASS__]['links']; + } + + /** + * Returns all the column names of this table + * + * @return array + */ + public static function &fields() { + if (!isset(\Civi::$statics[__CLASS__]['fields'])) { + \Civi::$statics[__CLASS__]['fields'] = [ + 'id' => [ + 'name' => 'id', + 'type' => \CRM_Utils_Type::T_INT, + 'title' => E::ts('ID'), + 'description' => E::ts('Unique TwingleProduct ID'), + 'required' => TRUE, + 'usage' => [ + 'import' => FALSE, + 'export' => FALSE, + 'duplicate_matching' => FALSE, + 'token' => FALSE, + ], + 'where' => 'civicrm_twingle_product.id', + 'table_name' => 'civicrm_twingle_product', + 'entity' => 'TwingleProduct', + 'bao' => 'CRM_Twingle_DAO_TwingleProduct', + 'localizable' => 0, + 'html' => [ + 'type' => 'Number', + ], + 'readonly' => TRUE, + 'add' => NULL, + ], + 'external_id' => [ + 'name' => 'external_id', + 'type' => \CRM_Utils_Type::T_INT, + 'title' => E::ts('External ID'), + 'description' => E::ts('The ID of this product in the Twingle database'), + 'required' => TRUE, + 'usage' => [ + 'import' => FALSE, + 'export' => FALSE, + 'duplicate_matching' => FALSE, + 'token' => FALSE, + ], + 'where' => 'civicrm_twingle_product.external_id', + 'table_name' => 'civicrm_twingle_product', + 'entity' => 'TwingleProduct', + 'bao' => 'CRM_Twingle_DAO_TwingleProduct', + 'localizable' => 0, + 'html' => [ + 'type' => 'Number', + ], + 'add' => NULL, + ], + 'price_field_id' => [ + 'name' => 'price_field_id', + 'type' => \CRM_Utils_Type::T_INT, + 'title' => E::ts('Price Field ID'), + 'description' => E::ts('FK to Price Field'), + 'required' => TRUE, + 'usage' => [ + 'import' => FALSE, + 'export' => FALSE, + 'duplicate_matching' => FALSE, + 'token' => FALSE, + ], + 'where' => 'civicrm_twingle_product.price_field_id', + 'table_name' => 'civicrm_twingle_product', + 'entity' => 'TwingleProduct', + 'bao' => 'CRM_Twingle_DAO_TwingleProduct', + 'localizable' => 0, + 'FKClassName' => 'CRM_Contact_DAO_Contact', + 'add' => NULL, + ], + 'twingle_shop_id' => [ + 'name' => 'twingle_shop_id', + 'type' => \CRM_Utils_Type::T_INT, + 'title' => E::ts('Twingle Shop ID'), + 'description' => E::ts('FK to Twingle Shop'), + 'usage' => [ + 'import' => FALSE, + 'export' => FALSE, + 'duplicate_matching' => FALSE, + 'token' => FALSE, + ], + 'where' => 'civicrm_twingle_product.twingle_shop_id', + 'table_name' => 'civicrm_twingle_product', + 'entity' => 'TwingleProduct', + 'bao' => 'CRM_Twingle_DAO_TwingleProduct', + 'localizable' => 0, + 'FKClassName' => 'CRM_Twingle_DAO_TwingleShop', + 'add' => NULL, + ], + 'created_at' => [ + 'name' => 'created_at', + 'type' => \CRM_Utils_Type::T_DATE + \CRM_Utils_Type::T_TIME, + 'title' => E::ts('Created At'), + 'description' => E::ts('Timestamp of when the product was created in the database'), + 'required' => TRUE, + 'usage' => [ + 'import' => FALSE, + 'export' => FALSE, + 'duplicate_matching' => FALSE, + 'token' => FALSE, + ], + 'where' => 'civicrm_twingle_product.created_at', + 'table_name' => 'civicrm_twingle_product', + 'entity' => 'TwingleProduct', + 'bao' => 'CRM_Twingle_DAO_TwingleProduct', + 'localizable' => 0, + 'add' => NULL, + ], + 'updated_at' => [ + 'name' => 'updated_at', + 'type' => \CRM_Utils_Type::T_DATE + \CRM_Utils_Type::T_TIME, + 'title' => E::ts('Updated At'), + 'description' => E::ts('Timestamp of when the product was last updated in the database'), + 'required' => TRUE, + 'usage' => [ + 'import' => FALSE, + 'export' => FALSE, + 'duplicate_matching' => FALSE, + 'token' => FALSE, + ], + 'where' => 'civicrm_twingle_product.updated_at', + 'table_name' => 'civicrm_twingle_product', + 'entity' => 'TwingleProduct', + 'bao' => 'CRM_Twingle_DAO_TwingleProduct', + 'localizable' => 0, + 'add' => NULL, + ], + ]; + \CRM_Core_DAO_AllCoreTables::invoke(__CLASS__, 'fields_callback', \Civi::$statics[__CLASS__]['fields']); + } + return \Civi::$statics[__CLASS__]['fields']; + } + + /** + * Return a mapping from field-name to the corresponding key (as used in fields()). + * + * @return array + * Array(string $name => string $uniqueName). + */ + public static function &fieldKeys() { + if (!isset(\Civi::$statics[__CLASS__]['fieldKeys'])) { + \Civi::$statics[__CLASS__]['fieldKeys'] = array_flip(\CRM_Utils_Array::collect('name', self::fields())); + } + return \Civi::$statics[__CLASS__]['fieldKeys']; + } + + /** + * Returns the names of this table + * + * @return string + */ + public static function getTableName() { + return self::$_tableName; + } + + /** + * Returns if this table needs to be logged + * + * @return bool + */ + public function getLog() { + return self::$_log; + } + + /** + * Returns the list of fields that can be imported + * + * @param bool $prefix + * + * @return array + */ + public static function &import($prefix = FALSE) { + $r = \CRM_Core_DAO_AllCoreTables::getImports(__CLASS__, 'twingle_product', $prefix, []); + return $r; + } + + /** + * Returns the list of fields that can be exported + * + * @param bool $prefix + * + * @return array + */ + public static function &export($prefix = FALSE) { + $r = \CRM_Core_DAO_AllCoreTables::getExports(__CLASS__, 'twingle_product', $prefix, []); + return $r; + } + + /** + * Returns the list of indices + * + * @param bool $localize + * + * @return array + */ + public static function indices($localize = TRUE) { + $indices = []; + return ($localize && !empty($indices)) ? \CRM_Core_DAO_AllCoreTables::multilingualize(__CLASS__, $indices) : $indices; + } + +} diff --git a/CRM/Twingle/DAO/TwingleShop.php b/CRM/Twingle/DAO/TwingleShop.php new file mode 100644 index 0000000..4b6e704 --- /dev/null +++ b/CRM/Twingle/DAO/TwingleShop.php @@ -0,0 +1,305 @@ +__table = 'civicrm_twingle_shop'; + parent::__construct(); + } + + /** + * Returns localized title of this entity. + * + * @param bool $plural + * Whether to return the plural version of the title. + */ + public static function getEntityTitle($plural = FALSE) { + return $plural ? E::ts('Twingle Shops') : E::ts('Twingle Shop'); + } + + /** + * Returns foreign keys and entity references. + * + * @return array + * [CRM_Core_Reference_Interface] + */ + public static function getReferenceColumns() { + if (!isset(\Civi::$statics[__CLASS__]['links'])) { + \Civi::$statics[__CLASS__]['links'] = static::createReferenceColumns(__CLASS__); + \Civi::$statics[__CLASS__]['links'][] = new \CRM_Core_Reference_Basic(self::getTableName(), 'price_set_id', 'civicrm_price_set', 'id'); + \CRM_Core_DAO_AllCoreTables::invoke(__CLASS__, 'links_callback', \Civi::$statics[__CLASS__]['links']); + } + return \Civi::$statics[__CLASS__]['links']; + } + + /** + * Returns all the column names of this table + * + * @return array + */ + public static function &fields() { + if (!isset(\Civi::$statics[__CLASS__]['fields'])) { + \Civi::$statics[__CLASS__]['fields'] = [ + 'id' => [ + 'name' => 'id', + 'type' => \CRM_Utils_Type::T_INT, + 'title' => E::ts('ID'), + 'description' => E::ts('Unique TwingleShop ID'), + 'required' => TRUE, + 'usage' => [ + 'import' => FALSE, + 'export' => FALSE, + 'duplicate_matching' => FALSE, + 'token' => FALSE, + ], + 'where' => 'civicrm_twingle_shop.id', + 'table_name' => 'civicrm_twingle_shop', + 'entity' => 'TwingleShop', + 'bao' => 'CRM_Twingle_DAO_TwingleShop', + 'localizable' => 0, + 'html' => [ + 'type' => 'Number', + ], + 'readonly' => TRUE, + 'add' => NULL, + ], + 'project_identifier' => [ + 'name' => 'project_identifier', + 'type' => \CRM_Utils_Type::T_STRING, + 'title' => E::ts('Project Identifier'), + 'description' => E::ts('Twingle Project Identifier'), + 'required' => TRUE, + 'maxlength' => 32, + 'size' => \CRM_Utils_Type::MEDIUM, + 'usage' => [ + 'import' => FALSE, + 'export' => FALSE, + 'duplicate_matching' => FALSE, + 'token' => FALSE, + ], + 'where' => 'civicrm_twingle_shop.project_identifier', + 'table_name' => 'civicrm_twingle_shop', + 'entity' => 'TwingleShop', + 'bao' => 'CRM_Twingle_DAO_TwingleShop', + 'localizable' => 0, + 'html' => [ + 'type' => 'Text', + ], + 'add' => NULL, + ], + 'numerical_project_id' => [ + 'name' => 'numerical_project_id', + 'type' => \CRM_Utils_Type::T_INT, + 'title' => E::ts('Numerical Project ID'), + 'description' => E::ts('Numerical Twingle Project Identifier'), + 'required' => TRUE, + 'usage' => [ + 'import' => FALSE, + 'export' => FALSE, + 'duplicate_matching' => FALSE, + 'token' => FALSE, + ], + 'where' => 'civicrm_twingle_shop.numerical_project_id', + 'table_name' => 'civicrm_twingle_shop', + 'entity' => 'TwingleShop', + 'bao' => 'CRM_Twingle_DAO_TwingleShop', + 'localizable' => 0, + 'html' => [ + 'type' => 'Number', + ], + 'add' => NULL, + ], + 'price_set_id' => [ + 'name' => 'price_set_id', + 'type' => \CRM_Utils_Type::T_INT, + 'title' => E::ts('Price Set ID'), + 'description' => E::ts('FK to Price Set'), + 'usage' => [ + 'import' => FALSE, + 'export' => FALSE, + 'duplicate_matching' => FALSE, + 'token' => FALSE, + ], + 'where' => 'civicrm_twingle_shop.price_set_id', + 'table_name' => 'civicrm_twingle_shop', + 'entity' => 'TwingleShop', + 'bao' => 'CRM_Twingle_DAO_TwingleShop', + 'localizable' => 0, + 'FKClassName' => 'CRM_Price_DAO_PriceSet', + 'add' => NULL, + ], + 'name' => [ + 'name' => 'name', + 'type' => \CRM_Utils_Type::T_STRING, + 'title' => E::ts('Name'), + 'description' => E::ts('name of the shop'), + 'required' => TRUE, + 'maxlength' => 64, + 'size' => \CRM_Utils_Type::BIG, + 'usage' => [ + 'import' => FALSE, + 'export' => FALSE, + 'duplicate_matching' => FALSE, + 'token' => FALSE, + ], + 'where' => 'civicrm_twingle_shop.name', + 'table_name' => 'civicrm_twingle_shop', + 'entity' => 'TwingleShop', + 'bao' => 'CRM_Twingle_Shop_DAO_TwingleShop', + 'localizable' => 0, + 'html' => [ + 'type' => 'Text', + ], + 'add' => NULL, + ], + ]; + \CRM_Core_DAO_AllCoreTables::invoke(__CLASS__, 'fields_callback', \Civi::$statics[__CLASS__]['fields']); + } + return \Civi::$statics[__CLASS__]['fields']; + } + + /** + * Return a mapping from field-name to the corresponding key (as used in fields()). + * + * @return array + * Array(string $name => string $uniqueName). + */ + public static function &fieldKeys() { + if (!isset(\Civi::$statics[__CLASS__]['fieldKeys'])) { + \Civi::$statics[__CLASS__]['fieldKeys'] = array_flip(\CRM_Utils_Array::collect('name', self::fields())); + } + return \Civi::$statics[__CLASS__]['fieldKeys']; + } + + /** + * Returns the names of this table + * + * @return string + */ + public static function getTableName() { + return self::$_tableName; + } + + /** + * Returns if this table needs to be logged + * + * @return bool + */ + public function getLog() { + return self::$_log; + } + + /** + * Returns the list of fields that can be imported + * + * @param bool $prefix + * + * @return array + */ + public static function &import($prefix = FALSE) { + $r = \CRM_Core_DAO_AllCoreTables::getImports(__CLASS__, 'twingle_shop', $prefix, []); + return $r; + } + + /** + * Returns the list of fields that can be exported + * + * @param bool $prefix + * + * @return array + */ + public static function &export($prefix = FALSE) { + $r = \CRM_Core_DAO_AllCoreTables::getExports(__CLASS__, 'twingle_shop', $prefix, []); + return $r; + } + + /** + * Returns the list of indices + * + * @param bool $localize + * + * @return array + */ + public static function indices($localize = TRUE) { + $indices = []; + return ($localize && !empty($indices)) ? \CRM_Core_DAO_AllCoreTables::multilingualize(__CLASS__, $indices) : $indices; + } + +} diff --git a/CRM/Twingle/Form/Profile.php b/CRM/Twingle/Form/Profile.php index e39ad52..76c9cb4 100644 --- a/CRM/Twingle/Form/Profile.php +++ b/CRM/Twingle/Form/Profile.php @@ -13,7 +13,12 @@ | written permission from the original author(s). | +-------------------------------------------------------------*/ +declare(strict_types = 1); + use CRM_Twingle_ExtensionUtil as E; +use Civi\Twingle\Exceptions\BaseException; +use Civi\Twingle\Exceptions\ProfileException; +use Civi\Twingle\Exceptions\ProfileValidationError; /** * Form controller class @@ -23,11 +28,17 @@ use CRM_Twingle_ExtensionUtil as E; class CRM_Twingle_Form_Profile extends CRM_Core_Form { /** - * @var CRM_Twingle_Profile $profile + * @var CRM_Twingle_Profile * * The profile object the form is acting on. */ - protected $profile; + protected ?CRM_Twingle_Profile $profile = NULL; + + /** + * The ID of this profile. + * @var int|NULL + */ + protected $profile_id = NULL; /** * @var string @@ -37,87 +48,246 @@ class CRM_Twingle_Form_Profile extends CRM_Core_Form { protected $_op; /** - * @var array + * @var array * * A static cache of retrieved payment instruments found within * self::getPaymentInstruments(). */ - protected static $_paymentInstruments = NULL; + protected static $_paymentInstruments; + + /** + * @var array + * + * A static cache of retrieved contribution statuses found within + * static::getContributionStatusOptions(). + */ + protected static array $_contributionStatusOptions; + + /** + * @var array + * + * A static cache of retrieved groups found within static::getGroups(). + */ + protected static array $_groups; + + /** + * @var array + * + * A static cache of retrieved newsletter groups found within + * static::getNewsletterGroups(). + */ + protected static array $_newsletterGroups; + + /** + * @var array + * + * A static cache of retrieved campaigns found within static::getCampaigns(). + */ + protected static array $_campaigns; + + /** + * @var array + * + * A static cache of retrieved financial types found within + * static::getFinancialTypes(). + */ + protected static array $_financialTypes; + + /** + * @var array + * + * A static cache of retrieved genders found within + * static::getGenderOptions(). + */ + protected static array $_genderOptions; + + /** + * @var array + * + * A static cache of retrieved prefixes found within + * static::getGenderOptions(). + */ + protected static array $_prefixOptions; + + /** + * @var array + * + * A static cache of retrieved location types found within + * static::getLocationTypes(). + */ + protected static array $_locationTypes; + + /** + * @var array + * + * A static cache of retrieved location types found within + * static::getXCMProfiles(). + */ + protected static array $_xcm_profiles; + + /** + * @var array + * + * A static cache of retrieved membership types found within + * static::getMembershipTypes(). + */ + protected static array $_membershipTypes; + + /** + * @var array + * + * A static cache of retrieved CiviSEPA creditors found within + * static::getSepaCreditors(). + */ + protected static array $_sepaCreditors; + + public function preProcess(): void { + // "Create" is the default operation. + $op = CRM_Utils_Request::retrieve('op', 'String', $this); + $this->_op = is_string($op) ? $op : 'create'; + + // Verify that a profile with the given id exists. + if ($this->_op != 'copy' && $this->_op != 'create') { + $this->profile_id = CRM_Utils_Request::retrieve('id', 'Int', $this); + $this->profile = CRM_Twingle_Profile::getProfile($this->profile_id); + if (!isset($this->profile)) { + throw new ProfileException(E::ts('Profile with ID "%1" not found', [1 => $this->profile_id])); + } + } + + // Set redirect destination. + $this->controller->_destination = CRM_Utils_System::url( + 'civicrm/admin/settings/twingle/profiles', + 'reset=1' + ); + + parent::preProcess(); + } /** * Builds the form structure. */ - public function buildQuickForm() { - // "Create" is the default operation. - if (!$this->_op = CRM_Utils_Request::retrieve('op', 'String', $this)) { - $this->_op = 'create'; - } - - // Verify that profile with the given name exists. - $profile_name = CRM_Utils_Request::retrieve('name', 'String', $this); - if (!$this->profile = CRM_Twingle_Profile::getProfile($profile_name)) { - $profile_name = NULL; - } - - // Assign template variables. - $this->assign('op', $this->_op); - $this->assign('profile_name', $profile_name); - - // Set redirect destination. - $this->controller->_destination = CRM_Utils_System::url('civicrm/admin/settings/twingle/profiles', 'reset=1'); + public function buildQuickForm(): void { + $profile_name = (isset($this->profile) ? $this->profile->getName() : NULL); switch ($this->_op) { case 'delete': - if ($profile_name) { - CRM_Utils_System::setTitle(E::ts('Delete Twingle API profile %1', array(1 => $profile_name))); - $this->addButtons(array( - array( + if (isset($this->profile)) { + CRM_Utils_System::setTitle(E::ts('Delete Twingle API profile %1', [1 => $this->profile->getName()])); + $this->addButtons([ + [ 'type' => 'submit', - 'name' => ($profile_name == 'default' ? E::ts('Reset') : E::ts('Delete')), + 'name' => ($this->profile->getName() == 'default' ? E::ts('Reset') : E::ts('Delete')), 'isDefault' => TRUE, - ), - )); + ], + ]); } parent::buildQuickForm(); return; - case 'edit': - // When editing without a valid profile name, edit the default profile. - if (!$profile_name) { - $profile_name = 'default'; - $this->profile = CRM_Twingle_Profile::getProfile($profile_name); + + case 'copy': + // Retrieve the source profile name. + $source_id = CRM_Utils_Request::retrieve('source_id', 'Int', $this); + // When copying without a valid profile id, copy the default profile. + if (!is_int($source_id)) { + $this->profile = CRM_Twingle_Profile::createDefaultProfile(); } - CRM_Utils_System::setTitle(E::ts('Edit Twingle API profile %1', array(1 => $this->profile->getName()))); + else { + try { + $source_profile = CRM_Twingle_Profile::getProfile($source_id); + if (!isset($source_profile)) { + throw new ProfileException(E::ts('Profile with ID "%1" not found', [1 => $source_id])); + } + $this->profile = $source_profile->copy(); + $this->profile->validate(); + } + catch (ProfileValidationError $exception) { + if ($exception->getErrorCode() == ProfileValidationError::ERROR_CODE_PROFILE_VALIDATION_FAILED) { + Civi::log()->error($exception->getLogMessage()); + CRM_Core_Session::setStatus(E::ts('The profile is invalid and cannot be copied.'), E::ts('Error')); + CRM_Utils_System::redirect(CRM_Utils_System::url('civicrm/admin/settings/twingle/profiles', 'reset=1')); + return; + } + } + catch (ProfileException $exception) { + if ($exception->getErrorCode() == ProfileException::ERROR_CODE_PROFILE_NOT_FOUND) { + Civi::log()->error($exception->getLogMessage()); + CRM_Core_Session::setStatus(E::ts('The profile to be copied could not be found.'), E::ts('Error')); + CRM_Utils_System::redirect(CRM_Utils_System::url('civicrm/admin/settings/twingle/profiles', 'reset=1')); + return; + } + } + catch (Civi\Core\Exception\DBQueryException $e) { + Civi::log()->error($e->getMessage()); + CRM_Core_Session::setStatus( + E::ts('A database error has occurred. See the log for details.'), + E::ts('Error') + ); + CRM_Utils_System::redirect(CRM_Utils_System::url('civicrm/admin/settings/twingle/profiles', 'reset=1')); + return; + } + } + CRM_Utils_System::setTitle(E::ts('New Twingle API profile')); break; + + case 'edit': + if (!isset($this->profile)) { + throw new ProfileException(E::ts('Profile with ID "%1" not found', [1 => $this->profile_id])); + } + CRM_Utils_System::setTitle( + E::ts('Edit Twingle API profile %1', [1 => $this->profile->getName()]) + ); + break; + case 'create': // Load factory default profile values. - $this->profile = CRM_twingle_Profile::createDefaultProfile($profile_name); + $this->profile = CRM_Twingle_Profile::createDefaultProfile(E::ts('New Profile')); CRM_Utils_System::setTitle(E::ts('New Twingle API profile')); break; } + // Is this the default profile? + $is_default = $this->profile->is_default(); + + // Assign template variables. + $this->assign('op', $this->_op); + $this->assign('twingle_use_shop', (int) Civi::settings()->get('twingle_use_shop')); + $this->assign('profile_name', $profile_name); + $this->assign('is_default', $is_default); + // Add form elements. - $is_default = $profile_name == 'default'; $this->add( - ($is_default ? 'static' : 'text'), + 'text', 'name', E::ts('Profile name'), - array(), + ['class' => 'huge'] + ($is_default && $this->_op == 'edit' ? ['readonly'] : []), !$is_default ); + // Do only display selector if this is not the default profile + if (!$is_default) { + $this->add( + 'text', + 'selector', + E::ts('Project IDs'), + ['class' => 'huge'], + TRUE + ); + } + $this->add( - 'text', // field type - 'selector', // field name - E::ts('Project IDs'), // field label - array(), - TRUE // is required + 'select', + 'xcm_profile', + E::ts('Contact Matcher (XCM) Profile'), + static::getXCMProfiles(), + TRUE ); $this->add( 'select', 'location_type_id', E::ts('Location type'), - $this->getLocationTypes(), + static::getLocationTypes(), TRUE ); @@ -125,49 +295,87 @@ class CRM_Twingle_Form_Profile extends CRM_Core_Form { 'select', 'location_type_id_organisation', E::ts('Location type for organisations'), - $this->getLocationTypes(), + static::getLocationTypes(), TRUE ); $this->add( - 'select', // field type - 'financial_type_id', // field name - E::ts('Financial type'), // field label - $this->getFinancialTypes(), // list of options - TRUE // is required + 'select', + 'financial_type_id', + E::ts('Financial type'), + static::getFinancialTypes(), + TRUE + ); + $this->add( + 'select', + 'financial_type_id_recur', + E::ts('Financial type (recurring)'), + static::getFinancialTypes(), + TRUE ); $this->add( 'select', 'gender_male', E::ts('Gender option for submitted value "male"'), - $this->getGenderOptions(), + static::getGenderOptions(), TRUE ); $this->add( 'select', 'gender_female', E::ts('Gender option for submitted value "female"'), - $this->getGenderOptions(), + static::getGenderOptions(), TRUE ); $this->add( 'select', 'gender_other', E::ts('Gender option for submitted value "other"'), - $this->getGenderOptions(), + static::getGenderOptions(), TRUE ); + $this->add( + 'select', + 'prefix_male', + E::ts('Prefix option for submitted value "male"'), + static::getPrefixOptions() + ); + $this->add( + 'select', + 'prefix_female', + E::ts('Prefix option for submitted value "female"'), + static::getPrefixOptions() + ); + $this->add( + 'select', + 'prefix_other', + E::ts('Prefix option for submitted value "other"'), + static::getPrefixOptions() + ); + + // Add script and css for Twingle Shop integration + Civi::resources()->addScriptUrl(E::url('js/twingle_shop.js')); + Civi::resources()->addStyleFile(E::LONG_NAME, 'css/twingle_shop.css'); + $payment_instruments = CRM_Twingle_Profile::paymentInstruments(); $this->assign('payment_instruments', $payment_instruments); foreach ($payment_instruments as $pi_name => $pi_label) { $this->add( - 'select', // field type - $pi_name, // field name - E::ts('Record %1 as', array(1 => $pi_label)), // field label - $this->getPaymentInstruments(), // list of options - TRUE // is required + 'select', + $pi_name, + E::ts('Record %1 as', [1 => $pi_label]), + static::getPaymentInstruments(), + TRUE + ); + + $this->add( + 'select', + $pi_name . '_status', + E::ts('Record %1 donations with contribution status', [1 => $pi_label]), + static::getContributionStatusOptions(), + TRUE ); } @@ -176,104 +384,278 @@ class CRM_Twingle_Form_Profile extends CRM_Core_Form { 'select', 'sepa_creditor_id', E::ts('CiviSEPA creditor'), - $this->getSepaCreditors(), + static::getSepaCreditors(), TRUE ); } $this->add( - 'select', // field type - 'newsletter_groups', // field name - E::ts('Sign up for newsletter groups'), // field label - $this->getNewsletterGroups(), // list of options - FALSE, // is not required - array('class' => 'crm-select2 huge', 'multiple' => 'multiple') + 'checkbox', + 'newsletter_double_opt_in', + E::ts('Use Double-Opt-In for newsletter') + ); + + $this->add( + 'select', + 'newsletter_groups', + E::ts('Sign up for newsletter groups'), + static::getNewsletterGroups(), + FALSE, + ['class' => 'crm-select2 huge', 'multiple' => 'multiple'] ); $this->add( - 'select', // field type - 'postinfo_groups', // field name - E::ts('Sign up for postal mail groups'), // field label - $this->getPostinfoGroups(), // list of options - FALSE, // is not required - array('class' => 'crm-select2 huge', 'multiple' => 'multiple') + 'select', + 'postinfo_groups', + E::ts('Sign up for postal mail groups'), + static::getPostinfoGroups(), + FALSE, + ['class' => 'crm-select2 huge', 'multiple' => 'multiple'] ); $this->add( - 'select', // field type - 'donation_receipt_groups', // field name - E::ts('Sign up for Donation receipt groups'), // field label - $this->getDonationReceiptGroups(), // list of options - FALSE, // is not required - array('class' => 'crm-select2 huge', 'multiple' => 'multiple') + 'select', + 'donation_receipt_groups', + E::ts('Sign up for Donation receipt groups'), + static::getDonationReceiptGroups(), + FALSE, + ['class' => 'crm-select2 huge', 'multiple' => 'multiple'] ); $this->add( - 'select', // field type - 'campaign', // field name - E::ts('Assign donation to campaign'), // field label - $this->getCampaigns(), // list of options - FALSE, // is not required - array('class' => 'crm-select2 huge') + 'select', + 'campaign', + E::ts('Default Campaign'), + ['' => E::ts('- none -')] + static::getCampaigns(), + FALSE, + ['class' => 'crm-select2 huge'] ); $this->add( - 'text', // field type - 'contribution_source', // field name - E::ts('Contribution source'), // field label - array() + 'select', + 'campaign_targets', + E::ts('Set Campaign for'), + [ + 'contribution' => E::ts('Contribution'), + 'recurring' => E::ts('Recurring Contribution'), + 'membership' => E::ts('Membership'), + 'mandate' => E::ts('SEPA Mandate'), + 'contact' => E::ts('Contacts (XCM)'), + ], + // is not required + FALSE, + ['class' => 'crm-select2 huge', 'multiple' => 'multiple'] ); - $this->addButtons(array( - array( + $this->add( + 'select', + 'membership_type_id', + E::ts('Create membership of type'), + ['' => E::ts('- none -')] + static::getMembershipTypes(), + FALSE, + ['class' => 'crm-select2 huge'] + ); + $this->add( + 'select', + 'membership_type_id_recur', + E::ts('Create membership of type (recurring)'), + ['' => E::ts('- none -')] + static::getMembershipTypes(), + FALSE, + ['class' => 'crm-select2 huge'] + ); + $this->add( + 'text', + 'membership_postprocess_call', + E::ts('API Call for Membership Postprocessing') + ); + $this->addRule( + 'membership_postprocess_call', + E::ts("The API call must have the form 'Entity.Action'."), + 'regex', + '/^[A-Za-z_]+[.][A-Za-z_]+$/' + ); + + $this->add( + 'text', + 'contribution_source', + E::ts('Contribution source'), + [] + ); + + $this->add( + 'select', + 'required_address_components', + E::ts('Required address components'), + [ + 'street_address' => E::ts('Street'), + 'postal_code' => E::ts('Postal Code'), + 'city' => E::ts('City'), + 'country' => E::ts('Country'), + ], + FALSE, + ['class' => 'crm-select2 huge', 'multiple' => 'multiple'] + ); + + $this->add( + 'textarea', + 'custom_field_mapping', + E::ts('Custom field mapping'), + [] + ); + + $this->add( + 'select', + 'map_as_contribution_notes', + E::ts('Create contribution notes for'), + [ + 'purpose' => E::ts('Purpose'), + 'remarks' => E::ts('Remarks'), + ], + // is not required + FALSE, + ['class' => 'crm-select2 huge', 'multiple' => 'multiple'] + ); + + $this->add( + 'select', + 'map_as_contact_notes', + E::ts('Create contact notes for'), + [ + 'user_extrafield' => E::ts('User Extra Field'), + ], + // is not required + FALSE, + ['class' => 'crm-select2 huge', 'multiple' => 'multiple'] + ); + + if (Civi::settings()->get('twingle_use_shop')) { + $this->add( + 'checkbox', // field type + 'enable_shop_integration', // field name + E::ts('Enable Shop Integration'), // field label + FALSE, + [] + ); + + $this->add( + 'select', // field type + 'shop_financial_type', // field name + E::ts('Default Financial Type'), // field label + static::getFinancialTypes(), // list of options + TRUE, + ['class' => 'crm-select2 huge'] + ); + + $this->add( + 'select', // field type + 'shop_donation_financial_type', // field name + E::ts('Financial Type for top up donations'), // field label + static::getFinancialTypes(), // list of options + TRUE, + ['class' => 'crm-select2 huge'] + ); + + $this->add( + 'checkbox', // field type + 'shop_map_products', // field name + E::ts('Map Products as Price Fields'), // field label + FALSE, // is not required + [] + ); + } + + $this->addButtons([ + [ 'type' => 'submit', 'name' => E::ts('Save'), 'isDefault' => TRUE, - ), - )); + ], + ]); // Export form elements. parent::buildQuickForm(); } - /** - * @inheritdoc - */ - public function addRules() { - $this->addFormRule(array('CRM_Twingle_Form_Profile', 'validateProfileForm')); - } - /** * Validates the profile form. * - * @param array $values - * The submitted form values, keyed by form element name. - * - * @return bool | array - * TRUE when the form was successfully validated, or an array of error - * messages, keyed by form element name. + * @return bool + * TRUE when the form was successfully validated. */ - public static function validateProfileForm($values) { - $errors = array(); + public function validate() { - // Restrict profile names to alphanumeric characters and the underscore. - if (isset($values['name']) && preg_match("/[^A-Za-z0-9\_]/", $values['name'])) { - $errors['name'] = E::ts('Only alphanumeric characters and the underscore (_) are allowed for profile names.'); + if (in_array($this->_op, ['create', 'edit', 'copy'], TRUE)) { + // Create profile with new values. + $profile_values = $this->exportValues(); + $profile = new CRM_Twingle_Profile( + $profile_values['name'], + $profile_values, + $this->profile_id + ); + + // Validate profile data + try { + $profile->validate(); + } + catch (ProfileValidationError $e) { + switch ($e->getErrorCode()) { + case ProfileValidationError::ERROR_CODE_PROFILE_VALIDATION_FAILED: + $this->setElementError($e->getAffectedFieldName(), $e->getMessage()); + break; + + case ProfileValidationError::ERROR_CODE_PROFILE_VALIDATION_WARNING: + CRM_Core_Session::setStatus($e->getMessage(), E::ts('Warning')); + } + } } - return empty($errors) ? TRUE : $errors; + return parent::validate(); } /** * Set the default values (i.e. the profile's current data) in the form. + * + * @return array */ public function setDefaultValues() { $defaults = parent::setDefaultValues(); - if (in_array($this->_op, array('create', 'edit'))) { + if (in_array($this->_op, ['create', 'edit', 'copy'], TRUE)) { + if (!isset($this->profile)) { + $this->profile = CRM_Twingle_Profile::createDefaultProfile()->copy(); + } $defaults['name'] = $this->profile->getName(); - foreach ($this->profile->getData() as $element_name => $value) { + $profile_data = $this->profile->getData(); + foreach ($profile_data as $element_name => $value) { $defaults[$element_name] = $value; } + + // backwards compatibility, see issue #27 + if (!isset($profile_data['campaign_targets'])) { + $defaults['campaign_targets'] = ['contribution', 'contact']; + } + + // Show warning when there is configuration missing for required fields. + $requiredConfig = CRM_Twingle_Profile::allowedAttributes(TRUE); + foreach ($requiredConfig as $key => $metadata) { + $required = $metadata['required'] ?? FALSE; + // Do not require twingle project IDs/selector for the default profile. + if ( + $this->profile->is_default() + && 'selector' === $key + ) { + $required = FALSE; + } + if (!isset($profile_data[$key]) && $required) { + CRM_Core_Session::setStatus( + E::ts( + 'The required configuration option "%1" has no value. Saving the profile might set this option to a possibly unwanted default value.', + [1 => $metadata['label'] ?? $key] + ), + E::ts('Error'), + 'error' + ); + } + } } return $defaults; } @@ -281,22 +663,39 @@ class CRM_Twingle_Form_Profile extends CRM_Core_Form { /** * Store the values submitted with the form in the profile. */ - public function postProcess() { + public function postProcess(): void { $values = $this->exportValues(); - if (in_array($this->_op, array('create', 'edit'))) { - if (empty($values['name'])) { - $values['name'] = 'default'; + try { + if (!isset($this->profile)) { + throw new BaseException(E::ts('No profile set.')); } - $this->profile->setName($values['name']); - foreach ($this->profile->getData() as $element_name => $value) { - if (isset($values[$element_name])) { - $this->profile->setAttribute($element_name, $values[$element_name]); + if (in_array($this->_op, ['create', 'edit', 'copy'], TRUE)) { + if (!is_string($values['name'])) { + $values['name'] = 'default'; } + $this->profile->setName($values['name']); + foreach ($this->profile->getData() as $element_name => $value) { + if ($element_name == 'newsletter_double_opt_in') { + $values[$element_name] = (int) isset($values[$element_name]); + } + if (isset($values[$element_name])) { + $this->profile->setAttribute($element_name, $values[$element_name]); + } + } + $this->profile->saveProfile(); + } + elseif ($this->_op == 'delete') { + $this->profile->deleteProfile(); } - $this->profile->saveProfile(); } - elseif ($this->_op == 'delete') { - $this->profile->deleteProfile(); + catch (ProfileException $e) { + Civi::log()->error($e->getLogMessage()); + CRM_Core_Session::setStatus( + E::ts('Error'), + $e->getMessage(), + 'error', + ['unique' => TRUE] + ); } parent::postProcess(); } @@ -305,122 +704,196 @@ class CRM_Twingle_Form_Profile extends CRM_Core_Form { * Retrieves location types present within the system as options for select * form elements. * - * @return array - * - * @throws \CiviCRM_API3_Exception + * @return array */ - public function getLocationTypes() { - $location_types = array(); - $query = civicrm_api3('LocationType', 'get', array( - 'is_active' => 1, - )); - foreach ($query['values'] as $type) { - $location_types[$type['id']] = $type['name']; + public static function getLocationTypes() { + if (!isset(static::$_locationTypes)) { + static::$_locationTypes = []; + /** + * @phpstan-var array{values: array} $query + */ + $query = civicrm_api3('LocationType', 'get', [ + 'option.limit' => 0, + 'is_active' => 1, + ]); + foreach ($query['values'] as $type) { + static::$_locationTypes[(int) $type['id']] = $type['name']; + } } + return static::$_locationTypes; + } - return $location_types; + /** + * Retrieves XCM profiles (if supported). 'default' profile is always available + * + * @return array + */ + public static function getXCMProfiles() { + if (!isset(static::$_xcm_profiles)) { + if (class_exists('CRM_Xcm_Configuration')) { + static::$_xcm_profiles = [ + '' => E::ts('<select profile>'), + ]; + /** + * @phpstan-var array $profiles + */ + $profiles = CRM_Xcm_Configuration::getProfileList(); + foreach ($profiles as $profile_key => $profile_name) { + static::$_xcm_profiles[$profile_key] = $profile_name; + } + } + } + return static::$_xcm_profiles; } /** * Retrieves financial types present within the system as options for select * form elements. * - * @return array - * - * @throws \CiviCRM_API3_Exception + * @return array */ - public function getFinancialTypes() { - $financial_types = array(); - $query = civicrm_api3('FinancialType', 'get', array( - 'is_active' => 1, - 'option.limit' => 0, - 'return' => 'id,name' - )); - foreach ($query['values'] as $type) { - $financial_types[$type['id']] = $type['name']; + public static function getFinancialTypes() { + if (!isset(static::$_financialTypes)) { + static::$_financialTypes = []; + /** + * @phpstan-var array{values: array} $query + */ + $query = civicrm_api3('FinancialType', 'get', [ + 'option.limit' => 0, + 'is_active' => 1, + 'return' => 'id,name', + ]); + foreach ($query['values'] as $type) { + static::$_financialTypes[(int) $type['id']] = $type['name']; + } } - return $financial_types; + return static::$_financialTypes; } /** - * Retrieves campaigns present within the system as options for select form + * Retrieves membership types present within the system as options for select + * form elements. + * + * @return array + */ + public static function getMembershipTypes() { + if (!isset(static::$_membershipTypes)) { + static::$_membershipTypes = []; + /** + * @phpstan-var array{values: array} $query + */ + $query = civicrm_api3('MembershipType', 'get', [ + 'option.limit' => 0, + 'is_active' => 1, + 'return' => 'id,name', + ]); + foreach ($query['values'] as $type) { + static::$_membershipTypes[(int) $type['id']] = $type['name']; + } + } + return static::$_membershipTypes; + } + + /** + * Retrieves genders present within the system as options for select form * elements. * - * @return array - * - * @throws \CiviCRM_API3_Exception + * @return array */ - public function getGenderOptions() { - $genders = array(); - $query = civicrm_api3('OptionValue', 'get', array( - 'option_group_id' => 'gender', - 'is_active' => 1, - 'option.limit' => 0, - 'return' => array( - 'value', - 'label', - ), - )); - foreach ($query['values'] as $gender) { - $genders[$gender['value']] = $gender['label']; + public static function getGenderOptions() { + if (!isset(static::$_genderOptions)) { + static::$_genderOptions = []; + /** + * @phpstan-var array{values: array} $query + */ + $query = civicrm_api3('OptionValue', 'get', [ + 'option.limit' => 0, + 'option_group_id' => 'gender', + 'is_active' => 1, + 'return' => [ + 'value', + 'label', + ], + ]); + foreach ($query['values'] as $gender) { + static::$_genderOptions[(int) $gender['value']] = $gender['label']; + } } - return $genders; + return static::$_genderOptions; + } + + /** + * Retrieves prefixes present within the system as options for select form + * elements. + * + * @return array + */ + public static function getPrefixOptions() { + if (!isset(static::$_prefixOptions)) { + static::$_prefixOptions = ['' => E::ts('none')]; + /** + * @phpstan-var array{values: array} $query + */ + $query = civicrm_api3('OptionValue', 'get', [ + 'option.limit' => 0, + 'option_group_id' => 'individual_prefix', + 'is_active' => 1, + 'return' => [ + 'value', + 'label', + ], + ]); + foreach ($query['values'] as $prefix) { + static::$_prefixOptions[$prefix['value']] = $prefix['label']; + } + } + return static::$_prefixOptions; } /** * Retrieves CiviSEPA creditors as options for select form elements. * - * @return array - * - * @throws \CiviCRM_API3_Exception + * @return array */ - public function getSepaCreditors() { - $creditors = array(); - - if (CRM_Twingle_Submission::civiSepaEnabled()) { - $result = civicrm_api3('SepaCreditor', 'get', array( - 'option.limit' => 0, - )); - foreach ($result['values'] as $sepa_creditor) { - $creditors[$sepa_creditor['id']] = $sepa_creditor['name']; + public static function getSepaCreditors() { + if (!isset(static::$_sepaCreditors)) { + static::$_sepaCreditors = []; + if (CRM_Twingle_Submission::civiSepaEnabled()) { + /** + * @phpstan-var array{values: array} $result + */ + $result = civicrm_api3('SepaCreditor', 'get', [ + 'option.limit' => 0, + ]); + foreach ($result['values'] as $sepa_creditor) { + static::$_sepaCreditors[(int) $sepa_creditor['id']] = $sepa_creditor['name']; + } } } - - return $creditors; + return static::$_sepaCreditors; } /** * Retrieves payment instruments present within the system as options for * select form elements. + * + * @return array */ - public function getPaymentInstruments() { + public static function getPaymentInstruments() { if (!isset(self::$_paymentInstruments)) { - self::$_paymentInstruments = array(); - $query = civicrm_api3('OptionValue', 'get', array( + self::$_paymentInstruments = []; + $query = civicrm_api3('OptionValue', 'get', [ + 'option.limit' => 0, 'option_group_id' => 'payment_instrument', 'is_active' => 1, - 'option.limit' => 0, - 'return' => 'value,label' - )); + 'return' => 'value,label', + ]); foreach ($query['values'] as $payment_instrument) { // Do not include CiviSEPA payment instruments, but add a SEPA option if // enabled. if ( CRM_Twingle_Submission::civiSepaEnabled() - && ( - ( - method_exists('CRM_Sepa_Logic_PaymentInstruments', 'isSDD') - && CRM_Sepa_Logic_PaymentInstruments::isSDD(array( - 'payment_instrument_id' => $payment_instrument['value'], - )) - ) - || ( - method_exists('CRM_Sepa_Logic_Settings', 'isSDD') - && CRM_Sepa_Logic_Settings::isSDD(array( - 'payment_instrument_id' => $payment_instrument['value'], - )) - ) - ) + && CRM_Twingle_Tools::isSDD($payment_instrument['value']) ) { if (!isset(self::$_paymentInstruments['sepa'])) { self::$_paymentInstruments['sepa'] = E::ts('CiviSEPA'); @@ -435,81 +908,126 @@ class CRM_Twingle_Form_Profile extends CRM_Core_Form { } /** - * Retrieves active groups used as mailing lists within the system as options - * for select form elements. + * Retrieves contribution statuses as options for select form elements. + * + * @return array */ - public function getNewsletterGroups() { - $groups = array(); - $group_types = civicrm_api3('OptionValue', 'get', array( - 'option_group_id' => 'group_type', - 'name' => CRM_Twingle_Submission::GROUP_TYPE_NEWSLETTER, - )); - if ($group_types['count'] > 0) { - $group_type = reset($group_types['values']); - $query = civicrm_api3('Group', 'get', array( - 'is_active' => 1, - 'group_type' => array('LIKE' => '%' . CRM_Utils_Array::implodePadded($group_type['value']) . '%'), - 'option.limit' => 0, - 'return' => 'id,name' - )); - foreach ($query['values'] as $group) { - $groups[$group['id']] = $group['name']; + public static function getContributionStatusOptions() { + if (!isset(self::$_contributionStatusOptions)) { + $query = civicrm_api3( + 'OptionValue', + 'get', + [ + 'option.limit' => 0, + 'option_group_id' => 'contribution_status', + 'return' => [ + 'value', + 'label', + ], + ] + ); + + foreach ($query['values'] as $contribution_status) { + self::$_contributionStatusOptions[(int) $contribution_status['value']] = $contribution_status['label']; } } - else { - $groups[''] = E::ts('No mailing lists available'); + + return self::$_contributionStatusOptions; + } + + /** + * Retrieves active groups used as mailing lists within the system as options + * for select form elements. + * + * @return array + * + */ + public static function getNewsletterGroups() { + if (!isset(static::$_newsletterGroups)) { + static::$_newsletterGroups = []; + $group_types = civicrm_api3('OptionValue', 'get', [ + 'option.limit' => 0, + 'option_group_id' => 'group_type', + 'name' => CRM_Twingle_Submission::GROUP_TYPE_NEWSLETTER, + ]); + if ($group_types['count'] > 0) { + $group_type = reset($group_types['values']); + $query = civicrm_api3('Group', 'get', [ + 'is_active' => 1, + 'group_type' => ['LIKE' => '%' . CRM_Utils_Array::implodePadded($group_type['value']) . '%'], + 'option.limit' => 0, + 'return' => 'id,name', + ]); + foreach ($query['values'] as $group) { + static::$_newsletterGroups[$group['id']] = $group['name']; + } + } + else { + static::$_newsletterGroups[''] = E::ts('No mailing lists available'); + } } - return $groups; + return static::$_newsletterGroups; } /** * Retrieves active groups as options for select form elements. + * + * @return array */ - public function getGroups() { - $groups = array(); - $query = civicrm_api3('Group', 'get', array( - 'is_active' => 1, - 'option.limit' => 0, - 'return' => 'id,name' - )); - foreach ($query['values'] as $group) { - $groups[$group['id']] = $group['name']; + public static function getGroups() { + if (!isset(static::$_groups)) { + static::$_groups = []; + $query = civicrm_api3('Group', 'get', [ + 'option.limit' => 0, + 'is_active' => 1, + 'return' => 'id,name', + ]); + foreach ($query['values'] as $group) { + static::$_groups[(int) $group['id']] = $group['name']; + } } - return $groups; + return static::$_groups; } /** * Retrieves active groups used as postal mailing lists within the system as * options for select form elements. + * + * @return array */ - public function getPostinfoGroups() { - return $this->getGroups(); + public static function getPostinfoGroups() { + return static::getGroups(); } /** * Retrieves active groups used as donation receipt requester lists within the * system as options for select form elements. + * + * @return array */ - public function getDonationReceiptGroups() { - return $this->getGroups(); + public static function getDonationReceiptGroups() { + return static::getGroups(); } /** * Retrieves campaigns as options for select elements. + * + * @return array */ - public function getCampaigns() { - $campaigns = array(); - $query = civicrm_api3('Campaign', 'get', array( - 'option.limit' => 0, - 'return' => array( - 'id', - 'title', - ) - )); - foreach ($query['values'] as $campaign) { - $campaigns[$campaign['id']] = $campaign['title']; + public static function getCampaigns() { + if (!isset(static::$_campaigns)) { + static::$_campaigns = []; + $query = civicrm_api3('Campaign', 'get', [ + 'option.limit' => 0, + 'return' => [ + 'id', + 'title', + ], + ]); + foreach ($query['values'] as $campaign) { + static::$_campaigns[(int) $campaign['id']] = $campaign['title']; + } } - return $campaigns; + return static::$_campaigns; } - } diff --git a/CRM/Twingle/Form/Settings.php b/CRM/Twingle/Form/Settings.php index a8460a2..450b52a 100644 --- a/CRM/Twingle/Form/Settings.php +++ b/CRM/Twingle/Form/Settings.php @@ -13,6 +13,8 @@ | written permission from the original author(s). | +-------------------------------------------------------------*/ +declare(strict_types = 1); + use CRM_Twingle_ExtensionUtil as E; /** @@ -22,171 +24,187 @@ use CRM_Twingle_ExtensionUtil as E; */ class CRM_Twingle_Form_Settings extends CRM_Core_Form { - private $_settingFilter = array('group' => 'de.systopia.twingle'); - - //everything from this line down is generic & can be re-used for a setting form in another extension - //actually - I lied - I added a specific call in getFormSettings - private $_submittedValues = array(); - private $_settings = array(); + /** + * @var array + * List of all settings options. + */ + public static $SETTINGS_LIST = [ + 'twingle_prefix', + 'twingle_use_sepa', + 'twingle_dont_use_reference', + 'twingle_protect_recurring', + 'twingle_protect_recurring_activity_type', + 'twingle_protect_recurring_activity_subject', + 'twingle_protect_recurring_activity_status', + 'twingle_protect_recurring_activity_assignee', + 'twingle_use_shop', + 'twingle_access_key', + ]; /** * @inheritdoc */ - function buildQuickForm() { + public function buildQuickForm(): void { // Set redirect destination. $this->controller->_destination = CRM_Utils_System::url('civicrm/admin/settings/twingle', 'reset=1'); - $settings = $this->getFormSettings(); - $form_elements = array(); + $this->add( + 'text', + 'twingle_prefix', + E::ts('Twingle ID Prefix') + ); - foreach ($settings as $name => $setting) { - if (isset($setting['quick_form_type'])) { - $add = 'add' . $setting['quick_form_type']; - if ($add == 'addElement') { - $this->$add( - $setting['html_type'], - $name, - ts($setting['title']), - CRM_Utils_Array::value('html_attributes', $setting, array()) - ); - } - elseif ($setting['html_type'] == 'Select') { - $optionValues = array(); - if (!empty($setting['pseudoconstant']) && !empty($setting['pseudoconstant']['optionGroupName'])) { - $optionValues = CRM_Core_OptionGroup::values($setting['pseudoconstant']['optionGroupName'], FALSE, FALSE, FALSE, NULL, 'name'); - } - $this->add( - 'select', - $setting['name'], - $setting['title'], - $optionValues, - FALSE, - CRM_Utils_Array::value('html_attributes', $setting, array()) - ); - } - else { - $this->$add($name, ts($setting['title'])); - } - $form_elements[$setting['name']] = array('description' => ts($setting['description'])); + $this->add( + 'checkbox', + 'twingle_use_sepa', + E::ts('Use CiviSEPA') + ); - // Disable CiviSEPA setting if the extension is not installed. - if ($name == 'twingle_use_sepa') { - $sepa_extension = civicrm_api3('Extension', 'get', array( - 'full_name' => 'org.project60.sepa', - 'is_active' => 1, - )); - if ($sepa_extension['count'] == 0) { - $element = $this->getElement('twingle_use_sepa'); - $element->freeze(); - $form_elements['twingle_use_sepa']['description'] .= ' The CiviSEPA (org.project60.sepa) extension is not installed.'; - } - } - } + $this->add( + 'checkbox', + 'twingle_dont_use_reference', + E::ts('Use CiviSEPA generated reference') + ); + + $this->add( + 'select', + 'twingle_protect_recurring', + E::ts('Protect Recurring Contributions'), + CRM_Twingle_Config::getRecurringProtectionOptions() + ); + + $this->add( + 'select', + 'twingle_protect_recurring_activity_type', + E::ts('Activity Type'), + $this->getOptionValueList('activity_type', [0]) + ); + + $this->add( + 'text', + 'twingle_protect_recurring_activity_subject', + E::ts('Subject'), + ['class' => 'huge'] + ); + + $this->add( + 'select', + 'twingle_protect_recurring_activity_status', + E::ts('Status'), + $this->getOptionValueList('activity_status') + ); + + $this->addEntityRef( + 'twingle_protect_recurring_activity_assignee', + E::ts('Assigned To'), + [ + 'api' => [ + 'params' => [ + 'contact_type' => ['IN' => ['Individual', 'Organization']], + 'check_permissions' => 0, + ], + ], + ] + ); + + $this->add( + 'checkbox', + 'twingle_use_shop', + E::ts('Use Twingle Shop Integration') + ); + + $this->add( + 'text', + 'twingle_access_key', + E::ts('Twingle Access Key') + ); + + $this->addButtons([ + [ + 'type' => 'submit', + 'name' => E::ts('Save'), + 'isDefault' => TRUE, + ], + ]); + + // set defaults + foreach (self::$SETTINGS_LIST as $setting) { + $this->setDefaults([ + $setting => Civi::settings()->get($setting), + ]); } - $this->assign('formElements', $form_elements); - - $this->addButtons(array( - array ( - 'type' => 'submit', - 'name' => ts('Save'), - 'isDefault' => TRUE, - ) - )); - - // Export form elements. - $this->assign('elementNames', $this->getRenderableElementNames()); parent::buildQuickForm(); } + /** + * Custom form validation, as some fields are mandatory only when others are active. + * @return bool + */ + public function validate() { + parent::validate(); + + // if activity creation is active, make sure the fields are set + $protection_mode = $this->_submitValues['twingle_protect_recurring'] ?? NULL; + if ($protection_mode == CRM_Twingle_Config::RCUR_PROTECTION_ACTIVITY) { + foreach ([ + 'twingle_protect_recurring_activity_type', + 'twingle_protect_recurring_activity_subject', + 'twingle_protect_recurring_activity_status', + 'twingle_protect_recurring_activity_assignee', + ] as $activity_field) { + if (NULL !== ($this->_submitValues[$activity_field] ?? NULL)) { + $this->_errors[$activity_field] = E::ts('This is required for activity creation'); + } + } + } + + // Twingle Access Key is required if Shop Integration is enabled + if ( + CRM_Utils_Array::value('twingle_use_shop', $this->_submitValues) && + !CRM_Utils_Array::value('twingle_access_key', $this->_submitValues, FALSE) + ) { + $this->_errors['twingle_access_key'] = E::ts('An Access Key is required to enable Twingle Shop Integration'); + } + + return (0 == count($this->_errors)); + } + /** * @inheritdoc */ - function postProcess() { - $this->_submittedValues = $this->exportValues(); - $this->saveSettings(); + public function postProcess(): void { + $values = $this->exportValues(); + + // store settings + foreach (self::$SETTINGS_LIST as $setting) { + Civi::settings()->set($setting, $values[$setting] ?? NULL); + } + parent::postProcess(); } /** - * Get the fields/elements defined in this form. - * - * @return array (string) + * Get a list of option group items + * @param string $group_id + * Group ID or name. + * @param array $reserved + * @return array list of ID(value) => label + * @throws \CRM_Core_Exception */ - function getRenderableElementNames() { - // The _elements list includes some items which should not be - // auto-rendered in the loop -- such as "qfKey" and "buttons". These - // items don't have labels. We'll identify renderable by filtering on - // the 'label'. - $elementNames = array(); - foreach ($this->_elements as $element) { - /* @var \HTML_QuickForm_element $element */ - $label = $element->getLabel(); - if (!empty($label)) { - $elementNames[] = $element->getName(); - } + protected function getOptionValueList(string $group_id, array $reserved = [0, 1]): array { + $list = ['' => E::ts('-select-')]; + $query = civicrm_api3('OptionValue', 'get', [ + 'option_group_id' => $group_id, + 'option.limit' => 0, + 'is_active' => 1, + 'is_reserved' => ['IN' => $reserved], + 'return' => 'value,label', + ]); + foreach ($query['values'] as $value) { + $list[$value['value']] = $value['label']; } - return $elementNames; - } - /** - * Get the settings we are going to allow to be set on this form. - * - * @return array - * - * @throws \CiviCRM_API3_Exception - */ - function getFormSettings() { - if (empty($this->_settings)) { - $settings = civicrm_api3('setting', 'getfields', array('filters' => $this->_settingFilter)); - $settings = $settings['values']; - } - else { - $settings = $this->_settings; - } - return $settings; - } - /** - * Save the settings set on this form. - */ - function saveSettings() { - $settings = $this->getFormSettings(); - $values = array_intersect_key($this->_submittedValues, $settings); - civicrm_api3('setting', 'create', $values); - } - /** - * @inheritdoc - */ - function setDefaultValues() { - $existing = civicrm_api3('setting', 'get', array('return' => array_keys($this->getFormSettings()))); - $defaults = array(); - $domainID = CRM_Core_Config::domainID(); - foreach ($existing['values'][$domainID] as $name => $value) { - $defaults[$name] = $value; - } - return $defaults; - } - - /** - * @inheritdoc - */ - public function addRules() { - $this->addFormRule(array('CRM_Twingle_Form_Settings', 'validateSettingsForm')); - } - - /** - * Validates the profile form. - * - * @param array $values - * The submitted form values, keyed by form element name. - * - * @return bool | array - * TRUE when the form was successfully validated, or an array of error - * messages, keyed by form element name. - */ - public static function validateSettingsForm($values) { - $errors = array(); - - return empty($errors) ? TRUE : $errors; + return $list; } } diff --git a/CRM/Twingle/Page/Configuration.php b/CRM/Twingle/Page/Configuration.php index 2a56343..d0e0e3c 100644 --- a/CRM/Twingle/Page/Configuration.php +++ b/CRM/Twingle/Page/Configuration.php @@ -13,11 +13,13 @@ | written permission from the original author(s). | +-------------------------------------------------------------*/ +declare(strict_types = 1); + use CRM_Twingle_ExtensionUtil as E; class CRM_Twingle_Page_Configuration extends CRM_Core_Page { - public function run() { + public function run(): void { parent::run(); } diff --git a/CRM/Twingle/Page/Profiles.php b/CRM/Twingle/Page/Profiles.php index f9fad8a..da8743e 100644 --- a/CRM/Twingle/Page/Profiles.php +++ b/CRM/Twingle/Page/Profiles.php @@ -13,19 +13,30 @@ | written permission from the original author(s). | +-------------------------------------------------------------*/ +declare(strict_types = 1); + use CRM_Twingle_ExtensionUtil as E; class CRM_Twingle_Page_Profiles extends CRM_Core_Page { - public function run() { - $profiles = array(); - foreach (CRM_Twingle_Profile::getProfiles() as $profile_name => $profile) { - $profiles[$profile_name]['name'] = $profile_name; + public function run():void { + CRM_Utils_System::setTitle(E::ts('Twingle API Profiles')); + $profiles = []; + foreach (CRM_Twingle_Profile::getProfiles() as $profile_id => $profile) { + $profiles[$profile_id]['id'] = $profile_id; + $profiles[$profile_id]['name'] = $profile->getName(); + $profiles[$profile_id]['is_default'] = $profile->is_default(); + $profiles[$profile_id]['selectors'] = $profile->getProjectIds(); foreach (CRM_Twingle_Profile::allowedAttributes() as $attribute) { - $profiles[$profile_name][$attribute] = $profile->getAttribute($attribute); + $profiles[$profile_id][$attribute] = $profile->getAttribute($attribute); } } $this->assign('profiles', $profiles); + $this->assign('profile_stats', CRM_Twingle_Profile::getProfileStats()); + $this->assign('twingle_use_shop', (int) Civi::settings()->get('twingle_use_shop')); + + // Add custom css + Civi::resources()->addStyleFile(E::LONG_NAME, 'css/twingle.css'); parent::run(); } diff --git a/CRM/Twingle/Profile.php b/CRM/Twingle/Profile.php index 474d2ad..a0d0cff 100644 --- a/CRM/Twingle/Profile.php +++ b/CRM/Twingle/Profile.php @@ -13,7 +13,11 @@ | written permission from the original author(s). | +-------------------------------------------------------------*/ +declare(strict_types = 1); + use CRM_Twingle_ExtensionUtil as E; +use Civi\Twingle\Exceptions\ProfileException as ProfileException; +use Civi\Twingle\Exceptions\ProfileValidationError; /** * Profiles define how incoming submissions from the Twingle API are @@ -22,32 +26,44 @@ use CRM_Twingle_ExtensionUtil as E; class CRM_Twingle_Profile { /** - * @var CRM_Twingle_Profile[] $_profiles - * Caches the profile objects. + * @var int + * The id of the profile. */ - protected static $_profiles = NULL; + protected ?int $id; /** - * @var string $name + * @var string * The name of the profile. */ - protected $name = NULL; + protected string $name; /** - * @var array $data + * @var array * The properties of the profile. */ - protected $data = NULL; + protected $data; + + /** + * @var array $check_box_fields + * List of check box fields + */ + public $check_box_fields = [ + 'newsletter_double_opt_in', + 'enable_shop_integration', + 'shop_map_products', + ]; /** * CRM_Twingle_Profile constructor. * * @param string $name * The name of the profile. - * @param array $data + * @param array $data * The properties of the profile + * @param int|NULL $id */ - public function __construct($name, $data) { + public function __construct($name, $data, $id = NULL) { + $this->id = $id; $this->name = $name; $allowed_attributes = self::allowedAttributes(); $this->data = $data + array_combine( @@ -56,60 +72,163 @@ class CRM_Twingle_Profile { ); } + /** + * Logs (production) access to this profile + */ + public function logAccess(): void { + CRM_Core_DAO::executeQuery(' + UPDATE civicrm_twingle_profile + SET + last_access = NOW(), + access_counter = access_counter + 1 + WHERE name = %1', [1 => [$this->name, 'String']]); + } + + /** + * Copy this profile by returning a clone with all unique information removed. + * + * @return CRM_Twingle_Profile + */ + public function copy() { + $copy = clone $this; + + // Remove unique data + $copy->id = NULL; + $copy->data['selector'] = NULL; + + // Propose a new name for this profile. + $profile_name = $this->getName() . '_copy'; + $copy->setName($profile_name); + return $copy; + } + /** * Checks whether the profile's selector matches the given project ID. * - * @param string | int $project_id + * @param string|int $project_id * * @return bool */ public function matches($project_id) { - $selector = $this->getAttribute('selector'); - $project_ids = explode(',', $selector); - return in_array($project_id, $project_ids); + return in_array($project_id, $this->getProjectIds(), TRUE); + } + + /** + * Retrieves the profile's configured custom field mapping. + * + * @return array + * The profile's configured custom field mapping + */ + public function getCustomFieldMapping() { + $custom_field_mapping = []; + if ('' !== ($custom_field_definition = $this->getAttribute('custom_field_mapping', ''))) { + /** @var string $custom_field_definition */ + $custom_field_maps = preg_split( + '/\r\n|\r|\n/', + $custom_field_definition, + -1, + PREG_SPLIT_NO_EMPTY + ); + if (FALSE !== $custom_field_maps) { + foreach ($custom_field_maps as $custom_field_map) { + [$twingle_field_name, $custom_field_name] = explode('=', $custom_field_map); + $custom_field_mapping[$twingle_field_name] = $custom_field_name; + } + } + } + return $custom_field_mapping; } /** * Retrieves all data attributes of the profile. * - * @return array + * @return array */ public function getData() { return $this->data; } + /** + * Retrieves the profile id. + * + * @return int + */ + public function getId(): ?int { + return $this->id; + } + + /** + * Set the profile id. + * + * @param int $id + */ + public function setId(int $id): void { + $this->id = $id; + } + /** * Retrieves the profile name. * * @return string */ - public function getName() { + public function getName(): string { return $this->name; } /** * Sets the profile name. * - * @param $name + * @param string $name */ - public function setName($name) { + public function setName(string $name): void { $this->name = $name; } + /** + * Is this the default profile? + * + * @return bool + */ + public function is_default(): bool { + return $this->name === 'default'; + } + + /** + * Retrieves the profile's project IDs. + * + * @return array + */ + public function getProjectIds(): array { + return array_map( + function($project_id) { + return trim($project_id); + }, + explode(',', $this->getAttribute('selector') ?? '') + ); + } + + /** + * Determine if Twingle Shop integration is enabled in general and + * specifically for this profile. + * @return bool + */ + public function isShopEnabled(): bool { + return Civi::settings()->get('twingle_use_shop') && + $this->data['enable_shop_integration']; + } + /** * Retrieves an attribute of the profile. * * @param string $attribute_name + * @param mixed $default * * @return mixed | NULL */ - public function getAttribute($attribute_name) { - if (isset($this->data[$attribute_name])) { - return $this->data[$attribute_name]; - } - else { - return NULL; - } + public function getAttribute($attribute_name, $default = NULL) { + return (isset($this->data[$attribute_name]) && $this->data[$attribute_name] !== '') + ? $this->data[$attribute_name] + : $default; } /** @@ -118,88 +237,365 @@ class CRM_Twingle_Profile { * @param string $attribute_name * @param mixed $value * - * @throws \Exception + * @throws \Civi\Twingle\Exceptions\ProfileException * When the attribute name is not known. */ - public function setAttribute($attribute_name, $value) { - if (!in_array($attribute_name, self::allowedAttributes())) { - throw new Exception(E::ts('Unknown attribute %1.', array(1 => $attribute_name))); + public function setAttribute($attribute_name, $value): void { + if (!in_array($attribute_name, self::allowedAttributes(), TRUE)) { + throw new ProfileException( + E::ts('Unknown attribute %1.', [1 => $attribute_name]), + ProfileException::ERROR_CODE_UNKNOWN_PROFILE_ATTRIBUTE + ); } // TODO: Check if value is acceptable. $this->data[$attribute_name] = $value; } + /** + * Get the CiviCRM transaction ID (to be used in contributions and recurring contributions) + * + * @param string $twingle_id Twingle ID + * @return string CiviCRM transaction ID + */ + public function getTransactionID(string $twingle_id) { + $prefix = Civi::settings()->get('twingle_prefix'); + return ($prefix ?? '') . $twingle_id; + } + /** * Verifies whether the profile is valid (i.e. consistent and not colliding * with other profiles). * - * @throws Exception + * @throws \Civi\Twingle\Exceptions\ProfileValidationError + * @throws \Civi\Core\Exception\DBQueryException * When the profile could not be successfully validated. */ - public function verifyProfile() { - // TODO: check - // data of this profile consistent? - // conflicts with other profiles? + public function validate(): void { + + // Name cannot be empty + if ('' === $this->getName()) { + throw new ProfileValidationError( + 'name', + E::ts('Profile name cannot be empty.'), + ProfileValidationError::ERROR_CODE_PROFILE_VALIDATION_FAILED + ); + } + + // Restrict profile names to alphanumeric characters, space and the underscore. + if (1 === preg_match('/[^A-Za-z0-9_\s]/', $this->getName())) { + throw new ProfileValidationError( + 'name', + E::ts('Only alphanumeric characters, space and the underscore (_) are allowed for profile names.'), + ProfileValidationError::ERROR_CODE_PROFILE_VALIDATION_FAILED + ); + } + + // Check if profile name is already used for other profile + $profile_name_duplicates = array_filter( + CRM_Twingle_Profile::getProfiles(), + function($profile) { + return $profile->getName() == $this->getName() && $this->getId() != $profile->getId(); + }); + if ([] !== $profile_name_duplicates) { + throw new ProfileValidationError( + 'name', + E::ts("A profile with the name '%1' already exists.", [1 => $this->getName()]), + ProfileValidationError::ERROR_CODE_PROFILE_VALIDATION_FAILED + ); + } + + // Check if project_id is already used in other profile + $profiles = $this::getProfiles(); + foreach ($profiles as $profile) { + if ($profile->getId() == $this->getId() || $profile->is_default()) { + continue; + }; + $project_ids = $this->getProjectIds(); + $id_duplicates = array_intersect($profile->getProjectIds(), $project_ids); + if ([] !== $id_duplicates) { + throw new ProfileValidationError( + 'selector', + E::ts( + "Project ID(s) [%1] already used in profile '%2'.", + [ + 1 => implode(', ', $id_duplicates), + 2 => $profile->getName(), + ] + ), + ProfileValidationError::ERROR_CODE_PROFILE_VALIDATION_WARNING + ); + } + } + + // Validate custom field mapping. + $custom_field_mapping = $this->getAttribute('custom_field_mapping'); + if (is_string($custom_field_mapping)) { + $custom_field_mapping = preg_split('/\r\n|\r|\n/', $custom_field_mapping, -1, PREG_SPLIT_NO_EMPTY); + $parsing_error = new ProfileValidationError( + 'custom_field_mapping', + E::ts('Could not parse custom field mapping.'), + ProfileValidationError::ERROR_CODE_PROFILE_VALIDATION_FAILED + ); + if (!is_array($custom_field_mapping)) { + throw $parsing_error; + } + foreach ($custom_field_mapping as $custom_field_map) { + $custom_field_map = explode('=', $custom_field_map); + if (count($custom_field_map) !== 2) { + throw $parsing_error; + } + [$twingle_field_name, $custom_field_name] = $custom_field_map; + $custom_field_id = substr($custom_field_name, strlen('custom_')); + + // Check for custom field existence + try { + /** + * @phpstan-var array $custom_field + */ + $custom_field = civicrm_api3( + 'CustomField', 'getsingle', ['id' => $custom_field_id] + ); + } + catch (CRM_Core_Exception $exception) { + throw new ProfileValidationError( + 'custom_field_mapping', + E::ts( + 'Custom field custom_%1 does not exist.', + [1 => $custom_field_id] + ), + ProfileValidationError::ERROR_CODE_PROFILE_VALIDATION_FAILED, + $exception + ); + } + + // Only allow custom fields on relevant entities. + try { + civicrm_api3('CustomGroup', 'getsingle', + [ + 'id' => $custom_field['custom_group_id'], + 'extends' => [ + 'IN' => [ + 'Contact', + 'Individual', + 'Organization', + 'Contribution', + 'ContributionRecur', + ], + ], + ]); + } + catch (CRM_Core_Exception $exception) { + throw new ProfileValidationError( + 'custom_field_mapping', + E::ts( + 'Custom field custom_%1 is not in a CustomGroup that extends one of the supported CiviCRM entities.', + [1 => $custom_field['id']] + ), + ProfileValidationError::ERROR_CODE_PROFILE_VALIDATION_FAILED, + $exception + ); + } + } + } } /** - * Persists the profile within the CiviCRM settings. + * Persists the profile within the database. + * + * @throws \Civi\Twingle\Exceptions\ProfileException */ - public function saveProfile() { - self::$_profiles[$this->getName()] = $this; - $this->verifyProfile(); - self::storeProfiles(); + public function saveProfile(): void { + try { + if (isset($this->id)) { + // existing profile -> just update the config + CRM_Core_DAO::executeQuery( + 'UPDATE civicrm_twingle_profile SET config = %2, name = %3 WHERE id = %1', + [ + 1 => [$this->id, 'String'], + 2 => [json_encode($this->data), 'String'], + 3 => [$this->name, 'String'], + ]); + } + else { + // new profile -> add new entry to the DB + CRM_Core_DAO::executeQuery( + << [$this->name, 'String'], + 2 => [json_encode($this->data), 'String'], + ]); + } + } + catch (Exception $exception) { + throw new ProfileException( + E::ts('Could not save/update profile: %1', [1 => $exception->getMessage()]), + ProfileException::ERROR_CODE_COULD_NOT_SAVE_PROFILE, + $exception + ); + } } /** - * Deletes the profile from the CiviCRM settings. + * Deletes the profile from the database + * + * @throws \Civi\Twingle\Exceptions\ProfileException */ - public function deleteProfile() { - unset(self::$_profiles[$this->getName()]); - self::storeProfiles(); + public function deleteProfile(): void { + // Do only reset default profile + if ($this->getName() == 'default') { + try { + $default_profile = CRM_Twingle_Profile::createDefaultProfile(); + $default_profile->setId($this->getId()); + $default_profile->saveProfile(); + + // Reset counter + CRM_Core_DAO::executeQuery( + 'UPDATE civicrm_twingle_profile SET access_counter = 0, last_access = NULL WHERE id = %1', + [1 => [$this->id, 'Integer']] + ); + } + catch (Exception $exception) { + throw new ProfileException( + E::ts('Could not reset default profile: %1', [1 => $exception->getMessage()]), + ProfileException::ERROR_CODE_COULD_NOT_RESET_PROFILE, + $exception + ); + } + } + else { + try { + CRM_Core_DAO::executeQuery( + 'DELETE FROM civicrm_twingle_profile WHERE id = %1', + [1 => [$this->id, 'Integer']] + ); + } + catch (Exception $exception) { + throw new ProfileException( + E::ts('Could not delete profile: %1', [1 => $exception->getMessage()]), + ProfileException::ERROR_CODE_COULD_NOT_DELETE_PROFILE, + $exception + ); + } + } } /** * Returns an array of attributes allowed for a profile. * - * @return array + * @return array|array */ - public static function allowedAttributes() { - return array( - 'selector', - 'location_type_id', - 'location_type_id_organisation', - 'financial_type_id', - 'pi_banktransfer', - 'pi_debit_manual', - 'pi_debit_automatic', - 'pi_creditcard', - 'pi_mobilephone_germany', - 'pi_paypal', - 'pi_sofortueberweisung', - 'pi_amazonpay', - 'pi_paydirekt', - 'pi_applepay', - 'pi_googlepay', - 'sepa_creditor_id', - 'gender_male', - 'gender_female', - 'gender_other', - 'newsletter_groups', - 'postinfo_groups', - 'donation_receipt_groups', - 'campaign', - 'contribution_source', + public static function allowedAttributes(bool $asMetadata = FALSE) { + $attributes = array_merge( + [ + 'selector' => [ + 'label' => E::ts('Project IDs'), + 'required' => TRUE, + ], + 'xcm_profile' => ['required' => FALSE], + 'location_type_id' => [ + 'label' => E::ts('Location type'), + 'required' => TRUE, + ], + 'location_type_id_organisation' => [ + 'label' => E::ts('Location type for organisations'), + 'required' => TRUE, + ], + 'financial_type_id' => [ + 'label' => E::ts('Financial type'), + 'required' => TRUE, + ], + 'financial_type_id_recur' => [ + 'label' => E::ts('Financial type (recurring)'), + 'required' => TRUE, + ], + 'sepa_creditor_id' => [ + 'label' => E::ts('CiviSEPA creditor'), + 'required' => CRM_Twingle_Submission::civiSepaEnabled(), + ], + 'gender_male' => [ + 'label' => E::ts('Gender option for submitted value "male"'), + 'required' => TRUE, + ], + 'gender_female' => [ + 'label' => E::ts('Gender option for submitted value "female"'), + 'required' => TRUE, + ], + 'gender_other' => [ + 'label' => E::ts('Gender option for submitted value "other"'), + 'required' => TRUE, + ], + 'prefix_male' => [ + 'label' => E::ts('Prefix option for submitted value "male"'), + 'required' => TRUE, + ], + 'prefix_female' => [ + 'label' => E::ts('Prefix option for submitted value "female"'), + 'required' => TRUE, + ], + 'prefix_other' => [ + 'label' => E::ts('Prefix option for submitted value "other"'), + 'required' => TRUE, + ], + 'newsletter_groups' => ['required' => FALSE], + 'postinfo_groups' => ['required' => FALSE], + 'donation_receipt_groups' => ['required' => FALSE], + 'campaign' => ['required' => FALSE], + 'campaign_targets' => ['required' => FALSE], + 'contribution_source' => ['required' => FALSE], + 'custom_field_mapping' => ['required' => FALSE], + 'membership_type_id' => ['required' => FALSE], + 'membership_type_id_recur' => ['required' => FALSE], + 'membership_postprocess_call' => ['required' => FALSE], + 'newsletter_double_opt_in' => ['required' => FALSE], + 'required_address_components' => ['required' => FALSE], + 'map_as_contribution_notes' => ['required' => FALSE], + 'map_as_contact_notes' => ['required' => FALSE], + 'enable_shop_integration' => ['required' => FALSE], + 'shop_financial_type' => ['required' => FALSE], + 'shop_donation_financial_type' => ['required' => FALSE], + 'shop_map_products' => ['required' => FALSE], + ], + // Add payment methods. + array_combine( + array_keys(static::paymentInstruments()), + array_map( + function ($value) { + return [ + 'label' => $value, + 'required' => TRUE, + ]; + }, + static::paymentInstruments() + )), + + // Add contribution status for all payment methods. + array_combine( + array_map(function($attribute) { + return $attribute . '_status'; + }, array_keys(static::paymentInstruments())), + array_map( + function($value) { + return [ + 'label' => $value . ' - ' . E::ts('Contribution Status'), + 'required' => TRUE, + ]; + }, + static::paymentInstruments() + )), ); + + return $asMetadata ? $attributes : array_keys($attributes); } /** * Retrieves a list of supported payment methods. * - * @return array + * @return array */ - public static function paymentInstruments() { - return array( + public static function paymentInstruments(): array { + return [ 'pi_banktransfer' => E::ts('Bank transfer'), 'pi_debit_manual' => E::ts('Debit manual'), 'pi_debit_automatic' => E::ts('Debit automatic'), @@ -208,10 +604,15 @@ class CRM_Twingle_Profile { 'pi_paypal' => E::ts('PayPal'), 'pi_sofortueberweisung' => E::ts('SOFORT Überweisung'), 'pi_amazonpay' => E::ts('Amazon Pay'), - 'pi_paydirekt' => E::ts('paydirekt'), 'pi_applepay' => E::ts('Apple Pay'), - 'pi_googlepay' => E::ts('Google Pay'), - ); + 'pi_googlepay' => E::ts('Google Pay'), + 'pi_paydirekt' => E::ts('Paydirekt'), + 'pi_twint' => E::ts('Twint'), + 'pi_ideal' => E::ts('iDEAL'), + 'pi_post_finance' => E::ts('Postfinance'), + 'pi_bancontact' => E::ts('Bancontact'), + 'pi_generic' => E::ts('Generic Payment Method'), + ]; } /** @@ -223,15 +624,22 @@ class CRM_Twingle_Profile { * @return CRM_Twingle_Profile */ public static function createDefaultProfile($name = 'default') { - return new CRM_Twingle_Profile($name, array( - 'selector' => '', + return new CRM_Twingle_Profile($name, [ + 'selector' => NULL, + 'xcm_profile' => '', 'location_type_id' => CRM_Twingle_Submission::LOCATION_TYPE_ID_WORK, 'location_type_id_organisation' => CRM_Twingle_Submission::LOCATION_TYPE_ID_WORK, - 'financial_type_id' => 1, // "Donation" - 'pi_banktransfer' => 5, // "EFT" + // "Donation" + 'financial_type_id' => 1, + // "Donation" + 'financial_type_id_recur' => 1, + // "EFT" + 'pi_banktransfer' => 5, 'pi_debit_manual' => NULL, - 'pi_debit_automatic' => 3, // Debit - 'pi_creditcard' => 1, // "Credit Card" + // Debit + 'pi_debit_automatic' => 2, + // "Credit Card" + 'pi_creditcard' => 1, 'pi_mobilephone_germany' => NULL, 'pi_paypal' => NULL, 'pi_sofortueberweisung' => NULL, @@ -239,6 +647,11 @@ class CRM_Twingle_Profile { 'pi_paydirekt' => NULL, 'pi_applepay' => NULL, 'pi_googlepay' => NULL, + 'pi_twint' => NULL, + 'pi_ideal' => NULL, + 'pi_post_finance' => NULL, + 'pi_bancontact' => NULL, + 'pi_generic' => NULL, 'sepa_creditor_id' => NULL, 'gender_male' => 2, 'gender_female' => 1, @@ -247,8 +660,30 @@ class CRM_Twingle_Profile { 'postinfo_groups' => NULL, 'donation_receipt_groups' => NULL, 'campaign' => NULL, + 'campaign_targets' => ['contribution', 'contact'], 'contribution_source' => NULL, - )); + 'custom_field_mapping' => NULL, + 'membership_type_id' => NULL, + 'membership_type_id_recur' => NULL, + 'newsletter_double_opt_in' => NULL, + 'required_address_components' => [ + 'street_address', + 'postal_code', + 'city', + 'country', + ], + 'map_as_contribution_notes' => [], + 'map_as_contact_notes' => [], + 'enable_shop_integration' => FALSE, + 'shop_financial_type' => 1, + 'shop_donation_financial_type' => 1, + 'shop_map_products' => FALSE, + ] + // Add contribution status for all payment methods. + // phpcs:ignore Drupal.Formatting.SpaceUnaryOperator.PlusMinus + + array_fill_keys(array_map(function($attribute) { + return $attribute . '_status'; + }, array_keys(static::paymentInstruments())), CRM_Twingle_Submission::CONTRIBUTION_STATUS_COMPLETED)); } /** @@ -256,76 +691,120 @@ class CRM_Twingle_Profile { * which is responsible for processing the project's data. * Returns the default profile if no match was found. * - * @param $project_id + * @param string $project_id * * @return CRM_Twingle_Profile + * @throws \Civi\Twingle\Exceptions\ProfileException + * @throws \Civi\Core\Exception\DBQueryException */ public static function getProfileForProject($project_id) { $profiles = self::getProfiles(); - - // If none matches, use the default profile. - $profile = $profiles['default']; + $default_profile = NULL; foreach ($profiles as $profile) { if ($profile->matches($project_id)) { - break; + return $profile; + } + if ($profile->is_default()) { + $default_profile = $profile; } } - return $profile; + // If none matches, use the default profile. + if (!empty($default_profile)) { + return $default_profile; + } + else { + throw new ProfileException( + 'Could not find default profile', + ProfileException::ERROR_CODE_DEFAULT_PROFILE_NOT_FOUND + ); + } } /** - * Retrieves the profile with the given name. + * Retrieves the profile with the given ID. * - * @param $name + * @param int|NULL $id * * @return CRM_Twingle_Profile | NULL + * @throws \Civi\Core\Exception\DBQueryException + * @throws \Civi\Twingle\Exceptions\ProfileException */ - public static function getProfile($name) { - $profiles = self::getProfiles(); - if (isset($profiles[$name])) { - return $profiles[$name]; - } - else { - return NULL; + public static function getProfile(int $id = NULL) { + if (isset($id)) { + /** + * @var CRM_Core_DAO $profile_data + */ + $profile_data = CRM_Core_DAO::executeQuery( + 'SELECT id, name, config FROM civicrm_twingle_profile WHERE id = %1', + [1 => [$id, 'Integer']] + ); + if ($profile_data->fetch()) { + return new CRM_Twingle_Profile( + $profile_data->name, + json_decode($profile_data->config, TRUE), + (int) $profile_data->id + ); + } } + throw new ProfileException('Profile not found.', ProfileException::ERROR_CODE_PROFILE_NOT_FOUND); } /** * Retrieves the list of all profiles persisted within the current CiviCRM * settings, including the default profile. * - * @return CRM_Twingle_Profile[] + * @return array + * An array of profiles with profile IDs as keys and profile objects as values. + * @throws \Civi\Core\Exception\DBQueryException */ - public static function getProfiles() { - if (self::$_profiles === NULL) { - self::$_profiles = array(); - if ($profiles_data = CRM_Core_BAO_Setting::getItem('de.systopia.twingle', 'twingle_profiles')) { - foreach ($profiles_data as $profile_name => $profile_data) { - self::$_profiles[$profile_name] = new CRM_Twingle_Profile($profile_name, $profile_data); - } - } + public static function getProfiles(): array { + // todo: cache? + $profiles = []; + /** + * @var CRM_Core_DAO $profile_data + */ + $profile_data = CRM_Core_DAO::executeQuery('SELECT id, name, config FROM civicrm_twingle_profile'); + while ($profile_data->fetch()) { + $profiles[(int) $profile_data->id] = new CRM_Twingle_Profile( + $profile_data->name, + json_decode($profile_data->config, TRUE), + (int) $profile_data->id + ); } - - // Include the default profile if it was not overridden within the settings. - if (!isset(self::$_profiles['default'])) { - self::$_profiles['default'] = self::createDefaultProfile(); - self::storeProfiles(); - } - - return self::$_profiles; + return $profiles; } - /** - * Persists the list of profiles into the CiviCRM settings. + * Get the stats (access_count, last_access) for all twingle profiles + * + * @return array> + * @throws \Civi\Core\Exception\DBQueryException */ - public static function storeProfiles() { - $profile_data = array(); - foreach (self::$_profiles as $profile_name => $profile) { - $profile_data[$profile_name] = $profile->data; + public static function getProfileStats() { + $stats = []; + /** + * @var CRM_Core_DAO $profile_data + */ + $profile_data = CRM_Core_DAO::executeQuery( + 'SELECT name, last_access, access_counter FROM civicrm_twingle_profile' + ); + while ($profile_data->fetch()) { + // phpcs:disable Drupal.Arrays.Array.ArrayIndentation + $stats[(string) $profile_data->name] = [ + 'name' => $profile_data->name, + 'last_access' => $profile_data->last_access, + 'last_access_txt' => $profile_data->last_access + ? date('Y-m-d H:i:s', strtotime($profile_data->last_access)) + : E::ts('never'), + 'access_counter' => $profile_data->access_counter, + 'access_counter_txt' => $profile_data->access_counter + ? ((int) $profile_data->access_counter) . 'x' + : E::ts('never'), + ]; + // phpcs:enable } - CRM_Core_BAO_Setting::setItem((object) $profile_data, 'de.systopia.twingle', 'twingle_profiles'); + return $stats; } } diff --git a/CRM/Twingle/Submission.php b/CRM/Twingle/Submission.php index a13d624..1955d18 100644 --- a/CRM/Twingle/Submission.php +++ b/CRM/Twingle/Submission.php @@ -13,24 +13,45 @@ | written permission from the original author(s). | +-------------------------------------------------------------*/ +declare(strict_types = 1); + use CRM_Twingle_ExtensionUtil as E; +use Civi\Twingle\Exceptions\BaseException; +use Civi\Twingle\Shop\Exceptions\LineItemException; class CRM_Twingle_Submission { /** * The default ID of the "Work" location type. */ - const LOCATION_TYPE_ID_WORK = 2; + public const LOCATION_TYPE_ID_WORK = 2; /** * The option value name of the group type for newsletter subscribers. */ - const GROUP_TYPE_NEWSLETTER = 'Mailing List'; + public const GROUP_TYPE_NEWSLETTER = 'Mailing List'; + + /** + * The option value for the contribution type for completed contributions. + */ + public const CONTRIBUTION_STATUS_COMPLETED = 'Completed'; /** * The default ID of the "Employer of" relationship type. */ - const EMPLOYER_RELATIONSHIP_TYPE_ID = 5; + public const EMPLOYER_RELATIONSHIP_TYPE_ID = 5; + + /** + * List of allowed product attributes. + */ + const ALLOWED_PRODUCT_ATTRIBUTES = [ + 'id', + 'name', + 'internal_id', + 'price', + 'count', + 'total_value', + ]; /** * @param array &$params @@ -40,23 +61,23 @@ class CRM_Twingle_Submission { * The Twingle profile to use for validation, defaults to the default * profile. * - * @throws \CiviCRM_API3_Exception + * @throws \CRM_Core_Exception * When invalid parameters have been submitted. */ - public static function validateSubmission(&$params, $profile = NULL) { - if (!$profile) { + public static function validateSubmission(&$params, $profile = NULL): void { + if (!isset($profile)) { $profile = CRM_Twingle_Profile::createDefaultProfile(); } // Validate donation rhythm. - if (!in_array($params['donation_rhythm'], array( + if (!in_array($params['donation_rhythm'], [ 'one_time', 'halfyearly', 'quarterly', 'yearly', 'monthly', - ))) { - throw new CiviCRM_API3_Exception( + ], TRUE)) { + throw new CRM_Core_Exception( E::ts('Invalid donation rhythm.'), 'invalid_format' ); @@ -64,8 +85,9 @@ class CRM_Twingle_Submission { // Get the payment instrument defined within the profile, or return an error // if none matches (i.e. an unknown payment method was submitted). - if (!$payment_instrument_id = $profile->getAttribute('pi_' . $params['payment_method'])) { - throw new CiviCRM_API3_Exception( + $payment_instrument_id = $profile->getAttribute('pi_' . $params['payment_method'], ''); + if ('' === $payment_instrument_id) { + throw new CRM_Core_Exception( E::ts('Payment method could not be matched to existing payment instrument.'), 'invalid_format' ); @@ -73,16 +95,16 @@ class CRM_Twingle_Submission { $params['payment_instrument_id'] = $payment_instrument_id; // Validate date for parameter "confirmed_at". - if (!DateTime::createFromFormat('YmdHis', $params['confirmed_at'])) { - throw new CiviCRM_API3_Exception( + if (FALSE === DateTime::createFromFormat('YmdHis', $params['confirmed_at'])) { + throw new CRM_Core_Exception( E::ts('Invalid date for parameter "confirmed_at".'), 'invalid_format' ); } // Validate date for parameter "user_birthdate". - if (!empty($params['user_birthdate']) && !DateTime::createFromFormat('Ymd', $params['user_birthdate'])) { - throw new CiviCRM_API3_Exception( + if (!empty($params['user_birthdate']) && FALSE === DateTime::createFromFormat('Ymd', $params['user_birthdate'])) { + throw new CRM_Core_Exception( E::ts('Invalid date for parameter "user_birthdate".'), 'invalid_format' ); @@ -90,15 +112,70 @@ class CRM_Twingle_Submission { // Get the gender ID defined within the profile, or return an error if none // matches (i.e. an unknown gender was submitted). - if (!empty($params['user_gender'])) { - if (!$gender_id = $profile->getAttribute('gender_' . $params['user_gender'])) { - throw new CiviCRM_API3_Exception( + if (is_string($params['user_gender'])) { + $gender_id = $profile->getAttribute('gender_' . $params['user_gender']); + if (!is_numeric($gender_id)) { + throw new CRM_Core_Exception( E::ts('Gender could not be matched to existing gender.'), 'invalid_format' ); } $params['gender_id'] = $gender_id; } + + // Validate custom fields parameter, if given. + if (isset($params['custom_fields'])) { + if (is_string($params['custom_fields'])) { + $params['custom_fields'] = json_decode($params['custom_fields'], TRUE); + } + if (!is_array($params['custom_fields'])) { + throw new CRM_Core_Exception( + E::ts('Invalid format for custom fields.'), + 'invalid_format' + ); + } + } + + // Validate products + if (!empty($params['products']) && $profile->isShopEnabled()) { + if (is_string($params['products'])) { + $products = json_decode($params['products'], TRUE); + $params['products'] = array_map(function ($product) { + return array_intersect_key($product, array_flip(self::ALLOWED_PRODUCT_ATTRIBUTES)); + }, $products); + } + if (!is_array($params['products'])) { + throw new CiviCRM_API3_Exception( + E::ts('Invalid format for products.'), + 'invalid_format' + ); + } + } + + // Validate campaign_id, if given. + if (isset($params['campaign_id'])) { + // Check whether campaign_id is a numeric string and cast it to an integer. + if (is_numeric($params['campaign_id'])) { + $params['campaign_id'] = intval($params['campaign_id']); + } + else { + throw new CRM_Core_Exception( + E::ts('campaign_id must be a numeric string. '), + 'invalid_format' + ); + } + // Check whether given campaign_id exists and if not, unset the parameter. + try { + civicrm_api3( + 'Campaign', + 'getsingle', + ['id' => $params['campaign_id']] + ); + } + catch (CRM_Core_Exception $e) { + unset($params['campaign_id']); + } + } } /** @@ -107,23 +184,41 @@ class CRM_Twingle_Submission { * * @param string $contact_type * The contact type to look for/to create. - * @param array $contact_data + * @param array $contact_data * Data to use for contact lookup/to create a contact with. + * @param CRM_Twingle_Profile $profile + * Profile used for this process + * @param array $submission + * Submission data * - * @return int | NULL + * @return int|NULL * The ID of the matching/created contact, or NULL if no matching contact * was found and no new contact could be created. - * @throws \CiviCRM_API3_Exception + * @throws \CRM_Core_Exception * When invalid data was given. */ - public static function getContact($contact_type, $contact_data) { + public static function getContact( + string $contact_type, + array $contact_data, + CRM_Twingle_Profile $profile, + array $submission = [] + ) { // If no parameters are given, do nothing. - if (empty($contact_data)) { + if ([] === $contact_data) { return NULL; } + // add xcm profile + $xcm_profile = $profile->getAttribute('xcm_profile'); + if (isset($xcm_profile) && '' !== $xcm_profile) { + $contact_data['xcm_profile'] = $xcm_profile; + } + + // add campaign, see issue #17 + CRM_Twingle_Submission::setCampaign($contact_data, 'contact', $submission, $profile); + // Prepare values: country. - if (!empty($contact_data['country'])) { + if (isset($contact_data['country'])) { if (is_numeric($contact_data['country'])) { // If a country ID is given, update the parameters. $contact_data['country_id'] = $contact_data['country']; @@ -131,65 +226,71 @@ class CRM_Twingle_Submission { } else { // Look up the country depending on the given ISO code. - $country = civicrm_api3('Country', 'get', array('iso_code' => $contact_data['country'])); - if (!empty($country['id'])) { + $country = civicrm_api3('Country', 'get', ['iso_code' => $contact_data['country']]); + if (isset($country['id'])) { $contact_data['country_id'] = $country['id']; unset($contact_data['country']); } else { - throw new \CiviCRM_API3_Exception( - E::ts('Unknown country %1.', array(1 => $contact_data['country'])), + throw new \CRM_Core_Exception( + E::ts('Unknown country %1.', [1 => $contact_data['country']]), 'invalid_format' ); } } } + // Prepare values: language. + if (is_string($contact_data['preferred_language']) && '' !== $contact_data['preferred_language']) { + $mapping = CRM_Core_I18n_PseudoConstant::longForShortMapping(); + // Override the default mapping for German. + $mapping['de'] = 'de_DE'; + $contact_data['preferred_language'] = $mapping[$contact_data['preferred_language']]; + } + // Pass to XCM. $contact_data['contact_type'] = $contact_type; $contact = civicrm_api3('Contact', 'getorcreate', $contact_data); - if (empty($contact['id'])) { - return NULL; - } - return $contact['id']; + return isset($contact['id']) ? (int) $contact['id'] : NULL; } /** * Shares an organisation's work address, unless the contact already has one. * - * @param $contact_id + * @param int $contact_id * The ID of the contact to share the organisation address with. - * @param $organisation_id + * @param int $organisation_id * The ID of the organisation whose address to share with the contact. - * @param $location_type_id + * @param int $location_type_id * The ID of the location type to use for address lookup. * * @return boolean * Whether the organisation address has been shared with the contact. * - * @throws \CiviCRM_API3_Exception + * @throws \CRM_Core_Exception * When looking up or creating the shared address failed. */ - public static function shareWorkAddress($contact_id, $organisation_id, $location_type_id = self::LOCATION_TYPE_ID_WORK) { - if (empty($organisation_id)) { - // Only if organisation exists. - return FALSE; - } - + public static function shareWorkAddress( + int $contact_id, + int $organisation_id, + int $location_type_id = self::LOCATION_TYPE_ID_WORK + ) { // Check whether organisation has a WORK address. - $existing_org_addresses = civicrm_api3('Address', 'get', array( + $existing_org_addresses = civicrm_api3('Address', 'get', [ 'contact_id' => $organisation_id, - 'location_type_id' => $location_type_id)); + 'location_type_id' => $location_type_id, + ]); if ($existing_org_addresses['count'] <= 0) { // Organisation does not have a WORK address. return FALSE; } // Check whether contact already has a WORK address. - $existing_contact_addresses = civicrm_api3('Address', 'get', array( + $existing_contact_addresses = civicrm_api3('Address', 'get', [ 'contact_id' => $contact_id, - 'location_type_id' => $location_type_id)); + 'location_type_id' => $location_type_id, + ]); if ($existing_contact_addresses['count'] > 0) { // Contact already has a WORK address. return FALSE; @@ -213,29 +314,25 @@ class CRM_Twingle_Submission { * @param int $organisation_id * The ID of the employer contact. * - * @throws \CiviCRM_API3_Exception + * @throws \CRM_Core_Exception */ - public static function updateEmployerRelation($contact_id, $organisation_id) { - if (empty($contact_id) || empty($organisation_id)) { - return; - } - + public static function updateEmployerRelation(int $contact_id, int $organisation_id): void { // see if there is already one - $existing_relationship = civicrm_api3('Relationship', 'get', array( + $existing_relationship = civicrm_api3('Relationship', 'get', [ 'relationship_type_id' => self::EMPLOYER_RELATIONSHIP_TYPE_ID, 'contact_id_a' => $contact_id, 'contact_id_b' => $organisation_id, 'is_active' => 1, - )); + ]); if ($existing_relationship['count'] == 0) { // There is currently no (active) relationship between these contacts. - $new_relationship_data = array( + $new_relationship_data = [ 'relationship_type_id' => self::EMPLOYER_RELATIONSHIP_TYPE_ID, 'contact_id_a' => $contact_id, 'contact_id_b' => $organisation_id, 'is_active' => 1, - ); + ]; civicrm_api3('Relationship', 'create', $new_relationship_data); } @@ -246,19 +343,15 @@ class CRM_Twingle_Submission { * functionality is activated within the Twingle extension settings. * * @return bool - * @throws \CiviCRM_API3_Exception + * @throws \CRM_Core_Exception */ public static function civiSepaEnabled() { - $sepa_extension = civicrm_api3('Extension', 'get', array( + $sepa_extension = civicrm_api3('Extension', 'get', [ 'full_name' => 'org.project60.sepa', 'is_active' => 1, - )); - return - CRM_Core_BAO_Setting::getItem( - 'de.systopia.twingle', - 'twingle_use_sepa' - ) - && $sepa_extension['count']; + ]); + return (bool) Civi::settings()->get('twingle_use_sepa') + && $sepa_extension['count'] >= 0; } /** @@ -269,30 +362,30 @@ class CRM_Twingle_Submission { * The submitted "donation_rhythm" paramter according to the API action * specification. * - * @return array + * @return array{'frequency_unit'?: string, 'frequency_interval'?: int} * An array with "frequency_unit" and "frequency_interval" keys, to be added * to contribution parameter arrays. */ public static function getFrequencyMapping($donation_rhythm) { - $mapping = array( - 'halfyearly' => array( + $mapping = [ + 'halfyearly' => [ 'frequency_unit' => 'month', 'frequency_interval' => 6, - ), - 'quarterly' => array( + ], + 'quarterly' => [ 'frequency_unit' => 'month', 'frequency_interval' => 3, - ), - 'yearly' => array( + ], + 'yearly' => [ 'frequency_unit' => 'month', 'frequency_interval' => 12, - ), - 'monthly' => array( + ], + 'monthly' => [ 'frequency_unit' => 'month', 'frequency_interval' => 1, - ), - 'one_time' => array(), - ); + ], + 'one_time' => [], + ]; return $mapping[$donation_rhythm]; } @@ -310,19 +403,190 @@ class CRM_Twingle_Submission { * @return int * The next possible day of this or the next month to start collecting. */ - public static function getSEPACycleDay($start_date, $creditor_id) { - $buffer_days = (int) CRM_Sepa_Logic_Settings::getSetting("pp_buffer_days"); - $frst_notice_days = (int) CRM_Sepa_Logic_Settings::getSetting("batching.FRST.notice", $creditor_id); - $earliest_rcur_date = strtotime("$start_date + $frst_notice_days days + $buffer_days days"); - - // Find the next cycle day - $cycle_days = CRM_Sepa_Logic_Settings::getListSetting("cycledays", range(1, 28), $creditor_id); - $earliest_cycle_day = $earliest_rcur_date; - while (!in_array(date('j', $earliest_cycle_day), $cycle_days)) { - $earliest_cycle_day = strtotime("+ 1 day", $earliest_cycle_day); + public static function getSEPACycleDay($start_date, $creditor_id): int { + $buffer_days = (int) CRM_Sepa_Logic_Settings::getSetting('pp_buffer_days'); + $frst_notice_days = (int) CRM_Sepa_Logic_Settings::getSetting('batching.FRST.notice', $creditor_id); + if (FALSE === ($earliest_rcur_date = strtotime("$start_date + $frst_notice_days days + $buffer_days days"))) { + throw new BaseException(E::ts('Could not calculate SEPA cycle day from configuration.')); } - return date('j', $earliest_cycle_day); + // Find the next cycle day + $cycle_days = CRM_Sepa_Logic_Settings::getListSetting('cycledays', range(1, 28), $creditor_id); + $earliest_cycle_day = $earliest_rcur_date; + while (!in_array(date('j', $earliest_cycle_day), $cycle_days, TRUE)) { + $earliest_cycle_day = strtotime('+ 1 day', $earliest_cycle_day); + } + + return (int) date('j', $earliest_cycle_day); } + /** + * Will set the campaign_id to the entity_data set, if the + * profile is configured to do so. In that case the campaign is taken + * from the submission data. Should that be empty, the profile's default + * campaign is used. + * + * @param array $entity_data + * the data set where the campaign_id should be set + * @param string $context + * defines the type of the entity_data: one of 'contribution', 'membership','mandate', 'recurring', 'contact' + * @param array $submission + * the submitted data + * @param CRM_Twingle_Profile $profile + * the twingle profile used + */ + public static function setCampaign( + array &$entity_data, + string $context, + array $submission, + CRM_Twingle_Profile $profile + ): void { + // first: make sure it's not set from other workflows + unset($entity_data['campaign_id']); + + // then: check if campaign should be set it this context + $enabled_contexts = $profile->getAttribute('campaign_targets'); + if ($enabled_contexts === NULL || !is_array($enabled_contexts)) { + // backward compatibility: + $enabled_contexts = ['contribution', 'contact']; + } + if (in_array($context, $enabled_contexts, TRUE)) { + // use the submitted campaign if set + if (is_numeric($submission['campaign_id'])) { + $entity_data['campaign_id'] = $submission['campaign_id']; + } + // otherwise use the profile's + elseif (is_numeric($campaign = $profile->getAttribute('campaign'))) { + $entity_data['campaign_id'] = $campaign; + } + } + } + + /** + * @param $values + * Processed data + * @param $submission + * Submission data + * @param $profile + * The twingle profile used + * + * @throws \CiviCRM_API3_Exception + * @throws \CRM_Core_Exception + * @throws \Civi\Twingle\Shop\Exceptions\LineItemException + */ + public static function createLineItems($values, $submission, $profile): array { + $line_items = []; + $sum_line_items = 0; + + $contribution_id = $values['contribution']['id']; + if (empty($contribution_id)) { + throw new LineItemException( + "Could not find contribution id for line item assignment.", + LineItemException::ERROR_CODE_CONTRIBUTION_NOT_FOUND + ); + } + + foreach ($submission['products'] as $product) { + + $line_item_data = [ + 'entity_table' => "civicrm_contribution", + 'contribution_id' => $contribution_id, + 'entity_id' => $contribution_id, + 'label' => $product['name'], + 'qty' => $product['count'], + 'unit_price' => $product['price'], + 'line_total' => $product['total_value'], + 'sequential' => 1, + ]; + + // Try to find the TwingleProduct with its corresponding PriceField + // for this product + try { + $price_field = CRM_Twingle_BAO_TwingleProduct::findByExternalId($product['id']); + } + catch (Exception $e) { + Civi::log()->error(E::LONG_NAME . + ": An error occurred when searching for TwingleShop with the external ID " . + $product['id'], ['exception' => $e]); + $price_field = NULL; + } + // If found, use the financial type and price field id from the price field + if ($price_field) { + + // Log warning if price is not variable and differs from the submission + if ($price_field->price !== Null && $price_field->price != (int) $product['price']) { + Civi::log()->warning(E::LONG_NAME . + ": Price for product " . $product['name'] . " differs from the PriceField. " . + "Using the price from the submission.", ['price_field' => $price_field->price, 'submission' => $product['price']]); + } + + // Log warning if name differs from the submission + if ($price_field->name != $product['name']) { + Civi::log()->warning(E::LONG_NAME . + ": Name for product " . $product['name'] . " differs from the PriceField " . + "Using the name from the submission.", ['price_field' => $price_field->name, 'submission' => $product['name']]); + } + + // Set the financial type and price field id + $line_item_data['financial_type_id'] = $price_field->financial_type_id; + $line_item_data['price_field_value_id'] = $price_field->getPriceFieldValueId(); + $line_item_data['price_field_id'] = $price_field->price_field_id; + $line_item_data['description'] = $price_field->description; + } + // If not found, use the shops default financial type + else { + $financial_type_id = $profile->getAttribute('shop_financial_type', 1); + $line_item_data['financial_type_id'] = $financial_type_id; + } + + // Create the line item + $line_item = civicrm_api3('LineItem', 'create', $line_item_data); + + if (!empty($line_item['is_error'])) { + $line_item_name = $line_item_data['name']; + throw new CiviCRM_API3_Exception( + E::ts("Could not create line item for product '%1'", [1 => $line_item_name]), + 'api_error' + ); + } + $line_items[] = array_pop($line_item['values']); + + $sum_line_items += $product['total_value']; + } + + // Create line item for donation part + $donation_sum = (float) $values['contribution']['total_amount'] - $sum_line_items; + if ($donation_sum > 0) { + $donation_financial_type_id = $profile->getAttribute('shop_donation_financial_type', 1); + $donation_label = civicrm_api3('FinancialType', 'getsingle', [ + 'return' => ['name'], + 'id' => $donation_financial_type_id, + ])['name']; + + $donation_line_item_data = [ + 'entity_table' => "civicrm_contribution", + 'contribution_id' => $contribution_id, + 'entity_id' => $contribution_id, + 'label' => $donation_label, + 'qty' => 1, + 'unit_price' => $donation_sum, + 'line_total' => $donation_sum, + 'financial_type_id' => $donation_financial_type_id, + 'sequential' => 1, + ]; + + $donation_line_item = civicrm_api3('LineItem', 'create', $donation_line_item_data); + + if (!empty($donation_line_item['is_error'])) { + throw new CiviCRM_API3_Exception( + E::ts("Could not create line item for donation"), + 'api_error' + ); + } + + $line_items[] = array_pop($donation_line_item['values']); + } + + return $line_items; + } } diff --git a/CRM/Twingle/Tools.php b/CRM/Twingle/Tools.php new file mode 100644 index 0000000..e2abc92 --- /dev/null +++ b/CRM/Twingle/Tools.php @@ -0,0 +1,254 @@ + $change + * @throws Exception if the change is not allowed + */ + public static function checkRecurringContributionChange(int $recurring_contribution_id, array $change): void { + // check if a change to the status is planned + if (empty($change['contribution_status_id'])) { + return; + } + + // check if the target status is not closed + if (in_array($change['contribution_status_id'], [2, 5])) { + return; + } + + // check if we're suspended + if (self::$protection_suspended) { + return; + } + + // check if protection is turned on + $protection_on = Civi::settings()->get('twingle_protect_recurring'); + if (empty($protection_on)) { + return; + } + + // load the recurring contribution + $recurring_contribution = civicrm_api3('ContributionRecur', 'getsingle', [ + 'return' => 'trxn_id,contribution_status_id,payment_instrument_id,contact_id', + 'id' => $recurring_contribution_id, + ]); + + // check if this is a SEPA transaction (doesn't concern us) + if (self::isSDD($recurring_contribution['payment_instrument_id'])) { + return; + } + + // see if this recurring contribution is from Twingle + if (!self::isTwingleRecurringContribution($recurring_contribution_id, $recurring_contribution)) { + return; + } + + // check if it's really a termination (i.e. current status is 2 or 5) + if (!in_array($recurring_contribution['contribution_status_id'], [2, 5])) { + return; + } + + // this _IS_ on of the cases where we should step in: + CRM_Twingle_Tools::processRecurringContributionTermination( + $recurring_contribution_id, + $recurring_contribution + ); + } + + /** + * @param $recurring_contribution_id int recurring contribution ID to check + * @param $recurring_contribution array recurring contribution data, optional + * @return bool|null true, false or null if can't be determined + * @throws \CRM_Core_Exception + */ + public static function isTwingleRecurringContribution($recurring_contribution_id, $recurring_contribution = NULL) { + // this currently only works with prefixes + $prefix = Civi::settings()->get('twingle_prefix'); + if (empty($prefix)) { + return NULL; + } + + // load recurring contribution if necessary + if (empty($recurring_contribution['trxn_id'])) { + $recurring_contribution = civicrm_api3('ContributionRecur', 'getsingle', ['id' => $recurring_contribution_id]); + } + + // check if it's a Twingle contribution by checking the prefix + // fixme: better ways (e.g. tags) should be used to mark twingle contributions + return (substr($recurring_contribution['trxn_id'], 0, strlen($prefix)) == $prefix); + } + + /** + * Execute the recurring contribution protection + * + * @param int $recurring_contribution_id + * Recurring contribution ID. + * @param array $recurring_contribution + * Recurring contribution fields. + * @throws Exception could be one of the measures + */ + public static function processRecurringContributionTermination( + int $recurring_contribution_id, + array $recurring_contribution + ) { + // check if we're suspended + if (self::$protection_suspended) { + return; + } + + $protection_mode = Civi::settings()->get('twingle_protect_recurring'); + switch ($protection_mode) { + case CRM_Twingle_Config::RCUR_PROTECTION_OFF: + // do nothing + break; + + case CRM_Twingle_Config::RCUR_PROTECTION_EXCEPTION: + // phpcs:disable Generic.Files.LineLength.TooLong + throw new BaseException(E::ts( + 'This is a Twingle recurring contribution. It should be terminated through the Twingle interface, otherwise it will still be collected.' + )); + + // phpcs:enable + + case CRM_Twingle_Config::RCUR_PROTECTION_ACTIVITY: + // create contact source activity + // first: get the contact ID + if (!empty($recurring_contribution['contact_id'])) { + $target_id = (int) $recurring_contribution['contact_id']; + } + else { + $target_id = (int) civicrm_api3('ContributionRecur', 'getvalue', [ + 'id' => $recurring_contribution_id, + 'return' => 'contact_id', + ]); + } + if (!empty($recurring_contribution['trxn_id'])) { + $trxn_id = $recurring_contribution['trxn_id']; + } + else { + $trxn_id = civicrm_api3('ContributionRecur', 'getvalue', [ + 'id' => $recurring_contribution_id, + 'return' => 'trxn_id', + ]); + } + + try { + civicrm_api3('Activity', 'create', [ + 'activity_type_id' => Civi::settings()->get('twingle_protect_recurring_activity_type'), + 'subject' => Civi::settings()->get('twingle_protect_recurring_activity_subject'), + 'activity_date_time' => date('YmdHis'), + 'target_id' => $target_id, + 'assignee_id' => Civi::settings()->get('twingle_protect_recurring_activity_assignee'), + 'status_id' => Civi::settings()->get('twingle_protect_recurring_activity_status'), + // phpcs:disable Generic.Files.LineLength.TooLong + 'details' => E::ts( + "Recurring contribution [%1] (Transaction ID '%2') was terminated by a user. You need to end the corresponding record in Twingle as well, or it will still be collected.", + [1 => $recurring_contribution_id, 2 => $trxn_id] + ), + // phpcs:enable + 'source_contact_id' => CRM_Core_Session::getLoggedInContactID(), + ]); + } + catch (Exception $ex) { + Civi::log()->warning("TwingleAPI: Couldn't create recurring protection activity: " . $ex->getMessage()); + } + break; + + default: + Civi::log()->warning("TwingleAPI: Unknown recurring contribution protection mode: '{$protection_mode}'"); + break; + } + } + + /** + * Check if the given payment instrument is SEPA + * + * @param string $payment_instrument_id + * @return boolean + */ + public static function isSDD(string $payment_instrument_id) { + static $sepa_payment_instruments = NULL; + if ($sepa_payment_instruments === NULL) { + // init with instrument names + $sepa_payment_instruments = ['FRST', 'RCUR', 'OOFF']; + + // lookup and add instrument IDs + $lookup = civicrm_api3('OptionValue', 'get', [ + 'option_group_id' => 'payment_instrument', + 'name' => ['IN' => $sepa_payment_instruments], + 'return' => 'value', + ]); + foreach ($lookup['values'] as $payment_instrument) { + $sepa_payment_instruments[] = $payment_instrument['value']; + } + } + return in_array($payment_instrument_id, $sepa_payment_instruments); + } + + /** + * Get a CiviSEPA mandate for the given contribution ID + * + * @param int $contribution_id contribution ID *or* recurring contribution ID + * @return array|null mandate or null + */ + public static function getMandateFor(int $contribution_id): ?array { + if ($contribution_id) { + try { + // try recurring mandate + $rcur_mandate = civicrm_api3('SepaMandate', 'get', [ + 'entity_id' => $contribution_id, + 'entity_table' => 'civicrm_contribution_recur', + 'type' => 'RCUR', + ]); + if ($rcur_mandate['count'] == 1) { + return reset($rcur_mandate['values']); + } + + // try OOFF mandate + // try recurring mandate + $ooff_mandate = civicrm_api3('SepaMandate', 'get', [ + 'entity_id' => $contribution_id, + 'entity_table' => 'civicrm_contribution', + 'type' => 'OOFF', + ]); + if ($ooff_mandate['count'] == 1) { + return reset($ooff_mandate['values']); + } + } + catch (Exception $ex) { + Civi::log()->warning("CRM_Twingle_Tools::getMandate failed for [{$contribution_id}]: " . $ex->getMessage()); + } + } + return NULL; + } + +} diff --git a/CRM/Twingle/Upgrader.php b/CRM/Twingle/Upgrader.php new file mode 100644 index 0000000..aa80b58 --- /dev/null +++ b/CRM/Twingle/Upgrader.php @@ -0,0 +1,151 @@ +executeSqlFile('sql/civicrm_twingle_profile.sql'); + + // add a default profile + CRM_Twingle_Profile::createDefaultProfile()->saveProfile(); + } + + /** + * Example: Run an external SQL script when the module is uninstalled. + * + * public function uninstall() { + * $this->executeSqlFile('sql/myuninstall.sql'); + * } + * + * /** + * Copy financial_type_id setting to new setting financial_type_id_recur. + */ + public function upgrade_4000(): bool { + $this->ctx->log->info('Applying update 4000: Copying Financial type to new setting Financial type (recurring).'); + foreach (CRM_Twingle_Profile::getProfiles() as $profile) { + $profile->setAttribute('financial_type_id_recur', $profile->getAttribute('financial_type_id')); + $profile->saveProfile(); + } + return TRUE; + } + + /** + * Convert serialized settings from objects to arrays. + * + * @link https://civicrm.org/advisory/civi-sa-2019-21-poi-saved-search-and-report-instance-apis + */ + public function upgrade_5011(): bool { + // Do not use CRM_Core_BAO::getItem() or Civi::settings()->get(). + // Extract and unserialize directly from the database. + $twingle_profiles_query = CRM_Core_DAO::executeQuery(" + SELECT `value` + FROM `civicrm_setting` + WHERE `name` = 'twingle_profiles';"); + if ($twingle_profiles_query->fetch()) { + $profiles = unserialize($twingle_profiles_query->value); + Civi::settings()->set('twingle_profiles', (array) $profiles); + } + + return TRUE; + } + + /** + * Upgrading to 1.4.0 needs to convert the profiles into the new infrastructure + * + * @return TRUE on success + * @throws Exception + */ + public function upgrade_5140(): bool { + $this->ctx->log->info('Converting twingle profiles.'); + + // create a DB table for the twingle profiles + $this->executeSqlFile('sql/civicrm_twingle_profile.sql'); + + // migrate the current profiles + if (is_array($profiles_data = Civi::settings()->get('twingle_profiles'))) { + foreach ($profiles_data as $profile_name => $profile_data) { + $profile = new CRM_Twingle_Profile($profile_name, $profile_data); + $data = json_encode($profile->getData()); + CRM_Core_DAO::executeQuery(<< [$profile_name, 'String'], + 2 => [$data, 'String'], + ]); + } + } + + return TRUE; + } + + /** + * Upgrade to 1.5.0 + * + * - Activate mapping of `purpose` and `user_extra_field` to notes in each existing profile to + * maintain default behavior after making the fields optional. + * + * @return bool + * @throws \Civi\Core\Exception\DBQueryException + * @throws \Civi\Twingle\Exceptions\ProfileException + */ + public function upgrade_5150(): bool { + $this->ctx->log->info('Activate mapping of `purpose` and `user_extra_field` to notes in each existing profile.'); + + foreach (CRM_Twingle_Profile::getProfiles() as $profile) { + $profile_changed = FALSE; + /** @phpstan-var array $contribution_notes */ + $contribution_notes = $profile->getAttribute('map_as_contribution_notes', []); + /** @phpstan-var array $contact_notes */ + $contact_notes = $profile->getAttribute('map_as_contact_notes', []); + if (!in_array('purpose', $contribution_notes, TRUE)) { + $profile->setAttribute('map_as_contribution_notes', array_merge($contribution_notes, ['purpose'])); + $profile_changed = TRUE; + } + if (!in_array('user_extrafield', $contact_notes, TRUE)) { + $profile->setAttribute('map_as_contact_notes', array_merge($contact_notes, ['user_extrafield'])); + $profile_changed = TRUE; + } + if ($profile_changed) { + $profile->saveProfile(); + } + } + + return TRUE; + } + + /** + * The Upgrade to 1.5.1 creates the tables civicrm_twingle_product and + * civicrm_twingle_shop. + * + * @return TRUE on success + */ + public function upgrade_5151() { + $this->ctx->log->info('Creating tables for Twingle Shop.'); + $this->executeSqlFile('sql/civicrm_twingle_shop.sql'); + return TRUE; + } +} diff --git a/Civi/Api4/TwingleProduct.php b/Civi/Api4/TwingleProduct.php new file mode 100644 index 0000000..839de01 --- /dev/null +++ b/Civi/Api4/TwingleProduct.php @@ -0,0 +1,12 @@ +. + */ + +declare(strict_types = 1); + +namespace Civi\Twingle\Exceptions; + +use CRM_Twingle_ExtensionUtil as E; + +/** + * A simple custom exception class that indicates a problem within a class + * of the Twingle API extension. + */ +class BaseException extends \Exception { + + /** + * @var int|string + */ + protected $code; + protected string $log_message; + + /** + * BaseException Constructor + * @param string $message + * Error message + * @param string $error_code + * A meaningful error code + */ + public function __construct(string $message = '', string $error_code = '') { + parent::__construct($message, 1); + $this->log_message = !empty($message) ? E::LONG_NAME . ': ' . $message : ''; + $this->code = $error_code; + } + + /** + * Returns the error message, but with the extension name prefixed. + * @return string + */ + public function getLogMessage() { + return $this->log_message; + } + + /** + * Returns the error code. + * @return string + */ + public function getErrorCode() { + return $this->code; + } + +} diff --git a/Civi/Twingle/Exceptions/ProfileException.php b/Civi/Twingle/Exceptions/ProfileException.php new file mode 100644 index 0000000..7581381 --- /dev/null +++ b/Civi/Twingle/Exceptions/ProfileException.php @@ -0,0 +1,35 @@ +. + */ + +declare(strict_types = 1); + +namespace Civi\Twingle\Exceptions; + +/** + * A simple custom exception that indicates a problem within the + * CRM_Twingle_Profile class + */ +class ProfileException extends BaseException { + + public const ERROR_CODE_PROFILE_NOT_FOUND = 'profile_not_found'; + public const ERROR_CODE_DEFAULT_PROFILE_NOT_FOUND = 'default_profile_not_found'; + public const ERROR_CODE_COULD_NOT_SAVE_PROFILE = 'could_not_save_profile'; + public const ERROR_CODE_COULD_NOT_RESET_PROFILE = 'could_not_reset_profile'; + public const ERROR_CODE_COULD_NOT_DELETE_PROFILE = 'could_not_delete_profile'; + public const ERROR_CODE_UNKNOWN_PROFILE_ATTRIBUTE = 'unknown_profile_attribute'; + +} diff --git a/Civi/Twingle/Exceptions/ProfileValidationError.php b/Civi/Twingle/Exceptions/ProfileValidationError.php new file mode 100644 index 0000000..da29705 --- /dev/null +++ b/Civi/Twingle/Exceptions/ProfileValidationError.php @@ -0,0 +1,54 @@ +. + */ + +declare(strict_types = 1); + +namespace Civi\Twingle\Exceptions; + +/** + * A simple custom error indicating a problem with the validation of the + * CRM_Twingle_Profile + */ +class ProfileValidationError extends BaseException { + + private string $affected_field_name; + public const ERROR_CODE_PROFILE_VALIDATION_FAILED = 'profile_validation_failed'; + public const ERROR_CODE_PROFILE_VALIDATION_WARNING = 'profile_validation_warning'; + + /** + * ProfileValidationError Constructor + * @param string $affected_field_name + * The name of the profile field which caused the exception + * @param string $message + * Error message + * @param string $error_code + * A meaningful error code + */ + public function __construct(string $affected_field_name, string $message = '', string $error_code = '') { + parent::__construct($message, $error_code); + $this->affected_field_name = $affected_field_name; + } + + /** + * Returns the name of the profile field that caused the exception. + * @return string + */ + public function getAffectedFieldName() { + return $this->affected_field_name; + } + +} diff --git a/Civi/Twingle/Shop/ApiCall.php b/Civi/Twingle/Shop/ApiCall.php new file mode 100644 index 0000000..d67c214 --- /dev/null +++ b/Civi/Twingle/Shop/ApiCall.php @@ -0,0 +1,269 @@ + + * @var string $apiToken + */ + private string $apiToken; + + /** + * The ID of your organization in the Twingle database. + * Automatically retrieved by sending a request with the associated API token. + * @var int $organisationId + */ + public int $organisationId; + + /** + * This boolean indicates whether the connection was successful. + * + * @var bool $isConnected + */ + public bool $isConnected; + + /** + * Limit the number of items requested per API call. + * @var int $limit + */ + public int $limit = 40; + + /** + * Header for cURL request. + * @var string[] $header + */ + private array $header; + + /** + * The cURL wrapper + * @var \Civi\Twingle\Shop\CurlWrapper $curlWrapper + */ + private CurlWrapper $curlWrapper; + + /** + * Protected TwingleApiCall constructor. + * Use \Civi\Twingle\ApiCall::singleton() instead. + * @param \Civi\Twingle\Shop\CurlWrapper $curlWrapper + */ + protected function __construct(CurlWrapper $curlWrapper) { + $this->curlWrapper = $curlWrapper; + $this->isConnected = FALSE; + } + + /** + * Returns \Civi\Twingle\Shop\ApiCall singleton + * + * @param \Civi\Twingle\Shop\CurlWrapper|null $curlWrapper + * Optional cURL wrapper for testing purposes + * @return \Civi\Twingle\Shop\ApiCall + */ + public static function singleton(CurlWrapper $curlWrapper = null): ApiCall { + if (empty(self::$singleton)) { + $curlWrapper = $curlWrapper ?? new CurlWrapper(); + self::$singleton = new ApiCall($curlWrapper); + return self::$singleton; + } + else { + return self::$singleton; + } + } + + /** + * Try to connect to the Twingle API and retrieve the organisation ID. + * + * @return bool + * returns TRUE if the connection was successfully established + * + * @throws \Civi\Twingle\Shop\Exceptions\ApiCallError + */ + public function connect(): bool { + + $this->isConnected = FALSE; + + try { + // Get api token from settings + $apiToken = \Civi::settings()->get("twingle_access_key"); + if (empty($apiToken)) { + throw new \TypeError(); + } + $this->apiToken = $apiToken; + } catch (\TypeError $e) { + throw new ApiCallError( + E::ts("Could not find Twingle API token"), + ApiCallError::ERROR_CODE_API_TOKEN_MISSING, + ); + } + + $this->header = [ + "x-access-code: $this->apiToken", + 'Content-Type: application/json', + ]; + + $url = self::PROTOCOL . 'organisation' . self::BASE_URL . "/"; + $curl = curl_init($url); + curl_setopt($curl, CURLOPT_RETURNTRANSFER, TRUE); + curl_setopt($curl, CURLOPT_HTTPHEADER, $this->header); + + $response = json_decode(curl_exec($curl), TRUE); + + if (empty($response)) { + curl_close($curl); + throw new ApiCallError( + E::ts("Call to Twingle API failed. Please check your api token."), + ApiCallError::ERROR_CODE_CONNECTION_FAILED, + ); + } + self::check_response_and_close($response, $curl); + + $this->organisationId = array_column($response, 'id')[0]; + $this->isConnected = TRUE; + return $this->isConnected; + } + + /** + * Check response on cURL + * + * @param $response + * the cURL response to check + * @param $curl + * the cURL resource + * + * @return bool + * returns true if the response is fine + * + * @throws \Civi\Twingle\Shop\Exceptions\ApiCallError + */ + protected static function check_response_and_close($response, $curl) { + + $curl_status_code = curl_getinfo($curl, CURLINFO_HTTP_CODE); + curl_close($curl); + + if ($response == FALSE) { + throw new ApiCallError( + E::ts('GET curl failed'), + ApiCallError::ERROR_CODE_GET_REQUEST_FAILED, + ); + } + if ($curl_status_code == 404) { + throw new ApiCallError( + E::ts('http status code 404 (not found)'), + ApiCallError::ERROR_CODE_404, + ); + } + elseif ($curl_status_code == 500) { + throw new ApiCallError( + E::ts('https status code 500 (internal error)'), + ApiCallError::ERROR_CODE_500, + ); + } + + return TRUE; + } + + /** + * Sends a GET cURL and returns the result array. + * + * @param $entity + * Twingle entity + * + * @param null $params + * Optional GET parameters + * + * @return array + * Returns the result array of the or FALSE, if the cURL failed + * @throws \Civi\Twingle\Shop\Exceptions\ApiCallError + */ + public function get( + string $entity, + string $entityId = NULL, + string $endpoint = NULL, + string $endpointId = NULL, + array $params = NULL + ): array { + + // Throw an error, if connection is not yet established + if ($this->isConnected == FALSE) { + throw new ApiCallError( + E::ts("Connection not yet established. Use connect() method."), + ApiCallError::ERROR_CODE_NOT_CONNECTED, + ); + } + + // Build URL and initialize cURL + $url = self::PROTOCOL . $entity . self::BASE_URL; + if (!empty($entityId)) { + $url .= "/$entityId"; + } + if (!empty($endpoint)) { + $url .= "/$endpoint"; + } + if (!empty($endpointId)) { + $url .= "/$endpointId"; + } + if (!empty($params)) { + $url .= '?' . http_build_query($params); + } + $curl = curl_init($url); + curl_setopt($curl, CURLOPT_RETURNTRANSFER, TRUE); + curl_setopt($curl, CURLOPT_HTTPHEADER, $this->header); + + // Execute cURL + $response = json_decode(curl_exec($curl), TRUE); + self::check_response_and_close($response, $curl); + + return $response; + } +} + +/** + * A simple wrapper for the cURL functions to allow for easier testing. + */ +class CurlWrapper { + public function init($url) { + return curl_init($url); + } + + public function setopt($ch, $option, $value) { + return curl_setopt($ch, $option, $value); + } + + public function exec($ch) { + return curl_exec($ch); + } + + public function getinfo($ch, $option) { + return curl_getinfo($ch, $option); + } + + public function close($ch) { + curl_close($ch); + } +} diff --git a/Civi/Twingle/Shop/Exceptions/ApiCallError.php b/Civi/Twingle/Shop/Exceptions/ApiCallError.php new file mode 100644 index 0000000..7d611ca --- /dev/null +++ b/Civi/Twingle/Shop/Exceptions/ApiCallError.php @@ -0,0 +1,19 @@ + $value) { + // Skip empty values + if (empty($value)) { + continue; + } + + // Find expected data type + $expected_data_type = strtolower(\CRM_Utils_Type::typeToString($allowed_attributes[$key])); // It could be so easy... + + // Validate data type + if (!\CRM_Utils_Type::validatePhpType($value, $expected_data_type)) { + $given_type = gettype($value); + throw new \Exception( + "Data type of attribute '$key' is $given_type, but $expected_data_type was expected." + ); + } + } +} + diff --git a/README.md b/README.md index 47d6cb6..b731fba 100644 --- a/README.md +++ b/README.md @@ -1,134 +1,15 @@ # Twingle API -Extension to connect to the Twingle fundraising service via its API. +This extension integrates [Twingle donation and membership forms](https://www.twingle.de/) with CiviCRM. -* [About Twingle](https://www.twingle.de/) +You can read the full documentation, including installation and configuration instructions and API specification, [here](https://docs.civicrm.org/twingle/en/latest/). -The extension is licensed under -[AGPL-3.0](https://github.com/systopia/de.systopia.twingle/blob/master/LICENSE.txt). +## We need your support +This CiviCRM extension is provided as Free and Open Source Software, +and we are happy if you find it useful. However, we have put a lot of work into it +(and continue to do so), much of it unpaid for. So if you benefit from our software, +please consider making a financial contribution so we can continue to maintain and develop it further. -## Configuration - -### Configure Twingle - -*This section is yet to be completed.* - -### Configure CiviCRM - -- Go to the Administration console `/civicrm/admin` -- Open "Twingle API Configuration" at `/civicrm/admin/settings/twingle` - -#### Configure CiviSEPA integration - -Open "Configure extension settings" at -`/civicrm/admin/settings/twingle/settings` and configure whether to integrate -with the [CiviSEPA](https://github.com/project60/org.project60.sepa) extension. - -This enables you to map incoming donations from Twingle with a specific payment -method (e.g. *debit_manual*) to be processed with CiviSEPA, that is, creating a -SEPA mandate and managing recurring payments. - -#### Configure profiles - -Open "Configure profiles" at `/civicrm/admin/settings/twingle/profiles`. - -The *default* profile is used whenever the plugin cannot match the Twingle -project ID from any other profile. Therefore the default profile will be used -for all newly created Twingle projects. - -| Label | Description | -|----------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------| -| Profile name | Internal name, used inside the extension. | -| Project IDs | Twingle project IDs. Separate multiple IDs with commas. | -| Location type | Specify how the address data sent by the form should be categorised in CiviCRM. The list is based on your CiviCRM configuration. | -| Financial type | Specify which financial type incoming donations should be recorded with in CiviCRM. The list is based on your CiviCRM configuration. | -| Gender options | Specify which CiviCRM gender option the incoming Twingle gender value should be mapped to. The list is based on your CiviCRM configuration. | -| Record *Payment method* as | Specifiy the payment methods mapping for incoming donations for each Twingle payment method. | -| CiviSEPA creditor | When enabled to integrate with CiviSEPA, specify the CiviSEPA creditor to use. | -| Sign up for groups | Whenever the donor checked the newsletter/postal mailing/donation receipt checkbox on the Twingle form, the contact will be added to the groups listed here. | - - -## API documentation - -The extension provides a new CiviCRM API entity `TwingleDonation` with API -actions to record a new donation, end a previously submitted recurring donation -and cancel previously submitted donation. - -### Submit donation - -This API action processes submitted Twingle donations and donor information. - -- Entity: `TwingleDonation` -- Action: `Submit` - -The action accepts the following parameters: - -| Parameter | Type | Description | Values/Format | Required | -|----------------------------------------|---------|-------------------------------------------------------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------------------------------------------------------------| -| `project_id` | String | The Twingle project ID | | Yes | -| `trx_id` | String | The unique transaction ID of the donation | A unique transaction ID for the donation. | Yes | -| `confirmed_at` | String | The date when the donation was issued | A string representing a date in the format `YmdHis` | Yes | -| `purpose` | String | The purpose of the donation | | | -| `amount` | Integer | The donation amount in minor currency unit | | Yes | -| `currency` | String | The ISO-4217 currency code of the donation | A valid ISO-4217 currency code | Yes | -| `newsletter` | Boolean | Whether to subscribe the contact to the newsletter group defined in the profile | | | -| `postinfo` | Boolean | Whether to subscribe the contact to the postal mailing group defined in the profile | | | -| `donation_receipt` | Boolean | Whether the contact requested a donation receipt | | | -| `payment_method` | String | The Twingle payment method used for the donation | One of:
  • `banktransfer`
  • `debit_manual`
  • `debit_automatic`
  • `creditcard`
  • `mobilephone_germany`
  • `paypal`
  • `sofortueberweisung`
  • `amazonpay`
  • `paydirekt`
  • `applepay`
  • `googlepay`
| Yes | -| `donation_rhythm` | String | The interval which the donation is recurring in | One of:
  • `'one_time',`
  • `'halfyearly',`
  • `'quarterly',`
  • `'yearly',`
  • `'monthly'`
| Yes | -| `debit_iban` | String | The IBAN for SEPA Direct Debit payments | A valid ISO 13616-1:2007 IBAN | Yes, if `payment_method` is `debit_manual` and CiviSEPA is used | -| `debit_bic` | String | The BIC for SEPA Direct Debit payments | A valid ISO 9362 BIC | Yes, if `payment_method` is `debit_manual` and CiviSEPA is used | -| `debit_mandate_reference` | String | The mandate reference for SEPA Direct Debit payments | | | -| `debit_account_holder` | String | The account holder for SEPA Direct Debit payments | | | -| `is_anonymous` | Boolean | Whether the donation is submitted anonymously | | | -| `user_gender` | String | The gender of the contact | | | -| `user_birthdate` | String | The date of birth of the contact | A string representing a date in the format `Ymd` | | -| `user_title` | String | The formal title of the contact | | | -| `user_email` | String | The e-mail address of the contact | A valid e-mail address | | -| `user_firstname` | String | The first name of the contact | | | -| `user_lastname` | String | The last name of the contact | | | -| `user_street` | String | The street address of the contact | | | -| `user_postal_code` | String | The postal code of the contact | | | -| `user_city` | String | The city of the contact | | | -| `user_telephone` | String | The telephone number of the contact | | | -| `user_company` | String | The company of the contact | | | -| `user_extrafield` | String | Additional information of the contact | | | - -You may also refer to -[the code](https://github.com/systopia/de.systopia.twingle/blob/master/api/v3/TwingleDonation/Submit.php) -for more insight into this API action. - -### End recurring donation - -- Entity: `TwingleDonation` -- Action: `Endrecurring` - -The action accepts the following parameters: - -| Parameter | Type | Description | Values/Format | Required | -|---------------------------|---------|------------------------------------------------|-------------------------------------------------------|----------| -| `project_id` | String | The Twingle project ID | | Yes | -| `trx_id` | String | The unique transaction ID of the donation | A unique transaction ID for the donation. | Yes | -| `ended_at` | Integer | The date when the recurring donation was ended | A string representing a date in the format `YmdHis` | Yes | - -You may also refer to -[the code](https://github.com/systopia/de.systopia.twingle/blob/master/api/v3/TwingleDonation/Endrecurring.php) -for more insight into this API action. - -### Cancel donation - -- Entity: `TwingleDonation` -- Action: `Cancel` - -The action accepts the following parameters: - -| Parameter | Type | Description | Values/Format | Required | -|------------------------------|--------|----------------------------------------------------|-------------------------------------------------------|----------| -| `project_id` | String | The Twingle project ID | | Yes | -| `trx_id` | String | The unique transaction ID of the donation | A unique transaction ID for the donation. | Yes | -| `cancelled_at` | String | The date when the recurring donation was cancelled | A string representing a date in the format `YmdHis` | Yes | -| `cancel_reason` | String | The reason for the donation being cancelled | | Yes | - -You may also refer to -[the code](https://github.com/systopia/de.systopia.twingle/blob/master/api/v3/TwingleDonation/Cancel.php) -for more insight into this API action. +If you are willing to support us in developing this CiviCRM extension, +please send an email to info@systopia.de to get an invoice or agree a different payment method. +Thank you! diff --git a/api/v3/TwingleDonation/Cancel.php b/api/v3/TwingleDonation/Cancel.php index 70d7747..9061476 100644 --- a/api/v3/TwingleDonation/Cancel.php +++ b/api/v3/TwingleDonation/Cancel.php @@ -13,125 +13,147 @@ | written permission from the original author(s). | +-------------------------------------------------------------*/ +declare(strict_types = 1); + use CRM_Twingle_ExtensionUtil as E; /** * TwingleDonation.Cancel API specification (optional) * This is used for documentation and validation. * - * @param array $params description of fields supported by this API call + * @param array> $params description of fields supported by this API call * * @return void * * @see http://wiki.civicrm.org/confluence/display/CRMDOC/API+Architecture+Standards */ function _civicrm_api3_twingle_donation_Cancel_spec(&$params) { - $params['project_id'] = array( + $params['project_id'] = [ 'name' => 'project_id', 'title' => E::ts('Project ID'), 'type' => CRM_Utils_Type::T_STRING, 'api.required' => 1, 'description' => E::ts('The Twingle project ID.'), - ); - $params['trx_id'] = array( + ]; + $params['trx_id'] = [ 'name' => 'trx_id', 'title' => E::ts('Transaction ID'), 'type' => CRM_Utils_Type::T_STRING, 'api.required' => 1, 'description' => E::ts('The unique transaction ID of the donation'), - ); - $params['cancelled_at'] = array( + ]; + $params['cancelled_at'] = [ 'name' => 'cancelled_at', 'title' => E::ts('Cancelled at'), 'type' => CRM_Utils_Type::T_INT, 'api.required' => 1, 'description' => E::ts('The date when the donation was cancelled, format: YmdHis.'), - ); - $params['cancel_reason'] = array( + ]; + $params['cancel_reason'] = [ 'name' => 'cancel_reason', 'title' => E::ts('Cancel reason'), 'type' => CRM_Utils_Type::T_STRING, 'api.required' => 1, 'description' => E::ts('The reason for the donation being cancelled.'), - ); + ]; } /** * TwingleDonation.Cancel API * - * @param array $params - * @return array API result descriptor + * @param array $params + * @return array API result descriptor * @see civicrm_api3_create_success * @see civicrm_api3_create_error */ function civicrm_api3_twingle_donation_Cancel($params) { // Log call if debugging is enabled within civicrm.settings.php. if (defined('TWINGLE_API_LOGGING') && TWINGLE_API_LOGGING) { - CRM_Core_Error::debug_log_message('TwingleDonation.Cancel: ' . json_encode($params, JSON_PRETTY_PRINT)); + Civi::log()->debug('TwingleDonation.Cancel: ' . json_encode($params, JSON_PRETTY_PRINT)); } try { // Validate date for parameter "cancelled_at". - if (!DateTime::createFromFormat('Ymd', $params['cancelled_at'])) { - throw new CiviCRM_API3_Exception( + if (!DateTime::createFromFormat('YmdHis', $params['cancelled_at'])) { + throw new CRM_Core_Exception( E::ts('Invalid date for parameter "cancelled_at".'), 'invalid_format' ); } // Retrieve (recurring) contribution. + $default_profile = CRM_Twingle_Profile::getProfile('default'); try { - $contribution = civicrm_api3('Contribution', 'getsingle', array( - 'trxn_id' => $params['trx_id'], - )); + $contribution = civicrm_api3('Contribution', 'getsingle', [ + 'trxn_id' => $default_profile->getTransactionID($params['trx_id']), + ]); $contribution_type = 'Contribution'; } - catch (CiviCRM_API3_Exception $exception) { - $contribution = civicrm_api3('ContributionRecur', 'getsingle', array( - 'trxn_id' => $params['trx_id'], - )); + catch (CRM_Core_Exception $exception) { + $contribution = civicrm_api3('ContributionRecur', 'getsingle', [ + 'trxn_id' => $default_profile->getTransactionID($params['trx_id']), + ]); $contribution_type = 'ContributionRecur'; } - // End SEPA mandate if applicable. if ( CRM_Twingle_Submission::civiSepaEnabled() - && CRM_Sepa_Logic_Settings::isSDD($contribution) + && CRM_Twingle_Tools::isSDD($contribution['payment_instrument_id']) ) { - $mandate_id = CRM_Sepa_Logic_Settings::getMandateFor($contribution['id']); + // End SEPA mandate if applicable. + $mandate = CRM_Twingle_Tools::getMandateFor((int) $contribution['id']); + if (!$mandate) { + throw new CRM_Core_Exception( + E::ts('SEPA Mandate for contribution [%1 not found.', [1 => $contribution['id']]), + 'api_error' + ); + } + $mandate_id = (int) $mandate['id']; + // Mandates can not be terminated in the past. - $end_date = date('Ymd', max( - time(), - date_create_from_format('Ymd', $params['cancelled_at'])->getTimestamp() - )); + $end_date = date_create_from_format('YmdHis', $params['cancelled_at']); + if (FALSE !== $end_date) { + // Mandates can not be terminated in the past: + $end_date = date('Ymd', max( + time(), + $end_date->getTimestamp())); + } + else { + // end date couldn't be parsed, use 'now' + $end_date = date('Ymd'); + } + if (!CRM_Sepa_BAO_SEPAMandate::terminateMandate( $mandate_id, $end_date, $params['cancel_reason'] )) { - throw new CiviCRM_API3_Exception( + throw new CRM_Core_Exception( E::ts('Could not terminate SEPA mandate'), 'api_error' ); } // Retrieve updated contribution for return value. - $contribution = civicrm_api3($contribution_type, 'getsingle', array( + $contribution = civicrm_api3($contribution_type, 'getsingle', [ 'id' => $contribution['id'], - )); + ]); } else { - $contribution = civicrm_api3($contribution_type, 'create', array( + // regular contribution + CRM_Twingle_Tools::$protection_suspended = TRUE; + $contribution = civicrm_api3($contribution_type, 'create', [ 'id' => $contribution['id'], 'cancel_date' => $params['cancelled_at'], 'contribution_status_id' => 'Cancelled', 'cancel_reason' => $params['cancel_reason'], - )); + ]); + CRM_Twingle_Tools::$protection_suspended = FALSE; } $result = civicrm_api3_create_success($contribution); } - catch (CiviCRM_API3_Exception $exception) { + catch (Exception $exception) { $result = civicrm_api3_create_error($exception->getMessage()); } diff --git a/api/v3/TwingleDonation/Endrecurring.php b/api/v3/TwingleDonation/Endrecurring.php index 4766359..68023f9 100644 --- a/api/v3/TwingleDonation/Endrecurring.php +++ b/api/v3/TwingleDonation/Endrecurring.php @@ -13,105 +13,136 @@ | written permission from the original author(s). | +-------------------------------------------------------------*/ +declare(strict_types = 1); + use CRM_Twingle_ExtensionUtil as E; /** * TwingleDonation.Endrecurring API specification (optional) * This is used for documentation and validation. * - * @param array $params description of fields supported by this API call + * @param array> $params description of fields supported by this API call * * @return void * * @see http://wiki.civicrm.org/confluence/display/CRMDOC/API+Architecture+Standards */ function _civicrm_api3_twingle_donation_endrecurring_spec(&$params) { - $params['project_id'] = array( + $params['project_id'] = [ 'name' => 'project_id', 'title' => E::ts('Project ID'), 'type' => CRM_Utils_Type::T_STRING, 'api.required' => 1, 'description' => E::ts('The Twingle project ID.'), - ); - $params['trx_id'] = array( + ]; + $params['trx_id'] = [ 'name' => 'trx_id', 'title' => E::ts('Transaction ID'), 'type' => CRM_Utils_Type::T_STRING, 'api.required' => 1, 'description' => E::ts('The unique transaction ID of the donation'), - ); - $params['ended_at'] = array( + ]; + $params['ended_at'] = [ 'name' => 'ended_at', 'title' => E::ts('Ended at'), 'type' => CRM_Utils_Type::T_INT, 'api.required' => 1, 'description' => E::ts('The date when the recurring donation was ended, format: YmdHis.'), - ); + ]; } /** * TwingleDonation.Endrecurring API * - * @param array $params - * @return array API result descriptor + * @param array $params + * @return array API result descriptor * @see civicrm_api3_create_success * @see civicrm_api3_create_error */ function civicrm_api3_twingle_donation_endrecurring($params) { // Log call if debugging is enabled within civicrm.settings.php. if (defined('TWINGLE_API_LOGGING') && TWINGLE_API_LOGGING) { - CRM_Core_Error::debug_log_message('TwingleDonation.Endrecurring: ' . json_encode($params, JSON_PRETTY_PRINT)); + Civi::log()->debug('TwingleDonation.Endrecurring: ' . json_encode($params, JSON_PRETTY_PRINT)); } try { // Validate date for parameter "ended_at". - if (!DateTime::createFromFormat('Ymd', $params['ended_at'])) { - throw new CiviCRM_API3_Exception( + if (FALSE === DateTime::createFromFormat('YmdHis', $params['ended_at'])) { + throw new CRM_Core_Exception( E::ts('Invalid date for parameter "ended_at".'), 'invalid_format' ); } - $contribution = civicrm_api3('ContributionRecur', 'getsingle', array( - 'trxn_id' => $params['trx_id'], - )); + $default_profile = CRM_Twingle_Profile::getProfile('default'); + $contribution = civicrm_api3('ContributionRecur', 'getsingle', [ + 'trxn_id' => $default_profile->getTransactionID($params['trx_id']), + ]); + // End SEPA mandate (which ends the associated recurring contribution) or // recurring contributions. if ( CRM_Twingle_Submission::civiSepaEnabled() - && CRM_Sepa_Logic_Settings::isSDD($contribution) + && CRM_Twingle_Tools::isSDD($contribution['payment_instrument_id']) ) { - $mandate_id = CRM_Sepa_Logic_Settings::getMandateFor($contribution['id']); - // Mandates can not be terminated in the past. - $end_date = date('Ymd', max( - time(), - date_create_from_format('Ymd', $params['cancelled_at'])->getTimestamp() - )); + // END SEPA MANDATE + $mandate = CRM_Twingle_Tools::getMandateFor((int) $contribution['id']); + if (!isset($mandate)) { + throw new CRM_Core_Exception( + E::ts('SEPA Mandate for recurring contribution [%1 not found.', [1 => $contribution['id']]), + 'api_error' + ); + } + + $mandate_id = $mandate['id']; + $end_date = date_create_from_format('YmdHis', $params['ended_at']); + if (FALSE !== $end_date) { + // Mandates can not be terminated in the past: + $end_date = date('Ymd', max( + time(), + $end_date->getTimestamp())); + } + else { + // end date couldn't be parsed, use 'now' + $end_date = date('Ymd'); + } + + // verify that the mandate has not been terminated in the past + if ($mandate['status'] != 'FRST' && $mandate['status'] != 'RCUR') { + throw new CRM_Core_Exception( + E::ts('SEPA Mandate [%1] already terminated.', [1 => $mandate_id]), + 'api_error' + ); + } + if (!CRM_Sepa_BAO_SEPAMandate::terminateMandate( $mandate_id, $end_date, E::ts('Mandate closed by TwingleDonation.Endrecurring API call') )) { - throw new CiviCRM_API3_Exception( + throw new CRM_Core_Exception( E::ts('Could not terminate SEPA mandate'), 'api_error' ); } - $contribution = civicrm_api3('ContributionRecur', 'getsingle', array( + $contribution = civicrm_api3('ContributionRecur', 'getsingle', [ 'id' => $contribution['id'], - )); + ]); } else { - $contribution = civicrm_api3('ContributionRecur', 'create', array( - 'id' => $contribution['id'], - 'end_date' => $params['ended_at'], - 'contribution_status_id' => 'Completed', - )); + // END RECURRING CONTRIBUTION + CRM_Twingle_Tools::$protection_suspended = TRUE; + $contribution = civicrm_api3('ContributionRecur', 'create', [ + 'id' => $contribution['id'], + 'end_date' => $params['ended_at'], + 'contribution_status_id' => CRM_Twingle_Submission::CONTRIBUTION_STATUS_COMPLETED, + ]); + CRM_Twingle_Tools::$protection_suspended = FALSE; } $result = civicrm_api3_create_success($contribution); } - catch (CiviCRM_API3_Exception $exception) { + catch (Exception $exception) { $result = civicrm_api3_create_error($exception->getMessage()); } diff --git a/api/v3/TwingleDonation/Submit.php b/api/v3/TwingleDonation/Submit.php index 3b8c274..013dc73 100644 --- a/api/v3/TwingleDonation/Submit.php +++ b/api/v3/TwingleDonation/Submit.php @@ -13,13 +13,17 @@ | written permission from the original author(s). | +-------------------------------------------------------------*/ +declare(strict_types = 1); + use CRM_Twingle_ExtensionUtil as E; +use Civi\Twingle\Exceptions\BaseException; +use Civi\Api4\Note; /** * TwingleDonation.Submit API specification * This is used for documentation and validation. * - * @param array $params + * @param array> $params * Description of fields supported by this API call. * * @return void @@ -27,283 +31,365 @@ use CRM_Twingle_ExtensionUtil as E; * @see http://wiki.civicrm.org/confluence/display/CRMDOC/API+Architecture+Standards */ function _civicrm_api3_twingle_donation_Submit_spec(&$params) { - $params['project_id'] = array( + $params['project_id'] = [ 'name' => 'project_id', 'title' => E::ts('Project ID'), 'type' => CRM_Utils_Type::T_STRING, 'api.required' => 1, 'description' => E::ts('The Twingle project ID.'), - ); - $params['trx_id'] = array( + ]; + $params['trx_id'] = [ 'name' => 'trx_id', 'title' => E::ts('Transaction ID'), 'type' => CRM_Utils_Type::T_STRING, 'api.required' => 1, 'description' => E::ts('The unique transaction ID of the donation'), - ); - $params['confirmed_at'] = array( + ]; + $params['confirmed_at'] = [ 'name' => 'confirmed_at', 'title' => E::ts('Confirmed at'), 'type' => CRM_Utils_Type::T_STRING, 'api.required' => 1, 'description' => E::ts('The date when the donation was issued, format: YmdHis.'), - ); - $params['purpose'] = array( + ]; + $params['purpose'] = [ 'name' => 'purpose', 'title' => E::ts('Purpose'), 'type' => CRM_Utils_Type::T_STRING, 'api.required' => 0, 'description' => E::ts('The purpose of the donation.'), - ); - $params['amount'] = array( + ]; + $params['amount'] = [ 'name' => 'amount', 'title' => E::ts('Amount'), 'type' => CRM_Utils_Type::T_INT, 'api.required' => 1, 'description' => E::ts('The donation amount in minor currency unit.'), - ); - $params['currency'] = array( - 'name' => 'currency', - 'title' => E::ts('Currency'), - 'type' => CRM_Utils_Type::T_STRING, + ]; + $params['currency'] = [ + 'name' => 'currency', + 'title' => E::ts('Currency'), + 'type' => CRM_Utils_Type::T_STRING, 'api.required' => 1, - 'description' => E::ts('The ISO-4217 currency code of the donation.'), - ); - $params['newsletter'] = array( - 'name' => 'newsletter', - 'title' => E::ts('Newsletter'), - 'type' => CRM_Utils_Type::T_BOOLEAN, + 'description' => E::ts('The ISO-4217 currency code of the donation.'), + ]; + $params['newsletter'] = [ + 'name' => 'newsletter', + 'title' => E::ts('Newsletter'), + 'type' => CRM_Utils_Type::T_BOOLEAN, 'api.required' => 0, - 'description' => E::ts('Whether to subscribe the contact to the newsletter group defined in the profile.'), - ); - $params['postinfo'] = array( - 'name' => 'postinfo', - 'title' => E::ts('Postal mailing'), - 'type' => CRM_Utils_Type::T_BOOLEAN, + 'description' => E::ts('Whether to subscribe the contact to the newsletter group defined in the profile.'), + ]; + $params['postinfo'] = [ + 'name' => 'postinfo', + 'title' => E::ts('Postal mailing'), + 'type' => CRM_Utils_Type::T_BOOLEAN, 'api.required' => 0, - 'description' => E::ts('Whether to subscribe the contact to the postal mailing group defined in the profile.'), - ); - $params['donation_receipt'] = array( - 'name' => 'donation_receipt', - 'title' => E::ts('Donation receipt'), - 'type' => CRM_Utils_Type::T_BOOLEAN, + 'description' => E::ts('Whether to subscribe the contact to the postal mailing group defined in the profile.'), + ]; + $params['donation_receipt'] = [ + 'name' => 'donation_receipt', + 'title' => E::ts('Donation receipt'), + 'type' => CRM_Utils_Type::T_BOOLEAN, 'api.required' => 0, - 'description' => E::ts('Whether the contact requested a donation receipt.'), - ); - $params['payment_method'] = array( - 'name' => 'payment_method', - 'title' => E::ts('Payment method'), - 'type' => CRM_Utils_Type::T_STRING, + 'description' => E::ts('Whether the contact requested a donation receipt.'), + ]; + $params['payment_method'] = [ + 'name' => 'payment_method', + 'title' => E::ts('Payment method'), + 'type' => CRM_Utils_Type::T_STRING, 'api.required' => 1, - 'description' => E::ts('The Twingle payment method used for the donation.'), - ); - $params['donation_rhythm'] = array( - 'name' => 'donation_rhythm', - 'title' => E::ts('Donation rhythm'), - 'type' => CRM_Utils_Type::T_STRING, + 'description' => E::ts('The Twingle payment method used for the donation.'), + ]; + $params['donation_rhythm'] = [ + 'name' => 'donation_rhythm', + 'title' => E::ts('Donation rhythm'), + 'type' => CRM_Utils_Type::T_STRING, 'api.required' => 1, - 'description' => E::ts('The interval which the donation is recurring in.'), - ); - $params['debit_iban'] = array( - 'name' => 'debit_iban', - 'title' => E::ts('SEPA IBAN'), - 'type' => CRM_Utils_Type::T_STRING, + 'description' => E::ts('The interval which the donation is recurring in.'), + ]; + $params['debit_iban'] = [ + 'name' => 'debit_iban', + 'title' => E::ts('SEPA IBAN'), + 'type' => CRM_Utils_Type::T_STRING, 'api.required' => 0, - 'description' => E::ts('The IBAN for SEPA Direct Debit payments, conforming with ISO 13616-1:2007.'), - ); - $params['debit_bic'] = array( - 'name' => 'debit_bic', - 'title' => E::ts('SEPA BIC'), - 'type' => CRM_Utils_Type::T_STRING, + 'description' => E::ts('The IBAN for SEPA Direct Debit payments, conforming with ISO 13616-1:2007.'), + ]; + $params['debit_bic'] = [ + 'name' => 'debit_bic', + 'title' => E::ts('SEPA BIC'), + 'type' => CRM_Utils_Type::T_STRING, 'api.required' => 0, - 'description' => E::ts('The BIC for SEPA Direct Debit payments, conforming with ISO 9362.'), - ); - $params['debit_mandate_reference'] = array( - 'name' => 'debit_mandate_reference', - 'title' => E::ts('SEPA Direct Debit Mandate reference'), - 'type' => CRM_Utils_Type::T_STRING, + 'description' => E::ts('The BIC for SEPA Direct Debit payments, conforming with ISO 9362.'), + ]; + $params['debit_mandate_reference'] = [ + 'name' => 'debit_mandate_reference', + 'title' => E::ts('SEPA Direct Debit Mandate reference'), + 'type' => CRM_Utils_Type::T_STRING, 'api.required' => 0, - 'description' => E::ts('The mandate reference for SEPA Direct Debit payments.'), - ); - $params['debit_account_holder'] = array( - 'name' => 'debit_account_holder', - 'title' => E::ts('SEPA Direct Debit Account holder'), - 'type' => CRM_Utils_Type::T_STRING, + 'description' => E::ts('The mandate reference for SEPA Direct Debit payments.'), + ]; + $params['debit_account_holder'] = [ + 'name' => 'debit_account_holder', + 'title' => E::ts('SEPA Direct Debit Account holder'), + 'type' => CRM_Utils_Type::T_STRING, 'api.required' => 0, - 'description' => E::ts('The account holder for SEPA Direct Debit payments.'), - ); - $params['is_anonymous'] = array( - 'name' => 'is_anonymous', - 'title' => E::ts('Anonymous donation'), - 'type' => CRM_Utils_Type::T_BOOLEAN, + 'description' => E::ts('The account holder for SEPA Direct Debit payments.'), + ]; + $params['is_anonymous'] = [ + 'name' => 'is_anonymous', + 'title' => E::ts('Anonymous donation'), + 'type' => CRM_Utils_Type::T_BOOLEAN, 'api.required' => 0, - 'api.default' => 0, - 'description' => E::ts('Whether the donation is submitted anonymously.'), - ); - $params['user_gender'] = array( - 'name' => 'user_gender', - 'title' => E::ts('Gender'), - 'type' => CRM_Utils_Type::T_STRING, + 'api.default' => 0, + 'description' => E::ts('Whether the donation is submitted anonymously.'), + ]; + $params['user_gender'] = [ + 'name' => 'user_gender', + 'title' => E::ts('Gender'), + 'type' => CRM_Utils_Type::T_STRING, 'api.required' => 0, - 'description' => E::ts('The gender of the contact.'), - ); - $params['user_birthdate'] = array( - 'name' => 'user_birthdate', - 'title' => E::ts('Date of birth'), - 'type' => CRM_Utils_Type::T_STRING, + 'description' => E::ts('The gender of the contact.'), + ]; + $params['user_birthdate'] = [ + 'name' => 'user_birthdate', + 'title' => E::ts('Date of birth'), + 'type' => CRM_Utils_Type::T_STRING, 'api.required' => 0, - 'description' => E::ts('The date of birth of the contact, format: Ymd.'), - ); - $params['user_title'] = array( - 'name' => 'user_title', - 'title' => E::ts('Formal title'), - 'type' => CRM_Utils_Type::T_STRING, + 'description' => E::ts('The date of birth of the contact, format: Ymd.'), + ]; + $params['user_title'] = [ + 'name' => 'user_title', + 'title' => E::ts('Formal title'), + 'type' => CRM_Utils_Type::T_STRING, 'api.required' => 0, - 'description' => E::ts('The formal title of the contact.'), - ); - $params['user_email'] = array( - 'name' => 'user_email', - 'title' => E::ts('E-mail address'), - 'type' => CRM_Utils_Type::T_STRING, + 'description' => E::ts('The formal title of the contact.'), + ]; + $params['user_email'] = [ + 'name' => 'user_email', + 'title' => E::ts('Email address'), + 'type' => CRM_Utils_Type::T_STRING, 'api.required' => 0, - 'description' => E::ts('The e-mail address of the contact.'), - ); - $params['user_firstname'] = array( - 'name' => 'user_firstname', - 'title' => E::ts('First name'), - 'type' => CRM_Utils_Type::T_STRING, + 'description' => E::ts('The e-mail address of the contact.'), + ]; + $params['user_firstname'] = [ + 'name' => 'user_firstname', + 'title' => E::ts('First name'), + 'type' => CRM_Utils_Type::T_STRING, 'api.required' => 0, - 'description' => E::ts('The first name of the contact.'), - ); - $params['user_lastname'] = array( - 'name' => 'user_lastname', - 'title' => E::ts('Last name'), - 'type' => CRM_Utils_Type::T_STRING, + 'description' => E::ts('The first name of the contact.'), + ]; + $params['user_lastname'] = [ + 'name' => 'user_lastname', + 'title' => E::ts('Last name'), + 'type' => CRM_Utils_Type::T_STRING, 'api.required' => 0, - 'description' => E::ts('The last name of the contact.'), - ); - $params['user_street'] = array( - 'name' => 'user_street', - 'title' => E::ts('Street address'), - 'type' => CRM_Utils_Type::T_STRING, + 'description' => E::ts('The last name of the contact.'), + ]; + $params['user_street'] = [ + 'name' => 'user_street', + 'title' => E::ts('Street address'), + 'type' => CRM_Utils_Type::T_STRING, 'api.required' => 0, - 'description' => E::ts('The street address of the contact.'), - ); - $params['user_postal_code'] = array( - 'name' => 'user_postal_code', - 'title' => E::ts('Postal code'), - 'type' => CRM_Utils_Type::T_STRING, + 'description' => E::ts('The street address of the contact.'), + ]; + $params['user_postal_code'] = [ + 'name' => 'user_postal_code', + 'title' => E::ts('Postal code'), + 'type' => CRM_Utils_Type::T_STRING, 'api.required' => 0, - 'description' => E::ts('The postal code of the contact.'), - ); - $params['user_city'] = array( - 'name' => 'user_city', - 'title' => E::ts('City'), - 'type' => CRM_Utils_Type::T_STRING, + 'description' => E::ts('The postal code of the contact.'), + ]; + $params['user_city'] = [ + 'name' => 'user_city', + 'title' => E::ts('City'), + 'type' => CRM_Utils_Type::T_STRING, 'api.required' => 0, - 'description' => E::ts('The city of the contact.'), - ); - $params['user_telephone'] = array( - 'name' => 'user_telephone', - 'title' => E::ts('Telephone'), - 'type' => CRM_Utils_Type::T_STRING, + 'description' => E::ts('The city of the contact.'), + ]; + $params['user_country'] = [ + 'name' => 'user_country', + 'title' => E::ts('Country'), + 'type' => CRM_Utils_Type::T_STRING, 'api.required' => 0, - 'description' => E::ts('The telephone number of the contact.'), - ); - $params['user_company'] = array( - 'name' => 'user_company', - 'title' => E::ts('Company'), - 'type' => CRM_Utils_Type::T_STRING, + 'description' => E::ts('The country of the contact.'), + ]; + $params['user_telephone'] = [ + 'name' => 'user_telephone', + 'title' => E::ts('Telephone'), + 'type' => CRM_Utils_Type::T_STRING, 'api.required' => 0, - 'description' => E::ts('The company of the contact.'), - ); - $params['user_extrafield'] = array( - 'name' => 'user_extrafield', - 'title' => E::ts('User extra field'), - 'type' => CRM_Utils_Type::T_STRING, + 'description' => E::ts('The telephone number of the contact.'), + ]; + $params['user_company'] = [ + 'name' => 'user_company', + 'title' => E::ts('Company'), + 'type' => CRM_Utils_Type::T_STRING, 'api.required' => 0, - 'description' => E::ts('Additional information of the contact.'), - ); - $params['campaign_id'] = array( + 'description' => E::ts('The company of the contact.'), + ]; + $params['user_language'] = [ + 'name' => 'user_language', + 'title' => E::ts('Language'), + 'type' => CRM_Utils_Type::T_STRING, + 'api.required' => 0, + 'description' => E::ts('The preferred language of the contact. A 2-digit ISO-639-1 language code.'), + ]; + $params['user_extrafield'] = [ + 'name' => 'user_extrafield', + 'title' => E::ts('User extra field'), + 'type' => CRM_Utils_Type::T_STRING, + 'api.required' => 0, + 'description' => E::ts('Additional information of the contact.'), + ]; + $params['campaign_id'] = [ 'name' => 'campaign_id', 'title' => E::ts('Campaign ID'), - 'type' => CRM_Utils_Type::T_INT, + 'type' => CRM_Utils_Type::T_STRING, 'api.required' => 0, 'description' => E::ts('The CiviCRM ID of a campaign to assign the contribution.'), - ); + ]; + $params['custom_fields'] = [ + 'name' => 'custom_fields', + 'title' => E::ts('Custom fields'), + 'type' => CRM_Utils_Type::T_STRING, + 'api.required' => 0, + 'description' => E::ts('Additional information for either the contact or the (recurring) contribution.'), + ]; + $params['products'] = [ + 'name' => 'products', + 'title' => E::ts('Products'), + 'type' => CRM_Utils_Type::T_STRING, + 'api.required' => 0, + 'description' => E::ts('Products ordered via TwingleShop'), + ]; + $params['remarks'] = [ + 'name' => 'remarks', + 'title' => E::ts('Remarks'), + 'type' => CRM_Utils_Type::T_STRING, + 'api.required' => 0, + 'description' => E::ts('Additional remarks for the donation.'), + ]; } /** * TwingleDonation.Submit API * - * @param array $params - * @return array API result descriptor + * @param array $params + * @return array API result descriptor * @see civicrm_api3_create_success * @see civicrm_api3_create_error */ function civicrm_api3_twingle_donation_Submit($params) { // Log call if debugging is enabled within civicrm.settings.php. if (defined('TWINGLE_API_LOGGING') && TWINGLE_API_LOGGING) { - CRM_Core_Error::debug_log_message('TwingleDonation.Submit: ' . json_encode($params, JSON_PRETTY_PRINT)); + Civi::log()->debug('TwingleDonation.Submit: ' . json_encode($params, JSON_PRETTY_PRINT)); } try { // Copy submitted parameters. $original_params = $params; + // Prepare results array. + $result_values = []; + // Get the profile defined for the given form ID, or the default profile // if none matches. $profile = CRM_Twingle_Profile::getProfileForProject($params['project_id']); + $profile->logAccess(); // Validate submitted parameters CRM_Twingle_Submission::validateSubmission($params, $profile); // Do not process an already existing contribution with the given // transaction ID. - $existing_contribution = civicrm_api3('Contribution', 'get', array( - 'trxn_id' => $params['trx_id'] - )); - $existing_contribution_recur = civicrm_api3('ContributionRecur', 'get', array( - 'trxn_id' => $params['trx_id'] - )); + $existing_contribution = civicrm_api3('Contribution', 'get', [ + 'trxn_id' => $profile->getTransactionID($params['trx_id']), + ]); + $existing_contribution_recur = civicrm_api3('ContributionRecur', 'get', [ + 'trxn_id' => $profile->getTransactionID($params['trx_id']), + ]); if ($existing_contribution['count'] > 0 || $existing_contribution_recur['count'] > 0) { - throw new CiviCRM_API3_Exception( + throw new CRM_Core_Exception( E::ts('Contribution with the given transaction ID already exists.'), 'api_error' ); } + // Extract custom field values using the profile's mapping of Twingle fields + // to CiviCRM custom fields. + $custom_fields = []; + if (is_array($params['custom_fields'])) { + $custom_field_mapping = $profile->getCustomFieldMapping(); + + // Make all params available for custom field mapping + $allowed_params = []; + _civicrm_api3_twingle_donation_Submit_spec($allowed_params); + $params['custom_fields'] += array_intersect_key($params, $custom_field_mapping, $allowed_params); + + foreach ($params['custom_fields'] as $twingle_field => $value) { + if (isset($custom_field_mapping[$twingle_field])) { + // Get custom field definition to store values by entity the field + // extends. + $custom_field_id = substr($custom_field_mapping[$twingle_field], strlen('custom_')); + $custom_field = civicrm_api3('CustomField', 'getsingle', [ + 'id' => $custom_field_id, + // Chain a CustomGroup.getsingle API call. + 'api.CustomGroup.getsingle' => [], + ]); + $entity = $custom_field['api.CustomGroup.getsingle']['extends']; + $custom_fields[$entity][$custom_field_mapping[$twingle_field]] = $value; + } + } + } + // Create contact(s). if ($params['is_anonymous']) { // Retrieve the ID of the contact to use for anonymous donations defined // within the profile - $contact_id = civicrm_api3('Contact', 'getsingle', array( + $contact_id = civicrm_api3('Contact', 'getsingle', [ 'id' => $profile->getAttribute('anonymous_contact_id'), - ))['id']; + ])['id']; } else { // Prepare parameter mapping for address. - foreach (array( - 'user_street' => 'street_address', - 'user_postal_code' => 'postal_code', - 'user_city' => 'city', - ) as $address_param => $address_component) { - if (!empty($params[$address_param])) { + foreach ([ + 'user_street' => 'street_address', + 'user_postal_code' => 'postal_code', + 'user_city' => 'city', + 'user_country' => 'country', + ] as $address_param => $address_component) { + if (isset($params[$address_param]) && '' !== $params[$address_param]) { $params[$address_component] = $params[$address_param]; - if ($address_param != $address_component) { + unset($params[$address_param]); + } + } + + // Remove address data when any address component that is configured as + // required is missing. + // See https://github.com/systopia/de.systopia.twingle/issues/47 + foreach ($profile->getAttribute('required_address_components', []) as $required_address_component) { + if (empty($params[$required_address_component])) { + foreach ([ + 'street_address', + 'postal_code', + 'city', + 'country', + ] as $address_param) { unset($params[$address_param]); } + break; } } // Prepare parameter mapping for organisation. - if (!empty($params['user_company'])) { + if (is_string($params['user_company']) && '' !== $params['user_company']) { $params['organization_name'] = $params['user_company']; unset($params['user_company']); } // Remove parameter "id". - if (!empty($params['id'])) { + if (isset($params['id'])) { unset($params['id']); } @@ -311,79 +397,118 @@ function civicrm_api3_twingle_donation_Submit($params) { $params['location_type_id'] = (int) $profile->getAttribute('location_type_id'); // Exclude address for now when retrieving/creating the individual contact - // and an organisation is given, as we are checking organisation address - // first and share it with the individual. - if (!empty($params['organization_name'])) { - $submitted_address = array(); - foreach (array( - 'street_address', - 'postal_code', - 'city', - 'country', - 'location_type_id', - ) as $address_component) { - if (!empty($params[$address_component])) { - $submitted_address[$address_component] = $params[$address_component]; - unset($params[$address_component]); - } + // as we are checking organisation address first and share it with the + // individual. + $submitted_address = []; + foreach ([ + 'street_address', + 'postal_code', + 'city', + 'country', + 'location_type_id', + ] as $address_component) { + if (!empty($params[$address_component])) { + $submitted_address[$address_component] = $params[$address_component]; + unset($params[$address_component]); } } // Get the ID of the contact matching the given contact data, or create a // new contact if none exists for the given contact data. - $contact_data = array(); - foreach (array( - 'user_firstname' => 'first_name', - 'user_lastname' => 'last_name', - 'gender_id' => 'gender_id', - 'user_birthdate' => 'birth_date', - 'user_email' => 'email', - 'user_telephone' => 'phone', - 'user_title' => 'formal_title', - ) as $contact_param => $contact_component) { + $contact_data = []; + foreach ([ + 'user_firstname' => 'first_name', + 'user_lastname' => 'last_name', + 'gender_id' => 'gender_id', + 'user_birthdate' => 'birth_date', + 'user_email' => 'email', + 'user_telephone' => 'phone', + 'user_language' => 'preferred_language', + 'user_title' => 'formal_title', + 'debit_iban' => 'iban', + ] as $contact_param => $contact_component) { if (!empty($params[$contact_param])) { $contact_data[$contact_component] = $params[$contact_param]; } } - if (!$contact_id = CRM_Twingle_Submission::getContact( - 'Individual', - $contact_data - )) { - throw new CiviCRM_API3_Exception( - E::ts('Individual contact could not be found or created.'), - 'api_error' - ); + + // Get the prefix ID defined within the profile + if ( + isset($params['user_gender']) + && is_numeric($prefix_id = $profile->getAttribute('prefix_' . $params['user_gender'])) + ) { + $contact_data['prefix_id'] = $prefix_id; } - // Save user_extrafield as contact note. - if (!empty($params['user_extrafield'])) { - civicrm_api3('Note', 'create', array( - 'entity_table' => 'civicrm_contact', - 'entity_id' => $contact_id, - 'note' => $params['user_extrafield'], - )); + // Add custom field values. + if (isset($custom_fields['Contact'])) { + $contact_data += $custom_fields['Contact']; + } + if (isset($custom_fields['Individual'])) { + $contact_data += $custom_fields['Individual']; } // Organisation lookup. - if (!empty($params['organization_name'])) { - $organisation_data = array( + if (is_string($params['organization_name']) && '' !== $params['organization_name']) { + $organisation_data = [ 'organization_name' => $params['organization_name'], - ); - if (!empty($submitted_address)) { + ]; + + // Add custom field values. + if (isset($custom_fields['Organization'])) { + $organisation_data += $custom_fields['Organization']; + } + + if ([] !== $submitted_address) { $organisation_data += $submitted_address; // Use configured location type for organisation address. $organisation_data['location_type_id'] = (int) $profile->getAttribute('location_type_id_organisation'); } - if (!$organisation_id = CRM_Twingle_Submission::getContact( + if (!is_int($organisation_id = CRM_Twingle_Submission::getContact( 'Organization', - $organisation_data - )) { - throw new CiviCRM_API3_Exception( + $organisation_data, + $profile, + $params + ))) { + throw new CRM_Core_Exception( E::ts('Organisation contact could not be found or created.'), 'api_error' ); } } + elseif ([] !== $submitted_address) { + $contact_data += $submitted_address; + } + + if (!is_int($contact_id = CRM_Twingle_Submission::getContact( + 'Individual', + $contact_data, + $profile, + $params + ))) { + throw new CRM_Core_Exception( + E::ts('Individual contact could not be found or created.'), + 'api_error' + ); + } + + // Create contact notes. + /** @phpstan-var array $contact_note_mappings */ + $contact_note_mappings = $profile->getAttribute('map_as_contact_notes', []); + foreach (['user_extrafield'] as $target) { + if ( + isset($params[$target]) + && '' !== $params[$target] + && in_array($target, $contact_note_mappings, TRUE) + ) { + Note::create(FALSE) + ->addValue('entity_table', 'civicrm_contact') + ->addValue('entity_id', $contact_id) + ->addValue('note', $params[$target]) + ->execute(); + } + } + // Share organisation address with individual contact, using configured // location type for organisation address. $address_shared = ( @@ -395,77 +520,141 @@ function civicrm_api3_twingle_donation_Submit($params) { ) ); - // Address is not shared, use submitted address with configured location - // type. - if (!$address_shared && !empty($submitted_address)) { - // Do not use `Address.create` API action in order for XCM to decide - // whether to create an address. - civicrm_api3('Contact', 'getorcreate', array( - 'id' => $contact_id, - ) + $submitted_address); - } - // Create employer relationship between organization and individual. if (isset($organisation_id)) { CRM_Twingle_Submission::updateEmployerRelation($contact_id, $organisation_id); } } - // If requested, add contact to newsletter groups defined in the profile. - if (!empty($params['newsletter']) && !empty($groups = $profile->getAttribute('newsletter_groups'))) { + $result_values['contact'] = $contact_id; + if (isset($organisation_id)) { + $result_values['organization'] = $organisation_id; + } + + // If usage of double opt-in is selected, use MailingEventSubscribe.create + // to add contact to newsletter groups defined in the profile + $result_values['newsletter_double_opt_in'] + = (bool) $profile->getAttribute('newsletter_double_opt_in') + ? 'true' + : 'false'; + if ( + (bool) $profile->getAttribute('newsletter_double_opt_in') + && (bool) ($params['newsletter'] ?? FALSE) + && is_array($groups = $profile->getAttribute('newsletter_groups')) + ) { + // TODO: Ensure the values being integers. + $group_memberships = array_column( + civicrm_api3( + 'GroupContact', + 'get', + [ + 'sequential' => 1, + 'contact_id' => $contact_id, + ] + )['values'], + 'group_id' + ); foreach ($groups as $group_id) { - civicrm_api3('GroupContact', 'create', array( - 'group_id' => $group_id, - 'contact_id' => $contact_id, - )); + $is_public_group = civicrm_api3( + 'Group', + 'getsingle', + [ + 'id' => (int) $group_id, + ] + )['visibility'] == 'Public Pages'; + if (!in_array($group_id, $group_memberships, FALSE) && $is_public_group) { + $result = civicrm_api3( + 'MailingEventSubscribe', + 'create', + [ + 'email' => $params['user_email'], + 'group_id' => (int) $group_id, + 'contact_id' => $contact_id, + ] + ); + $subscription = reset($result['values']); + $subscription['group_id'] = $group_id; + $result_values['newsletter_subscriptions'][] = $subscription; + } + elseif ($is_public_group) { + $result_values['newsletter_group_ids'][] = $group_id; + } + } + // If requested, add contact to newsletter groups defined in the profile. + } + elseif ( + (bool) ($params['newsletter'] ?? FALSE) + && is_array($groups = $profile->getAttribute('newsletter_groups')) + ) { + foreach ($groups as $group_id) { + civicrm_api3( + 'GroupContact', + 'create', + [ + 'group_id' => $group_id, + 'contact_id' => $contact_id, + ] + ); + $result_values['newsletter_group_ids'][] = $group_id; } } // If requested, add contact to postinfo groups defined in the profile. - if (!empty($params['postinfo']) && !empty($groups = $profile->getAttribute('postinfo_groups'))) { + if ( + (bool) ($params['postinfo'] ?? FALSE) + && is_array($groups = $profile->getAttribute('postinfo_groups')) + ) { foreach ($groups as $group_id) { - civicrm_api3('GroupContact', 'create', array( + civicrm_api3('GroupContact', 'create', [ 'group_id' => $group_id, 'contact_id' => $contact_id, - )); + ]); + + $result_values['postinfo'][] = $group_id; } } // If requested, add contact to donation_receipt groups defined in the - // profile. - if (!empty($params['donation_receipt']) && !empty($groups = $profile->getAttribute('donation_receipt_groups'))) { + // profile. If an organisation is provided, add it to the groups instead. + // (see issue #83) + if ( + (bool) ($params['donation_receipt'] ?? FALSE) + && is_array($groups = $profile->getAttribute('donation_receipt_groups')) + ) { foreach ($groups as $group_id) { - civicrm_api3('GroupContact', 'create', array( + civicrm_api3('GroupContact', 'create', [ 'group_id' => $group_id, - 'contact_id' => $contact_id, - )); + 'contact_id' => $organisation_id ?? $contact_id, + ]); + $result_values['donation_receipt_group_ids'][] = $group_id; } } // Create contribution or SEPA mandate. Those attributes are valid for both, // single and recurring contributions. - $contribution_data = array( + $contribution_data = [ 'contact_id' => (isset($organisation_id) ? $organisation_id : $contact_id), 'currency' => $params['currency'], - 'trxn_id' => $params['trx_id'], - 'financial_type_id' => $profile->getAttribute('financial_type_id'), + 'trxn_id' => $profile->getTransactionID($params['trx_id']), 'payment_instrument_id' => $params['payment_instrument_id'], 'amount' => $params['amount'] / 100, 'total_amount' => $params['amount'] / 100, - ); + ]; - if (!empty($params['purpose'])) { - $contribution_data['note'] = $params['purpose']; + // If the submission contains products, do not auto-create a line item + if (!empty($params['products']) && $profile->isShopEnabled()) { + $contribution_data['skipLineItem'] = 1; } - if (!empty($params['campaign_id'])) { - $contribution_data['campaign_id'] = $params['campaign_id']; - } - elseif (!empty($campaign = $profile->getAttribute('campaign'))) { - $contribution_data['campaign_id'] = $campaign; + // Add custom field values. + if (isset($custom_fields['Contribution'])) { + $contribution_data += $custom_fields['Contribution']; } - if (!empty($contribution_source = $profile->getAttribute('contribution_source'))) { + // set campaign, subject to configuration + CRM_Twingle_Submission::setCampaign($contribution_data, 'contribution', $params, $profile); + + if (NULL !== ($contribution_source = $profile->getAttribute('contribution_source'))) { $contribution_data['source'] = $contribution_source; } @@ -476,92 +665,298 @@ function civicrm_api3_twingle_donation_Submit($params) { // If CiviSEPA is installed and the financial type is a CiviSEPA-one, // create SEPA mandate (and recurring contribution, using "createfull" API // action). - foreach (array( + foreach ([ 'debit_iban', 'debit_bic', - ) as $sepa_attribute) { - if (empty($params[$sepa_attribute])) { - throw new CiviCRM_API3_Exception( - E::ts('Missing attribute %1 for SEPA mandate', array( + ] as $sepa_attribute) { + if (!isset($params[$sepa_attribute])) { + throw new CRM_Core_Exception( + E::ts('Missing attribute %1 for SEPA mandate', [ 1 => $sepa_attribute, - )), + ]), 'invalid_format' ); } } $creditor_id = $profile->getAttribute('sepa_creditor_id'); + if (!isset($creditor_id) || '' === $creditor_id) { + throw new BaseException( + E::ts('SEPA creditor is not configured for profile "%1".', [1 => $profile->getName()]) + ); + } // Compose mandate data from contribution data, ... $mandate_data = $contribution_data // ... CiviSEPA mandate attributes, ... - + array( + // phpcs:ignore Drupal.Formatting.SpaceUnaryOperator.PlusMinus + + [ 'type' => ($params['donation_rhythm'] == 'one_time' ? 'OOFF' : 'RCUR'), 'iban' => $params['debit_iban'], 'bic' => $params['debit_bic'], 'reference' => $params['debit_mandate_reference'], - 'date' => $params['confirmed_at'], // Signature date - 'start_date' => $params['confirmed_at'], // Earliest collection date. + // Signature date + 'date' => $params['confirmed_at'], + // Earliest collection date. + 'start_date' => $params['confirmed_at'], 'creditor_id' => $creditor_id, - ) - // ... and frequency unit and interval from a static mapping. - + CRM_Twingle_Submission::getFrequencyMapping($params['donation_rhythm']); + ] + // ... and frequency unit and interval from a static mapping. + // phpcs:ignore Drupal.Formatting.SpaceUnaryOperator.PlusMinus + + CRM_Twingle_Submission::getFrequencyMapping($params['donation_rhythm']); + // Add custom field values. + if (isset($custom_fields['ContributionRecur'])) { + $mandate_data += $custom_fields['ContributionRecur']; + } + if (NULL !== ($mandate_source = $profile->getAttribute('contribution_source'))) { + $mandate_data['source'] = $mandate_source; + } // Add cycle day for recurring contributions. if ($params['donation_rhythm'] != 'one_time') { $mandate_data['cycle_day'] = CRM_Twingle_Submission::getSEPACycleDay($params['confirmed_at'], $creditor_id); + $mandate_data['financial_type_id'] = $profile->getAttribute('financial_type_id_recur'); + } + else { + $mandate_data['financial_type_id'] = $profile->getAttribute('financial_type_id'); } // Let CiviSEPA set the correct payment instrument depending on the // mandate type. unset($mandate_data['payment_instrument_id']); + // If requested, let CiviSEPA generate the mandate reference + $use_own_mandate_reference = Civi::settings()->get('twingle_dont_use_reference'); + if ((bool) $use_own_mandate_reference) { + unset($mandate_data['reference']); + } + + // set campaign, subject to configuration + CRM_Twingle_Submission::setCampaign($mandate_data, 'mandate', $params, $profile); + // Create the mandate. $mandate = civicrm_api3('SepaMandate', 'createfull', $mandate_data); - $result_values = $mandate['values']; + $result_values['sepa_mandate'] = reset($mandate['values']); + + // Add contribution data to result_values for later use + $contribution_id = $result_values['sepa_mandate']['entity_id']; + if ($contribution_id) { + $contribution = civicrm_api3( + 'Contribution', + 'getsingle', + ['id' => $contribution_id] + ); + $result_values['contribution'] = $contribution; + } else { + $mandate_id = $result_values['sepa_mandate']['id']; + $message = E::LONG_NAME . ": could not find contribution for sepa mandate $mandate_id"; + throw new CiviCRM_API3_Exception($message, 'api_error'); + } + + // Add products as line items to the contribution + if (!empty($params['products']) && $profile->isShopEnabled()) { + $line_items = CRM_Twingle_Submission::createLineItems($result_values, $params, $profile); + $result_values['contribution']['line_items'] = $line_items; + } } else { - // Create (recurring) contribution. + // Set financial type depending on donation rhythm. This applies for + // initial recurring contributions and subsequent single contributions. if ($params['donation_rhythm'] != 'one_time') { + $contribution_data['financial_type_id'] = $profile->getAttribute('financial_type_id_recur'); + } + else { + $contribution_data['financial_type_id'] = $profile->getAttribute('financial_type_id'); + } + + // Create (recurring) contribution. + // Those will have a donation_rhythm different from "one_time" and no + // parent_trx_id set. + if ( + $params['donation_rhythm'] != 'one_time' + && empty($params['parent_trx_id']) + ) { // Create recurring contribution first. $contribution_recur_data = $contribution_data - + array( + + [ 'contribution_status_id' => 'Pending', 'start_date' => $params['confirmed_at'], - ) + ] + CRM_Twingle_Submission::getFrequencyMapping($params['donation_rhythm']); - $contribution_recur = civicrm_api3('contributionRecur', 'create', $contribution_recur_data); + + // Add custom field values. + if (isset($custom_fields['ContributionRecur'])) { + $contribution_recur_data += $custom_fields['ContributionRecur']; + $contribution_data += $custom_fields['ContributionRecur']; + } + + // set campaign, subject to configuration + CRM_Twingle_Submission::setCampaign($contribution_data, 'recurring', $params, $profile); + + $contribution_recur = civicrm_api3('ContributionRecur', 'create', $contribution_recur_data); if ($contribution_recur['is_error']) { - throw new CiviCRM_API3_Exception( + throw new CRM_Core_Exception( E::ts('Could not create recurring contribution.'), 'api_error' ); } $contribution_data['contribution_recur_id'] = $contribution_recur['id']; + $contribution_data['financial_type_id'] = $contribution_recur_data['financial_type_id']; } // Create contribution. - $contribution_data += array( - 'contribution_status_id' => 'Completed', + $contribution_data += [ + 'contribution_status_id' => $profile->getAttribute( + "pi_{$params['payment_method']}_status", + CRM_Twingle_Submission::CONTRIBUTION_STATUS_COMPLETED + ), 'receive_date' => $params['confirmed_at'], - ); + ]; + + // Assign to recurring contribution. + if (!empty($params['parent_trx_id'])) { + try { + $parent_contribution = civicrm_api3('ContributionRecur', 'getsingle', [ + 'trxn_id' => $profile->getTransactionID($params['parent_trx_id']), + ]); + $contribution_data['contribution_recur_id'] = $parent_contribution['id']; + } + catch (CRM_Core_Exception $exception) { + $result_values['parent_contribution'] = E::ts( + 'Could not find recurring contribution with given parent transaction ID.' + ); + } + } + $contribution = civicrm_api3('Contribution', 'create', $contribution_data); - if ($contribution['is_error']) { - throw new CiviCRM_API3_Exception( + /** @phpstan-var array{'values': array>, 'is_error'?: string} $contribution */ + if ((bool) ($contribution['is_error'] ?? FALSE)) { + throw new CRM_Core_Exception( E::ts('Could not create contribution'), 'api_error' ); } + $contribution = reset($contribution['values']); + /** @phpstan-var array{'id': int} $contribution */ - $result_values = $contribution['values']; + // Add notes to the contribution. + /** @phpstan-var array $contribution_note_mappings */ + $contribution_note_mappings = $profile->getAttribute('map_as_contribution_notes', []); + foreach (['purpose', 'remarks'] as $target) { + if ( + in_array($target, $contribution_note_mappings, TRUE) + && isset($params[$target]) + && '' !== $params[$target] + ) { + Note::create(FALSE) + ->addValue('entity_table', 'civicrm_contribution') + ->addValue('entity_id', $contribution['id']) + ->addValue('note', $params[$target]) + ->execute(); + } + } + + $result_values['contribution'] = $contribution; + + // Add products as line items to the contribution + if (!empty($params['products']) && $profile->isShopEnabled()) { + $line_items = CRM_Twingle_Submission::createLineItems($result_values, $params, $profile); + $result_values['contribution']['line_items'] = $line_items; + } + } + + // MEMBERSHIP CREATION + + // CHECK whether a membership should be created (based on profile settings and data provided) + if ($params['donation_rhythm'] == 'one_time') { + // membership creation based on one-off contributions + $membership_type_id = $profile->getAttribute('membership_type_id'); + } + else { + // membership creation based on recurring contributions + if (empty($params['parent_trx_id'])) { + // this is the initial payment + $membership_type_id = $profile->getAttribute('membership_type_id_recur'); + } + else { + // this is a follow-up recurring payment + $membership_type_id = NULL; + } + } + + // CREATE the membership if required + if (isset($membership_type_id)) { + $membership_data = [ + 'contact_id' => $contact_id, + 'membership_type_id' => $membership_type_id, + ]; + // set campaign, subject to configuration + CRM_Twingle_Submission::setCampaign($membership_data, 'membership', $params, $profile); + // set source + if (!empty($membership_source = $profile->getAttribute('contribution_source'))) { + $membership_data['source'] = $membership_source; + } + + $membership = civicrm_api3('Membership', 'create', $membership_data); + $result_values['membership'] = $membership; + + // call the postprocess API + if ('' !== ($postprocess_call = $profile->getAttribute('membership_postprocess_call', ''))) { + /** @var string $postprocess_call */ + [$pp_entity, $pp_action] = explode('.', $postprocess_call, 2); + try { + // gather the contribution IDs + $recurring_contribution_id = $contribution_id = ''; + if (isset($contribution_recur['id'])) { + $recurring_contribution_id = $contribution_recur['id']; + } + elseif (isset($result_values['sepa_mandate'])) { + $mandate = reset($result_values['sepa_mandate']); + if ($mandate['entity_table'] == 'civicrm_contribution_recur') { + $recurring_contribution_id = (int) $mandate['entity_id']; + } + } + if (isset($contribution['id'])) { + $contribution_id = $contribution['id']; + } + + // run the call + civicrm_api3(trim($pp_entity), trim($pp_action), [ + 'membership_id' => $membership['id'], + 'contact_id' => $contact_id, + 'organization_id' => isset($organisation_id) ? $organisation_id : '', + 'contribution_id' => $contribution_id, + 'recurring_contribution_id' => $recurring_contribution_id, + ]); + + // refresh membership data + $result_values['membership'] = civicrm_api3('Membership', 'getsingle', ['id' => $membership['id']]); + } + catch (CRM_Core_Exception $exception) { + // TODO: more error handling? + Civi::log()->warning( + sprintf( + 'Twingle membership postprocessing call %s.%s has failed: %s', + $pp_entity, + $pp_action, + $exception->getMessage() + ) + ); + throw new BaseException( + E::ts('Twingle membership postprocessing call has failed, see log for more information'), + NULL, + $exception + ); + } + } } $result = civicrm_api3_create_success($result_values); } - catch (CiviCRM_API3_Exception $exception) { + catch (Exception $exception) { $result = civicrm_api3_create_error($exception->getMessage()); } diff --git a/api/v3/TwingleProduct/Create.php b/api/v3/TwingleProduct/Create.php new file mode 100644 index 0000000..2490557 --- /dev/null +++ b/api/v3/TwingleProduct/Create.php @@ -0,0 +1,137 @@ + 'id', + 'title' => E::ts('TwingleProduct ID'), + 'type' => CRM_Utils_Type::T_INT, + 'api.required' => 0, + 'description' => E::ts('The TwingleProduct ID in the database'), + ]; + $spec['external_id'] = [ + 'name' => 'external_id', + 'title' => E::ts('Twingle ID'), + 'type' => CRM_Utils_Type::T_INT, + 'api.required' => 1, + 'description' => E::ts('External product ID in Twingle database'), + ]; + $spec['project_id'] = [ + 'name' => 'project_id', + 'title' => E::ts('Twingle Shop ID'), + 'type' => CRM_Utils_Type::T_INT, + 'api.required' => 1, + 'description' => E::ts('ID of the corresponding Twingle Shop'), + ]; + $spec['name'] = [ + 'name' => 'name', + 'title' => E::ts('Product Name'), + 'type' => CRM_Utils_Type::T_STRING, + 'api.required' => 1, + 'description' => E::ts('Name of the product'), + ]; + $spec['is_active'] = [ + 'name' => 'is_active', + 'title' => E::ts('Is active?'), + 'type' => CRM_Utils_Type::T_BOOLEAN, + 'api.required' => 0, + 'api.default' => 1, + 'description' => E::ts('Is the product active?'), + ]; + $spec['description'] = [ + 'name' => 'description', + 'title' => E::ts('Product Description'), + 'type' => CRM_Utils_Type::T_TEXT, + 'api.required' => 0, + 'description' => E::ts('Short description of the product'), + ]; + $spec['price'] = [ + 'name' => 'price', + 'title' => E::ts('Product Price'), + 'type' => CRM_Utils_Type::T_FLOAT, + 'api.required' => 0, + 'description' => E::ts('Price of the product'), + ]; + $spec['sort'] = [ + 'name' => 'sort', + 'title' => E::ts('Sort'), + 'type' => CRM_Utils_Type::T_INT, + 'api.required' => 0, + 'description' => E::ts('Sort order of the product'), + ]; + $spec['financial_type_id'] = [ + 'name' => 'financial_type_id', + 'title' => E::ts('Financial Type ID'), + 'type' => CRM_Utils_Type::T_INT, + 'api.required' => 1, + 'description' => E::ts('ID of the financial type of the product'), + ]; + $spec['twingle_shop_id'] = [ + 'name' => 'twingle_shop_id', + 'title' => E::ts('FK to TwingleShop'), + 'type' => CRM_Utils_Type::T_INT, + 'api.required' => 1, + 'description' => E::ts('FK to TwingleShop'), + ]; + $spec['tw_updated_at'] = [ + 'name' => 'tw_updated_at', + 'title' => E::ts('Twingle timestamp'), + 'type' => CRM_Utils_Type::T_INT, + 'api.required' => 1, + 'description' => E::ts('Timestamp of last update in Twingle db'), + ]; + $spec['price_field_id'] = [ + 'name' => 'price_field_id', + 'title' => E::ts('FK to PriceField'), + 'type' => CRM_Utils_Type::T_INT, + 'api.required' => 0, + 'description' => E::ts('FK to PriceField'), + ]; +} + +/** + * TwingleProduct.Create API + * + * @param array $params + * + * @return array + * API result descriptor + * + * @see civicrm_api3_create_success + * + * @throws API_Exception + * @throws \Exception + */ +function civicrm_api3_twingle_product_Create($params): array { + // Filter for allowed params + $allowed_params = []; + _civicrm_api3_twingle_product_Create_spec($allowed_params); + $params = array_intersect_key($params, $allowed_params); + + try { + // Create TwingleProduct and load params + $product = new CRM_Twingle_BAO_TwingleProduct(); + $product->load($params); + + // Save TwingleProduct + $product->add(); + $result = $product->getAttributes(); + return civicrm_api3_create_success($result, $params, 'TwingleProduct', 'Create'); + } + catch (ProductException $e) { + return civicrm_api3_create_error($e->getMessage(), [ + 'error_code' => $e->getCode(), + 'params' => $params, + ]); + } +} diff --git a/api/v3/TwingleProduct/Delete.php b/api/v3/TwingleProduct/Delete.php new file mode 100644 index 0000000..7c675ab --- /dev/null +++ b/api/v3/TwingleProduct/Delete.php @@ -0,0 +1,71 @@ + 'id', + 'title' => E::ts('TwingleProduct ID'), + 'type' => CRM_Utils_Type::T_INT, + 'api.required' => 0, + 'description' => E::ts('The TwingleProduct ID in CiviCRM'), + ]; + $spec['external_id'] = [ + 'name' => 'external_id', + 'title' => E::ts('External TwingleProduct ID'), + 'type' => CRM_Utils_Type::T_INT, + 'api.required' => 0, + 'description' => E::ts('Twingle\'s ID of the product'), + ]; +} + +/** + * TwingleProduct.Delete API + * + * @param array $params + * + * @return array + * API result descriptor + * + * @throws API_Exception*@throws \Exception + * @throws \Exception + * @see civicrm_api3_create_success + * + */ +function civicrm_api3_twingle_product_Delete($params) { + // Filter for allowed params + $allowed_params = []; + _civicrm_api3_twingle_product_Delete_spec($allowed_params); + $params = array_intersect_key($params, $allowed_params); + + // Find TwingleProduct via getsingle API + $product_data = civicrm_api3('TwingleProduct', 'getsingle', $params); + if ($product_data['is_error']) { + return civicrm_api3_create_error($product_data['error_message'], + ['error_code' => $product_data['error_code'], 'params' => $params] + ); + } + + // Get TwingleProduct object + $product = CRM_Twingle_BAO_TwingleProduct::findById($product_data['id']); + + // Delete TwingleProduct and associated PriceField and PriceFieldValue + $result = $product->delete(); + if ($result) { + return civicrm_api3_create_success(1, $params, 'TwingleProduct', 'Delete'); + } + else { + return civicrm_api3_create_error( + E::ts('TwingleProduct could not be deleted.'), + ['error_code' => 'delete_failed', 'params' => $params] + ); + } +} diff --git a/api/v3/TwingleProduct/Get.php b/api/v3/TwingleProduct/Get.php new file mode 100644 index 0000000..9544678 --- /dev/null +++ b/api/v3/TwingleProduct/Get.php @@ -0,0 +1,136 @@ + 'id', + 'title' => E::ts('TwingleProduct ID'), + 'type' => CRM_Utils_Type::T_INT, + 'api.required' => 0, + 'description' => E::ts('The TwingleProduct ID in CiviCRM'), + ]; + $spec['external_id'] = [ + 'name' => 'external_id', + 'title' => E::ts('External TwingleProduct ID'), + 'type' => CRM_Utils_Type::T_INT, + 'api.required' => 0, + 'description' => E::ts('Twingle\'s ID of the product'), + ]; + $spec['price_field_id'] = [ + 'name' => 'Price Field ID', + 'title' => E::ts('Price Field ID'), + 'type' => CRM_Utils_Type::T_INT, + 'api.required' => 0, + 'description' => E::ts('FK to civicrm_price_field'), + ]; + $spec['twingle_shop_id'] = [ + 'name' => 'twingle_shop_id', + 'title' => E::ts('TwingleShop ID'), + 'type' => CRM_Utils_Type::T_INT, + 'api.required' => 0, + 'description' => E::ts('The TwingleShop ID in CiviCRM'), + ]; + $spec['project_identifier'] = [ + 'name' => 'project_identifier', + 'title' => E::ts('Project Identifier'), + 'type' => CRM_Utils_Type::T_STRING, + 'api.required' => 0, + 'description' => E::ts('Twingle project identifier'), + ]; + $spec['numerical_project_id'] = [ + 'name' => 'numerical_project_id', + 'title' => E::ts('Numerical Project Identifier'), + 'type' => CRM_Utils_Type::T_INT, + 'api.required' => 0, + 'description' => E::ts('Twingle numerical project identifier'), + ]; +} + +/** + * TwingleProduct.Get API + * + * @param array $params + * + * @return array + * API result descriptor + * + * @throws API_Exception + * @see civicrm_api3_create_success + * + */ +function civicrm_api3_twingle_product_Get($params) { + // Filter for allowed params + $allowed_params = []; + _civicrm_api3_twingle_product_Get_spec($allowed_params); + $params = array_intersect_key($params, $allowed_params); + + // Build query + $query = 'SELECT ctp.* FROM civicrm_twingle_product ctp + INNER JOIN civicrm_twingle_shop cts ON ctp.twingle_shop_id = cts.id'; + $query_params = []; + + if (!empty($params)) { + $query = $query . ' WHERE'; + $possible_params = []; + _civicrm_api3_twingle_product_Get_spec($possible_params); + $param_count = 1; + $altered_params = []; + + // Specify product fields to define table prefix + $productFields = array_keys(CRM_Twingle_BAO_TwingleProduct::fields()); + + // Alter params (prefix with table name) + foreach ($possible_params as $param) { + if (!empty($params[$param['name']])) { + // Prefix with table name + $table_prefix = in_array($param['name'], $productFields) ? 'ctp.' : 'cts.'; + $altered_params[] = [ + 'name' => $table_prefix . $param['name'], + 'value' => $params[$param['name']], + 'type' => $param['type'], + ]; + } + } + + // Add altered params to query + foreach ($altered_params as $param) { + $query = $query . ' ' . $param['name'] . " = %$param_count AND"; + $query_params[$param_count] = [ + $param['value'], + $param['type'] == CRM_Utils_Type::T_INT ? 'Integer' : 'String', + ]; + $param_count++; + } + } + + // Cut away last 'AND' + $query = substr($query, 0, -4); + + // Execute query + try { + $dao = CRM_Twingle_BAO_TwingleProduct::executeQuery($query, $query_params); + } + catch (Exception $e) { + return civicrm_api3_create_error($e->getMessage(), [ + 'error_code' => $e->getCode(), + 'params' => $params, + ]); + } + + // Prepare return values + $returnValues = []; + while ($dao->fetch()) { + $returnValues[] = $dao->toArray(); + } + + return civicrm_api3_create_success($returnValues, $params, 'TwingleProduct', 'Get'); +} diff --git a/api/v3/TwingleProduct/Getsingle.php b/api/v3/TwingleProduct/Getsingle.php new file mode 100644 index 0000000..06eb88a --- /dev/null +++ b/api/v3/TwingleProduct/Getsingle.php @@ -0,0 +1,54 @@ + 'missing_parameter', 'params' => $params] + ); + } + + // Find TwingleProduct via get API + $returnValues = civicrm_api3('TwingleProduct', 'get', $params); + $count = $returnValues['count']; + + // Check whether only a single TwingleProduct is found + if ($count != 1) { + return civicrm_api3_create_error( + "Expected one TwingleProduct but found $count", + ['error_code' => 'not_found', 'params' => $params] + ); + } + return $returnValues['values'][$returnValues['id']]; +} diff --git a/api/v3/TwingleShop/Create.php b/api/v3/TwingleShop/Create.php new file mode 100644 index 0000000..ab858ff --- /dev/null +++ b/api/v3/TwingleShop/Create.php @@ -0,0 +1,79 @@ + 'project_identifier', + 'title' => E::ts('Project Identifier'), + 'type' => CRM_Utils_Type::T_STRING, + 'api.required' => 1, + 'description' => E::ts('Twingle project identifier'), + ]; + $spec['numerical_project_id'] = [ + 'name' => 'numerical_project_id', + 'title' => E::ts('Numerical Project Identifier'), + 'type' => CRM_Utils_Type::T_INT, + 'api.required' => 1, + 'description' => E::ts('Numerical Twingle project identifier'), + ]; + $spec['name'] = [ + 'name' => 'name', + 'title' => E::ts('Shop Name'), + 'type' => CRM_Utils_Type::T_STRING, + 'api.required' => 1, + 'description' => E::ts('Name of the shop'), + ]; + $spec['financial_type_id'] = [ + 'name' => 'financial_type_id', + 'title' => E::ts('Financial Type ID'), + 'type' => CRM_Utils_Type::T_INT, + 'api.required' => 1, + 'description' => E::ts('FK to civicrm_financial_type'), + ]; +} + +/** + * TwingleShop.Create API + * + * @param array $params + * + * @return array + * API result descriptor + * + * @see civicrm_api3_create_success + * + * @throws API_Exception + */ +function civicrm_api3_twingle_shop_Create($params) { + // Filter for allowed params + $allowed_params = []; + _civicrm_api3_twingle_shop_Create_spec($allowed_params); + $params = array_intersect_key($params, $allowed_params); + + try { + // Create TwingleShop and load params + $shop = new CRM_Twingle_BAO_TwingleShop(); + $shop->load($params); + + // Save TwingleShop + $result = $shop->add(); + + // Return success + return civicrm_api3_create_success($result, $params, 'TwingleShop', 'Create'); + } + catch (ShopException $e) { + return civicrm_api3_create_error($e->getMessage(), [ + 'error_code' => $e->getErrorCode(), + 'params' => $params, + ]); + } +} diff --git a/api/v3/TwingleShop/Delete.php b/api/v3/TwingleShop/Delete.php new file mode 100644 index 0000000..cc851a7 --- /dev/null +++ b/api/v3/TwingleShop/Delete.php @@ -0,0 +1,79 @@ + 'id', + 'title' => E::ts('TwingleShop ID'), + 'type' => CRM_Utils_Type::T_INT, + 'api.required' => 0, + 'description' => E::ts('The TwingleShop ID in CiviCRM'), + ]; + $spec['project_identifier'] = [ + 'name' => 'project_identifier', + 'title' => E::ts('Project Identifier'), + 'type' => CRM_Utils_Type::T_STRING, + 'api.required' => 0, + 'description' => E::ts('Twingle project identifier'), + ]; +} + +/** + * TwingleShop.Delete API + * + * @param array $params + * + * @return array + * API result descriptor + * + * @throws \API_Exception + * @throws \Civi\Twingle\Shop\Exceptions\ShopException + * @throws \Exception + * @see civicrm_api3_create_success + * + */ +function civicrm_api3_twingle_shop_Delete($params) { + // Filter for allowed params + $allowed_params = []; + _civicrm_api3_twingle_shop_Delete_spec($allowed_params); + $params = array_intersect_key($params, $allowed_params); + + // Find TwingleShop via getsingle API + $shop_data = civicrm_api3('TwingleShop', 'getsingle', $params); + if ($shop_data['is_error']) { + return civicrm_api3_create_error($shop_data['error_message'], + ['error_code' => $shop_data['error_code'], 'params' => $params] + ); + } + + // Get TwingleShop object + $shop = CRM_Twingle_BAO_TwingleShop::findById($shop_data['id']); + + // Delete TwingleShop + /** @var \CRM_Twingle_BAO_TwingleShop $shop */ + $result = $shop->deleteByConstraint(); + if ($result) { + return civicrm_api3_create_success(1, $params, 'TwingleShop', 'Delete'); + } + elseif ($result === 0) { + return civicrm_api3_create_error( + E::ts('TwingleShop could not be found.'), + ['error_code' => 'not_found', 'params' => $params] + ); + } + else { + return civicrm_api3_create_error( + E::ts('TwingleShop could not be deleted.'), + ['error_code' => 'delete_failed', 'params' => $params] + ); + } +} diff --git a/api/v3/TwingleShop/Fetch.php b/api/v3/TwingleShop/Fetch.php new file mode 100644 index 0000000..9c5d3e3 --- /dev/null +++ b/api/v3/TwingleShop/Fetch.php @@ -0,0 +1,96 @@ + 'project_identifiers', + 'title' => E::ts('Project Identifiers'), + 'type' => CRM_Utils_Type::T_STRING, + 'api.required' => 1, + 'description' => E::ts('Comma separated list of Twingle project identifiers.'), + ]; +} + +/** + * TwingleShop.Fetch API + * + * @param array $params + * + * @return array + * API result descriptor + * + * @see civicrm_api3_create_success + * + * @throws API_Exception + */ +function civicrm_api3_twingle_shop_Fetch($params) { + // Filter for allowed params + $allowed_params = []; + _civicrm_api3_twingle_shop_Fetch_spec($allowed_params); + $params = array_intersect_key($params, $allowed_params); + + $returnValues = []; + + // Explode string with project IDs and trim + $projectIds = array_map( + function ($projectId) { + return trim($projectId); + }, + explode(',', $params['project_identifiers']) + ); + + // Get products for all projects of type 'shop' + foreach ($projectIds as $projectId) { + try { + $shop = CRM_Twingle_BAO_TwingleShop::findByProjectIdentifier($projectId); + $products = $shop->fetchProducts(); + $returnValues[$projectId] = []; + $returnValues[$projectId] += $shop->getAttributes(); + $returnValues[$projectId]['products'] = array_map(function ($product) { + return $product->getAttributes(); + }, $products); + } + catch (ShopException | ApiCallError | ProductException $e) { + // If this project identifier doesn't belong to a project of type + // 'shop', just skip it + if ($e->getErrorCode() == ShopException::ERROR_CODE_NOT_A_SHOP) { + $returnValues[$projectId] = "project is not of type 'shop'"; + continue; + } + // Else, log error and throw exception + else { + Civi::log()->error( + $e->getMessage(), + [ + 'project_identifier' => $projectId, + 'params' => $params, + ] + ); + return civicrm_api3_create_error($e->getMessage(), [ + 'error_code' => $e->getErrorCode(), + 'project_identifier' => $projectId, + 'params' => $params, + ]); + } + } + } + + return civicrm_api3_create_success( + $returnValues, + $params, + 'TwingleShop', + 'Fetch' + ); +} diff --git a/api/v3/TwingleShop/Get.php b/api/v3/TwingleShop/Get.php new file mode 100644 index 0000000..9309e04 --- /dev/null +++ b/api/v3/TwingleShop/Get.php @@ -0,0 +1,111 @@ + 'id', + 'title' => E::ts('TwingleShop ID'), + 'type' => CRM_Utils_Type::T_INT, + 'api.required' => 0, + 'description' => E::ts('The TwingleShop ID in CiviCRM'), + ]; + $spec['project_identifier'] = [ + 'name' => 'project_identifier', + 'title' => E::ts('Project Identifier'), + 'type' => CRM_Utils_Type::T_STRING, + 'api.required' => 0, + 'description' => E::ts('Twingle project identifier'), + ]; + $spec['numerical_project_id'] = [ + 'name' => 'numerical_project_id', + 'title' => E::ts('Numerical Project Identifier'), + 'type' => CRM_Utils_Type::T_INT, + 'api.required' => 0, + 'description' => E::ts('Twingle numerical project identifier'), + ]; + $spec['name'] = [ + 'name' => 'name', + 'title' => E::ts('Name'), + 'type' => CRM_Utils_Type::T_STRING, + 'api.required' => 0, + 'description' => E::ts('Name of the TwingleShop'), + ]; + $spec['price_set_id'] = [ + 'name' => 'price_set_id', + 'title' => E::ts('Price Set ID'), + 'type' => CRM_Utils_Type::T_INT, + 'api.required' => 0, + 'description' => E::ts('FK to civicrm_price_set'), + ]; +} + +/** + * TwingleShop.Get API + * + * @param array $params + * + * @return array + * API result descriptor + * + * @see civicrm_api3_create_success + * + * @throws API_Exception + */ +function civicrm_api3_twingle_shop_Get($params) { + // Filter for allowed params + $allowed_params = []; + _civicrm_api3_twingle_shop_Get_spec($allowed_params); + $params = array_intersect_key($params, $allowed_params); + + // Build query + $query = 'SELECT * FROM civicrm_twingle_shop'; + $query_params = []; + + if (!empty($params)) { + $query = $query . ' WHERE'; + $possible_params = []; + _civicrm_api3_twingle_shop_Get_spec($possible_params); + $param_count = 1; + + foreach ($possible_params as $param) { + if (!empty($params[$param['name']])) { + $query = $query . ' ' . $param['name'] . " = %$param_count AND"; + $query_params[$param_count] = [ + $params[$param['name']], + $param['type'] == CRM_Utils_Type::T_INT ? 'Integer' : 'String' + ]; + $param_count++; + } + } + // Cut away last 'AND' + $query = substr($query, 0, -4); + } + + // Execute query + try { + $dao = CRM_Twingle_BAO_TwingleShop::executeQuery($query, $query_params); + } + catch (\Exception $e) { + return civicrm_api3_create_error($e->getMessage(), [ + 'error_code' => $e->getCode(), + 'params' => $params, + ]); + } + + // Prepare return values + $returnValues = []; + while ($dao->fetch()) { + $returnValues[] = $dao->toArray(); + } + + return civicrm_api3_create_success($returnValues, $params, 'TwingleShop', 'Get'); +} diff --git a/api/v3/TwingleShop/Getsingle.php b/api/v3/TwingleShop/Getsingle.php new file mode 100644 index 0000000..ff5cf86 --- /dev/null +++ b/api/v3/TwingleShop/Getsingle.php @@ -0,0 +1,54 @@ + 'missing_parameter', 'params' => $params] + ); + } + + // Find TwingleShop via get API + $returnValues = civicrm_api3('TwingleShop', 'get', $params); + $count = $returnValues['count']; + + // Check whether only a single TwingleShop is found + if ($count != 1) { + return civicrm_api3_create_error( + "Expected one TwingleShop but found $count", + ['error_code' => 'not_found', 'params' => $params] + ); + } + return $returnValues['values'][$returnValues['id']]; +} diff --git a/ci/README.md b/ci/README.md new file mode 100644 index 0000000..0bfc584 --- /dev/null +++ b/ci/README.md @@ -0,0 +1,2 @@ +The dependencies specified in composer.json of this directory are required to +run phpstan in CI. diff --git a/ci/composer.json b/ci/composer.json new file mode 100644 index 0000000..ab469d6 --- /dev/null +++ b/ci/composer.json @@ -0,0 +1,33 @@ +{ + "minimum-stability": "dev", + "prefer-stable": true, + "config": { + "allow-plugins": { + "civicrm/composer-compile-plugin": false, + "civicrm/composer-downloads-plugin": true, + "cweagans/composer-patches": true + } + }, + "require": { + "civicrm/civicrm-core": "^5" + }, + "scripts": { + "post-install-or-update": [ + "# The following statements are only necessary when the extension is inside a CiviCRM installation, actually not required in CI.", + "# Avoid redeclaration of function \\GuzzleHttp\\http_build_query()", + "if [ -e vendor/civicrm/civicrm-core/guzzle_php81_shim.php ]; then echo '' >vendor/civicrm/civicrm-core/guzzle_php81_shim.php; fi", + "# Avoid redeclaration of function \\GuzzleHttp\\Promise\\queue()", + "if [ -e vendor/guzzlehttp/promises/src/functions.php ]; then echo '' >vendor/guzzlehttp/promises/src/functions.php; fi", + "# Avoid CiviCRM load extensions in vendor", + "if [ -e vendor/civicrm ]; then find vendor/civicrm -name 'info.xml' -delete; fi", + "# Avoid Class 'CRM_AfformAdmin_ExtensionUtil' not found", + "find vendor -name '*.mgd.php' -delete" + ], + "post-install-cmd": [ + "@post-install-or-update" + ], + "post-update-cmd": [ + "@post-install-or-update" + ] + } +} diff --git a/composer.json b/composer.json new file mode 100644 index 0000000..5489fbd --- /dev/null +++ b/composer.json @@ -0,0 +1,45 @@ +{ + "name": "systopia/de.systopia.twingle", + "type": "civicrm-ext", + "license": "AGPL-3.0-or-later", + "minimum-stability": "dev", + "prefer-stable": true, + "config": { + "sort-packages": true + }, + "require": { + }, + "scripts": { + "composer-phpcs": [ + "@composer --working-dir=tools/phpcs" + ], + "composer-phpstan": [ + "@composer --working-dir=tools/phpstan" + ], + "composer-phpunit": [ + "@composer --working-dir=tools/phpunit" + ], + "composer-tools": [ + "@composer-phpcs", + "@composer-phpstan", + "@composer-phpunit" + ], + "phpcs": [ + "@php tools/phpcs/vendor/bin/phpcs" + ], + "phpcbf": [ + "@php tools/phpcs/vendor/bin/phpcbf" + ], + "phpstan": [ + "@php tools/phpstan/vendor/bin/phpstan" + ], + "phpunit": [ + "@php tools/phpunit/vendor/bin/simple-phpunit --coverage-text" + ], + "test": [ + "@phpcs", + "@phpstan", + "@phpunit" + ] + } +} diff --git a/css/twingle.css b/css/twingle.css new file mode 100644 index 0000000..341a393 --- /dev/null +++ b/css/twingle.css @@ -0,0 +1,3 @@ +.twingle-profile-list { + border-bottom: 1px solid #cfcec3; +} diff --git a/css/twingle_shop.css b/css/twingle_shop.css new file mode 100644 index 0000000..898001f --- /dev/null +++ b/css/twingle_shop.css @@ -0,0 +1,37 @@ +.twingle-shop-table-caption { + font-weight: bold; + font-size: 13px; + padding: 6px; + text-align: left; +} + +.twingle-shop-table-divider { + border-top: 1px solid #ddd; + margin-top: 20px; + margin-bottom: 4px; +} + +#twingle-shop-spinner { + animation: spin 2s linear infinite; +} + +.twingle-shop-table tbody tr { + height: 32px; +} + +.twingle-shop-table-button { + margin: 10px 15px 0 0 !important; +} + +.twingle-shop-cell-button { + margin: 3px 5px 3px 5px; +} + +.strikethrough { + text-decoration: line-through; +} + +@keyframes spin { + 0% { transform: rotate(0deg); } + 100% { transform: rotate(360deg); } +} diff --git a/docs/api.md b/docs/api.md new file mode 100644 index 0000000..4165d29 --- /dev/null +++ b/docs/api.md @@ -0,0 +1,87 @@ +# API documentation + +The extension provides a new CiviCRM API 3 entity `TwingleDonation` with API +actions to record a new donation, end a previously submitted recurring donation +and cancel previously submitted donation. + +### Submit donation + +This API action processes submitted Twingle donations and donor information. + +- Entity: `TwingleDonation` +- Action: `Submit` + +The action accepts the following parameters: + +| Parameter | Type | Description | Values/Format | Required | +| -------------------------------------- | ------- | ----------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------- | +| `project_id` | String | The Twingle project ID | | Yes | +| `trx_id` | String | The unique transaction ID of the donation | A unique transaction ID for the donation. | Yes | +| `confirmed_at` | String | The date when the donation was issued | A string representing a date in the format `YmdHis` | Yes | +| `purpose` | String | The purpose of the donation | | | +| `amount` | Integer | The donation amount in minor currency unit | | Yes | +| `currency` | String | The ISO-4217 currency code of the donation | A valid ISO-4217 currency code | Yes | +| `newsletter` | Boolean | Whether to subscribe the contact to the newsletter group defined in the profile | | | +| `postinfo` | Boolean | Whether to subscribe the contact to the postal mailing group defined in the profile | | | +| `donation_receipt` | Boolean | Whether the contact requested a donation receipt | | | +| `payment_method` | String | The Twingle payment method used for the donation | One of:
  • `banktransfer`
  • `debit_manual`
  • `debit_automatic`
  • `creditcard`
  • `mobilephone_germany`
  • `paypal`
  • `sofortueberweisung`
  • `amazonpay`
  • `paydirekt`
  • `applepay`
  • `googlepay`
| Yes | +| `donation_rhythm` | String | The interval which the donation is recurring in | One of:
  • `'one_time',`
  • `'halfyearly',`
  • `'quarterly',`
  • `'yearly',`
  • `'monthly'`
| Yes | +| `debit_iban` | String | The IBAN for SEPA Direct Debit payments | A valid ISO 13616-1:2007 IBAN | Yes, if `payment_method` is `debit_manual` and CiviSEPA is used | +| `debit_bic` | String | The BIC for SEPA Direct Debit payments | A valid ISO 9362 BIC | Yes, if `payment_method` is `debit_manual` and CiviSEPA is used | +| `debit_mandate_reference` | String | The mandate reference for SEPA Direct Debit payments | | | +| `debit_account_holder` | String | The account holder for SEPA Direct Debit payments | | | +| `is_anonymous` | Boolean | Whether the donation is submitted anonymously | | | +| `user_gender` | String | The gender of the contact | | | +| `user_birthdate` | String | The date of birth of the contact | A string representing a date in the format `Ymd` | | +| `user_title` | String | The formal title of the contact | | | +| `user_email` | String | The e-mail address of the contact | A valid e-mail address | | +| `user_firstname` | String | The first name of the contact | | | +| `user_lastname` | String | The last name of the contact | | | +| `user_street` | String | The street address of the contact | | | +| `user_postal_code` | String | The postal code of the contact | | | +| `user_city` | String | The city of the contact | | | +| `user_country` | String | The country of the contact | A [ISO 3166-1 Alpha-2 country code](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2#Officially_assigned_code_elements) | | +| `user_telephone` | String | The telephone number of the contact | | | +| `user_company` | String | The company of the contact | | | +| `user_extrafield` | String | Additional information of the contact | | | +| `user_language` | String | The preferred language of the contact. | A [ISO-639-1 2-digit language code](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) | | +| `campaign_id` | Integer | The CiviCRM ID of a campaign to assign the contribution | A valid CiviCRM Campaign ID. This overrides the campaign ID configured within the profile. | | + +You may also refer to +[the code](https://github.com/systopia/de.systopia.twingle/blob/master/api/v3/TwingleDonation/Submit.php) +for more insight into this API action. + +### End recurring donation + +- Entity: `TwingleDonation` +- Action: `Endrecurring` + +The action accepts the following parameters: + +| Parameter | Type | Description | Values/Format | Required | +| ------------------------- | ------- | ---------------------------------------------- | --------------------------------------------------- | -------- | +| `project_id` | String | The Twingle project ID | | Yes | +| `trx_id` | String | The unique transaction ID of the donation | A unique transaction ID for the donation. | Yes | +| `ended_at` | Integer | The date when the recurring donation was ended | A string representing a date in the format `YmdHis` | Yes | + +You may also refer to +[the code](https://github.com/systopia/de.systopia.twingle/blob/master/api/v3/TwingleDonation/Endrecurring.php) +for more insight into this API action. + +### Cancel donation + +- Entity: `TwingleDonation` +- Action: `Cancel` + +The action accepts the following parameters: + +| Parameter | Type | Description | Values/Format | Required | +| ---------------------------- | ------ | -------------------------------------------------- | --------------------------------------------------- | -------- | +| `project_id` | String | The Twingle project ID | | Yes | +| `trx_id` | String | The unique transaction ID of the donation | A unique transaction ID for the donation. | Yes | +| `cancelled_at` | String | The date when the recurring donation was cancelled | A string representing a date in the format `YmdHis` | Yes | +| `cancel_reason` | String | The reason for the donation being cancelled | | Yes | + +You may also refer to +[the code](https://github.com/systopia/de.systopia.twingle/blob/master/api/v3/TwingleDonation/Cancel.php) +for more insight into this API action. diff --git a/docs/configuration/account.md b/docs/configuration/account.md new file mode 100644 index 0000000..c141036 --- /dev/null +++ b/docs/configuration/account.md @@ -0,0 +1,27 @@ +# Twingle account settings on the Twingle website + +The use of the Twingle API extension requires that you already have a Twingle +account and that you make some settings in this account for the connection. + +You will have to provide the following settings in your Twingle account settings +in order to send donations to CiviCRM: + +1. API key from your Twingle user +2. Site key +3. URL + +Important: The URL must always be the complete URL to the CiviCRM REST API +endpoint. +Examples: + +- Drupal (with the *AuthX* extension): https://example.org/civicrm/ajax/rest +- Drupal (legacy + method): https://example.org/sites/all/modules/civicrm/extern/rest.php +- Wordpress (with CiviCRM < + 5.25): https://example.org/wp-content/plugins/civicrm/civicrm/extern/rest.php +- Wordpress (with CiviCRM + 5.25+): https://example.org/wp-json/civicrm/v3/rest + +For detailled information, please see +the [Twingle documentation](https://support.twingle.de/faq/de-de/9-anbindung-externer-systeme/46-wie-kann-ich-civicrm-mit-twingle-nutzen) ( +in German language only). diff --git a/docs/configuration/civisepa.md b/docs/configuration/civisepa.md new file mode 100644 index 0000000..28dbef2 --- /dev/null +++ b/docs/configuration/civisepa.md @@ -0,0 +1,32 @@ +# Activating CiviSEPA integration + +The Twingle API extension provides integration with the [ +*CiviSEPA*](https://civicrm.org/extensions/civisepa-sepa-direct-debit-extension) +extension. This allows for managing SEPA mandates and collections with +*CiviSEPA* for donations being initiated via a *Twingle* form. + +1. In CiviCRM, go to **Administer**. +2. Choose **Twingle API configuration**. + ![](../img/Konso.jpg) + +3. Then click on **Configure extension settings**. + ![](../img/SepaKon.jpg) + +4. Tick the boxes **Use CiviSEPA** and **Use CiviSEPA generated reference**. + These options can only be activated if CiviSEPA is installed and used. If it + is not activated, the administration of SEPA mandates will have to take place + in Twingle, which is subject to configuration of your available payment + methods. +5. Write **TW-** in the **Twingle ID Prefix** field. + To avoid overlaps when assigning CiviCRM IDs and Twingle transaction IDs, a + prefix should be assigned here, e.g. "TWNGL" or "Twingle" or similar. + Attention: The prefix should not be changed later, otherwise problems may + occur. +6. In the **Protect Recurring Contributions** field select **No**. + If you choose Yes, all recurring donations created by Twingle can no longer + be changed in CiviCRM, but must then be changed accordingly in Twingle. If no + recurring payments are processed via Twingle, but only one-off donations, + then this does not need to be activated. Otherwise, we strongly recommend + setting the button here to **Yes** so that there are no discrepancies between + CiviCRM and Twingle. + ![](../img/Sepa.jpg) diff --git a/docs/configuration/profiles.md b/docs/configuration/profiles.md new file mode 100644 index 0000000..34612c1 --- /dev/null +++ b/docs/configuration/profiles.md @@ -0,0 +1,30 @@ +# Configuring the Twingle Profile in CiviCRM + +The Twingle API extension is being configured through configuration profiles. +This allows you to have different sets of configuration, as you might want to +handle donation submissions differently, depending on which form was used. +Each profile can react to one ore more form IDs being submitted along with +donation data. + +1. In CiviCRM, go to **Administer**. +2. Choose **Twingle API configuration**. + ![](../img/Konso.jpg) + +3. Then click on **Configure profiles**. + ![](../img/SepaKon.jpg) + +4. The Twingle configuration is always done with the help of a profile. Please + use the Twingle default profile and click on **Edit**. + ![](../img/Prof.jpg) + +5. Then you will identify the Twingle API profile window. Start by entering the + corresponding information in the **General settings** section. + ![](../img/GenSet.jpg) + +6. Define the different payment methods in the Payments section. + ![](../img/twpay.jpg) + +7. Make the settings for the groups. + ![](../img/Twgrou.jpg) + +8. When you have made all the settings, please press the **Save** button. diff --git a/docs/configuration/user_permissions.md b/docs/configuration/user_permissions.md new file mode 100644 index 0000000..68e81ef --- /dev/null +++ b/docs/configuration/user_permissions.md @@ -0,0 +1,82 @@ +# User, permissions, and API authentication + +After the installation of the Twingle API extension, various configuration steps +must be carried out so that the connection functions smoothly. Among other +things, certain configurations must be made on the CMS platform CiviCRM is +implemented on. + +Connecting to the Twingle API via CiviCRM's REST interface requires a user with +appropriate permissions in your CMS-system. + +You might want to create a specific user role to assign permissions necessary +for calling the Twingle API only. This section describes how to accomplish this +in *Drupal* and *Wordpress*: + +## New User Role in Drupal + +1. In Drupal, go to **Administration/People/Permissions/Roles**. +2. Type Twingle API in the text box and select **Add role**. To the right of + your role there will be a *edit role* function and an *edit permissions* + button. The *edit permissions* selection will show only the permission + selections for the individual role. +3. As Permission you only have to select the following entry: **Twingle API: + Access Twingle API**. + +## New User Role in Wordpress + +1. In CiviCRM, go to **Administer/User and Permissions (Access Control)**. +2. Then select the **WordPress Access Control** link. + Here you can adjust the CiviCRM settings for each of the predefined User + Roles from WordPress. +3. Scroll down. As Permission you only have to select the following entry: * + *Twingle API: Access Twingle API**. + +![](../img/Twin_per.png) + +## New User in Drupal + +1. In Drupal, go to **Administration/People**. +2. Then select **Add user**. +3. In user name field enter something like **Twingle API** +5. In Roles select **Twingle API**. + +## Take over user + +The Twingle API only works correctly if a contact connected to the permissioned +user exists in CiviCRM. + +Here, the corresponding steps are described by way of example when using Drupal. + +1. In CiviCRM, go to **Administer**. +2. In the **Users and Permissions** section, choose **Synchronize Users to + Contacts**. + +![](../img/Kon_syn.jpg) + +This function checks each user record in Drupal for a contact record in CiviCRM. +If there is no corresponding contact record for a user, a new one will be +generated. Check this in your CiviCRM contact management. + +![](../img/civiuser_tw.jpg) + +## Assign API key for the Twingle API user + +The Twingle API contact in CiviCRM needs their own API key for authenticating +against CiviCRM's REST API endpoint. The API key is assigned with the help of +the API Explorer in CiviCRM. + +1. Select the Twingle API contact in CiviCRM. +2. Look for the corresponding **CiviCRM ID** and remember the ID. +3. Go to **Support/Developper/API Explorer v4**. +4. Enter **Contact** in the entity field, **create** in action field and the + **ID** of the Twingle User in the **index** field. +5. In the values field, select **api_key**. +6. Enter the API key for the Twingle API user in the **add value** field. +7. Click on **Execute**. + +![](../img/apikey.jpg) + +!!!note + You can also create API keys for contacts by using the [*API + Key*](https://civicrm.org/extensions/api-key) extension or with administrator + tools like *cv* or *drush*. diff --git a/docs/configuration/xcm.md b/docs/configuration/xcm.md new file mode 100644 index 0000000..87d36e5 --- /dev/null +++ b/docs/configuration/xcm.md @@ -0,0 +1,75 @@ +# Configuring the Extended Contact Manager extension (XCM) + +After the installation of the Twingle API extension, various configuration steps +must be carried out so that the connection functions smoothly. Twingle API +depends on the *Extended Contact Manager (XCM)* extension. + +Taking over contact data using the Twingle API means that they may produce +duplicates in your CiviCRM contact management. Before contacts are added or +updated in CiviCRM a data check should take place to avoid this problem. This +data check is handled by the *Extended Contact Manager (XCM)* extension. This +extension must be configured accordingly for use with Twingle by defining a +corresponding profile. + +## Creating an XCM Profile + +Your first task regarding the Extended Contact Manager extension (XCM) +configuration will be to create an XCM profile to be used for the Twingle API. +This works best if you copy the *Default* profile. + +1. In CiviCRM, go to **Administer**. + +2. Select **Xtended Contact Matcher (XCM) Configuration** in the **System + Settings** section. + +![](../img/XCMAdmin.jpg) + +3. Click on **Copy** in the **Default** profile. + +4. Rename the new profile with **Twingle** in the **Profile name** field. + +![](../img/ProNam.jpg) + +5. Click **Save** at the bottom of this window. In the Profiles overview you can + find your new Twingle profile. + +![](../img/XCM_Profile.jpg) + +## Set up the Extended Contact Manager extension + +After you have created the XCM profile, you must enter the configuration +settings for the Twingle connection to CiviCRM in this profile. Generally, you +will find a description of all the settings in +the [Extended Contact Manager (XCM) documentation](https://docs.civicrm.org/xcm/en/latest/configuration/). + +Here you will find as support screenshots of the various sections of the +Extended Contact Manager extension (XCM). The settings are only an example. +Please adapt the settings to your individual requirements or environnement. + +#### General section + +![](../img/XCMGen.jpg) + +#### Update section + +![](../img/XCMUpda.jpg) + +#### Assignment rules section + +![](../img/XCMReg.jpg) + +#### Identified contacts section + +![](../img/XCMIde.jpg) + +#### New contact section + +![](../img/XCMNeu.jpg) + +#### Duplicate section + +![](../img/XCMDup.jpg) + +#### Difference Handling section + +![](../img/xcmdif.jpg) diff --git a/docs/img/GenSet.jpg b/docs/img/GenSet.jpg new file mode 100644 index 0000000..072f50f Binary files /dev/null and b/docs/img/GenSet.jpg differ diff --git a/docs/img/Kon_syn.jpg b/docs/img/Kon_syn.jpg new file mode 100644 index 0000000..c9ba9d5 Binary files /dev/null and b/docs/img/Kon_syn.jpg differ diff --git a/docs/img/Konso.jpg b/docs/img/Konso.jpg new file mode 100644 index 0000000..5dfb07e Binary files /dev/null and b/docs/img/Konso.jpg differ diff --git a/docs/img/NewUser_Tw.jpg b/docs/img/NewUser_Tw.jpg new file mode 100644 index 0000000..c0857d7 Binary files /dev/null and b/docs/img/NewUser_Tw.jpg differ diff --git a/docs/img/ProNam.jpg b/docs/img/ProNam.jpg new file mode 100644 index 0000000..bf5e906 Binary files /dev/null and b/docs/img/ProNam.jpg differ diff --git a/docs/img/Prof.jpg b/docs/img/Prof.jpg new file mode 100644 index 0000000..d8246b4 Binary files /dev/null and b/docs/img/Prof.jpg differ diff --git a/docs/img/Role_Twingle.jpg b/docs/img/Role_Twingle.jpg new file mode 100644 index 0000000..b686527 Binary files /dev/null and b/docs/img/Role_Twingle.jpg differ diff --git a/docs/img/Sepa.jpg b/docs/img/Sepa.jpg new file mode 100644 index 0000000..4a6474b Binary files /dev/null and b/docs/img/Sepa.jpg differ diff --git a/docs/img/SepaKon.jpg b/docs/img/SepaKon.jpg new file mode 100644 index 0000000..9b8793e Binary files /dev/null and b/docs/img/SepaKon.jpg differ diff --git a/docs/img/Twgrou.jpg b/docs/img/Twgrou.jpg new file mode 100644 index 0000000..20f05c7 Binary files /dev/null and b/docs/img/Twgrou.jpg differ diff --git a/docs/img/Twin_per.png b/docs/img/Twin_per.png new file mode 100644 index 0000000..1ea0e10 Binary files /dev/null and b/docs/img/Twin_per.png differ diff --git a/docs/img/XCMAdmin.jpg b/docs/img/XCMAdmin.jpg new file mode 100644 index 0000000..1ad6f92 Binary files /dev/null and b/docs/img/XCMAdmin.jpg differ diff --git a/docs/img/XCMAkt.jpg b/docs/img/XCMAkt.jpg new file mode 100644 index 0000000..027975a Binary files /dev/null and b/docs/img/XCMAkt.jpg differ diff --git a/docs/img/XCMDup.jpg b/docs/img/XCMDup.jpg new file mode 100644 index 0000000..da2036a Binary files /dev/null and b/docs/img/XCMDup.jpg differ diff --git a/docs/img/XCMGen.jpg b/docs/img/XCMGen.jpg new file mode 100644 index 0000000..a35c50f Binary files /dev/null and b/docs/img/XCMGen.jpg differ diff --git a/docs/img/XCMIde.jpg b/docs/img/XCMIde.jpg new file mode 100644 index 0000000..e3bec85 Binary files /dev/null and b/docs/img/XCMIde.jpg differ diff --git a/docs/img/XCMNeu.jpg b/docs/img/XCMNeu.jpg new file mode 100644 index 0000000..53d481f Binary files /dev/null and b/docs/img/XCMNeu.jpg differ diff --git a/docs/img/XCMPro.jpg b/docs/img/XCMPro.jpg new file mode 100644 index 0000000..52cb39a Binary files /dev/null and b/docs/img/XCMPro.jpg differ diff --git a/docs/img/XCMReg.jpg b/docs/img/XCMReg.jpg new file mode 100644 index 0000000..9f7a455 Binary files /dev/null and b/docs/img/XCMReg.jpg differ diff --git a/docs/img/XCMUpda.jpg b/docs/img/XCMUpda.jpg new file mode 100644 index 0000000..054f9bc Binary files /dev/null and b/docs/img/XCMUpda.jpg differ diff --git a/docs/img/XCM_Profile.jpg b/docs/img/XCM_Profile.jpg new file mode 100644 index 0000000..741d29d Binary files /dev/null and b/docs/img/XCM_Profile.jpg differ diff --git a/docs/img/apikey.jpg b/docs/img/apikey.jpg new file mode 100644 index 0000000..12387a0 Binary files /dev/null and b/docs/img/apikey.jpg differ diff --git a/docs/img/civiuser_tw.jpg b/docs/img/civiuser_tw.jpg new file mode 100644 index 0000000..9a560b8 Binary files /dev/null and b/docs/img/civiuser_tw.jpg differ diff --git a/docs/img/twpay.jpg b/docs/img/twpay.jpg new file mode 100644 index 0000000..6a48197 Binary files /dev/null and b/docs/img/twpay.jpg differ diff --git a/docs/img/xcmdif.jpg b/docs/img/xcmdif.jpg new file mode 100644 index 0000000..8f76b12 Binary files /dev/null and b/docs/img/xcmdif.jpg differ diff --git a/docs/index.md b/docs/index.md deleted file mode 120000 index 32d46ee..0000000 --- a/docs/index.md +++ /dev/null @@ -1 +0,0 @@ -../README.md \ No newline at end of file diff --git a/docs/index.md b/docs/index.md new file mode 100644 index 0000000..8abbdd0 --- /dev/null +++ b/docs/index.md @@ -0,0 +1,15 @@ +# Twingle API +Twingle is a payment service provider that makes it possible to create donation forms with various payment options and embed them on websites or integrate them into your homepage. Interested parties can donate via known payment options ( e.g. credit card, PayPal). The procedure is also set up and optimised for mobile devices. If you want to use the Twingle fundraising service, you have to set up a corresponding online account. + +For further information about Twingle fundraising see the [Twingle](https://www.twingle.de) website. + +Twingle as fundraising service can be connected to CiviCRM via its API with the extension Twingle API. + +## Features +* Donations from Twingle can be automatically created as contributions in CiviCRM and assigned to existing or new contacts and administered in CiviCRM. +* Supporters and contacts of donations can be managed in CiviCRM. +* Donations can be submitted with different payment statuses depending on the payment type +* SEPA mandates can be created for one-off and recurring payments. +* Donors can be added to groups for receiving newsletters, mailings and donation receipts. +* A membership can be set up for a donor. +* Data can be entered in user-defined fields diff --git a/docs/installation.md b/docs/installation.md new file mode 100644 index 0000000..352a50f --- /dev/null +++ b/docs/installation.md @@ -0,0 +1,19 @@ +# Installation + +You can find an official release archive from +the [release page](https://github.com/systopia/de.systopia.twingle). + +1. First, download and then unpack the archive and move the directory into your + CiviCRM extensions folder (e.g.,`.../civicrm/ext/`. + If you don't know where your extensions folder is, just have a look in your + CiviCRM settings ( **Administer**/**System Settings**/**Directories**)). +2. Next, open the extensions page in the CiviCRM settings (**Administer**/* + *System Settings**/**Extensions**). +3. Find the extension Twingle API in the*Extensions*tab and click on**Install**. + The extension will be set up. + +## Extended Contact Matcher (XCM) + +Please note that for the correct working of Twingle API you still need to +install the extension Extended Contact Matcher (XCM), see +the [documentation](https://docs.civicrm.org/xcm). diff --git a/info.xml b/info.xml index 88ca2d9..edfa3fb 100644 --- a/info.xml +++ b/info.xml @@ -10,21 +10,33 @@ https://github.com/systopia/de.systopia.twingle - https://github.com/systopia/de.systopia.twingle/blob/master/README.md + https://docs.civicrm.org/twingle/en/latest https://github.com/systopia/de.systopia.twingle/issues http://www.gnu.org/licenses/agpl-3.0.html - 2019-01-23 - 0.9 + + 1.6-dev dev - 4.7 + 5.58 + + + + de.systopia.xcm CRM/Twingle + 23.02.1 + + menu-xml@1.0.0 + mgd-php@1.0.0 + smarty-v2@1.0.1 + entity-types-php@1.0.0 + + CRM_Twingle_Upgrader diff --git a/js/twingle_shop.js b/js/twingle_shop.js new file mode 100644 index 0000000..68c9d89 --- /dev/null +++ b/js/twingle_shop.js @@ -0,0 +1,744 @@ +/** + * This file contains the JavaScript code for the Twingle Shop integration. + */ + +/** + * This function initializes the Twingle Shop integration. + */ +function twingleShopInit() { + cj('#twingle-shop-spinner').hide(); + + // Run once on page load + load_financial_types(); + twingle_shop_active_changed(); + twingle_map_products_changed(); + twingle_fetch_products(); + + // Add event listeners + cj('#enable_shop_integration:checkbox').change(twingle_shop_active_changed); + cj('#shop_map_products:checkbox').change(twingle_map_products_changed); + cj('#btn_fetch_products').click(function (event) { + event.preventDefault(); // Prevent the default form submission behavior + twingle_fetch_products(); + }); +} + +// Define financial types as global variable +let financialTypes = {}; + +/** + * Load financial types from CiviCRM + */ +function load_financial_types() { + CRM.api3('FinancialType', 'get', { + 'sequential': 1, + 'options': { 'limit': 0 }, + }).then(function (result) { + financialTypes = result.values.reduce((obj, item) => { + obj[item.id] = item.name; + return obj; + }, {}); + }); +} + +/** + * Fetches the Twingle products for the given project identifiers. + */ +function twingle_fetch_products() { + let active = cj('#shop_map_products:checkbox:checked').length; + if (active) { + cj('#twingle-shop-spinner').show(); + CRM.api3('TwingleShop', 'fetch', { + 'project_identifiers': cj('#selectors :input').val(), + }).then(function (result) { + if (result.is_error === 1) { + cj('#btn_fetch_products').crmError(result.error_message, ts('Could not fetch products', [])); + cj('#twingle-shop-spinner').hide(); + return; + } + buildShopTables(result); + cj('#twingle-shop-spinner').hide(); + }, function () { + cj('#btn_fetch_products').crmError(ts('Could not fetch products. Please check your Twingle API key.', [])); + cj('#twingle-shop-spinner').hide(); + }); + } +} + +/** + * Update the form fields based on whether shop integration is currently active + */ +function twingle_shop_active_changed() { + let active = cj('#enable_shop_integration:checkbox:checked').length; + if (active) { + cj('.twingle-shop-element').show(); + } else { + cj('.twingle-shop-element').hide(); + } +} + +/** + * Display fetch button and product mapping when the corresponding option is active + */ +function twingle_map_products_changed() { + let active = cj('#shop_map_products:checkbox:checked').length; + if (active) { + cj('.twingle-product-mapping').show(); + } else { + cj('.twingle-product-mapping').hide(); + } +} + +/** + * This function builds the shop tables. + * @param shopData + */ +function buildShopTables(shopData) { + + let productTables = []; + + // Create table for each project (shop) + for (const key in shopData.values) { + productTables.push(new ProductsTable(shopData.values[key])); + } + + // Add table container to DOM + const tableContainer = document.getElementById('tableContainer'); + + // Add tables to table container + for (const productTable of productTables) { + tableContainer.appendChild(productTable.table); + } +} + +/** + * Get the value of the default financial type for the shops defined in this profile. + * @returns {string|string} + */ +function getShopDefaultFinancialType() { + const default_selection = document.getElementById('s2id_shop_financial_type'); + const selected = default_selection.getElementsByClassName('select2-chosen')[0]; + return selected ? selected.textContent : ''; +} + +/** + * Get the value of the default financial type. + * @returns {string} + */ +function getShopDefaultFinancialTypeValue() { + const shopDefaultFinancialType = getShopDefaultFinancialType(); + return Object.keys(financialTypes).find(key => financialTypes[key] === shopDefaultFinancialType); +} + +/** + * This class represents a Twingle Product. + */ +class Product { + + /** + * Creates a new Product object. + * @param productData + * @param parentTable + */ + constructor(productData, parentTable) { + this.parentTable = parentTable; + this.setProps(productData); + } + + /** + * Sets the properties of this product. + * @param productData + * @private + */ + setProps(productData) { + this.id = productData.id; + this.name = productData.name; + this.isActive = productData.is_active; + this.price = productData.price; + this.sort = productData.sort; + this.description = productData.description; + this.projectId = productData.project_id; + this.externalId = productData.external_id; + this.isOutdated = productData.is_outdated; + this.isOrphaned = productData.is_orphaned; + // this.updatedAt = productData.updated_at; + this.createdAt = productData.created_at; + this.twUpdatedAt = productData.tw_updated_at; + this.financialTypeId = productData.financial_type_id; + this.priceFieldId = productData.price_field_id; + } + + /** + * Dumps the product data. + * @returns {{id, name, is_active, price, sort, description, project_id, external_id, financial_type_id, tw_updated_at, twingle_shop_id: *}} + */ + dumpData() { + return { + 'id': this.id, + 'name': this.name, + 'is_active': this.isActive, + 'price': this.price, + 'sort': this.sort, + 'description': this.description, + 'project_id': this.projectId, + 'external_id': this.externalId, + 'financial_type_id': this.financialTypeId, + 'price_field_id': this.priceFieldId, + 'tw_updated_at': this.twUpdatedAt, + 'twingle_shop_id': this.parentTable.id, + }; + } + + /** + * Creates a button for creating, updating or deleting the price field for + * this product. + * @param action + * @param handler + * @returns {HTMLButtonElement} + * @private + */ + createProductButton(action, handler) { + // Create button + const button = document.createElement('button'); + button.id = action + '_twingle_product_tw_' + this.externalId; + button.classList.add('twingle-shop-cell-button'); + + // Add button text + let text = action === 'create' ? ts('Create', []) : action === 'update' ? ts('Update', []) : ts('Delete', []); + button.textContent = ' ' + ts(text, []); + + // Add button handler + if (handler) { + button.onclick = handler; + } else { + button.disabled = true; + } + + // Deactivate 'create' button if product hast no financial type + if (action === 'create' && this.financialTypeId === null) { + button.disabled = true; + } + + // Deactivate 'update' button if product is not outdated + if (action === 'update' && !this.isOutdated) { + button.disabled = true; + } + + // Add icon + const icon = document.createElement('i'); + const iconClass = action === 'create' ? 'fa-plus-circle' : action === 'update' ? 'fa-refresh' : 'fa-trash'; + icon.classList.add('crm-i', iconClass); + button.insertBefore(icon, button.firstChild); + + return button; + } + + /** + * Creates a handler for creating a price field for this product. + * @returns {(function(*): void)|*} + * @private + */ + createPriceFieldHandler() { + const self = this; + return function (event) { + event.preventDefault(); + const action = event.target.innerText.includes('Update') ? 'updated' : 'created'; + CRM.api3('TwingleProduct', 'create', self.dumpData()) + .then(function (result) { + if (result.is_error === 1) { + cj('#create_twingle_product_tw_' + self.id).crmError(result.error_message, ts('Could not create Price Field for this product', [])); + } else { + self.update(result.values); + CRM.alert(ts(`The Price Field was ${action} successfully.`, []), ts(`Price Field ${action}`, []), 'success', {'expires': 5000}); + } + }, function (error) { + cj('#create_twingle_product_tw_' + self.id).crmError(error.message, ts('Could not create Price Field for this product', [])); + }); + }; + } + + /** + * Creates a handler for creating a price field for this product. + * @returns {(function(*): void)|*} + * @private + */ + deletePriceFieldHandler() { + let self = this; + return function (event) { + event.preventDefault(); + const options = { + 'title': ts('Delete Price Field', []), + 'message': ts('Are you sure you want to delete the price field associated with this product?', []), + }; + CRM.confirm(options) + .on('crmConfirm:yes', function () { + CRM.api3('TwingleProduct', 'delete', { 'id': self.id }) + .then(function (result) { + if (result.is_error === 1) { + cj('#create_twingle_product_tw_' + self.id).crmError(result.error_message, ts('Could not delete Price Field', [])); + } else { + self.update(); + } + CRM.alert(ts('The Price Field was deleted successfully.', []), ts('Price Field deleted', []), 'success', {'expires': 5000}); + }, function (error) { + cj('#create_twingle_product_tw_' + self.id).crmError(error.message, ts('Could not delete Price Field', [])); + }); + }); + }; + } + + /** + * Creates a new row with the product name and buttons for creating, updating + * or deleting the price field for this product. + * @returns {*} + */ + createRow() { + let row; + + // Clear row + if (this.row) { + for (let i = this.row.cells.length - 1; i >= 0; i--) { + // Delete everything from row + this.row.deleteCell(i); + } + row = this.row; + } else { + // Create new row element + row = document.createElement('tr'); + + // Add id to row + row.id = 'twingle_product_tw_' + this.externalId; + } + + // Add cell with product name + const nameCell = document.createElement('td'); + if (this.isOrphaned) { + nameCell.classList.add('strikethrough'); + } + nameCell.textContent = this.name; + row.appendChild(nameCell); + + // Add cell for buttons + let buttonCell = row.insertCell(1); + + // Add product buttons which allow to create, update or delete the price + // field for this product + if (this.parentTable.id) { + let buttons = this.createProductButtons(); + for (const button of buttons) { + buttonCell.appendChild(button); + } + } + + // Add financial type dropdown for each product if price set exists + if (this.parentTable.id) { + let dropdown = this.createFinancialTypeDropdown(); + const cell = document.createElement('td'); + cell.classList.add('twingle-shop-financial-type-select'); + cell.appendChild(dropdown); + row.insertCell(2).appendChild(cell); + } + // else add default financial type + else { + const cell = document.createElement('td'); + cell.classList.add('twingle-shop-financial-type-default'); + cell.innerHTML = '' + getShopDefaultFinancialType() + ''; + row.insertCell(1).appendChild(cell); + } + + this.row = row; + return this.row; + } + + /** + * Determining which actions are available for this product and creating a + * button for each of them. + * @returns {Array} Array of buttons + */ + createProductButtons() { + let actionsAndHandlers = []; + let buttons = []; + + // Determine actions; if product has price field id, it can be updated or + // deleted, otherwise it can be created + if (this.priceFieldId) { + if (!this.isOrphaned) { + actionsAndHandlers.push(['update', this.createPriceFieldHandler()]); + } + actionsAndHandlers.push(['delete', this.deletePriceFieldHandler()]); + } else if (!this.isOrphaned) { + actionsAndHandlers.push(['create', this.createPriceFieldHandler()]); + } + + // Create button for each action + for (const [action, handler] of actionsAndHandlers) { + buttons.push(this.createProductButton(action, handler)); + } + + return buttons; + } + + /** + * Creates a dropdown for selecting the financial type for this product. + * @returns {HTMLSelectElement} + * @private + */ + createFinancialTypeDropdown() { + // Create new dropdown element + const dropdown = document.createElement('select'); + dropdown.id = 'twingle_product_tw_' + this.externalId + '_financial_type'; + + // Add empty option if no price field exists + if (!this.priceFieldId) { + let option = document.createElement('option'); + option.value = ''; + option.innerHTML = '<' + ts('select financial type', []) + '>'; + option.selected = true; + option.disabled = true; + dropdown.appendChild(option); + } + + // Add options for each financial type available in CiviCRM + for (const key in financialTypes) { + let option = document.createElement('option'); + option.value = key; + option.text = financialTypes[key]; // financialTypes is defined in twingle_shop.tpl as smarty variable + if (this.financialTypeId !== null && this.financialTypeId.toString() === key) { + option.selected = true; + } + dropdown.appendChild(option); + } + + // Add handlers + let self = this; + dropdown.onchange = function () { + + // Enable 'create' or 'update' button if financial type is selected + const button = document.getElementById('twingle_product_tw_' + self.externalId).getElementsByClassName('twingle-shop-cell-button')[0]; + if (button.textContent.includes('Create') || button.textContent.includes('Update')) { + button.disabled = dropdown.value === '0'; + } + + // Update financial type + self.financialTypeId = dropdown.value; + }; + + return dropdown; + } + + /** + * Updates the product properties and rebuilds the row. + * @param productData + */ + update(productData = null) { + if (productData) { + this.setProps(productData); + } else { + this.reset(); + } + this.createRow(); + } + + /** + * Resets the product properties. + */ + reset() { + this.financialTypeId = null; + this.priceFieldId = null; + this.isOutdated = null; + this.isOutdated = null; + // this.updatedAt = null; + this.createdAt = null; + this.id = null; + } + +} + +/** + * This class represents a Twingle Shop. + */ +class ProductsTable { + + /** + * Creates a new ProductsTable object. + * @param projectData + */ + constructor(projectData) { + this.setProps(projectData); + } + + /** + * Sets the properties of this project. + * @param projectData + * @private + */ + setProps(projectData) { + this.id = projectData.id; + this.name = projectData.name; + this.numericalProjectId = projectData.numerical_project_id; + this.projectIdentifier = projectData.project_identifier; + this.products = projectData.products.map(productData => new Product(productData, this)); + this.priceSetId = projectData.price_set_id; + this.table = this.buildTable(); + } + + /** + * Dumps the projects data. + * @returns {{price_set_id, financial_type_id, numerical_project_id, name, id, project_identifier, products: *}} + */ + dumpData() { + return { + 'id': this.id, + 'name': this.name, + 'numerical_project_id': this.numericalProjectId, + 'project_identifier': this.projectIdentifier, + 'price_set_id': this.priceSetId, + 'products': this.products.map(product => product.dumpData()), + 'financial_type_id': getShopDefaultFinancialTypeValue() + }; + } + + /** + * Builds the table for this project (shop). + * @returns {HTMLTableElement} + * @private + */ + buildTable() { + let table; + + // Clear table body + if (this.table) { + this.clearTableHeader(); + this.clearTableBody(); + this.updateTableButtons(); + table = this.table; + } else { + // Create new table element + table = document.createElement('table'); + table.classList.add('twingle-shop-table'); + table.id = this.projectIdentifier; + + // Add caption + const caption = table.createCaption(); + caption.textContent = this.name + ' (' + this.projectIdentifier + ')'; + caption.classList.add('twingle-shop-table-caption'); + + // Add table body + const tbody = document.createElement('tbody'); + table.appendChild(tbody); + + // Add table buttons + this.addTableButtons(table); + } + + // Add header row + const thead = table.createTHead(); + const headerRow = thead.insertRow(); + const headers = [ts('Product', []), ts('Financial Type', [])]; + + // Add price field column if price set exists + if (this.priceSetId) { + headers.splice(1, 0, ts('Price Field', [])); + } + + for (const headerText of headers) { + const headerCell = document.createElement('th'); + headerCell.textContent = headerText; + headerRow.appendChild(headerCell); + } + + // Add products to table + this.addProductsToTable(table); + + return table; + } + + /** + * Adds buttons for creating, updating or deleting the price set for the + * given project (shop). + * @private + */ + addTableButtons(table) { + table.appendChild(this.createTableButton('update', this.updatePriceSetHandler())); + if (this.priceSetId === null) { + table.appendChild(this.createTableButton('create', this.createPriceSetHandler())); + } else { + table.appendChild(this.createTableButton('delete', this.deletePriceSetHandler())); + } + } + + /** + * Creates a button for creating, updating or deleting the price set for the + * given project (shop). + * @param action + * @param handler + * @returns {HTMLButtonElement} + * @private + */ + createTableButton(action, handler) { + // Create button + const button = document.createElement('button'); + button.id = 'btn_' + action + '_twingle_shop_' + this.projectIdentifier; + button.classList.add('crm-button', 'twingle-shop-table-button'); + + // Add button text + const text = action === 'create' ? ts('Create Price Set', []) : action === 'update' ? ts('Update Price Set', []) : ts('Delete Price Set', []); + button.textContent = ' ' + ts(text, []); + + // Add button handler + button.onclick = handler; + + // Add icon + const icon = document.createElement('i'); + const iconClass = action === 'create' ? 'fa-plus-circle' : action === 'update' ? 'fa-refresh' : 'fa-trash'; + icon.classList.add('crm-i', iconClass); + button.insertBefore(icon, button.firstChild); + + return button; + } + + /** + * Adds products to table body. + * @param table + * @private + */ + addProductsToTable(table) { + // Get table body + const tbody = table.getElementsByTagName('tbody')[0]; + + // Add products to table body + for (const product of this.products) { + // Add row for product + const row = product.createRow(); + // Add row to table + tbody.appendChild(row); + } + } + + /** + * Updates the table buttons. + */ + updateTableButtons() { + const table_buttons = this.table.getElementsByClassName('twingle-shop-table-button'); + // Remove all price set buttons from table + while (table_buttons.length > 0) { + table_buttons[0].remove(); + } + this.addTableButtons(this.table); + } + + /** + * Clears the table header. + * @private + */ + clearTableHeader() { + const thead = this.table.getElementsByTagName('thead')[0]; + while (thead.firstChild) { + thead.removeChild(thead.firstChild); + } + } + + /** + * Clears the table body. + */ + clearTableBody() { + const tbody = this.table.getElementsByTagName('tbody')[0]; + while (tbody.firstChild) { + tbody.removeChild(tbody.firstChild); + } + } + + /** + * Creates a handler for creating the price set for the given project (shop). + * @returns {(function(*): void)|*} + */ + createPriceSetHandler() { + let self = this; + return function (event) { + event.preventDefault(); + CRM.api3('TwingleShop', 'create', self.dumpData()) + .then(function (result) { + if (result.is_error === 1) { + cj('#btn_create_price_set_' + self.projectIdentifier).crmError(result.error_message, ts('Could not create Twingle Shop', [])); + } else { + self.update(); + CRM.alert(ts('The Price Set was created successfully.', []), ts('Price Field created', []), 'success', {'expires': 5000}); + } + }, function (error) { + cj('#btn_create_price_set_' + self.projectIdentifier).crmError(error.message, ts('Could not create TwingleShop', [])); + }); + }; + } + + /** + * Creates a handler for deleting the price set for the given project (shop). + * @returns {(function(*): void)|*} + */ + deletePriceSetHandler() { + let self = this; + return function (event) { + event.preventDefault(); + const options = { + 'title': ts('Delete Price Set', []), + 'message': ts('Are you sure you want to delete the price set associated with this Twingle Shop?', []), + }; + CRM.confirm(options) + .on('crmConfirm:yes', function () { + CRM.api3('TwingleShop', 'delete', { + 'project_identifier': self.projectIdentifier, + }).then(function (result) { + if (result.is_error === 1) { + cj('#btn_create_price_set_' + self.projectIdentifier).crmError(result.error_message, ts('Could not delete Twingle Shop', [])); + } else { + self.update(); + CRM.alert(ts('The Price Set was deleted successfully.', []), ts('Price Set deleted', []), 'success', {'expires': 5000}); + } + }, function (error) { + cj('#btn_delete_price_set_' + self.projectIdentifier).crmError(error.message, ts('Could not delete Twingle Shop', [])); + }); + }); + }; + } + + /** + * Creates a handler for updating the price set for the given project (shop). + * @returns {(function(*): void)|*} + */ + updatePriceSetHandler() { + let self = this; + return function (event) { + cj('#twingle-shop-spinner').show(); + if (event) { + event.preventDefault(); + } + CRM.api3('TwingleShop', 'fetch', { + 'project_identifiers': self.projectIdentifier, + }).then(function (result) { + if (result.is_error === 1) { + cj('#btn_create_price_set_' + self.projectIdentifier).crmError(result.error_message, ts('Could not delete Twingle Shop', [])); + cj('#twingle-shop-spinner').hide(); + } else { + self.update(result.values[self.projectIdentifier]); + cj('#twingle-shop-spinner').hide(); + } + }, function (error) { + cj('#btn_update_price_set_' + self.projectIdentifier).crmError(error.message, ts('Could not update Twingle Shop', [])); + cj('#twingle-shop-spinner').hide(); + }); + }; + } + + /** + * Updates the project properties and rebuilds the table. + * @param projectData + */ + update(projectData) { + if (!projectData) { + const updatePriceSet = this.updatePriceSetHandler(); + updatePriceSet(); + } else { + this.setProps(projectData); + this.buildTable(); + } + } +} diff --git a/l10n/de.systopia.twingle.pot b/l10n/de.systopia.twingle.pot new file mode 100644 index 0000000..e358b75 --- /dev/null +++ b/l10n/de.systopia.twingle.pot @@ -0,0 +1,1600 @@ +#: CRM/Twingle/BAO/TwingleProduct.php +msgid "Could not find PriceField for Twingle Product ['id': %1, 'external_id': %2]: %3" +msgstr "" + +#: CRM/Twingle/BAO/TwingleProduct.php +msgid "Could not find PriceFieldValue for Twingle Product ['id': %1, 'external_id': %2]: %3" +msgstr "" + +#: CRM/Twingle/BAO/TwingleProduct.php +msgid "PriceField for this Twingle Product already exists." +msgstr "" + +#: CRM/Twingle/BAO/TwingleProduct.php +msgid "PriceField for this Twingle Product does not exist and cannot be edited." +msgstr "" + +#: CRM/Twingle/BAO/TwingleProduct.php +msgid "Could not check if PriceField for this Twingle Product already exists." +msgstr "" + +#: CRM/Twingle/BAO/TwingleProduct.php +msgid "Could not find PriceSet for this Twingle Product." +msgstr "" + +#: CRM/Twingle/BAO/TwingleProduct.php +msgid "Could not create PriceField for this Twingle Product: %1" +msgstr "" + +#: CRM/Twingle/BAO/TwingleProduct.php +msgid "Could not find PriceFieldValue for this Twingle Product: %1" +msgstr "" + +#: CRM/Twingle/BAO/TwingleProduct.php +msgid "Could not create PriceFieldValue for this Twingle Product: %1" +msgstr "" + +#: CRM/Twingle/BAO/TwingleProduct.php +msgid "Could not find TwingleProduct in database: %1" +msgstr "" + +#: CRM/Twingle/BAO/TwingleProduct.php +msgid "Could not save TwingleProduct to database: %1" +msgstr "" + +#: CRM/Twingle/BAO/TwingleProduct.php +msgid "An Error occurred while searching for the associated PriceFieldValue: %1" +msgstr "" + +#: CRM/Twingle/BAO/TwingleProduct.php +msgid "Could not delete associated PriceFieldValue: %1" +msgstr "" + +#: CRM/Twingle/BAO/TwingleProduct.php +msgid "PriceField for this Twingle Product still exists." +msgstr "" + +#: CRM/Twingle/BAO/TwingleProduct.php +msgid "An Error occurred while searching for the associated PriceField: %1" +msgstr "" + +#: CRM/Twingle/BAO/TwingleProduct.php +msgid "Could not delete associated PriceField: %1" +msgstr "" + +#: CRM/Twingle/BAO/TwingleShop.php +msgid "Could not find TwingleShop in database: %1" +msgstr "" + +#: CRM/Twingle/BAO/TwingleShop.php +msgid "Could not find associated PriceSet: %1" +msgstr "" + +#: CRM/Twingle/BAO/TwingleShop.php +msgid "Could not delete associated PriceSet: %1" +msgstr "" + +#: CRM/Twingle/BAO/TwingleShop.php +msgid "PriceSet for this Twingle Shop already exists." +msgstr "" + +#: CRM/Twingle/BAO/TwingleShop.php +msgid "PriceSet for this Twingle Shop does not exist and cannot be edited." +msgstr "" + +#: CRM/Twingle/BAO/TwingleShop.php +msgid "Could not check if PriceSet for this TwingleShop already exists." +msgstr "" + +#: CRM/Twingle/BAO/TwingleShop.php +msgid "Could not create PriceSet for this TwingleShop." +msgstr "" + +#: CRM/Twingle/BAO/TwingleShop.php +msgid "This Twingle Project is not a shop." +msgstr "" + +#: CRM/Twingle/BAO/TwingleShop.php +msgid "Could not retrieve Twingle projects from API.\n Please check your API credentials." +msgstr "" + +#: CRM/Twingle/BAO/TwingleShop.php +msgid "Could not retrieve associated products: %1" +msgstr "" + +#: CRM/Twingle/BAO/TwingleShop.php +msgid "Could not delete associated products: %1" +msgstr "" + +#: CRM/Twingle/Config.php +msgid "No" +msgstr "" + +#: CRM/Twingle/Config.php +msgid "Raise Exception" +msgstr "" + +#: CRM/Twingle/Config.php +msgid "Create Activity" +msgstr "" + +#: CRM/Twingle/DAO/TwingleProduct.php +msgid "Twingle Products" +msgstr "" + +#: CRM/Twingle/DAO/TwingleProduct.php +msgid "Twingle Product" +msgstr "" + +#: CRM/Twingle/DAO/TwingleProduct.php CRM/Twingle/DAO/TwingleShop.php +msgid "ID" +msgstr "" + +#: CRM/Twingle/DAO/TwingleProduct.php +msgid "Unique TwingleProduct ID" +msgstr "" + +#: CRM/Twingle/DAO/TwingleProduct.php +msgid "External ID" +msgstr "" + +#: CRM/Twingle/DAO/TwingleProduct.php +msgid "The ID of this product in the Twingle database" +msgstr "" + +#: CRM/Twingle/DAO/TwingleProduct.php api/v3/TwingleProduct/Get.php +msgid "Price Field ID" +msgstr "" + +#: CRM/Twingle/DAO/TwingleProduct.php +msgid "FK to Price Field" +msgstr "" + +#: CRM/Twingle/DAO/TwingleProduct.php api/v3/TwingleProduct/Create.php +msgid "Twingle Shop ID" +msgstr "" + +#: CRM/Twingle/DAO/TwingleProduct.php +msgid "FK to Twingle Shop" +msgstr "" + +#: CRM/Twingle/DAO/TwingleProduct.php +msgid "Created At" +msgstr "" + +#: CRM/Twingle/DAO/TwingleProduct.php +msgid "Timestamp of when the product was created in the database" +msgstr "" + +#: CRM/Twingle/DAO/TwingleProduct.php +msgid "Updated At" +msgstr "" + +#: CRM/Twingle/DAO/TwingleProduct.php +msgid "Timestamp of when the product was last updated in the database" +msgstr "" + +#: CRM/Twingle/DAO/TwingleShop.php +msgid "Twingle Shops" +msgstr "" + +#: CRM/Twingle/DAO/TwingleShop.php +msgid "Twingle Shop" +msgstr "" + +#: CRM/Twingle/DAO/TwingleShop.php +msgid "Unique TwingleShop ID" +msgstr "" + +#: CRM/Twingle/DAO/TwingleShop.php api/v3/TwingleProduct/Get.php api/v3/TwingleShop/Create.php api/v3/TwingleShop/Delete.php api/v3/TwingleShop/Get.php +msgid "Project Identifier" +msgstr "" + +#: CRM/Twingle/DAO/TwingleShop.php +msgid "Twingle Project Identifier" +msgstr "" + +#: CRM/Twingle/DAO/TwingleShop.php +msgid "Numerical Project ID" +msgstr "" + +#: CRM/Twingle/DAO/TwingleShop.php +msgid "Numerical Twingle Project Identifier" +msgstr "" + +#: CRM/Twingle/DAO/TwingleShop.php api/v3/TwingleShop/Get.php +msgid "Price Set ID" +msgstr "" + +#: CRM/Twingle/DAO/TwingleShop.php +msgid "FK to Price Set" +msgstr "" + +#: CRM/Twingle/DAO/TwingleShop.php api/v3/TwingleShop/Get.php +msgid "Name" +msgstr "" + +#: CRM/Twingle/DAO/TwingleShop.php +msgid "name of the shop" +msgstr "" + +#: CRM/Twingle/Form/Profile.php +msgid "Profile with ID \"%1\" not found" +msgstr "" + +#: CRM/Twingle/Form/Profile.php +msgid "Delete Twingle API profile %1" +msgstr "" + +#: CRM/Twingle/Form/Profile.php templates/CRM/Twingle/Page/Profiles.tpl +msgid "Reset" +msgstr "" + +#: CRM/Twingle/Form/Profile.php js/twingle_shop.js templates/CRM/Twingle/Page/Profiles.tpl +msgid "Delete" +msgstr "" + +#: CRM/Twingle/Form/Profile.php +msgid "The profile is invalid and cannot be copied." +msgstr "" + +#: CRM/Twingle/Form/Profile.php +msgid "Error" +msgstr "" + +#: CRM/Twingle/Form/Profile.php +msgid "The profile to be copied could not be found." +msgstr "" + +#: CRM/Twingle/Form/Profile.php +msgid "A database error has occurred. See the log for details." +msgstr "" + +#: CRM/Twingle/Form/Profile.php +msgid "New Twingle API profile" +msgstr "" + +#: CRM/Twingle/Form/Profile.php +msgid "Edit Twingle API profile %1" +msgstr "" + +#: CRM/Twingle/Form/Profile.php +msgid "New Profile" +msgstr "" + +#: CRM/Twingle/Form/Profile.php templates/CRM/Twingle/Page/Profiles.tpl +msgid "Profile name" +msgstr "" + +#: CRM/Twingle/Form/Profile.php CRM/Twingle/Profile.php templates/CRM/Twingle/Form/Profile.tpl +msgid "Project IDs" +msgstr "" + +#: CRM/Twingle/Form/Profile.php +msgid "Contact Matcher (XCM) Profile" +msgstr "" + +#: CRM/Twingle/Form/Profile.php CRM/Twingle/Profile.php templates/CRM/Twingle/Form/Profile.tpl +msgid "Location type" +msgstr "" + +#: CRM/Twingle/Form/Profile.php CRM/Twingle/Profile.php templates/CRM/Twingle/Form/Profile.tpl +msgid "Location type for organisations" +msgstr "" + +#: CRM/Twingle/Form/Profile.php CRM/Twingle/Profile.php templates/CRM/Twingle/Form/Profile.tpl +msgid "Financial type" +msgstr "" + +#: CRM/Twingle/Form/Profile.php CRM/Twingle/Profile.php templates/CRM/Twingle/Form/Profile.tpl +msgid "Financial type (recurring)" +msgstr "" + +#: CRM/Twingle/Form/Profile.php CRM/Twingle/Profile.php +msgid "Gender option for submitted value \"male\"" +msgstr "" + +#: CRM/Twingle/Form/Profile.php CRM/Twingle/Profile.php +msgid "Gender option for submitted value \"female\"" +msgstr "" + +#: CRM/Twingle/Form/Profile.php CRM/Twingle/Profile.php +msgid "Gender option for submitted value \"other\"" +msgstr "" + +#: CRM/Twingle/Form/Profile.php CRM/Twingle/Profile.php +msgid "Prefix option for submitted value \"male\"" +msgstr "" + +#: CRM/Twingle/Form/Profile.php CRM/Twingle/Profile.php +msgid "Prefix option for submitted value \"female\"" +msgstr "" + +#: CRM/Twingle/Form/Profile.php CRM/Twingle/Profile.php +msgid "Prefix option for submitted value \"other\"" +msgstr "" + +#: CRM/Twingle/Form/Profile.php +msgid "Record %1 as" +msgstr "" + +#: CRM/Twingle/Form/Profile.php +msgid "Record %1 donations with contribution status" +msgstr "" + +#: CRM/Twingle/Form/Profile.php CRM/Twingle/Profile.php +msgid "CiviSEPA creditor" +msgstr "" + +#: CRM/Twingle/Form/Profile.php +msgid "Use Double-Opt-In for newsletter" +msgstr "" + +#: CRM/Twingle/Form/Profile.php +msgid "Sign up for newsletter groups" +msgstr "" + +#: CRM/Twingle/Form/Profile.php +msgid "Sign up for postal mail groups" +msgstr "" + +#: CRM/Twingle/Form/Profile.php +msgid "Sign up for Donation receipt groups" +msgstr "" + +#: CRM/Twingle/Form/Profile.php +msgid "Default Campaign" +msgstr "" + +#: CRM/Twingle/Form/Profile.php +msgid "- none -" +msgstr "" + +#: CRM/Twingle/Form/Profile.php +msgid "Set Campaign for" +msgstr "" + +#: CRM/Twingle/Form/Profile.php +msgid "Contribution" +msgstr "" + +#: CRM/Twingle/Form/Profile.php +msgid "Recurring Contribution" +msgstr "" + +#: CRM/Twingle/Form/Profile.php +msgid "Membership" +msgstr "" + +#: CRM/Twingle/Form/Profile.php +msgid "SEPA Mandate" +msgstr "" + +#: CRM/Twingle/Form/Profile.php +msgid "Contacts (XCM)" +msgstr "" + +#: CRM/Twingle/Form/Profile.php +msgid "Create membership of type" +msgstr "" + +#: CRM/Twingle/Form/Profile.php +msgid "Create membership of type (recurring)" +msgstr "" + +#: CRM/Twingle/Form/Profile.php +msgid "API Call for Membership Postprocessing" +msgstr "" + +#: CRM/Twingle/Form/Profile.php +msgid "The API call must have the form 'Entity.Action'." +msgstr "" + +#: CRM/Twingle/Form/Profile.php +msgid "Contribution source" +msgstr "" + +#: CRM/Twingle/Form/Profile.php templates/CRM/Twingle/Form/Profile.tpl +msgid "Required address components" +msgstr "" + +#: CRM/Twingle/Form/Profile.php +msgid "Street" +msgstr "" + +#: CRM/Twingle/Form/Profile.php +msgid "Postal Code" +msgstr "" + +#: CRM/Twingle/Form/Profile.php api/v3/TwingleDonation/Submit.php +msgid "City" +msgstr "" + +#: CRM/Twingle/Form/Profile.php api/v3/TwingleDonation/Submit.php +msgid "Country" +msgstr "" + +#: CRM/Twingle/Form/Profile.php templates/CRM/Twingle/Form/Profile.tpl +msgid "Custom field mapping" +msgstr "" + +#: CRM/Twingle/Form/Profile.php +msgid "Create contribution notes for" +msgstr "" + +#: CRM/Twingle/Form/Profile.php api/v3/TwingleDonation/Submit.php +msgid "Purpose" +msgstr "" + +#: CRM/Twingle/Form/Profile.php api/v3/TwingleDonation/Submit.php +msgid "Remarks" +msgstr "" + +#: CRM/Twingle/Form/Profile.php +msgid "Create contact notes for" +msgstr "" + +#: CRM/Twingle/Form/Profile.php +msgid "User Extra Field" +msgstr "" + +#: CRM/Twingle/Form/Profile.php templates/CRM/Twingle/Form/Profile.tpl +msgid "Enable Shop Integration" +msgstr "" + +#: CRM/Twingle/Form/Profile.php +msgid "Default Financial Type" +msgstr "" + +#: CRM/Twingle/Form/Profile.php +msgid "Financial Type for top up donations" +msgstr "" + +#: CRM/Twingle/Form/Profile.php templates/CRM/Twingle/Form/Profile.tpl +msgid "Map Products as Price Fields" +msgstr "" + +#: CRM/Twingle/Form/Profile.php CRM/Twingle/Form/Settings.php +msgid "Save" +msgstr "" + +#: CRM/Twingle/Form/Profile.php +msgid "Warning" +msgstr "" + +#: CRM/Twingle/Form/Profile.php +msgid "The required configuration option \"%1\" has no value. Saving the profile might set this option to a possibly unwanted default value." +msgstr "" + +#: CRM/Twingle/Form/Profile.php +msgid "No profile set." +msgstr "" + +#: CRM/Twingle/Form/Profile.php +msgid "<select profile>" +msgstr "" + +#: CRM/Twingle/Form/Profile.php +msgid "none" +msgstr "" + +#: CRM/Twingle/Form/Profile.php +msgid "CiviSEPA" +msgstr "" + +#: CRM/Twingle/Form/Profile.php +msgid "No mailing lists available" +msgstr "" + +#: CRM/Twingle/Form/Settings.php +msgid "Twingle ID Prefix" +msgstr "" + +#: CRM/Twingle/Form/Settings.php +msgid "Use CiviSEPA" +msgstr "" + +#: CRM/Twingle/Form/Settings.php +msgid "Use CiviSEPA generated reference" +msgstr "" + +#: CRM/Twingle/Form/Settings.php +msgid "Protect Recurring Contributions" +msgstr "" + +#: CRM/Twingle/Form/Settings.php +msgid "Activity Type" +msgstr "" + +#: CRM/Twingle/Form/Settings.php +msgid "Subject" +msgstr "" + +#: CRM/Twingle/Form/Settings.php +msgid "Status" +msgstr "" + +#: CRM/Twingle/Form/Settings.php +msgid "Assigned To" +msgstr "" + +#: CRM/Twingle/Form/Settings.php +msgid "Use Twingle Shop Integration" +msgstr "" + +#: CRM/Twingle/Form/Settings.php +msgid "Twingle Access Key" +msgstr "" + +#: CRM/Twingle/Form/Settings.php +msgid "This is required for activity creation" +msgstr "" + +#: CRM/Twingle/Form/Settings.php +msgid "An Access Key is required to enable Twingle Shop Integration" +msgstr "" + +#: CRM/Twingle/Form/Settings.php +msgid "-select-" +msgstr "" + +#: CRM/Twingle/Page/Profiles.php managed/Navigation__twingle_configuration.mgd.php +msgid "Twingle API Profiles" +msgstr "" + +#: CRM/Twingle/Profile.php +msgid "Unknown attribute %1." +msgstr "" + +#: CRM/Twingle/Profile.php +msgid "Profile name cannot be empty." +msgstr "" + +#: CRM/Twingle/Profile.php +msgid "Only alphanumeric characters, space and the underscore (_) are allowed for profile names." +msgstr "" + +#: CRM/Twingle/Profile.php +msgid "A profile with the name '%1' already exists." +msgstr "" + +#: CRM/Twingle/Profile.php +msgid "Project ID(s) [%1] already used in profile '%2'." +msgstr "" + +#: CRM/Twingle/Profile.php +msgid "Could not parse custom field mapping." +msgstr "" + +#: CRM/Twingle/Profile.php +msgid "Custom field custom_%1 does not exist." +msgstr "" + +#: CRM/Twingle/Profile.php +msgid "Custom field custom_%1 is not in a CustomGroup that extends one of the supported CiviCRM entities." +msgstr "" + +#: CRM/Twingle/Profile.php +msgid "Could not save/update profile: %1" +msgstr "" + +#: CRM/Twingle/Profile.php +msgid "Could not reset default profile: %1" +msgstr "" + +#: CRM/Twingle/Profile.php +msgid "Could not delete profile: %1" +msgstr "" + +#: CRM/Twingle/Profile.php +msgid "Contribution Status" +msgstr "" + +#: CRM/Twingle/Profile.php +msgid "Bank transfer" +msgstr "" + +#: CRM/Twingle/Profile.php +msgid "Debit manual" +msgstr "" + +#: CRM/Twingle/Profile.php +msgid "Debit automatic" +msgstr "" + +#: CRM/Twingle/Profile.php +msgid "Credit card" +msgstr "" + +#: CRM/Twingle/Profile.php +msgid "Mobile phone Germany" +msgstr "" + +#: CRM/Twingle/Profile.php +msgid "PayPal" +msgstr "" + +#: CRM/Twingle/Profile.php +msgid "SOFORT Überweisung" +msgstr "" + +#: CRM/Twingle/Profile.php +msgid "Amazon Pay" +msgstr "" + +#: CRM/Twingle/Profile.php +msgid "Apple Pay" +msgstr "" + +#: CRM/Twingle/Profile.php +msgid "Google Pay" +msgstr "" + +#: CRM/Twingle/Profile.php +msgid "Paydirekt" +msgstr "" + +#: CRM/Twingle/Profile.php +msgid "Twint" +msgstr "" + +#: CRM/Twingle/Profile.php +msgid "iDEAL" +msgstr "" + +#: CRM/Twingle/Profile.php +msgid "Postfinance" +msgstr "" + +#: CRM/Twingle/Profile.php +msgid "Bancontact" +msgstr "" + +#: CRM/Twingle/Profile.php +msgid "Generic Payment Method" +msgstr "" + +#: CRM/Twingle/Profile.php +msgid "never" +msgstr "" + +#: CRM/Twingle/Submission.php +msgid "Invalid donation rhythm." +msgstr "" + +#: CRM/Twingle/Submission.php +msgid "Payment method could not be matched to existing payment instrument." +msgstr "" + +#: CRM/Twingle/Submission.php +msgid "Invalid date for parameter \"confirmed_at\"." +msgstr "" + +#: CRM/Twingle/Submission.php +msgid "Invalid date for parameter \"user_birthdate\"." +msgstr "" + +#: CRM/Twingle/Submission.php +msgid "Gender could not be matched to existing gender." +msgstr "" + +#: CRM/Twingle/Submission.php +msgid "Invalid format for custom fields." +msgstr "" + +#: CRM/Twingle/Submission.php +msgid "Invalid format for products." +msgstr "" + +#: CRM/Twingle/Submission.php +msgid "campaign_id must be a numeric string. " +msgstr "" + +#: CRM/Twingle/Submission.php +msgid "Unknown country %1." +msgstr "" + +#: CRM/Twingle/Submission.php +msgid "Could not calculate SEPA cycle day from configuration." +msgstr "" + +#: CRM/Twingle/Submission.php +msgid "Could not create line item for product '%1'" +msgstr "" + +#: CRM/Twingle/Submission.php +msgid "Could not create line item for donation" +msgstr "" + +#: CRM/Twingle/Tools.php +msgid "This is a Twingle recurring contribution. It should be terminated through the Twingle interface, otherwise it will still be collected." +msgstr "" + +#: CRM/Twingle/Tools.php +msgid "Recurring contribution [%1] (Transaction ID '%2') was terminated by a user. You need to end the corresponding record in Twingle as well, or it will still be collected." +msgstr "" + +#: Civi/Twingle/Shop/ApiCall.php +msgid "Could not find Twingle API token" +msgstr "" + +#: Civi/Twingle/Shop/ApiCall.php +msgid "Call to Twingle API failed. Please check your api token." +msgstr "" + +#: Civi/Twingle/Shop/ApiCall.php +msgid "GET curl failed" +msgstr "" + +#: Civi/Twingle/Shop/ApiCall.php +msgid "http status code 404 (not found)" +msgstr "" + +#: Civi/Twingle/Shop/ApiCall.php +msgid "https status code 500 (internal error)" +msgstr "" + +#: Civi/Twingle/Shop/ApiCall.php +msgid "Connection not yet established. Use connect() method." +msgstr "" + +#: api/v3/TwingleDonation/Cancel.php api/v3/TwingleDonation/Endrecurring.php api/v3/TwingleDonation/Submit.php +msgid "Project ID" +msgstr "" + +#: api/v3/TwingleDonation/Cancel.php api/v3/TwingleDonation/Endrecurring.php api/v3/TwingleDonation/Submit.php +msgid "The Twingle project ID." +msgstr "" + +#: api/v3/TwingleDonation/Cancel.php api/v3/TwingleDonation/Endrecurring.php api/v3/TwingleDonation/Submit.php +msgid "Transaction ID" +msgstr "" + +#: api/v3/TwingleDonation/Cancel.php api/v3/TwingleDonation/Endrecurring.php api/v3/TwingleDonation/Submit.php +msgid "The unique transaction ID of the donation" +msgstr "" + +#: api/v3/TwingleDonation/Cancel.php +msgid "Cancelled at" +msgstr "" + +#: api/v3/TwingleDonation/Cancel.php +msgid "The date when the donation was cancelled, format: YmdHis." +msgstr "" + +#: api/v3/TwingleDonation/Cancel.php +msgid "Cancel reason" +msgstr "" + +#: api/v3/TwingleDonation/Cancel.php +msgid "The reason for the donation being cancelled." +msgstr "" + +#: api/v3/TwingleDonation/Cancel.php +msgid "Invalid date for parameter \"cancelled_at\"." +msgstr "" + +#: api/v3/TwingleDonation/Cancel.php +msgid "SEPA Mandate for contribution [%1 not found." +msgstr "" + +#: api/v3/TwingleDonation/Cancel.php api/v3/TwingleDonation/Endrecurring.php +msgid "Could not terminate SEPA mandate" +msgstr "" + +#: api/v3/TwingleDonation/Endrecurring.php +msgid "Ended at" +msgstr "" + +#: api/v3/TwingleDonation/Endrecurring.php +msgid "The date when the recurring donation was ended, format: YmdHis." +msgstr "" + +#: api/v3/TwingleDonation/Endrecurring.php +msgid "Invalid date for parameter \"ended_at\"." +msgstr "" + +#: api/v3/TwingleDonation/Endrecurring.php +msgid "SEPA Mandate for recurring contribution [%1 not found." +msgstr "" + +#: api/v3/TwingleDonation/Endrecurring.php +msgid "SEPA Mandate [%1] already terminated." +msgstr "" + +#: api/v3/TwingleDonation/Endrecurring.php +msgid "Mandate closed by TwingleDonation.Endrecurring API call" +msgstr "" + +#: api/v3/TwingleDonation/Submit.php +msgid "Confirmed at" +msgstr "" + +#: api/v3/TwingleDonation/Submit.php +msgid "The date when the donation was issued, format: YmdHis." +msgstr "" + +#: api/v3/TwingleDonation/Submit.php +msgid "The purpose of the donation." +msgstr "" + +#: api/v3/TwingleDonation/Submit.php +msgid "Amount" +msgstr "" + +#: api/v3/TwingleDonation/Submit.php +msgid "The donation amount in minor currency unit." +msgstr "" + +#: api/v3/TwingleDonation/Submit.php +msgid "Currency" +msgstr "" + +#: api/v3/TwingleDonation/Submit.php +msgid "The ISO-4217 currency code of the donation." +msgstr "" + +#: api/v3/TwingleDonation/Submit.php +msgid "Newsletter" +msgstr "" + +#: api/v3/TwingleDonation/Submit.php +msgid "Whether to subscribe the contact to the newsletter group defined in the profile." +msgstr "" + +#: api/v3/TwingleDonation/Submit.php +msgid "Postal mailing" +msgstr "" + +#: api/v3/TwingleDonation/Submit.php +msgid "Whether to subscribe the contact to the postal mailing group defined in the profile." +msgstr "" + +#: api/v3/TwingleDonation/Submit.php +msgid "Donation receipt" +msgstr "" + +#: api/v3/TwingleDonation/Submit.php +msgid "Whether the contact requested a donation receipt." +msgstr "" + +#: api/v3/TwingleDonation/Submit.php +msgid "Payment method" +msgstr "" + +#: api/v3/TwingleDonation/Submit.php +msgid "The Twingle payment method used for the donation." +msgstr "" + +#: api/v3/TwingleDonation/Submit.php +msgid "Donation rhythm" +msgstr "" + +#: api/v3/TwingleDonation/Submit.php +msgid "The interval which the donation is recurring in." +msgstr "" + +#: api/v3/TwingleDonation/Submit.php +msgid "SEPA IBAN" +msgstr "" + +#: api/v3/TwingleDonation/Submit.php +msgid "The IBAN for SEPA Direct Debit payments, conforming with ISO 13616-1:2007." +msgstr "" + +#: api/v3/TwingleDonation/Submit.php +msgid "SEPA BIC" +msgstr "" + +#: api/v3/TwingleDonation/Submit.php +msgid "The BIC for SEPA Direct Debit payments, conforming with ISO 9362." +msgstr "" + +#: api/v3/TwingleDonation/Submit.php +msgid "SEPA Direct Debit Mandate reference" +msgstr "" + +#: api/v3/TwingleDonation/Submit.php +msgid "The mandate reference for SEPA Direct Debit payments." +msgstr "" + +#: api/v3/TwingleDonation/Submit.php +msgid "SEPA Direct Debit Account holder" +msgstr "" + +#: api/v3/TwingleDonation/Submit.php +msgid "The account holder for SEPA Direct Debit payments." +msgstr "" + +#: api/v3/TwingleDonation/Submit.php +msgid "Anonymous donation" +msgstr "" + +#: api/v3/TwingleDonation/Submit.php +msgid "Whether the donation is submitted anonymously." +msgstr "" + +#: api/v3/TwingleDonation/Submit.php +msgid "Gender" +msgstr "" + +#: api/v3/TwingleDonation/Submit.php +msgid "The gender of the contact." +msgstr "" + +#: api/v3/TwingleDonation/Submit.php +msgid "Date of birth" +msgstr "" + +#: api/v3/TwingleDonation/Submit.php +msgid "The date of birth of the contact, format: Ymd." +msgstr "" + +#: api/v3/TwingleDonation/Submit.php +msgid "Formal title" +msgstr "" + +#: api/v3/TwingleDonation/Submit.php +msgid "The formal title of the contact." +msgstr "" + +#: api/v3/TwingleDonation/Submit.php +msgid "Email address" +msgstr "" + +#: api/v3/TwingleDonation/Submit.php +msgid "The e-mail address of the contact." +msgstr "" + +#: api/v3/TwingleDonation/Submit.php +msgid "First name" +msgstr "" + +#: api/v3/TwingleDonation/Submit.php +msgid "The first name of the contact." +msgstr "" + +#: api/v3/TwingleDonation/Submit.php +msgid "Last name" +msgstr "" + +#: api/v3/TwingleDonation/Submit.php +msgid "The last name of the contact." +msgstr "" + +#: api/v3/TwingleDonation/Submit.php +msgid "Street address" +msgstr "" + +#: api/v3/TwingleDonation/Submit.php +msgid "The street address of the contact." +msgstr "" + +#: api/v3/TwingleDonation/Submit.php +msgid "Postal code" +msgstr "" + +#: api/v3/TwingleDonation/Submit.php +msgid "The postal code of the contact." +msgstr "" + +#: api/v3/TwingleDonation/Submit.php +msgid "The city of the contact." +msgstr "" + +#: api/v3/TwingleDonation/Submit.php +msgid "The country of the contact." +msgstr "" + +#: api/v3/TwingleDonation/Submit.php +msgid "Telephone" +msgstr "" + +#: api/v3/TwingleDonation/Submit.php +msgid "The telephone number of the contact." +msgstr "" + +#: api/v3/TwingleDonation/Submit.php +msgid "Company" +msgstr "" + +#: api/v3/TwingleDonation/Submit.php +msgid "The company of the contact." +msgstr "" + +#: api/v3/TwingleDonation/Submit.php +msgid "Language" +msgstr "" + +#: api/v3/TwingleDonation/Submit.php +msgid "The preferred language of the contact. A 2-digit ISO-639-1 language code." +msgstr "" + +#: api/v3/TwingleDonation/Submit.php +msgid "User extra field" +msgstr "" + +#: api/v3/TwingleDonation/Submit.php +msgid "Additional information of the contact." +msgstr "" + +#: api/v3/TwingleDonation/Submit.php +msgid "Campaign ID" +msgstr "" + +#: api/v3/TwingleDonation/Submit.php +msgid "The CiviCRM ID of a campaign to assign the contribution." +msgstr "" + +#: api/v3/TwingleDonation/Submit.php +msgid "Custom fields" +msgstr "" + +#: api/v3/TwingleDonation/Submit.php +msgid "Additional information for either the contact or the (recurring) contribution." +msgstr "" + +#: api/v3/TwingleDonation/Submit.php +msgid "Products" +msgstr "" + +#: api/v3/TwingleDonation/Submit.php +msgid "Products ordered via TwingleShop" +msgstr "" + +#: api/v3/TwingleDonation/Submit.php +msgid "Additional remarks for the donation." +msgstr "" + +#: api/v3/TwingleDonation/Submit.php +msgid "Contribution with the given transaction ID already exists." +msgstr "" + +#: api/v3/TwingleDonation/Submit.php +msgid "Organisation contact could not be found or created." +msgstr "" + +#: api/v3/TwingleDonation/Submit.php +msgid "Individual contact could not be found or created." +msgstr "" + +#: api/v3/TwingleDonation/Submit.php +msgid "Missing attribute %1 for SEPA mandate" +msgstr "" + +#: api/v3/TwingleDonation/Submit.php +msgid "SEPA creditor is not configured for profile \"%1\"." +msgstr "" + +#: api/v3/TwingleDonation/Submit.php +msgid "Could not create recurring contribution." +msgstr "" + +#: api/v3/TwingleDonation/Submit.php +msgid "Could not find recurring contribution with given parent transaction ID." +msgstr "" + +#: api/v3/TwingleDonation/Submit.php +msgid "Could not create contribution" +msgstr "" + +#: api/v3/TwingleDonation/Submit.php +msgid "Twingle membership postprocessing call has failed, see log for more information" +msgstr "" + +#: api/v3/TwingleProduct/Create.php api/v3/TwingleProduct/Delete.php api/v3/TwingleProduct/Get.php +msgid "TwingleProduct ID" +msgstr "" + +#: api/v3/TwingleProduct/Create.php +msgid "The TwingleProduct ID in the database" +msgstr "" + +#: api/v3/TwingleProduct/Create.php +msgid "Twingle ID" +msgstr "" + +#: api/v3/TwingleProduct/Create.php +msgid "External product ID in Twingle database" +msgstr "" + +#: api/v3/TwingleProduct/Create.php +msgid "ID of the corresponding Twingle Shop" +msgstr "" + +#: api/v3/TwingleProduct/Create.php +msgid "Product Name" +msgstr "" + +#: api/v3/TwingleProduct/Create.php +msgid "Name of the product" +msgstr "" + +#: api/v3/TwingleProduct/Create.php +msgid "Is active?" +msgstr "" + +#: api/v3/TwingleProduct/Create.php +msgid "Is the product active?" +msgstr "" + +#: api/v3/TwingleProduct/Create.php +msgid "Product Description" +msgstr "" + +#: api/v3/TwingleProduct/Create.php +msgid "Short description of the product" +msgstr "" + +#: api/v3/TwingleProduct/Create.php +msgid "Product Price" +msgstr "" + +#: api/v3/TwingleProduct/Create.php +msgid "Price of the product" +msgstr "" + +#: api/v3/TwingleProduct/Create.php +msgid "Sort" +msgstr "" + +#: api/v3/TwingleProduct/Create.php +msgid "Sort order of the product" +msgstr "" + +#: api/v3/TwingleProduct/Create.php api/v3/TwingleShop/Create.php +msgid "Financial Type ID" +msgstr "" + +#: api/v3/TwingleProduct/Create.php +msgid "ID of the financial type of the product" +msgstr "" + +#: api/v3/TwingleProduct/Create.php +msgid "FK to TwingleShop" +msgstr "" + +#: api/v3/TwingleProduct/Create.php +msgid "Twingle timestamp" +msgstr "" + +#: api/v3/TwingleProduct/Create.php +msgid "Timestamp of last update in Twingle db" +msgstr "" + +#: api/v3/TwingleProduct/Create.php +msgid "FK to PriceField" +msgstr "" + +#: api/v3/TwingleProduct/Delete.php api/v3/TwingleProduct/Get.php +msgid "The TwingleProduct ID in CiviCRM" +msgstr "" + +#: api/v3/TwingleProduct/Delete.php api/v3/TwingleProduct/Get.php +msgid "External TwingleProduct ID" +msgstr "" + +#: api/v3/TwingleProduct/Delete.php api/v3/TwingleProduct/Get.php +msgid "Twingle's ID of the product" +msgstr "" + +#: api/v3/TwingleProduct/Delete.php +msgid "TwingleProduct could not be deleted." +msgstr "" + +#: api/v3/TwingleProduct/Get.php +msgid "FK to civicrm_price_field" +msgstr "" + +#: api/v3/TwingleProduct/Get.php api/v3/TwingleShop/Delete.php api/v3/TwingleShop/Get.php +msgid "TwingleShop ID" +msgstr "" + +#: api/v3/TwingleProduct/Get.php api/v3/TwingleShop/Delete.php api/v3/TwingleShop/Get.php +msgid "The TwingleShop ID in CiviCRM" +msgstr "" + +#: api/v3/TwingleProduct/Get.php api/v3/TwingleShop/Create.php api/v3/TwingleShop/Delete.php api/v3/TwingleShop/Get.php +msgid "Twingle project identifier" +msgstr "" + +#: api/v3/TwingleProduct/Get.php api/v3/TwingleShop/Create.php api/v3/TwingleShop/Get.php +msgid "Numerical Project Identifier" +msgstr "" + +#: api/v3/TwingleProduct/Get.php api/v3/TwingleShop/Get.php +msgid "Twingle numerical project identifier" +msgstr "" + +#: api/v3/TwingleShop/Create.php +msgid "Numerical Twingle project identifier" +msgstr "" + +#: api/v3/TwingleShop/Create.php +msgid "Shop Name" +msgstr "" + +#: api/v3/TwingleShop/Create.php +msgid "Name of the shop" +msgstr "" + +#: api/v3/TwingleShop/Create.php +msgid "FK to civicrm_financial_type" +msgstr "" + +#: api/v3/TwingleShop/Delete.php +msgid "TwingleShop could not be found." +msgstr "" + +#: api/v3/TwingleShop/Delete.php +msgid "TwingleShop could not be deleted." +msgstr "" + +#: api/v3/TwingleShop/Fetch.php +msgid "Project Identifiers" +msgstr "" + +#: api/v3/TwingleShop/Fetch.php +msgid "Comma separated list of Twingle project identifiers." +msgstr "" + +#: api/v3/TwingleShop/Get.php +msgid "Name of the TwingleShop" +msgstr "" + +#: api/v3/TwingleShop/Get.php +msgid "FK to civicrm_price_set" +msgstr "" + +#: js/twingle_shop.js +msgid "Could not fetch products" +msgstr "" + +#: js/twingle_shop.js +msgid "Could not fetch products. Please check your Twingle API key." +msgstr "" + +#: js/twingle_shop.js +msgid "Create" +msgstr "" + +#: js/twingle_shop.js +msgid "Update" +msgstr "" + +#: js/twingle_shop.js +msgid "Could not create Price Field for this product" +msgstr "" + +#: js/twingle_shop.js +msgid "Delete Price Field" +msgstr "" + +#: js/twingle_shop.js +msgid "Are you sure you want to delete the price field associated with this product?" +msgstr "" + +#: js/twingle_shop.js +msgid "Could not delete Price Field" +msgstr "" + +#: js/twingle_shop.js +msgid "The Price Field was deleted successfully." +msgstr "" + +#: js/twingle_shop.js +msgid "Price Field deleted" +msgstr "" + +#: js/twingle_shop.js +msgid "select financial type" +msgstr "" + +#: js/twingle_shop.js +msgid "Product" +msgstr "" + +#: js/twingle_shop.js +msgid "Financial Type" +msgstr "" + +#: js/twingle_shop.js +msgid "Price Field" +msgstr "" + +#: js/twingle_shop.js +msgid "Create Price Set" +msgstr "" + +#: js/twingle_shop.js +msgid "Update Price Set" +msgstr "" + +#: js/twingle_shop.js +msgid "Delete Price Set" +msgstr "" + +#: js/twingle_shop.js +msgid "Could not create Twingle Shop" +msgstr "" + +#: js/twingle_shop.js +msgid "The Price Set was created successfully." +msgstr "" + +#: js/twingle_shop.js +msgid "Price Field created" +msgstr "" + +#: js/twingle_shop.js +msgid "Could not create TwingleShop" +msgstr "" + +#: js/twingle_shop.js +msgid "Are you sure you want to delete the price set associated with this Twingle Shop?" +msgstr "" + +#: js/twingle_shop.js +msgid "Could not delete Twingle Shop" +msgstr "" + +#: js/twingle_shop.js +msgid "The Price Set was deleted successfully." +msgstr "" + +#: js/twingle_shop.js +msgid "Price Set deleted" +msgstr "" + +#: js/twingle_shop.js +msgid "Could not update Twingle Shop" +msgstr "" + +#: managed/Navigation__twingle_configuration.mgd.php +msgid "Twingle API Configuration" +msgstr "" + +#: managed/Navigation__twingle_configuration.mgd.php +msgid "Twingle API Settings" +msgstr "" + +#: templates/CRM/Twingle/Form/Profile.hlp +msgid "Select which location type to use for addresses for individuals, either when no organisation name is specified, or an organisation address can not be shared with the individual contact." +msgstr "" + +#: templates/CRM/Twingle/Form/Profile.hlp +msgid "Put your project's Twingle ID in here, to activate this profile for that project." +msgstr "" + +#: templates/CRM/Twingle/Form/Profile.hlp +msgid "You can also provide multiple project IDs separated by a comma." +msgstr "" + +#: templates/CRM/Twingle/Form/Profile.hlp +msgid "The Contact Matcher (XCM) manages the identification or creation of the related contact." +msgstr "" + +#: templates/CRM/Twingle/Form/Profile.hlp +msgid "We recommend creating a new XCM profile only to be used with the Twingle API." +msgstr "" + +#: templates/CRM/Twingle/Form/Profile.hlp +msgid "Select which location type to use for addresses for organisations and shared organisation addresses for individual contacts." +msgstr "" + +#: templates/CRM/Twingle/Form/Profile.hlp +msgid "Select which financial type to use for one-time contributions." +msgstr "" + +#: templates/CRM/Twingle/Form/Profile.hlp +msgid "Select which financial type to use for recurring contributions." +msgstr "" + +#: templates/CRM/Twingle/Form/Profile.hlp +msgid "Select whether to use CiviCRM's Double-Opt-In feature for subscribing to mailing lists. Note that this only works for public mailing lists. Any non-public mailing list selected above will be ignored when this setting is enabled." +msgstr "" + +#: templates/CRM/Twingle/Form/Profile.hlp +msgid "Also, do not forget to disable Twingle's own Double Opt-In option in the Twingle Manager to avoid subscribers receiving multiple confirmation e-mails. Only one or the other option should be enabled." +msgstr "" + +#: templates/CRM/Twingle/Form/Profile.hlp +msgid "Some organisations have specific conventions on how a membership should be created. Since the Twingle-API can only create a \"bare bone\" membership object, you can enter a API Call (as 'Entity.Action') to adjust any newly created membership to your organisation's needs." +msgstr "" + +#: templates/CRM/Twingle/Form/Profile.hlp +msgid "The API call would receive the following parameters:
    \n
  • membership_id: The ID of the newly created membership
    • \n
  • contact_id: The ID of the contact involved
    • \n
  • organization_id: The ID of the contact's organisation, potentially empty
    • \n
  • contribution_id: The ID contribution received, potentially empty
    • \n
  • recurring_contribution_id: The ID of the recurring contribution. If empty, this was only a one-off donation.
    • \n
" +msgstr "" + +#: templates/CRM/Twingle/Form/Profile.hlp +msgid "Select the address components that must be present to create or update an address for the contact." +msgstr "" + +#: templates/CRM/Twingle/Form/Profile.hlp +msgid "Depending on your XCM settings, the transferred address might replace an existing one." +msgstr "" + +#: templates/CRM/Twingle/Form/Profile.hlp +msgid "Since in some cases Twingle send the country of the user as the only address parameter, depending on your XCM configuration, not declaring other address components as required might lead to the current user address being overwritten with an address containing the country only." +msgstr "" + +#: templates/CRM/Twingle/Form/Profile.hlp +msgid "

Map Twingle custom fields to CiviCRM fields using the following format (each assignment in a separate line):

\n 
twingle_field_1=custom_123
twingle_field_2=custom_789
\n

Always use the custom_[id] notation for CiviCRM custom fields.

\n

This works for fields that Twingle themselves provide in the custom_fields parameter, and for any other parameter (e.g. user_extrafield)

\n

Only custom fields extending one of the following CiviCRM entities are allowed:

\n
    \n
  • Contact – Will be set on the Individual contact
    • \n
  • Individual – Will be set on the Individual contact
    • \n
  • Organization – Will be set on the Organization contact, if an organisation name was submitted
    • \n
  • Contribution – Will be set on the contribution
    • \n
  • ContributionRecur – Will be set on the recurring contribution and deriving single contributions
    • \n
" +msgstr "" + +#: templates/CRM/Twingle/Form/Profile.hlp +msgid "

Create a contribution note for each field specified in this selection.

\n

Tip: You can enable or disable this fields in the TwingleMANAGER.

" +msgstr "" + +#: templates/CRM/Twingle/Form/Profile.hlp +msgid "

Create a contact note for each field specified in this selection.

\n

Tip: You can enable or disable this fields in the TwingleMANAGER.

" +msgstr "" + +#: templates/CRM/Twingle/Form/Profile.hlp +msgid "Enable the processing of orders via Twingle Shop for this profile. The ordered products will then appear as line items in the contribution." +msgstr "" + +#: templates/CRM/Twingle/Form/Profile.hlp +msgid "If this option is enabled, all Twingle Shop products corresponding to the specified project IDs will be retrieved from Twingle and mapped as price sets and price fields. Each Twingle Shop is mapped as a price set with its products as price fields." +msgstr "" + +#: templates/CRM/Twingle/Form/Profile.hlp +msgid "This allows you to manually create contributions with the same line items for phone orders, for example, as would be the case for orders placed through the Twingle Shop." +msgstr "" + +#: templates/CRM/Twingle/Form/Profile.tpl +msgid "General settings" +msgstr "" + +#: templates/CRM/Twingle/Form/Profile.tpl +msgid "Help" +msgstr "" + +#: templates/CRM/Twingle/Form/Profile.tpl +msgid "XCM Profile" +msgstr "" + +#: templates/CRM/Twingle/Form/Profile.tpl +msgid "Gender/Prefix for value 'male'" +msgstr "" + +#: templates/CRM/Twingle/Form/Profile.tpl +msgid "Gender/Prefix for value 'female'" +msgstr "" + +#: templates/CRM/Twingle/Form/Profile.tpl +msgid "Gender/Prefix for value 'other'" +msgstr "" + +#: templates/CRM/Twingle/Form/Profile.tpl +msgid "Payment methods" +msgstr "" + +#: templates/CRM/Twingle/Form/Profile.tpl +msgid "Groups and Correlations" +msgstr "" + +#: templates/CRM/Twingle/Form/Profile.tpl +msgid "Newsletter Double Opt-In" +msgstr "" + +#: templates/CRM/Twingle/Form/Profile.tpl +msgid "Membership Postprocessing" +msgstr "" + +#: templates/CRM/Twingle/Form/Profile.tpl templates/CRM/Twingle/Page/Profiles.tpl +msgid "Shop Integration" +msgstr "" + +#: templates/CRM/Twingle/Form/Profile.tpl +msgid "Are you sure you want to reset the default profile?" +msgstr "" + +#: templates/CRM/Twingle/Form/Profile.tpl +msgid "Are you sure you want to delete the profile %1?" +msgstr "" + +#: templates/CRM/Twingle/Form/Profile.tpl +msgid "Profile name not given or invalid." +msgstr "" + +#: templates/CRM/Twingle/Form/Settings.hlp +msgid "When the %1 is enabled and one of its payment instruments is assigned to a Twingle payment method (practically the debit_manual payment method), submitting a Twingle donation through the API will create a SEPA mandate with the given data." +msgstr "" + +#: templates/CRM/Twingle/Form/Settings.hlp +msgid "When the %1 is enabled, you can activate this to use your own references instead of the ones submitted by Twingle." +msgstr "" + +#: templates/CRM/Twingle/Form/Settings.hlp +msgid "Will protect all recurring contributions created by Twingle from termination, since this does NOT terminate the Twingle collection process" +msgstr "" + +#: templates/CRM/Twingle/Form/Settings.hlp +msgid "You can use this setting to add a prefix to the Twingle transaction ID, in order to avoid collisions with other transaction ids." +msgstr "" + +#: templates/CRM/Twingle/Form/Settings.hlp +msgid "If you enable Twingle Shop integration, you can configure Twingle API profiles to include products ordered through Twingle Shop as line items in the created contribution." +msgstr "" + +#: templates/CRM/Twingle/Form/Settings.hlp +msgid "Enter your twingle API access key." +msgstr "" + +#: templates/CRM/Twingle/Page/Configuration.tpl +msgid "Profiles" +msgstr "" + +#: templates/CRM/Twingle/Page/Configuration.tpl +msgid "Configure profiles" +msgstr "" + +#: templates/CRM/Twingle/Page/Configuration.tpl +msgid "Settings" +msgstr "" + +#: templates/CRM/Twingle/Page/Configuration.tpl +msgid "Configure extension settings" +msgstr "" + +#: templates/CRM/Twingle/Page/Profiles.tpl +msgid "New profile" +msgstr "" + +#: templates/CRM/Twingle/Page/Profiles.tpl +msgid "Selectors" +msgstr "" + +#: templates/CRM/Twingle/Page/Profiles.tpl +msgid "Used" +msgstr "" + +#: templates/CRM/Twingle/Page/Profiles.tpl +msgid "Last Used" +msgstr "" + +#: templates/CRM/Twingle/Page/Profiles.tpl +msgid "Operations" +msgstr "" + +#: templates/CRM/Twingle/Page/Profiles.tpl +msgid "enabled" +msgstr "" + +#: templates/CRM/Twingle/Page/Profiles.tpl +msgid "disabled" +msgstr "" + +#: templates/CRM/Twingle/Page/Profiles.tpl +msgid "Edit profile %1" +msgstr "" + +#: templates/CRM/Twingle/Page/Profiles.tpl +msgid "Edit" +msgstr "" + +#: templates/CRM/Twingle/Page/Profiles.tpl +msgid "Copy profile %1" +msgstr "" + +#: templates/CRM/Twingle/Page/Profiles.tpl +msgid "Copy" +msgstr "" + +#: templates/CRM/Twingle/Page/Profiles.tpl +msgid "Reset profile %1" +msgstr "" + +#: templates/CRM/Twingle/Page/Profiles.tpl +msgid "Delete profile %1" +msgstr "" + +#: twingle.php +msgid "Twingle API: Access Twingle API" +msgstr "" + +#: twingle.php +msgid "Allows access to the Twingle API actions." +msgstr "" + diff --git a/l10n/de_DE/LC_MESSAGES/twingle.mo b/l10n/de_DE/LC_MESSAGES/twingle.mo index 831829b..b7c9729 100644 Binary files a/l10n/de_DE/LC_MESSAGES/twingle.mo and b/l10n/de_DE/LC_MESSAGES/twingle.mo differ diff --git a/l10n/de_DE/LC_MESSAGES/twingle.po b/l10n/de_DE/LC_MESSAGES/twingle.po index f914552..a4ce3d5 100644 --- a/l10n/de_DE/LC_MESSAGES/twingle.po +++ b/l10n/de_DE/LC_MESSAGES/twingle.po @@ -13,8 +13,259 @@ msgstr "" "MIME-Version: 1.0\n" "Content-Type: text/plain; charset=UTF-8\n" "Content-Transfer-Encoding: 8bit\n" -"X-Generator: Poedit 1.8.7.1\n" "Plural-Forms: nplurals=2; plural=(n != 1);\n" +"X-Generator: Poedit 3.0.1\n" + +#: CRM/Twingle/BAO/TwingleProduct.php +msgid "" +"Could not find PriceField for Twingle Product ['id': %1, 'external_id': %2]: " +"%3" +msgstr "" +"PriceField für Twingle-Produkt ['id': %1, 'external_id': %2] konnte nicht " +"gefunden werden: %3" + +#: CRM/Twingle/BAO/TwingleProduct.php +msgid "" +"Could not find PriceFieldValue for Twingle Product ['id': %1, 'external_id': " +"%2]: %3" +msgstr "" +"PriceFieldValue für Twingle-Produkt ['id': %1, 'external_id': %2] konnte " +"nicht gefunden werden: %3" + +#: CRM/Twingle/BAO/TwingleProduct.php +msgid "PriceField for this Twingle Product already exists." +msgstr "PriceField für dieses Twingle-Produkt existiert bereits." + +#: CRM/Twingle/BAO/TwingleProduct.php +msgid "" +"PriceField for this Twingle Product does not exist and cannot be edited." +msgstr "" +"PriceField für dieses Twingle-Produkt existiert nicht und kann nicht " +"bearbeitet werden." + +#: CRM/Twingle/BAO/TwingleProduct.php +msgid "Could not check if PriceField for this Twingle Product already exists." +msgstr "" +"Es konnte nicht überprüft werden, ob PriceField für dieses Twingle-Produkt " +"bereits existiert." + +#: CRM/Twingle/BAO/TwingleProduct.php +msgid "Could not find PriceSet for this Twingle Product." +msgstr "PriceSet für dieses Twingle-Produkt konnte nicht gefunden werden." + +#: CRM/Twingle/BAO/TwingleProduct.php +msgid "Could not create PriceField for this Twingle Product: %1" +msgstr "PriceField für dieses Twingle-Produkt konnte nicht erstellt werden: %1" + +#: CRM/Twingle/BAO/TwingleProduct.php +msgid "Could not find PriceFieldValue for this Twingle Product: %1" +msgstr "PriceField für dieses Twingle-Produkt konnte nicht gefunden werden: %1" + +#: CRM/Twingle/BAO/TwingleProduct.php +msgid "Could not create PriceFieldValue for this Twingle Product: %1" +msgstr "PriceField für dieses Twingle-Produkt konnte nicht erstellt werden: %1" + +#: CRM/Twingle/BAO/TwingleProduct.php +msgid "Could not find TwingleProduct in database: %1" +msgstr "TwingleProduct konnte nicht in der Datenbank gefunden werden: %1" + +#: CRM/Twingle/BAO/TwingleProduct.php +msgid "Could not save TwingleProduct to database: %1" +msgstr "TwingleProduct konnte nicht in die Datenbank geschrieben werden: %1" + +#: CRM/Twingle/BAO/TwingleProduct.php +msgid "" +"An Error occurred while searching for the associated PriceFieldValue: %1" +msgstr "" +"Während der Suche nach zugehörigem PriceFieldValue ist ein Fehler " +"aufgetreten: %1" + +#: CRM/Twingle/BAO/TwingleProduct.php +msgid "Could not delete associated PriceFieldValue: %1" +msgstr "Zugehöriger PriceFieldValue konnte nicht gelöscht werden: %1" + +#: CRM/Twingle/BAO/TwingleProduct.php +msgid "PriceField for this Twingle Product still exists." +msgstr "PriceField für dieses Twingle-Produkt existiert noch." + +#: CRM/Twingle/BAO/TwingleProduct.php +msgid "An Error occurred while searching for the associated PriceField: %1" +msgstr "" +"Während der Suche nach zugehörigem PriceField ist ein Fehler aufgetreten: %1" + +#: CRM/Twingle/BAO/TwingleProduct.php +msgid "Could not delete associated PriceField: %1" +msgstr "Zugehöriges PriceField konnte nicht gelöscht werden: %1" + +#: CRM/Twingle/BAO/TwingleShop.php +msgid "Could not find TwingleShop in database: %1" +msgstr "TwingleShop konnte nicht in der Datenbank gefunden werden: %1" + +#: CRM/Twingle/BAO/TwingleShop.php +msgid "Could not find associated PriceSet: %1" +msgstr "Zugehöriges PriceSet konnte nicht gefunden werden: %1" + +#: CRM/Twingle/BAO/TwingleShop.php +msgid "Could not delete associated PriceSet: %1" +msgstr "Zugehöriges PriceSet konnte nicht gelöscht werden: %1" + +#: CRM/Twingle/BAO/TwingleShop.php +msgid "PriceSet for this Twingle Shop already exists." +msgstr "PriceSet für diesen Twingle-Shop existiert bereits." + +#: CRM/Twingle/BAO/TwingleShop.php +msgid "PriceSet for this Twingle Shop does not exist and cannot be edited." +msgstr "" +"PriceSet für diesen Twingle-Shop existiert nicht und kann nicht bearbeitet " +"werden." + +#: CRM/Twingle/BAO/TwingleShop.php +msgid "Could not check if PriceSet for this TwingleShop already exists." +msgstr "" +"Es konnte nicht überprüft werden, ob PriceSet für diesen TwingleShop bereits " +"existiert." + +#: CRM/Twingle/BAO/TwingleShop.php +msgid "Could not create PriceSet for this TwingleShop." +msgstr "PriceSet für diesen TwingleShop konnte nicht erstellt werden." + +#: CRM/Twingle/BAO/TwingleShop.php +msgid "This Twingle Project is not a shop." +msgstr "Dieses Twingle-Projekt ist kein Shop." + +#: CRM/Twingle/BAO/TwingleShop.php +msgid "" +"Could not retrieve Twingle projects from API.\n" +" Please check your API credentials." +msgstr "" +"Twingle-Projekte konnte nicht über die API abgerufen werden. Überprüfen Sie " +"Ihre Zugangsdaten." + +#: CRM/Twingle/BAO/TwingleShop.php +msgid "Could not retrieve associated products: %1" +msgstr "Zugehörige Profukte konnten nicht abgerufen werden: %1" + +#: CRM/Twingle/BAO/TwingleShop.php +msgid "Could not delete associated products: %1" +msgstr "Zugehörige Produkte konnten nicht gelöscht werden: %1" + +#: CRM/Twingle/Config.php +msgid "No" +msgstr "Nein" + +#: CRM/Twingle/Config.php +msgid "Raise Exception" +msgstr "Ausnahme auslösen" + +#: CRM/Twingle/Config.php +msgid "Create Activity" +msgstr "Aktivität erstellen" + +#: CRM/Twingle/DAO/TwingleProduct.php +msgid "Twingle Products" +msgstr "Twingle-Produkte" + +#: CRM/Twingle/DAO/TwingleProduct.php +msgid "Twingle Product" +msgstr "Twingle-Produkt" + +#: CRM/Twingle/DAO/TwingleProduct.php CRM/Twingle/DAO/TwingleShop.php +msgid "ID" +msgstr "ID" + +#: CRM/Twingle/DAO/TwingleProduct.php +msgid "Unique TwingleProduct ID" +msgstr "Eindeutige TwingleProduct-ID" + +#: CRM/Twingle/DAO/TwingleProduct.php +msgid "External ID" +msgstr "Externe ID" + +#: CRM/Twingle/DAO/TwingleProduct.php +msgid "The ID of this product in the Twingle database" +msgstr "Die ID dieses Produkts in der Twingle-Datenbank" + +#: CRM/Twingle/DAO/TwingleProduct.php api/v3/TwingleProduct/Get.php +msgid "Price Field ID" +msgstr "Preisfeld-ID" + +#: CRM/Twingle/DAO/TwingleProduct.php +msgid "FK to Price Field" +msgstr "Fremdschlüssel zu Preisfeld" + +#: CRM/Twingle/DAO/TwingleProduct.php api/v3/TwingleProduct/Create.php +msgid "Twingle Shop ID" +msgstr "Twingle-Shop-ID" + +#: CRM/Twingle/DAO/TwingleProduct.php +msgid "FK to Twingle Shop" +msgstr "Fremdschlüssel zu Twingle-Shop" + +#: CRM/Twingle/DAO/TwingleProduct.php +msgid "Created At" +msgstr "Erstellt am" + +#: CRM/Twingle/DAO/TwingleProduct.php +msgid "Timestamp of when the product was created in the database" +msgstr "Zeitstempel der Erstellung des Produkts in der Datenbank" + +#: CRM/Twingle/DAO/TwingleProduct.php +msgid "Updated At" +msgstr "Aktualisiert am" + +#: CRM/Twingle/DAO/TwingleProduct.php +msgid "Timestamp of when the product was last updated in the database" +msgstr "Zeitstempel der letzten Aktualisierung des Produkts in der Datenbank" + +#: CRM/Twingle/DAO/TwingleShop.php +msgid "Twingle Shops" +msgstr "Twingle-Shops" + +#: CRM/Twingle/DAO/TwingleShop.php +msgid "Twingle Shop" +msgstr "Twingle-Shops" + +#: CRM/Twingle/DAO/TwingleShop.php +msgid "Unique TwingleShop ID" +msgstr "Eindeutige Twingle-Shop-ID" + +#: CRM/Twingle/DAO/TwingleShop.php api/v3/TwingleProduct/Get.php +#: api/v3/TwingleShop/Create.php api/v3/TwingleShop/Delete.php +#: api/v3/TwingleShop/Get.php +msgid "Project Identifier" +msgstr "Projekt-Identifikator" + +#: CRM/Twingle/DAO/TwingleShop.php +msgid "Twingle Project Identifier" +msgstr "Twingle-Projekt-Identifikator" + +#: CRM/Twingle/DAO/TwingleShop.php +msgid "Numerical Project ID" +msgstr "Numerische Projekt-ID" + +#: CRM/Twingle/DAO/TwingleShop.php +msgid "Numerical Twingle Project Identifier" +msgstr "Numerischer Twingle-Projekt-Identifikator" + +#: CRM/Twingle/DAO/TwingleShop.php api/v3/TwingleShop/Get.php +msgid "Price Set ID" +msgstr "Preisschema-ID" + +#: CRM/Twingle/DAO/TwingleShop.php +msgid "FK to Price Set" +msgstr "Fremdschlüssel zu Preisschema" + +#: CRM/Twingle/DAO/TwingleShop.php api/v3/TwingleShop/Get.php +msgid "Name" +msgstr "Name" + +#: CRM/Twingle/DAO/TwingleShop.php +msgid "name of the shop" +msgstr "Name des Shops" + +#: CRM/Twingle/Form/Profile.php +msgid "Profile with ID \"%1\" not found" +msgstr "Profil mit ID \"%1\" nicht gefunden" #: CRM/Twingle/Form/Profile.php msgid "Delete Twingle API profile %1" @@ -24,54 +275,113 @@ msgstr "Twingle-API-Profil %1 löschen" msgid "Reset" msgstr "Zurücksetzen" -#: CRM/Twingle/Form/Profile.php templates/CRM/Twingle/Page/Profiles.tpl +#: CRM/Twingle/Form/Profile.php js/twingle_shop.js +#: templates/CRM/Twingle/Page/Profiles.tpl msgid "Delete" msgstr "Löschen" +#: CRM/Twingle/Form/Profile.php +msgid "The profile is invalid and cannot be copied." +msgstr "Das Profil ist ungültig und kann nicht kopiert werden." + +#: CRM/Twingle/Form/Profile.php +msgid "Error" +msgstr "Fehler" + +#: CRM/Twingle/Form/Profile.php +msgid "The profile to be copied could not be found." +msgstr "Das zu kopierende Profil konnte nicht gefunden werden." + +#: CRM/Twingle/Form/Profile.php +msgid "A database error has occurred. See the log for details." +msgstr "" +"Ein Datenbankfehler ist aufgetreten. Siehe das Protokoll für Einzeilheiten." + +#: CRM/Twingle/Form/Profile.php +msgid "New Twingle API profile" +msgstr "Neues Twingle-API-Profil" + #: CRM/Twingle/Form/Profile.php msgid "Edit Twingle API profile %1" msgstr "Twingle-API-Profil %1 bearbeiten" #: CRM/Twingle/Form/Profile.php -msgid "New Twingle API profile" -msgstr "Neues Twingle-API-Profil" +msgid "New Profile" +msgstr "Neues Profil" #: CRM/Twingle/Form/Profile.php templates/CRM/Twingle/Page/Profiles.tpl msgid "Profile name" msgstr "Profil-Name" -#: CRM/Twingle/Form/Profile.php +#: CRM/Twingle/Form/Profile.php CRM/Twingle/Profile.php +#: templates/CRM/Twingle/Form/Profile.tpl msgid "Project IDs" msgstr "Projekt-IDs" #: CRM/Twingle/Form/Profile.php +msgid "Contact Matcher (XCM) Profile" +msgstr "Extended Contact Matcher (XCM)-Profil" + +#: CRM/Twingle/Form/Profile.php CRM/Twingle/Profile.php +#: templates/CRM/Twingle/Form/Profile.tpl msgid "Location type" msgstr "Adresskategorie" -#: CRM/Twingle/Form/Profile.php -msgid "Financial Type" +#: CRM/Twingle/Form/Profile.php CRM/Twingle/Profile.php +#: templates/CRM/Twingle/Form/Profile.tpl +msgid "Location type for organisations" +msgstr "Adresskategorie für Organisationen" + +#: CRM/Twingle/Form/Profile.php CRM/Twingle/Profile.php +#: templates/CRM/Twingle/Form/Profile.tpl +msgid "Financial type" msgstr "Zuwendungsart" -#: CRM/Twingle/Form/Profile.php +#: CRM/Twingle/Form/Profile.php CRM/Twingle/Profile.php +#: templates/CRM/Twingle/Form/Profile.tpl +msgid "Financial type (recurring)" +msgstr "Zuwendungsart (wiederkehrend)" + +#: CRM/Twingle/Form/Profile.php CRM/Twingle/Profile.php msgid "Gender option for submitted value \"male\"" msgstr "Geschlechtsoption für übermittelten Wert \"male\"" -#: CRM/Twingle/Form/Profile.php +#: CRM/Twingle/Form/Profile.php CRM/Twingle/Profile.php msgid "Gender option for submitted value \"female\"" msgstr "Geschlechtsoption für übermittelten Wert \"female\"" -#: CRM/Twingle/Form/Profile.php +#: CRM/Twingle/Form/Profile.php CRM/Twingle/Profile.php msgid "Gender option for submitted value \"other\"" msgstr "Geschlechtsoption für übermittelten Wert \"other\"" +#: CRM/Twingle/Form/Profile.php CRM/Twingle/Profile.php +msgid "Prefix option for submitted value \"male\"" +msgstr "Anredeoption für übermittelten Wert \"male\"" + +#: CRM/Twingle/Form/Profile.php CRM/Twingle/Profile.php +msgid "Prefix option for submitted value \"female\"" +msgstr "Anredeoption für übermittelten Wert \"female\"" + +#: CRM/Twingle/Form/Profile.php CRM/Twingle/Profile.php +msgid "Prefix option for submitted value \"other\"" +msgstr "Anredeoption für übermittelten Wert \"other\"" + #: CRM/Twingle/Form/Profile.php msgid "Record %1 as" msgstr "%1 erfassen als" #: CRM/Twingle/Form/Profile.php +msgid "Record %1 donations with contribution status" +msgstr "%1 erfassen mit Zuwendungsstatus" + +#: CRM/Twingle/Form/Profile.php CRM/Twingle/Profile.php msgid "CiviSEPA creditor" msgstr "CiviSEPA-Kreditor" +#: CRM/Twingle/Form/Profile.php +msgid "Use Double-Opt-In for newsletter" +msgstr "Nutze Double-Opt-In für Newsletter" + #: CRM/Twingle/Form/Profile.php msgid "Sign up for newsletter groups" msgstr "Newsletter-Gruppen beitreten" @@ -84,17 +394,146 @@ msgstr "Postversand-Gruppen beitreten" msgid "Sign up for Donation receipt groups" msgstr "Zuwendungsbescheinigungs-Gruppen beitreten" +#: CRM/Twingle/Form/Profile.php +msgid "Default Campaign" +msgstr "Standardkampagne" + +#: CRM/Twingle/Form/Profile.php +msgid "- none -" +msgstr "- keine -" + +#: CRM/Twingle/Form/Profile.php +msgid "Set Campaign for" +msgstr "Kampagne setzen für" + +#: CRM/Twingle/Form/Profile.php +msgid "Contribution" +msgstr "Zuwendung" + +#: CRM/Twingle/Form/Profile.php +msgid "Recurring Contribution" +msgstr "Wiederkehrende Zuwendung" + +#: CRM/Twingle/Form/Profile.php +msgid "Membership" +msgstr "Mitgliedschaft" + +#: CRM/Twingle/Form/Profile.php +msgid "SEPA Mandate" +msgstr "SEPA-Lastschriftmandat" + +#: CRM/Twingle/Form/Profile.php +msgid "Contacts (XCM)" +msgstr "Kontakte (XCM)" + +#: CRM/Twingle/Form/Profile.php +msgid "Create membership of type" +msgstr "Mitgliedschaft mit Typ erstellen" + +#: CRM/Twingle/Form/Profile.php +msgid "Create membership of type (recurring)" +msgstr "Mitgliedschaft mit Typ erstellen (wiederkehrend)" + +#: CRM/Twingle/Form/Profile.php +msgid "API Call for Membership Postprocessing" +msgstr "API-Aufruf für Mitgliedschafts-Nachbearbeitung" + +#: CRM/Twingle/Form/Profile.php +msgid "The API call must have the form 'Entity.Action'." +msgstr "Der API-Aufruf muss in der Form 'Entität.Aktion' angegeben werden." + +#: CRM/Twingle/Form/Profile.php +msgid "Contribution source" +msgstr "Herkunft der Zuwendung" + +#: CRM/Twingle/Form/Profile.php templates/CRM/Twingle/Form/Profile.tpl +msgid "Required address components" +msgstr "Erforderliche Adresskomponenten" + +#: CRM/Twingle/Form/Profile.php +msgid "Street" +msgstr "Straße" + +#: CRM/Twingle/Form/Profile.php +msgid "Postal Code" +msgstr "Postleitzahl" + +#: CRM/Twingle/Form/Profile.php api/v3/TwingleDonation/Submit.php +msgid "City" +msgstr "Ort" + +#: CRM/Twingle/Form/Profile.php api/v3/TwingleDonation/Submit.php +msgid "Country" +msgstr "Land" + +#: CRM/Twingle/Form/Profile.php templates/CRM/Twingle/Form/Profile.tpl +msgid "Custom field mapping" +msgstr "Zuordnung benutzerdefinierter Felder" + +#: CRM/Twingle/Form/Profile.php +msgid "Create contribution notes for" +msgstr "Zuwendungs-Notizen erstellen für" + +#: CRM/Twingle/Form/Profile.php api/v3/TwingleDonation/Submit.php +msgid "Purpose" +msgstr "Zweck" + +#: CRM/Twingle/Form/Profile.php api/v3/TwingleDonation/Submit.php +msgid "Remarks" +msgstr "Anmerkungen" + +#: CRM/Twingle/Form/Profile.php +msgid "Create contact notes for" +msgstr "Kontakt-Notizen erstellen für" + +#: CRM/Twingle/Form/Profile.php +msgid "User Extra Field" +msgstr "Benutzer-Extra-Feld" + +#: CRM/Twingle/Form/Profile.php templates/CRM/Twingle/Form/Profile.tpl +msgid "Enable Shop Integration" +msgstr "Shop-Integration aktivieren" + +#: CRM/Twingle/Form/Profile.php +msgid "Default Financial Type" +msgstr "Standard-Zuwendungsart" + +#: CRM/Twingle/Form/Profile.php +msgid "Financial Type for top up donations" +msgstr "Zuwendungsart für zusätzliche Spenden" + +#: CRM/Twingle/Form/Profile.php templates/CRM/Twingle/Form/Profile.tpl +msgid "Map Products as Price Fields" +msgstr "Produkte Preisfeldern zuordnen" + #: CRM/Twingle/Form/Profile.php CRM/Twingle/Form/Settings.php msgid "Save" msgstr "Speichern" +#: CRM/Twingle/Form/Profile.php +msgid "Warning" +msgstr "Warnung" + #: CRM/Twingle/Form/Profile.php msgid "" -"Only alphanumeric characters and the underscore (_) are allowed for profile " -"names." +"The required configuration option \"%1\" has no value. Saving the profile " +"might set this option to a possibly unwanted default value." msgstr "" -"Nur alphanumerische Zeichen und der Unterstrich (_) sind für Profilnamen " -"erlaubt." +"Die erforderliche Konfigurationsoption \"%1\" hat keinen Wert. Das Speichern " +"des Profils könnte diese Option auf einen möglicherweise ungewollten " +"Standardwert setzen." + +#: CRM/Twingle/Form/Profile.php +msgid "No profile set." +msgstr "Kein Profil eingestellt." + +#: CRM/Twingle/Form/Profile.php +msgid "<select profile>" +msgstr "<Profil auswählen>" + +#: CRM/Twingle/Form/Profile.php +msgid "none" +msgstr "keines" #: CRM/Twingle/Form/Profile.php msgid "CiviSEPA" @@ -104,17 +543,128 @@ msgstr "CiviSEPA" msgid "No mailing lists available" msgstr "Keine Versandlisten verfügbar" +#: CRM/Twingle/Form/Settings.php +msgid "Twingle ID Prefix" +msgstr "Twingle-ID-Präfix" + +#: CRM/Twingle/Form/Settings.php +msgid "Use CiviSEPA" +msgstr "CiviSEPA verwenden" + +#: CRM/Twingle/Form/Settings.php +msgid "Use CiviSEPA generated reference" +msgstr "Von CiviSEPA erstellte Referenc verwenden" + +#: CRM/Twingle/Form/Settings.php +msgid "Protect Recurring Contributions" +msgstr "Wiederkehrende Zuwendungen schützen" + +#: CRM/Twingle/Form/Settings.php +msgid "Activity Type" +msgstr "Aktivitätstyp" + +#: CRM/Twingle/Form/Settings.php +msgid "Subject" +msgstr "Betreff" + +#: CRM/Twingle/Form/Settings.php +msgid "Status" +msgstr "Status" + +#: CRM/Twingle/Form/Settings.php +msgid "Assigned To" +msgstr "Zugewiesen an" + +#: CRM/Twingle/Form/Settings.php +msgid "Use Twingle Shop Integration" +msgstr "Twingle-Shop-Integration verwenden" + +#: CRM/Twingle/Form/Settings.php +msgid "Twingle Access Key" +msgstr "Twingle-Zugriffsschlüssel" + +#: CRM/Twingle/Form/Settings.php +msgid "This is required for activity creation" +msgstr "Diese Angaben sind erforderlich für das Erstellen von Aktivitäten" + +#: CRM/Twingle/Form/Settings.php +msgid "An Access Key is required to enable Twingle Shop Integration" +msgstr "" +"Ein Zugriffsschlüssel ist für die Aktivierung der Twingle-Shop-Integration " +"erforderlich" + +#: CRM/Twingle/Form/Settings.php +msgid "-select-" +msgstr "- auswählen -" + +#: CRM/Twingle/Page/Profiles.php +#: managed/Navigation__twingle_configuration.mgd.php +msgid "Twingle API Profiles" +msgstr "Twingle-API-Profile" + #: CRM/Twingle/Profile.php msgid "Unknown attribute %1." msgstr "Unbekanntes Attribut %1." +#: CRM/Twingle/Profile.php +msgid "Profile name cannot be empty." +msgstr "Profilname darf nicht leer sein." + +#: CRM/Twingle/Profile.php +msgid "" +"Only alphanumeric characters, space and the underscore (_) are allowed for " +"profile names." +msgstr "" +"Nur alphanumerische Zeichen und der Unterstrich (_) sind für Profilnamen " +"erlaubt." + +#: CRM/Twingle/Profile.php +msgid "A profile with the name '%1' already exists." +msgstr "Ein profil mit dem Namen '%1' existiert bereits." + +#: CRM/Twingle/Profile.php +msgid "Project ID(s) [%1] already used in profile '%2'." +msgstr "Projekt-ID(s) [%1] werden ebreits in Profil '%2' verwendet." + +#: CRM/Twingle/Profile.php +msgid "Could not parse custom field mapping." +msgstr "Zuordnung benutzerdefinierter Felder konnte nicht verarbeitet werden." + +#: CRM/Twingle/Profile.php +msgid "Custom field custom_%1 does not exist." +msgstr "Benutezrdefiniertes Feld custom_%1 existiert nicht." + +#: CRM/Twingle/Profile.php +msgid "" +"Custom field custom_%1 is not in a CustomGroup that extends one of the " +"supported CiviCRM entities." +msgstr "" +"Benutzerdefiniertes Feld custom_%1 ist in einer benutzerdefinierten " +"Feldgruppe, die eine nicht unterstützte Entität erweitert." + +#: CRM/Twingle/Profile.php +msgid "Could not save/update profile: %1" +msgstr "Speichern/Aktualisieren von Profil fehlgeschlagen: %1" + +#: CRM/Twingle/Profile.php +msgid "Could not reset default profile: %1" +msgstr "Zurücksetzen des Standardprofils fehlgeschlagen: %1" + +#: CRM/Twingle/Profile.php +msgid "Could not delete profile: %1" +msgstr "Löschen des Profils fehlgeschlagen: %1" + +#: CRM/Twingle/Profile.php +msgid "Contribution Status" +msgstr "Zuwendungsstatus" + #: CRM/Twingle/Profile.php msgid "Bank transfer" msgstr "Banküberweisung" #: CRM/Twingle/Profile.php msgid "Debit manual" -msgstr "manuelle Abbuchung" +msgstr "Manuelle Abbuchung" #: CRM/Twingle/Profile.php msgid "Debit automatic" @@ -140,10 +690,6 @@ msgstr "SOFORT-Überweisung" msgid "Amazon Pay" msgstr "Amazon Pay" -#: CRM/Twingle/Profile.php -msgid "paydirekt" -msgstr "paydirekt" - #: CRM/Twingle/Profile.php msgid "Apple Pay" msgstr "Apple Pay" @@ -152,9 +698,37 @@ msgstr "Apple Pay" msgid "Google Pay" msgstr "Google Pay" +#: CRM/Twingle/Profile.php +msgid "Paydirekt" +msgstr "Paydirekt" + +#: CRM/Twingle/Profile.php +msgid "Twint" +msgstr "Twint" + +#: CRM/Twingle/Profile.php +msgid "iDEAL" +msgstr "iDEAL" + +#: CRM/Twingle/Profile.php +msgid "Postfinance" +msgstr "Postfinance" + +#: CRM/Twingle/Profile.php +msgid "Bancontact" +msgstr "Bancontact" + +#: CRM/Twingle/Profile.php +msgid "Generic Payment Method" +msgstr "Generische Zahlungsmethode" + +#: CRM/Twingle/Profile.php +msgid "never" +msgstr "nie" + #: CRM/Twingle/Submission.php msgid "Invalid donation rhythm." -msgstr "Ungültiger Zuwendungsrhythmus" +msgstr "Ungültiger Zuwendungsrhythmus." #: CRM/Twingle/Submission.php msgid "Payment method could not be matched to existing payment instrument." @@ -175,61 +749,1029 @@ msgid "Gender could not be matched to existing gender." msgstr "" "Geschlecht konnte keiner existierenden Geschlechtsoption zugeordnet werden." +#: CRM/Twingle/Submission.php +msgid "Invalid format for custom fields." +msgstr "Ungültiges Format für benutzerdefinierte Felder." + +#: CRM/Twingle/Submission.php +msgid "Invalid format for products." +msgstr "Ungültiges Format für Produkte." + +#: CRM/Twingle/Submission.php +msgid "campaign_id must be a numeric string. " +msgstr "campaign_id muss eine numerische Zeichenkette sein. " + #: CRM/Twingle/Submission.php msgid "Unknown country %1." msgstr "Unbekanntes Land %1." +#: CRM/Twingle/Submission.php +msgid "Could not calculate SEPA cycle day from configuration." +msgstr "SEPA-Einzugstag konnte nicht aus der Konfiguration berechnet werden." + +#: CRM/Twingle/Submission.php +msgid "Could not create line item for product '%1'" +msgstr "Belegzeile für Produkt konnte nicht erstellt werden: %1" + +#: CRM/Twingle/Submission.php +msgid "Could not create line item for donation" +msgstr "Belegzeile für Spende konnte nicht erstellt werden" + +#: CRM/Twingle/Tools.php +msgid "" +"This is a Twingle recurring contribution. It should be terminated through " +"the Twingle interface, otherwise it will still be collected." +msgstr "" +"Dies ist eine wiederkehrende Twingle-Zuwendung. Sie sollte durch die Twingle-" +"Benutzeroberfläche beendet werden, da sie ansonsten weiter eingezogen wird." + +#: CRM/Twingle/Tools.php +msgid "" +"Recurring contribution [%1] (Transaction ID '%2') was terminated by a user. " +"You need to end the corresponding record in Twingle as well, or it will " +"still be collected." +msgstr "" +"Wiederkehrende Zuwendung [%1] (Transaktions-ID '%2') wurde von einem " +"Benutzer beendet. Es ist erforderlich, den zugehörigen Datensatz auch in " +"Twingle zu beenden, da die Zuwendung ansonsten weiter eingezogen wird." + +#: Civi/Twingle/Shop/ApiCall.php +msgid "Could not find Twingle API token" +msgstr "Twingle-API-Token konnte nicht gefunden werden" + +#: Civi/Twingle/Shop/ApiCall.php +msgid "Call to Twingle API failed. Please check your api token." +msgstr "Aufruf der Twingle-API fehlgeschlagen. Überprüfen Sie Ihren API-Token." + +#: Civi/Twingle/Shop/ApiCall.php +msgid "GET curl failed" +msgstr "GET cURL fehlgeschlagen" + +#: Civi/Twingle/Shop/ApiCall.php +msgid "http status code 404 (not found)" +msgstr "HTTP-Statuscode 404 (not found)" + +#: Civi/Twingle/Shop/ApiCall.php +msgid "https status code 500 (internal error)" +msgstr "HTTP-Statuscode 500 (internal error)" + +#: Civi/Twingle/Shop/ApiCall.php +msgid "Connection not yet established. Use connect() method." +msgstr "Verbindung nch nicht hergestellt. connect()-Methode verwenden." + +#: api/v3/TwingleDonation/Cancel.php api/v3/TwingleDonation/Endrecurring.php +#: api/v3/TwingleDonation/Submit.php +msgid "Project ID" +msgstr "Projekt-ID" + +#: api/v3/TwingleDonation/Cancel.php api/v3/TwingleDonation/Endrecurring.php +#: api/v3/TwingleDonation/Submit.php +msgid "The Twingle project ID." +msgstr "Die Twingle-Projekt-ID." + +#: api/v3/TwingleDonation/Cancel.php api/v3/TwingleDonation/Endrecurring.php +#: api/v3/TwingleDonation/Submit.php +msgid "Transaction ID" +msgstr "Transaktions-ID" + +#: api/v3/TwingleDonation/Cancel.php api/v3/TwingleDonation/Endrecurring.php +#: api/v3/TwingleDonation/Submit.php +msgid "The unique transaction ID of the donation" +msgstr "Die eindeutige Transaktions-ID der Zuwendung" + +#: api/v3/TwingleDonation/Cancel.php +msgid "Cancelled at" +msgstr "Storniert am" + +#: api/v3/TwingleDonation/Cancel.php +msgid "The date when the donation was cancelled, format: YmdHis." +msgstr "Das Datum der Stornierung der Zuwendung, Format: YmdHis." + +#: api/v3/TwingleDonation/Cancel.php +msgid "Cancel reason" +msgstr "Stornierungsgrund" + +#: api/v3/TwingleDonation/Cancel.php +msgid "The reason for the donation being cancelled." +msgstr "Der Grund der Stornierung der Zuwendung." + #: api/v3/TwingleDonation/Cancel.php msgid "Invalid date for parameter \"cancelled_at\"." msgstr "Ungültiges Datum für Parameter \"cancelled_at\"." +#: api/v3/TwingleDonation/Cancel.php +msgid "SEPA Mandate for contribution [%1 not found." +msgstr "SEPA-Lastschriftmandat für Zuwendung [%1] nicht gefunden." + #: api/v3/TwingleDonation/Cancel.php api/v3/TwingleDonation/Endrecurring.php msgid "Could not terminate SEPA mandate" msgstr "Konnte SEPA-Mandat nicht beenden" +#: api/v3/TwingleDonation/Endrecurring.php +msgid "Ended at" +msgstr "Beendet am" + +#: api/v3/TwingleDonation/Endrecurring.php +msgid "The date when the recurring donation was ended, format: YmdHis." +msgstr "" +"Das Datum der Beendigung der wiederkehrenden Zuwendung, Format: YmdHis." + #: api/v3/TwingleDonation/Endrecurring.php msgid "Invalid date for parameter \"ended_at\"." msgstr "Ungültiges Datum für Parameter \"ended_at\"." +#: api/v3/TwingleDonation/Endrecurring.php +msgid "SEPA Mandate for recurring contribution [%1 not found." +msgstr "" +"SEPA-lastschriftmandat für wiederkehrende Zuwendung [%1] nicht gefunden." + +#: api/v3/TwingleDonation/Endrecurring.php +msgid "SEPA Mandate [%1] already terminated." +msgstr "SEPA-lastschriftmandat [%1] wurde bereits beendet." + #: api/v3/TwingleDonation/Endrecurring.php msgid "Mandate closed by TwingleDonation.Endrecurring API call" msgstr "Mandat geschlossen durch TwingleDonation.Endrecurring API-Aufruf" #: api/v3/TwingleDonation/Submit.php -msgid "Contribution with the given transaction ID already exists." -msgstr "Zuwendung mit der gegebenen Transkations-ID existiert bereits." +msgid "Confirmed at" +msgstr "Bestätigt am" #: api/v3/TwingleDonation/Submit.php -msgid "Individual contact could not be found or created." -msgstr "Kontakt für Person konnte nicht gefunden oder erstellt werden." +msgid "The date when the donation was issued, format: YmdHis." +msgstr "Das Datum der Ausstellung der Zuwendung, Format: YmdHis." + +#: api/v3/TwingleDonation/Submit.php +msgid "The purpose of the donation." +msgstr "Der Anlass der Zuwendung." + +#: api/v3/TwingleDonation/Submit.php +msgid "Amount" +msgstr "Betrag" + +#: api/v3/TwingleDonation/Submit.php +msgid "The donation amount in minor currency unit." +msgstr "" +"Der Zuwendungsbetrag in untergeordneter Währungseinheit (z. B. Euro-Cent)" + +#: api/v3/TwingleDonation/Submit.php +msgid "Currency" +msgstr "Währung" + +#: api/v3/TwingleDonation/Submit.php +msgid "The ISO-4217 currency code of the donation." +msgstr "Der ISO-4217-Code der Währung der Zuwendung." + +#: api/v3/TwingleDonation/Submit.php +msgid "Newsletter" +msgstr "Newsletter" + +#: api/v3/TwingleDonation/Submit.php +msgid "" +"Whether to subscribe the contact to the newsletter group defined in the " +"profile." +msgstr "" +"Ob der Kontakt in die im Profil definierte Newsletter-Gruppe aufgenommen " +"werden soll." + +#: api/v3/TwingleDonation/Submit.php +msgid "Postal mailing" +msgstr "Postverteiler" + +#: api/v3/TwingleDonation/Submit.php +msgid "" +"Whether to subscribe the contact to the postal mailing group defined in the " +"profile." +msgstr "" +"Ob der Kontakt in die im Profil definierte Postverteilergruppe aufgenommen " +"werden soll." + +#: api/v3/TwingleDonation/Submit.php +msgid "Donation receipt" +msgstr "Zuwendungsbescheinigung" + +#: api/v3/TwingleDonation/Submit.php +msgid "Whether the contact requested a donation receipt." +msgstr "Ob der Kontakt eine Zuwendungsbescheinigung angefordert hat." + +#: api/v3/TwingleDonation/Submit.php +msgid "Payment method" +msgstr "Zahlungsmethode" + +#: api/v3/TwingleDonation/Submit.php +msgid "The Twingle payment method used for the donation." +msgstr "Die für die Zuwendung verwendete Twingle-Zahlungsmethode." + +#: api/v3/TwingleDonation/Submit.php +msgid "Donation rhythm" +msgstr "Zuwendungsrhythmus" + +#: api/v3/TwingleDonation/Submit.php +msgid "The interval which the donation is recurring in." +msgstr "Das Intervall, in dem die Zuwendung wiederkehrt." + +#: api/v3/TwingleDonation/Submit.php +msgid "SEPA IBAN" +msgstr "SEPA-IBAN" + +#: api/v3/TwingleDonation/Submit.php +msgid "" +"The IBAN for SEPA Direct Debit payments, conforming with ISO 13616-1:2007." +msgstr "Die IBAN für SEPA-Lastschriftzahlungen, konform mit ISO 13616-1:2007." + +#: api/v3/TwingleDonation/Submit.php +msgid "SEPA BIC" +msgstr "SEPA-BIC" + +#: api/v3/TwingleDonation/Submit.php +msgid "The BIC for SEPA Direct Debit payments, conforming with ISO 9362." +msgstr "Die BIC für SEPA-Lastschriftzahlungen, konform mit ISO 9362." + +#: api/v3/TwingleDonation/Submit.php +msgid "SEPA Direct Debit Mandate reference" +msgstr "SEPA-Lastschriftmandatsreferenz" + +#: api/v3/TwingleDonation/Submit.php +msgid "The mandate reference for SEPA Direct Debit payments." +msgstr "Die Mandatsreferenz für SEPA-Lastschriftzahlungen." + +#: api/v3/TwingleDonation/Submit.php +msgid "SEPA Direct Debit Account holder" +msgstr "Inhaber des SEPA-Lastschriftkontos" + +#: api/v3/TwingleDonation/Submit.php +msgid "The account holder for SEPA Direct Debit payments." +msgstr "Der Kontoinhaber für SEPA-Lastschriften." + +#: api/v3/TwingleDonation/Submit.php +msgid "Anonymous donation" +msgstr "Anonyme Zuwendung" + +#: api/v3/TwingleDonation/Submit.php +msgid "Whether the donation is submitted anonymously." +msgstr "Ob die Zuwendung anonym übermittelt wird." + +#: api/v3/TwingleDonation/Submit.php +msgid "Gender" +msgstr "Geschlecht" + +#: api/v3/TwingleDonation/Submit.php +msgid "The gender of the contact." +msgstr "Das Geschlecht des Kontakts." + +#: api/v3/TwingleDonation/Submit.php +msgid "Date of birth" +msgstr "Geburtsdatum" + +#: api/v3/TwingleDonation/Submit.php +msgid "The date of birth of the contact, format: Ymd." +msgstr "Das Geburtsdatum des Kontakts, Format: Ymd." + +#: api/v3/TwingleDonation/Submit.php +msgid "Formal title" +msgstr "Formeller Titel" + +#: api/v3/TwingleDonation/Submit.php +msgid "The formal title of the contact." +msgstr "Der formelle Titel des Kontakts." + +#: api/v3/TwingleDonation/Submit.php +msgid "Email address" +msgstr "E-Mail-Adresse" + +#: api/v3/TwingleDonation/Submit.php +msgid "The e-mail address of the contact." +msgstr "Die E-Mail-Adresse des Kontakts." + +#: api/v3/TwingleDonation/Submit.php +msgid "First name" +msgstr "Vorname" + +#: api/v3/TwingleDonation/Submit.php +msgid "The first name of the contact." +msgstr "Der Vorname des Kontakts." + +#: api/v3/TwingleDonation/Submit.php +msgid "Last name" +msgstr "Nachname" + +#: api/v3/TwingleDonation/Submit.php +msgid "The last name of the contact." +msgstr "Der Nachname des Kontakts." + +#: api/v3/TwingleDonation/Submit.php +msgid "Street address" +msgstr "Straße" + +#: api/v3/TwingleDonation/Submit.php +msgid "The street address of the contact." +msgstr "Die Straße des Kontakts." + +#: api/v3/TwingleDonation/Submit.php +msgid "Postal code" +msgstr "Postleitzahl" + +#: api/v3/TwingleDonation/Submit.php +msgid "The postal code of the contact." +msgstr "Die Postleitzahl des Kontakts." + +#: api/v3/TwingleDonation/Submit.php +msgid "The city of the contact." +msgstr "Der Wohnort des Kontakts." + +#: api/v3/TwingleDonation/Submit.php +msgid "The country of the contact." +msgstr "Das Land des Kontakts." + +#: api/v3/TwingleDonation/Submit.php +msgid "Telephone" +msgstr "Telefonnummer" + +#: api/v3/TwingleDonation/Submit.php +msgid "The telephone number of the contact." +msgstr "Die Telefonnummer des Kontakts." + +#: api/v3/TwingleDonation/Submit.php +msgid "Company" +msgstr "Firma" + +#: api/v3/TwingleDonation/Submit.php +msgid "The company of the contact." +msgstr "Die Firma/Arbeitgeber des Kontakts." + +#: api/v3/TwingleDonation/Submit.php +msgid "Language" +msgstr "Sprache" + +#: api/v3/TwingleDonation/Submit.php +msgid "" +"The preferred language of the contact. A 2-digit ISO-639-1 language code." +msgstr "" +"Die bevorzugte Sprache des Kontakts. Ein zweistelliger ISO-639-1-Sprachcode." + +#: api/v3/TwingleDonation/Submit.php +msgid "User extra field" +msgstr "Zusätzliches Benutzerfeld (user extra field)" + +#: api/v3/TwingleDonation/Submit.php +msgid "Additional information of the contact." +msgstr "Zusätzliche Kontaktinformationen." + +#: api/v3/TwingleDonation/Submit.php +msgid "Campaign ID" +msgstr "Kampagnen-ID" + +#: api/v3/TwingleDonation/Submit.php +msgid "The CiviCRM ID of a campaign to assign the contribution." +msgstr "" +"Die CiviCRM-ID einer Kampagne, der die Zuwendung zugeordnet werden soll." + +#: api/v3/TwingleDonation/Submit.php +msgid "Custom fields" +msgstr "Benutzerdefinierte Felder" + +#: api/v3/TwingleDonation/Submit.php +msgid "" +"Additional information for either the contact or the (recurring) " +"contribution." +msgstr "" +"Zusätzliche Informationen für entweder den Kontakt oder die (wiederkehrende) " +"Zuwendung." + +#: api/v3/TwingleDonation/Submit.php +msgid "Products" +msgstr "Produkte" + +#: api/v3/TwingleDonation/Submit.php +msgid "Products ordered via TwingleShop" +msgstr "Über TwingleShop bestellte Produkte" + +#: api/v3/TwingleDonation/Submit.php +msgid "Additional remarks for the donation." +msgstr "Zusätzliche Anmerkungen für die Zuwendung." + +#: api/v3/TwingleDonation/Submit.php +msgid "Contribution with the given transaction ID already exists." +msgstr "Zuwendung mit der gegebenen Transkations-ID existiert bereits." #: api/v3/TwingleDonation/Submit.php msgid "Organisation contact could not be found or created." msgstr "Kontakt für Organisation konnte nicht gefunden oder erstellt werden." +#: api/v3/TwingleDonation/Submit.php +msgid "Individual contact could not be found or created." +msgstr "Kontakt für Person konnte nicht gefunden oder erstellt werden." + #: api/v3/TwingleDonation/Submit.php msgid "Missing attribute %1 for SEPA mandate" msgstr "Fehlendes Attribute %1 für SEPA-Mandat" +#: api/v3/TwingleDonation/Submit.php +msgid "SEPA creditor is not configured for profile \"%1\"." +msgstr "SEPA-Kreditor ist nicht konfiguriert für Profil \"%1\"." + #: api/v3/TwingleDonation/Submit.php msgid "Could not create recurring contribution." -msgstr "Wiederkehrende Zuwendung konnte nicht erstellen." +msgstr "Wiederkehrende Zuwendung konnte nicht erstellt werden." + +#: api/v3/TwingleDonation/Submit.php +msgid "Could not find recurring contribution with given parent transaction ID." +msgstr "" +"Wiederkehrende Zuwendung mit angegebener Transkations-ID konnte nicht " +"gefunden werden." #: api/v3/TwingleDonation/Submit.php msgid "Could not create contribution" msgstr "Zuwendung konnte nicht erstellt werden" +#: api/v3/TwingleDonation/Submit.php +msgid "" +"Twingle membership postprocessing call has failed, see log for more " +"information" +msgstr "" +"Die Nachbearbeitung (postprocessing) der Twingle-Mitgliedschaft ist " +"fehlgeschlagen, siehe Protokoll für weitere Informationen." + +#: api/v3/TwingleProduct/Create.php api/v3/TwingleProduct/Delete.php +#: api/v3/TwingleProduct/Get.php +msgid "TwingleProduct ID" +msgstr "TwingleProduct-ID" + +#: api/v3/TwingleProduct/Create.php +msgid "The TwingleProduct ID in the database" +msgstr "Die TwingleProduct-ID in der Datenbank" + +#: api/v3/TwingleProduct/Create.php +msgid "Twingle ID" +msgstr "Twingle-ID" + +#: api/v3/TwingleProduct/Create.php +msgid "External product ID in Twingle database" +msgstr "Externe Produkt-ID in der Twingle-Datenbank" + +#: api/v3/TwingleProduct/Create.php +msgid "ID of the corresponding Twingle Shop" +msgstr "ID des zugehlrigen Twingle-Shops" + +#: api/v3/TwingleProduct/Create.php +msgid "Product Name" +msgstr "Produktname" + +#: api/v3/TwingleProduct/Create.php +msgid "Name of the product" +msgstr "Name des Produkts" + +#: api/v3/TwingleProduct/Create.php +msgid "Is active?" +msgstr "Status" + +#: api/v3/TwingleProduct/Create.php +msgid "Is the product active?" +msgstr "Ob das Produkt aktiviert ist" + +#: api/v3/TwingleProduct/Create.php +msgid "Product Description" +msgstr "Produktbeschreibung" + +#: api/v3/TwingleProduct/Create.php +msgid "Short description of the product" +msgstr "Kurzbeschreibung des Produkts" + +#: api/v3/TwingleProduct/Create.php +msgid "Product Price" +msgstr "Produkt-Preis" + +#: api/v3/TwingleProduct/Create.php +msgid "Price of the product" +msgstr "Preis des Produkts" + +#: api/v3/TwingleProduct/Create.php +msgid "Sort" +msgstr "Sortierung" + +#: api/v3/TwingleProduct/Create.php +msgid "Sort order of the product" +msgstr "Sortierungsreihenfolge des Produkts" + +#: api/v3/TwingleProduct/Create.php api/v3/TwingleShop/Create.php +msgid "Financial Type ID" +msgstr "Zuwendungsart" + +#: api/v3/TwingleProduct/Create.php +msgid "ID of the financial type of the product" +msgstr "ID der Zuwendungsart des Produkts" + +#: api/v3/TwingleProduct/Create.php +msgid "FK to TwingleShop" +msgstr "Fremdschlüssel zu TwingleShop" + +#: api/v3/TwingleProduct/Create.php +msgid "Twingle timestamp" +msgstr "Twingle-Zeitstempel" + +#: api/v3/TwingleProduct/Create.php +msgid "Timestamp of last update in Twingle db" +msgstr "Zeitstempel der letzten Aktualisierung in der Twingle-Datenbank" + +#: api/v3/TwingleProduct/Create.php +msgid "FK to PriceField" +msgstr "Fremdschlüssel zu PriceField" + +#: api/v3/TwingleProduct/Delete.php api/v3/TwingleProduct/Get.php +msgid "The TwingleProduct ID in CiviCRM" +msgstr "Die TwingleProduct-ID in CiviCRM" + +#: api/v3/TwingleProduct/Delete.php api/v3/TwingleProduct/Get.php +msgid "External TwingleProduct ID" +msgstr "Externe TwingleProduct-ID" + +#: api/v3/TwingleProduct/Delete.php api/v3/TwingleProduct/Get.php +msgid "Twingle's ID of the product" +msgstr "Twingles ID des Produkts" + +#: api/v3/TwingleProduct/Delete.php +msgid "TwingleProduct could not be deleted." +msgstr "TwingleProduct konnte nicht gelöscht werden." + +#: api/v3/TwingleProduct/Get.php +msgid "FK to civicrm_price_field" +msgstr "Fremdschlüssel zu civicrm_price_field" + +#: api/v3/TwingleProduct/Get.php api/v3/TwingleShop/Delete.php +#: api/v3/TwingleShop/Get.php +msgid "TwingleShop ID" +msgstr "TwingleShop-ID" + +#: api/v3/TwingleProduct/Get.php api/v3/TwingleShop/Delete.php +#: api/v3/TwingleShop/Get.php +msgid "The TwingleShop ID in CiviCRM" +msgstr "Die TwingleShop-ID in CiviCRM" + +#: api/v3/TwingleProduct/Get.php api/v3/TwingleShop/Create.php +#: api/v3/TwingleShop/Delete.php api/v3/TwingleShop/Get.php +msgid "Twingle project identifier" +msgstr "Twingle-Projekt-Identifikator" + +#: api/v3/TwingleProduct/Get.php api/v3/TwingleShop/Create.php +#: api/v3/TwingleShop/Get.php +msgid "Numerical Project Identifier" +msgstr "Numerischer Projekt-Identifikator" + +#: api/v3/TwingleProduct/Get.php api/v3/TwingleShop/Get.php +msgid "Twingle numerical project identifier" +msgstr "Twingles numerischer Projekt-Identifikator" + +#: api/v3/TwingleShop/Create.php +msgid "Numerical Twingle project identifier" +msgstr "Numerischer Twingle-Projekt-Identifikator" + +#: api/v3/TwingleShop/Create.php +msgid "Shop Name" +msgstr "Shop-Name" + +#: api/v3/TwingleShop/Create.php +msgid "Name of the shop" +msgstr "Name des Shops" + +#: api/v3/TwingleShop/Create.php +msgid "FK to civicrm_financial_type" +msgstr "ZuwendungsartFremdschlüssel zu civicrm_financial_type" + +#: api/v3/TwingleShop/Delete.php +msgid "TwingleShop could not be found." +msgstr "TwingleShop konnte nicht gefunden werden." + +#: api/v3/TwingleShop/Delete.php +msgid "TwingleShop could not be deleted." +msgstr "TwingleShop konnte nicht gelöscht werden." + +#: api/v3/TwingleShop/Fetch.php +msgid "Project Identifiers" +msgstr "Projekt-Identifikatoren" + +#: api/v3/TwingleShop/Fetch.php +msgid "Comma separated list of Twingle project identifiers." +msgstr "Kommaseparierte Liste von Twingle-Projekt-Identifikatoren." + +#: api/v3/TwingleShop/Get.php +msgid "Name of the TwingleShop" +msgstr "Name des TwingleShop" + +#: api/v3/TwingleShop/Get.php +msgid "FK to civicrm_price_set" +msgstr "Fremdschlüssel zu civicrm_price_set" + +#: js/twingle_shop.js +msgid "Could not fetch products" +msgstr "Produkte konnten nicht abgerufen werden" + +#: js/twingle_shop.js +msgid "Could not fetch products. Please check your Twingle API key." +msgstr "" +"Produkte konnten nicht abgerufen werden. Überprüfen Sie Ihren Twingle-API-" +"Schlüssel." + +#: js/twingle_shop.js +msgid "Create" +msgstr "Erstellen" + +#: js/twingle_shop.js +msgid "Update" +msgstr "Bearbeiten" + +#: js/twingle_shop.js +msgid "Could not create Price Field for this product" +msgstr "Preisfeld für dieses Produkt konnte nicht erstellt werden" + +#: js/twingle_shop.js +msgid "Delete Price Field" +msgstr "Preisfeld löschen" + +#: js/twingle_shop.js +msgid "" +"Are you sure you want to delete the price field associated with this product?" +msgstr "Möchten Sie wirklich das diesem Produkt zugehörige Preisfeld löschen?" + +#: js/twingle_shop.js +msgid "Could not delete Price Field" +msgstr "Preisfeld konnte nicht gelöscht werden" + +#: js/twingle_shop.js +msgid "The Price Field was deleted successfully." +msgstr "Das Preisfeld wurde erfolgreich gelöscht." + +#: js/twingle_shop.js +msgid "Price Field deleted" +msgstr "Preisfeld gelöscht" + +#: js/twingle_shop.js +msgid "select financial type" +msgstr "Zuwendungsart auswählen" + +#: js/twingle_shop.js +msgid "Product" +msgstr "Produkt" + +#: js/twingle_shop.js +msgid "Financial Type" +msgstr "Zuwendungsart" + +#: js/twingle_shop.js +msgid "Price Field" +msgstr "Preisfeld" + +#: js/twingle_shop.js +msgid "Create Price Set" +msgstr "Preisschema erstellen" + +#: js/twingle_shop.js +msgid "Update Price Set" +msgstr "Preisschema bearbeiten" + +#: js/twingle_shop.js +msgid "Delete Price Set" +msgstr "Preisschema löschen" + +#: js/twingle_shop.js +msgid "Could not create Twingle Shop" +msgstr "Twingle-Shop konnte nicht erstellt werden" + +#: js/twingle_shop.js +msgid "The Price Set was created successfully." +msgstr "Das Preisschema wurde erfolgreich erstellt." + +#: js/twingle_shop.js +msgid "Price Field created" +msgstr "Preisfeld erstellt" + +#: js/twingle_shop.js +msgid "Could not create TwingleShop" +msgstr "TwingleShop konnte nicht erstellt werden" + +#: js/twingle_shop.js +msgid "" +"Are you sure you want to delete the price set associated with this Twingle " +"Shop?" +msgstr "" +"Möchten Sie wirklich das diesem Twingle-Shop zugehörige Preisschema löschen?" + +#: js/twingle_shop.js +msgid "Could not delete Twingle Shop" +msgstr "Twingle-Shop konnte nicht gelöscht werden" + +#: js/twingle_shop.js +msgid "The Price Set was deleted successfully." +msgstr "Das Preisschema wurde erfolgreiche gelöscht." + +#: js/twingle_shop.js +msgid "Price Set deleted" +msgstr "Preisschema gelöscht" + +#: js/twingle_shop.js +msgid "Could not update Twingle Shop" +msgstr "Twingle-Shop konnte nicht aktualisiert werden" + +#: managed/Navigation__twingle_configuration.mgd.php +msgid "Twingle API Configuration" +msgstr "Twingle-API-Konfiguration" + +#: managed/Navigation__twingle_configuration.mgd.php +msgid "Twingle API Settings" +msgstr "Twingle-API-Einstellungen" + +#: templates/CRM/Twingle/Form/Profile.hlp +msgid "" +"Select which location type to use for addresses for individuals, either when " +"no organisation name is specified, or an organisation address can not be " +"shared with the individual contact." +msgstr "" +"Wählen Sie die zu verwendende Adresskategorie für Personen, entweder wenn " +"kein Organisationsname angegeben wurde, oder die Organisationsadresse nicht " +"mit dem Personen-Kontakt geteilt werden kann." + +#: templates/CRM/Twingle/Form/Profile.hlp +msgid "" +"Put your project's Twingle ID in here, to activate this profile for that " +"project." +msgstr "" +"Geben Sie hier die Twingle-ID des Projekts ein, um das Profil für dieses " +"Projekt zu aktivieren." + +#: templates/CRM/Twingle/Form/Profile.hlp +msgid "You can also provide multiple project IDs separated by a comma." +msgstr "" +"Es können auch mehrere durch Kommata getrennte Projekt-IDs angegeben werden." + +#: templates/CRM/Twingle/Form/Profile.hlp +msgid "" +"The Contact Matcher (XCM) manages the identification or creation of the " +"related contact." +msgstr "" +"Der Extended Contact Matcher (XCM) verwaltet die Identifizierung und " +"Erstellung des zugehörigen Kontakts." + +#: templates/CRM/Twingle/Form/Profile.hlp +msgid "" +"We recommend creating a new XCM profile only to be used with the Twingle API." +msgstr "" +"Es wird empfohlen, ein neues XCM-Profil zur ausschließlichen Verwendung mit " +"der Twingle-API zu erstellen." + +#: templates/CRM/Twingle/Form/Profile.hlp +msgid "" +"Select which location type to use for addresses for organisations and shared " +"organisation addresses for individual contacts." +msgstr "" +"Wählen Sie die zu verwendende Adresskategorie für Organisationen und " +"geteilte Organisationsadressen für Personen-Kontakte." + +#: templates/CRM/Twingle/Form/Profile.hlp +msgid "Select which financial type to use for one-time contributions." +msgstr "Wählen Sie die Zuwendungsart für einmalige Zuwendungen." + +#: templates/CRM/Twingle/Form/Profile.hlp +msgid "Select which financial type to use for recurring contributions." +msgstr "Wählen Sie die Zuwendungsart für wiederkehrende Zuwendungen." + +#: templates/CRM/Twingle/Form/Profile.hlp +msgid "" +"Select whether to use CiviCRM's Double-Opt-In feature for subscribing to " +"mailing lists. Note that this only works for public mailing lists. Any non-" +"public mailing list selected above will be ignored when this setting is " +"enabled." +msgstr "" +"Wählen Sie, ob das Double-Opt-In-Verfahren von CiviCRM für das Abonnieren " +"von E-Mail-Verteilern verwendet werden soll. Beachten Sie, dass dies nur für " +"öffentliche Verteilerlisten funktioniert. Alle ausgewählten nicht-" +"öffentlichen Verteilerlisten werden bei Aktivierung dieser Einstellung " +"ignoriert." + +#: templates/CRM/Twingle/Form/Profile.hlp +msgid "" +"Also, do not forget to disable Twingle's own Double Opt-In option in the " +"Twingle Manager to avoid subscribers receiving multiple confirmation e-" +"mails. Only one or the other option should be enabled." +msgstr "" +"Vergessen Sie außerdem nicht, das Double-Opt-In-Verfahren im Twingle-Manager " +"auszuschalten, um zu verhindern, dass Abonnenten mehrere Bestätigungs-E-Mail-" +"Nachrichten erhalten. Nur eines der beiden Verfahren sollte aktiviert werden." + +#: templates/CRM/Twingle/Form/Profile.hlp +msgid "" +"Some organisations have specific conventions on how a membership should be " +"created. Since the Twingle-API can only create a \"bare bone\" membership " +"object, you can enter a API Call (as 'Entity.Action') to adjust any newly " +"created membership to your organisation's needs." +msgstr "" +"Einige Organisationen haben bestimmte Vorschriften bzgl. der Erstellung von " +"Mitgliedschaften. Da die Twingle-API nur ein \"reines\" " +"Mitgliedschaftsobjekt erstellt, können Sie einen API-Aufruf (als 'Entität." +"Aktion') angeben, um neu erstellt Mitgliedschaften an die Anforderungen " +"Ihrer Organisation anzupassen." + +#: templates/CRM/Twingle/Form/Profile.hlp +msgid "" +"The API call would receive the following parameters:
    \n" +"
  • membership_id: The ID of the newly created " +"membership
    • \n" +"
  • contact_id: The ID of the contact involved
    • \n" +"
  • organization_id: The ID of the contact's " +"organisation, potentially empty
    • \n" +"
  • contribution_id: The ID contribution received, " +"potentially empty
    • \n" +"
  • recurring_contribution_id: The ID of the recurring " +"contribution. If empty, this was only a one-off donation.
    • \n" +"
" +msgstr "" +"Der API-Aufruf nimmt die folgenden Parameter entgegen:
    \n" +"
  • membership_id: Die ID der neu erstellten " +"Mitgliedschaft
    • \n" +"
  • contact_id: Die ID des betreffenden Kontakts
    • \n" +"
  • organization_id: Die ID der dem Kontakt " +"zugeordneten Organisation (optional)
    • \n" +"
  • contribution_id: Die ID der erhaltenen Zuwendung " +"(optional)
    • \n" +"
  • recurring_contribution_id: Die ID der " +"wiederkehrenden Zuwendung (optional, falls leer war dies eine einmalige " +"Zuwendung)
    • \n" +"
" + +#: templates/CRM/Twingle/Form/Profile.hlp +msgid "" +"Select the address components that must be present to create or update an " +"address for the contact." +msgstr "" +"Wählen Sie die erforderlichen Adresskomponenten für die Erstellung oder " +"Aktualisierung der Adresse des Kontakts." + +#: templates/CRM/Twingle/Form/Profile.hlp +msgid "" +"Depending on your XCM settings, the transferred address might replace an " +"existing one." +msgstr "" +"Abhängig von den XCM-Einstellungen kann die übertragene Adresse eine " +"bestehende ersetzen." + +#: templates/CRM/Twingle/Form/Profile.hlp +msgid "" +"Since in some cases Twingle send the country of the user as the only address " +"parameter, depending on your XCM configuration, not declaring other address " +"components as required might lead to the current user address being " +"overwritten with an address containing the country only." +msgstr "" +"Da Twingle in einigen Fällen das Land des Benutzers als den einzigen " +"Adressparameter übermittelt, kann - abhängig von Ihrer XCM-Konfiguration - " +"die Definition anderer Adresskomponenten als nicht erforderlich dazu führen, " +"dass die bestehende Adresse mit einer neuen überschrieben wird, die nur das " +"Land enthält." + +#: templates/CRM/Twingle/Form/Profile.hlp +msgid "" +"

Map Twingle custom fields to CiviCRM fields using the following format " +"(each assignment in a separate line):

\n" +" 
twingle_field_1=custom_123
twingle_field_2=custom_789
\n" +"

Always use the custom_[id] notation for CiviCRM custom " +"fields.

\n" +"

This works for fields that Twingle themselves provide in the " +"custom_fields parameter, and for any other parameter (e.g. " +"user_extrafield)

\n" +"

Only custom fields extending one of the following CiviCRM entities " +"are allowed:

\n" +"
    \n" +"
  • Contact – Will be set on the Individual " +"contact
    • \n" +"
  • Individual – Will be set on the Individual " +"contact
    • \n" +"
  • Organization – Will be set on the " +"Organization contact, if an organisation name was submitted
    • \n" +"
  • Contribution – Will be set on the " +"contribution
    • \n" +"
  • ContributionRecur – Will be set on the " +"recurring contribution and deriving single contributions
    • \n" +"
" +msgstr "" +"

Zuordnung von Twingle-Feldern zu benutzerdefinierten CiviCRM-Feldern mit " +"folgendem Format (jede Zuordnung in einer neuen Zeile):

\n" +" 
twingle_field_1=custom_123
twingle_field_2=custom_789
\n" +"

Verwenden Sie immer die Notation custom_[id] für " +"benutzerdefinierte Felder in CiviCRM.

\n" +"

Unterstützt werden Felder, die Twingle im Parameter " +"custom_fields bereitstellt, sowie für alle anderen Parameter (z." +" B. user_extrafield)

\n" +"

Es werden nur benutzerdefinierte CiviCRM-Felder der folgenden " +"Entitäten unterstützt:

\n" +"
    \n" +"
  • Kontakt – wird am Personen-Kontakt gesetzt\n" +"
  • Person – wird am Personen-Kontakt gesetzt\n" +"
  • Organisation – wird am Organisations-" +"Kontakt gesetzt, sofern ein Organisationsname übermittelt wurde
    • \n" +"
  • Zuwendung – wird an der Zuwendung gesetzt\n" +"
  • Wiederkehrende Zuwendung – wird an der " +"wiederkehrenden Zuwendung sowie an abgeleiteten Einzel-Zuwendungen gesetzt\n" +"
" + +#: templates/CRM/Twingle/Form/Profile.hlp +msgid "" +"

Create a contribution note for each field specified in this selection.\n" +"

Tip: You can enable or disable this fields in the TwingleMANAGER.

" +msgstr "" +"

Erstelle eine Zuwendungs-Notiz für jedes Feld, das in dieser Auswahl " +"angegeben ist.

\n" +"

Tipp: Sie können diese Felder im TwingleMANAGER aktivieren oder " +"deaktivieren.

" + +#: templates/CRM/Twingle/Form/Profile.hlp +msgid "" +"

Create a contact note for each field specified in this selection.

\n" +"

Tip: You can enable or disable this fields in the TwingleMANAGER.

" +msgstr "" +"

Erstelle eine Kontakt-Notiz für jedes Feld, das in dieser Auswahl " +"angegeben ist.

\n" +"

Tipp: Sie können diese Felder im TwingleMANAGER aktivieren oder " +"deaktivieren.

" + +#: templates/CRM/Twingle/Form/Profile.hlp +msgid "" +"Enable the processing of orders via Twingle Shop for this profile. The " +"ordered products will then appear as line items in the contribution." +msgstr "" +"Aktiviert die Verarbeitung von Bestellungen über den Twingle-Shop für dieses " +"Profil. Die bestellten Produkte werden als Belegzeilen der Zuwendung " +"erscheinen." + +#: templates/CRM/Twingle/Form/Profile.hlp +msgid "" +"If this option is enabled, all Twingle Shop products corresponding to the " +"specified project IDs will be retrieved from Twingle and mapped as price " +"sets and price fields. Each Twingle Shop is mapped as a price set with its " +"products as price fields." +msgstr "" +"Wenn diese Option aktiviert ist, werden alle zur angegebenen Projekt-ID " +"gehörenden Twingle-Shop-Produkte von Twingle abgerufen und als Preisschemata " +"und Preisfelder zugeordnet. Jeder Twingle-Shop wird als ein Preisschema mit " +"seinen Produkten als Preisfelder zugeordnet." + +#: templates/CRM/Twingle/Form/Profile.hlp +msgid "" +"This allows you to manually create contributions with the same line items " +"for phone orders, for example, as would be the case for orders placed " +"through the Twingle Shop." +msgstr "" +"Dies ermöglicht das manuelle Erstellen von Zuwendungen mit den gleichen " +"Belegzeilen wie bei Bestellungen über den Twingle-Shop, z. B. für " +"telefonische Bestellungen." + #: templates/CRM/Twingle/Form/Profile.tpl msgid "General settings" msgstr "Allgemeine Einstellungen" +#: templates/CRM/Twingle/Form/Profile.tpl +msgid "Help" +msgstr "Hilfe" + +#: templates/CRM/Twingle/Form/Profile.tpl +msgid "XCM Profile" +msgstr "XCM-Profil" + +#: templates/CRM/Twingle/Form/Profile.tpl +msgid "Gender/Prefix for value 'male'" +msgstr "Geschlechts-/Anredeoption für übermittelten Wert \"male\"" + +#: templates/CRM/Twingle/Form/Profile.tpl +msgid "Gender/Prefix for value 'female'" +msgstr "Geschlechts-/Anredeoption für übermittelten Wert \"female\"" + +#: templates/CRM/Twingle/Form/Profile.tpl +msgid "Gender/Prefix for value 'other'" +msgstr "Geschlechts-/Anredeoption für übermittelten Wert \"other\"" + #: templates/CRM/Twingle/Form/Profile.tpl msgid "Payment methods" msgstr "Zahlungsmethoden" #: templates/CRM/Twingle/Form/Profile.tpl -msgid "Groups" -msgstr "Gruppen" +msgid "Groups and Correlations" +msgstr "Gruppen und Beziehungen" + +#: templates/CRM/Twingle/Form/Profile.tpl +msgid "Newsletter Double Opt-In" +msgstr "Double-Opt-In für Newsletter" + +#: templates/CRM/Twingle/Form/Profile.tpl +msgid "Membership Postprocessing" +msgstr "Mitgliedschafts--Nachbearbeitung (Postprocessing)" + +#: templates/CRM/Twingle/Form/Profile.tpl +#: templates/CRM/Twingle/Page/Profiles.tpl +msgid "Shop Integration" +msgstr "Shop-Integration" #: templates/CRM/Twingle/Form/Profile.tpl msgid "Are you sure you want to reset the default profile?" @@ -255,9 +1797,44 @@ msgstr "" "debit_manual), wird bei Einsendung einer Twingle-Zuwendung durch " "die API ein SEPA-Mandat mit den gegebenen Daten erzeugt." -#: templates/CRM/Twingle/Form/Settings.tpl -msgid "Help" -msgstr "Hilfe" +#: templates/CRM/Twingle/Form/Settings.hlp +msgid "" +"When the %1 is enabled, you can activate this to use your own references " +"instead of the ones submitted by Twingle." +msgstr "" +"Wenn die %1 aktiviert ist, können Sie diese Option aktivieren, um Ihre " +"eigenen Referenzen statt der von Twingle übermittelten zu verwenden." + +#: templates/CRM/Twingle/Form/Settings.hlp +msgid "" +"Will protect all recurring contributions created by Twingle from " +"termination, since this does NOT terminate the Twingle collection process" +msgstr "" +"Schützt alle von Twingle erstellten wiederkehrenden Zuwendungen vor " +"Beendigung, da dies nicht den Einzug bei Twingle beendet." + +#: templates/CRM/Twingle/Form/Settings.hlp +msgid "" +"You can use this setting to add a prefix to the Twingle transaction ID, in " +"order to avoid collisions with other transaction ids." +msgstr "" +"Sie können diese Einstellung verwenden, um ein Präfix der Twingle-" +"Transaktions-ID voranzustellen, um Kollisionen mit anderen Transaktions-IDs " +"auszuschließen." + +#: templates/CRM/Twingle/Form/Settings.hlp +msgid "" +"If you enable Twingle Shop integration, you can configure Twingle API " +"profiles to include products ordered through Twingle Shop as line items in " +"the created contribution." +msgstr "" +"Mit aktivierter Twingle-Shop-Integration können Twingle-API-Profile so " +"konfiguriert werden, dass über den Twingle-Shop bestellte Produkte als " +"Belegzeilen in der erstellten Zuwendung enthalten sind." + +#: templates/CRM/Twingle/Form/Settings.hlp +msgid "Enter your twingle API access key." +msgstr "Geben Sie ihren Zugriffsschlüssel für die Twingle-API ein." #: templates/CRM/Twingle/Page/Configuration.tpl msgid "Profiles" @@ -280,16 +1857,28 @@ msgid "New profile" msgstr "Neues Profil" #: templates/CRM/Twingle/Page/Profiles.tpl -msgid "Properties" -msgstr "Eigenschaften" +msgid "Selectors" +msgstr "Selektoren" + +#: templates/CRM/Twingle/Page/Profiles.tpl +msgid "Used" +msgstr "Verwendet" + +#: templates/CRM/Twingle/Page/Profiles.tpl +msgid "Last Used" +msgstr "Zuletzt verwendet" #: templates/CRM/Twingle/Page/Profiles.tpl msgid "Operations" msgstr "Operationen" #: templates/CRM/Twingle/Page/Profiles.tpl -msgid "Selector" -msgstr "Selektor" +msgid "enabled" +msgstr "aktiviert" + +#: templates/CRM/Twingle/Page/Profiles.tpl +msgid "disabled" +msgstr "deaktiviert" #: templates/CRM/Twingle/Page/Profiles.tpl msgid "Edit profile %1" @@ -299,6 +1888,14 @@ msgstr "Profil %1 bearbeiten" msgid "Edit" msgstr "Bearbeiten" +#: templates/CRM/Twingle/Page/Profiles.tpl +msgid "Copy profile %1" +msgstr "Profil %1 kopieren" + +#: templates/CRM/Twingle/Page/Profiles.tpl +msgid "Copy" +msgstr "Kopieren" + #: templates/CRM/Twingle/Page/Profiles.tpl msgid "Reset profile %1" msgstr "Profil %1 zurücksetzen" @@ -306,3 +1903,20 @@ msgstr "Profil %1 zurücksetzen" #: templates/CRM/Twingle/Page/Profiles.tpl msgid "Delete profile %1" msgstr "Profil % 1 löschen" + +#: twingle.php +msgid "Twingle API: Access Twingle API" +msgstr "Twingle-API: Zugriff auf Twingle-API" + +#: twingle.php +msgid "Allows access to the Twingle API actions." +msgstr "Gewährt Zugriff auf Aktionen der Twingle-API." + +#~ msgid "Groups" +#~ msgstr "Gruppen" + +#~ msgid "Create contact note for" +#~ msgstr "Kontakt-Notiz erstellen für" + +#~ msgid "Properties" +#~ msgstr "Eigenschaften" diff --git a/l10n/pot/twingle.pot b/l10n/pot/twingle.pot deleted file mode 100644 index 868ab0a..0000000 --- a/l10n/pot/twingle.pot +++ /dev/null @@ -1,276 +0,0 @@ -#: ./CRM/Twingle/Form/Profile.php -msgid "Delete Twingle API profile %1" -msgstr "" - -#: ./CRM/Twingle/Form/Profile.php ./templates/CRM/Twingle/Page/Profiles.tpl -msgid "Reset" -msgstr "" - -#: ./CRM/Twingle/Form/Profile.php ./templates/CRM/Twingle/Page/Profiles.tpl -msgid "Delete" -msgstr "" - -#: ./CRM/Twingle/Form/Profile.php -msgid "Edit Twingle API profile %1" -msgstr "" - -#: ./CRM/Twingle/Form/Profile.php -msgid "New Twingle API profile" -msgstr "" - -#: ./CRM/Twingle/Form/Profile.php ./templates/CRM/Twingle/Page/Profiles.tpl -msgid "Profile name" -msgstr "" - -#: ./CRM/Twingle/Form/Profile.php -msgid "Project IDs" -msgstr "" - -#: ./CRM/Twingle/Form/Profile.php -msgid "Location type" -msgstr "" - -#: ./CRM/Twingle/Form/Profile.php -msgid "Financial Type" -msgstr "" - -#: ./CRM/Twingle/Form/Profile.php -msgid "Gender option for submitted value \"male\"" -msgstr "" - -#: ./CRM/Twingle/Form/Profile.php -msgid "Gender option for submitted value \"female\"" -msgstr "" - -#: ./CRM/Twingle/Form/Profile.php -msgid "Gender option for submitted value \"other\"" -msgstr "" - -#: ./CRM/Twingle/Form/Profile.php -msgid "Record %1 as" -msgstr "" - -#: ./CRM/Twingle/Form/Profile.php -msgid "CiviSEPA creditor" -msgstr "" - -#: ./CRM/Twingle/Form/Profile.php -msgid "Sign up for newsletter groups" -msgstr "" - -#: ./CRM/Twingle/Form/Profile.php -msgid "Sign up for postal mail groups" -msgstr "" - -#: ./CRM/Twingle/Form/Profile.php -msgid "Sign up for Donation receipt groups" -msgstr "" - -#: ./CRM/Twingle/Form/Profile.php ./CRM/Twingle/Form/Settings.php -msgid "Save" -msgstr "" - -#: ./CRM/Twingle/Form/Profile.php -msgid "Only alphanumeric characters and the underscore (_) are allowed for profile names." -msgstr "" - -#: ./CRM/Twingle/Form/Profile.php -msgid "CiviSEPA" -msgstr "" - -#: ./CRM/Twingle/Form/Profile.php -msgid "No mailing lists available" -msgstr "" - -#: ./CRM/Twingle/Profile.php -msgid "Unknown attribute %1." -msgstr "" - -#: ./CRM/Twingle/Profile.php -msgid "Bank transfer" -msgstr "" - -#: ./CRM/Twingle/Profile.php -msgid "Debit manual" -msgstr "" - -#: ./CRM/Twingle/Profile.php -msgid "Debit automatic" -msgstr "" - -#: ./CRM/Twingle/Profile.php -msgid "Credit card" -msgstr "" - -#: ./CRM/Twingle/Profile.php -msgid "Mobile phone Germany" -msgstr "" - -#: ./CRM/Twingle/Profile.php -msgid "PayPal" -msgstr "" - -#: ./CRM/Twingle/Profile.php -msgid "SOFORT Überweisung" -msgstr "" - -#: ./CRM/Twingle/Profile.php -msgid "Amazon Pay" -msgstr "" - -#: ./CRM/Twingle/Profile.php -msgid "paydirekt" -msgstr "" - -#: ./CRM/Twingle/Profile.php -msgid "Apple Pay" -msgstr "" - -#: ./CRM/Twingle/Profile.php -msgid "Google Pay" -msgstr "" - -#: ./CRM/Twingle/Submission.php -msgid "Invalid donation rhythm." -msgstr "" - -#: ./CRM/Twingle/Submission.php -msgid "Payment method could not be matched to existing payment instrument." -msgstr "" - -#: ./CRM/Twingle/Submission.php -msgid "Invalid date for parameter \"confirmed_at\"." -msgstr "" - -#: ./CRM/Twingle/Submission.php -msgid "Invalid date for parameter \"user_birthdate\"." -msgstr "" - -#: ./CRM/Twingle/Submission.php -msgid "Gender could not be matched to existing gender." -msgstr "" - -#: ./CRM/Twingle/Submission.php -msgid "Unknown country %1." -msgstr "" - -#: ./api/v3/TwingleDonation/Cancel.php -msgid "Invalid date for parameter \"cancelled_at\"." -msgstr "" - -#: ./api/v3/TwingleDonation/Cancel.php ./api/v3/TwingleDonation/Endrecurring.php -msgid "Could not terminate SEPA mandate" -msgstr "" - -#: ./api/v3/TwingleDonation/Endrecurring.php -msgid "Invalid date for parameter \"ended_at\"." -msgstr "" - -#: ./api/v3/TwingleDonation/Endrecurring.php -msgid "Mandate closed by TwingleDonation.Endrecurring API call" -msgstr "" - -#: ./api/v3/TwingleDonation/Submit.php -msgid "Contribution with the given transaction ID already exists." -msgstr "" - -#: ./api/v3/TwingleDonation/Submit.php -msgid "Individual contact could not be found or created." -msgstr "" - -#: ./api/v3/TwingleDonation/Submit.php -msgid "Organisation contact could not be found or created." -msgstr "" - -#: ./api/v3/TwingleDonation/Submit.php -msgid "Missing attribute %1 for SEPA mandate" -msgstr "" - -#: ./api/v3/TwingleDonation/Submit.php -msgid "Could not create recurring contribution." -msgstr "" - -#: ./api/v3/TwingleDonation/Submit.php -msgid "Could not create contribution" -msgstr "" - -#: ./templates/CRM/Twingle/Form/Profile.tpl -msgid "General settings" -msgstr "" - -#: ./templates/CRM/Twingle/Form/Profile.tpl -msgid "Payment methods" -msgstr "" - -#: ./templates/CRM/Twingle/Form/Profile.tpl -msgid "Groups" -msgstr "" - -#: ./templates/CRM/Twingle/Form/Profile.tpl -msgid "Are you sure you want to reset the default profile?" -msgstr "" - -#: ./templates/CRM/Twingle/Form/Profile.tpl -msgid "Are you sure you want to delete the profile %1?" -msgstr "" - -#: ./templates/CRM/Twingle/Form/Profile.tpl -msgid "Profile name not given or invalid." -msgstr "" - -#: ./templates/CRM/Twingle/Form/Settings.hlp -msgid "When the %1 is enabled and one of its payment instruments is assigned to a Twingle payment method (practically the debit_manual payment method), submitting a Twingle donation through the API will create a SEPA mandate with the given data." -msgstr "" - -#: ./templates/CRM/Twingle/Form/Settings.tpl -msgid "Help" -msgstr "" - -#: ./templates/CRM/Twingle/Page/Configuration.tpl -msgid "Profiles" -msgstr "" - -#: ./templates/CRM/Twingle/Page/Configuration.tpl -msgid "Configure profiles" -msgstr "" - -#: ./templates/CRM/Twingle/Page/Configuration.tpl -msgid "Settings" -msgstr "" - -#: ./templates/CRM/Twingle/Page/Configuration.tpl -msgid "Configure extension settings" -msgstr "" - -#: ./templates/CRM/Twingle/Page/Profiles.tpl -msgid "New profile" -msgstr "" - -#: ./templates/CRM/Twingle/Page/Profiles.tpl -msgid "Properties" -msgstr "" - -#: ./templates/CRM/Twingle/Page/Profiles.tpl -msgid "Operations" -msgstr "" - -#: ./templates/CRM/Twingle/Page/Profiles.tpl -msgid "Selector" -msgstr "" - -#: ./templates/CRM/Twingle/Page/Profiles.tpl -msgid "Edit profile %1" -msgstr "" - -#: ./templates/CRM/Twingle/Page/Profiles.tpl -msgid "Edit" -msgstr "" - -#: ./templates/CRM/Twingle/Page/Profiles.tpl -msgid "Reset profile %1" -msgstr "" - -#: ./templates/CRM/Twingle/Page/Profiles.tpl -msgid "Delete profile %1" -msgstr "" - diff --git a/managed/Navigation__twingle_configuration.mgd.php b/managed/Navigation__twingle_configuration.mgd.php new file mode 100644 index 0000000..be2d284 --- /dev/null +++ b/managed/Navigation__twingle_configuration.mgd.php @@ -0,0 +1,93 @@ +. + */ + +use CRM_Twingle_ExtensionUtil as E; + +return [ + [ + 'name' => 'Navigation__twingle_configuration', + 'entity' => 'Navigation', + 'cleanup' => 'unused', + 'update' => 'unmodified', + 'params' => [ + 'version' => 4, + 'values' => [ + 'domain_id' => 'current_domain', + 'label' => E::ts('Twingle API Configuration'), + 'name' => 'twingle_configuration', + 'url' => 'civicrm/admin/settings/twingle', + 'icon' => NULL, + 'permission' => [ + 'administer CiviCRM', + ], + 'permission_operator' => 'OR', + 'parent_id.name' => 'CiviContribute', + 'is_active' => TRUE, + 'has_separator' => 0, + ], + 'match' => ['name', 'parent_id'], + ], + ], + [ + 'name' => 'Navigation__twingle_settings', + 'entity' => 'Navigation', + 'cleanup' => 'unused', + 'update' => 'unmodified', + 'params' => [ + 'version' => 4, + 'values' => [ + 'domain_id' => 'current_domain', + 'label' => E::ts('Twingle API Settings'), + 'name' => 'twingle_settings', + 'url' => 'civicrm/admin/settings/twingle/settings', + 'icon' => NULL, + 'permission' => [ + 'administer CiviCRM', + ], + 'permission_operator' => 'OR', + 'parent_id.name' => 'twingle_configuration', + 'is_active' => TRUE, + 'has_separator' => 0, + ], + 'match' => ['name', 'parent_id'], + ], + ], + [ + 'name' => 'Navigation__twingle_profiles', + 'entity' => 'Navigation', + 'cleanup' => 'unused', + 'update' => 'unmodified', + 'params' => [ + 'version' => 4, + 'values' => [ + 'domain_id' => 'current_domain', + 'label' => E::ts('Twingle API Profiles'), + 'name' => 'twingle_profiles', + 'url' => 'civicrm/admin/settings/twingle/profiles', + 'icon' => NULL, + 'permission' => [ + 'administer CiviCRM', + ], + 'permission_operator' => 'OR', + 'parent_id.name' => 'twingle_configuration', + 'is_active' => TRUE, + 'has_separator' => 0, + ], + 'match' => ['name', 'parent_id'], + ], + ], +]; diff --git a/mixin/smarty-v2@1.0.1.mixin.php b/mixin/smarty-v2@1.0.1.mixin.php new file mode 100644 index 0000000..5972dbd --- /dev/null +++ b/mixin/smarty-v2@1.0.1.mixin.php @@ -0,0 +1,51 @@ +getPath('templates'); + if (!file_exists($dir)) { + return; + } + + $register = function() use ($dir) { + // This implementation has a theoretical edge-case bug on older versions of CiviCRM where a template could + // be registered more than once. + CRM_Core_Smarty::singleton()->addTemplateDir($dir); + }; + + // Let's figure out what environment we're in -- so that we know the best way to call $register(). + + if (!empty($GLOBALS['_CIVIX_MIXIN_POLYFILL'])) { + // Polyfill Loader (v<=5.45): We're already in the middle of firing `hook_config`. + if ($mixInfo->isActive()) { + $register(); + } + return; + } + + if (CRM_Extension_System::singleton()->getManager()->extensionIsBeingInstalledOrEnabled($mixInfo->longName)) { + // New Install, Standard Loader: The extension has just been enabled, and we're now setting it up. + // System has already booted. New templates may be needed for upcoming installation steps. + $register(); + return; + } + + // Typical Pageview, Standard Loader: Defer the actual registration for a moment -- to ensure that Smarty is online. + \Civi::dispatcher()->addListener('hook_civicrm_config', function() use ($mixInfo, $register) { + if ($mixInfo->isActive()) { + $register(); + } + }); + +}; diff --git a/mkdocs.yml b/mkdocs.yml index dc51ca6..2765312 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -1,19 +1,33 @@ site_name: Twingle API repo_url: https://github.com/systopia/de.systopia.twingle -theme: material +theme: + name: material -pages: -- 'Home': index.md +nav: + - Introduction: index.md + - Installation: installation.md + - Configuration: + - User, permissions and API authentication: configuration/user_permissions.md + - Extended Contact Manager (XCM) extension: configuration/xcm.md + - CiviSEPA integration: configuration/civisepa.md + - Twingle Profiles: configuration/profiles.md + - Configuring the Twingle Account on the Twingle website: configuration/account.md + - API documentation: api.md markdown_extensions: -- attr_list -- admonition -- def_list -- codehilite -- toc: - permalink: true -- pymdownx.superfences -- pymdownx.inlinehilite -- pymdownx.tilde -- pymdownx.betterem -- pymdownx.mark + - attr_list + - admonition + - def_list + - pymdownx.highlight: + guess_lang: false + - toc: + permalink: true + - pymdownx.superfences + - pymdownx.inlinehilite + - pymdownx.tilde + - pymdownx.betterem + - pymdownx.mark + +plugins: + - search: + lang: en \ No newline at end of file diff --git a/phpcs.xml.dist b/phpcs.xml.dist new file mode 100644 index 0000000..0e10e72 --- /dev/null +++ b/phpcs.xml.dist @@ -0,0 +1,83 @@ + + + CiviCRM coding standard with some additional changes + + api + Civi + CRM + tests + + /CRM/[^/]+/DAO/.*\.php$ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/phpstan.ci.neon b/phpstan.ci.neon new file mode 100644 index 0000000..883179f --- /dev/null +++ b/phpstan.ci.neon @@ -0,0 +1,13 @@ +includes: + - phpstan.neon.dist + +parameters: + scanDirectories: + - ci/vendor/civicrm/civicrm-core/CRM/ + bootstrapFiles: + - ci/vendor/autoload.php + # Because we test with different versions in CI we have unmatched errors + reportUnmatchedIgnoredErrors: false + ignoreErrors: + # Errors we get when using "prefer-lowest" + - '#::getSubscribedEvents\(\) return type has no value type specified in iterable type array.$#' diff --git a/phpstan.neon.dist b/phpstan.neon.dist new file mode 100644 index 0000000..0691f8e --- /dev/null +++ b/phpstan.neon.dist @@ -0,0 +1,42 @@ +parameters: + paths: + - api + - Civi + - CRM + - tests + excludePaths: + analyse: + - CRM/*/DAO/* + - tests/phpunit/bootstrap.php + scanFiles: + - twingle.civix.php + - tools/phpunit/vendor/bin/.phpunit/phpunit/src/Framework/TestCase.php + scanDirectories: + - tools/phpunit/vendor/bin/.phpunit/phpunit/src/Framework + bootstrapFiles: + - tools/phpunit/vendor/bin/.phpunit/phpunit/vendor/autoload.php + - vendor/autoload.php + - phpstanBootstrap.php + level: 9 + universalObjectCratesClasses: + - Civi\Core\Event\GenericHookEvent + checkTooWideReturnTypesInProtectedAndPublicMethods: true + checkUninitializedProperties: true + checkMissingCallableSignature: true + treatPhpDocTypesAsCertain: false + exceptions: + check: + missingCheckedExceptionInThrows: true + tooWideThrowType: true + checkedExceptionClasses: + - \Webmozart\Assert\InvalidArgumentException + implicitThrows: false + ignoreErrors: + # Note paths are prefixed with "*/" to work with inspections in PHPStorm because of: + # https://youtrack.jetbrains.com/issue/WI-63891/PHPStan-ignoreErrors-configuration-isnt-working-with-inspections + + # Example + #- # Accessing results of API requests + #message: "#^Offset '[^']+' does not exist on array[^\\|]+\\|null.$#" + #path: */tests/phpunit/**/*Test.php + tmpDir: .phpstan diff --git a/phpstan.neon.template b/phpstan.neon.template new file mode 100644 index 0000000..a65c395 --- /dev/null +++ b/phpstan.neon.template @@ -0,0 +1,14 @@ +# Copy this file to phpstan.neon and replace {VENDOR_DIR} with the appropriate +# path. + +includes: + - phpstan.neon.dist + +parameters: + scanDirectories: + - {VENDOR_DIR}/civicrm/civicrm-core/Civi/ + - {VENDOR_DIR}/civicrm/civicrm-core/CRM/ + - {VENDOR_DIR}/civicrm/civicrm-core/api/ + - {VENDOR_DIR}/civicrm/civicrm-packages/ + bootstrapFiles: + - {VENDOR_DIR}/autoload.php diff --git a/phpstanBootstrap.php b/phpstanBootstrap.php new file mode 100644 index 0000000..08b3403 --- /dev/null +++ b/phpstanBootstrap.php @@ -0,0 +1,43 @@ +. + */ + +declare(strict_types = 1); + +// phpcs:disable Drupal.Commenting.DocComment.ContentAfterOpen +/** @var \PHPStan\DependencyInjection\Container $container */ +/** @phpstan-var array $bootstrapFiles */ +$bootstrapFiles = $container->getParameter('bootstrapFiles'); +foreach ($bootstrapFiles as $bootstrapFile) { + if (str_ends_with($bootstrapFile, 'vendor/autoload.php')) { + $vendorDir = dirname($bootstrapFile); + $civiCrmVendorDir = $vendorDir . '/civicrm'; + $civiCrmCoreDir = $civiCrmVendorDir . '/civicrm-core'; + if (file_exists($civiCrmCoreDir)) { + set_include_path(get_include_path() + . PATH_SEPARATOR . $civiCrmCoreDir + . PATH_SEPARATOR . $civiCrmVendorDir . '/civicrm-packages' + ); + // $bootstrapFile might not be included, yet. It is required for the + // following require_once, though. + require_once $bootstrapFile; + // Prevent error "Class 'CRM_Core_Exception' not found in file". + require_once $civiCrmCoreDir . '/CRM/Core/Exception.php'; + + break; + } + } +} diff --git a/phpunit.xml.dist b/phpunit.xml.dist new file mode 100644 index 0000000..2df3e9e --- /dev/null +++ b/phpunit.xml.dist @@ -0,0 +1,35 @@ + + + + + + + + + + + ./tests/phpunit + + + + + api + CRM + Civi + + CRM/*/DAO + + + + + + + + + diff --git a/settings/twingle.setting.php b/settings/twingle.setting.php deleted file mode 100644 index 164c97e..0000000 --- a/settings/twingle.setting.php +++ /dev/null @@ -1,34 +0,0 @@ - array( - 'group_name' => 'de.systopia.twingle', - 'group' => 'de.systopia.twingle', - 'name' => 'twingle_use_sepa', - 'type' => 'Boolean', - 'quick_form_type' => 'YesNo', - 'html_type' => 'radio', - 'title' => 'Use CiviSEPA', - 'default' => 0, - 'add' => '4.6', - 'is_domain' => 1, - 'is_contact' => 0, - 'description' => 'Whether to provide CiviSEPA functionality for manual debit payment method. This requires the CiviSEPA (org.project60.sepa) extension be installed.', - ), -); diff --git a/sql/auto_uninstall.sql b/sql/auto_uninstall.sql new file mode 100644 index 0000000..b37b946 --- /dev/null +++ b/sql/auto_uninstall.sql @@ -0,0 +1,21 @@ +-- +--------------------------------------------------------------------+ +-- | Copyright CiviCRM LLC. All rights reserved. | +-- | | +-- | This work is published under the GNU AGPLv3 license with some | +-- | permitted exceptions and without any warranty. For full license | +-- | and copyright information, see https://civicrm.org/licensing | +-- +--------------------------------------------------------------------+ +-- +-- Generated from drop.tpl +-- DO NOT EDIT. Generated by CRM_Core_CodeGen +---- /******************************************************* +-- * +-- * Clean up the existing tables-- * +-- *******************************************************/ + +SET FOREIGN_KEY_CHECKS=0; + +DROP TABLE IF EXISTS `civicrm_twingle_product`; +DROP TABLE IF EXISTS `civicrm_twingle_shop`; + +SET FOREIGN_KEY_CHECKS=1; \ No newline at end of file diff --git a/sql/civicrm_twingle_profile.sql b/sql/civicrm_twingle_profile.sql new file mode 100644 index 0000000..479e231 --- /dev/null +++ b/sql/civicrm_twingle_profile.sql @@ -0,0 +1,16 @@ +-- /******************************************************* +-- ** civicrm_twingle_profile +-- ** +-- ** stores twingle profile data v1.4+ +-- ********************************************************/ + +CREATE TABLE IF NOT EXISTS `civicrm_twingle_profile`( + `id` int unsigned NOT NULL AUTO_INCREMENT COMMENT 'ID', + `name` varchar(255) COMMENT 'configuration name, i.e. internal ID', + `config` text COMMENT 'JSON encoded configuration', + `last_access` datetime COMMENT 'timestamp of the last access (through the api)', + `access_counter` int unsigned COMMENT 'number of accesses (through the api)', + PRIMARY KEY (`id`), + UNIQUE INDEX (`name`) +) ENGINE=InnoDB DEFAULT CHARACTER SET utf8 COLLATE utf8_unicode_ci; + diff --git a/sql/civicrm_twingle_shop.sql b/sql/civicrm_twingle_shop.sql new file mode 100644 index 0000000..918b0ef --- /dev/null +++ b/sql/civicrm_twingle_shop.sql @@ -0,0 +1,66 @@ +-- +--------------------------------------------------------------------+ +-- | Copyright CiviCRM LLC. All rights reserved. | +-- | | +-- | This work is published under the GNU AGPLv3 license with some | +-- | permitted exceptions and without any warranty. For full license | +-- | and copyright information, see https://civicrm.org/licensing | +-- +--------------------------------------------------------------------+ +-- +-- Generated from schema.tpl +-- DO NOT EDIT. Generated by CRM_Core_CodeGen +-- +-- /******************************************************* +-- * +-- * Clean up the existing tables - this section generated from drop.tpl +-- * +-- *******************************************************/ + +SET FOREIGN_KEY_CHECKS=0; + +DROP TABLE IF EXISTS `civicrm_twingle_product`; +DROP TABLE IF EXISTS `civicrm_twingle_shop`; + +SET FOREIGN_KEY_CHECKS=1; +-- /******************************************************* +-- * +-- * Create new tables +-- * +-- *******************************************************/ + +-- /******************************************************* +-- * +-- * civicrm_twingle_shop +-- * +-- * This table contains the Twingle Shop data. Each Twingle Shop is linked to a corresponding Price Set. +-- * +-- *******************************************************/ +CREATE TABLE `civicrm_twingle_shop` ( + `id` int unsigned NOT NULL AUTO_INCREMENT COMMENT 'Unique TwingleShop ID', + `project_identifier` varchar(32) NOT NULL COMMENT 'Twingle Project Identifier', + `numerical_project_id` int unsigned NOT NULL COMMENT 'Numerical Twingle Project Identifier', + `price_set_id` int unsigned COMMENT 'FK to Price Set', + `name` varchar(64) NOT NULL COMMENT 'name of the shop', + PRIMARY KEY (`id`), + CONSTRAINT FK_civicrm_twingle_shop_price_set_id FOREIGN KEY (`price_set_id`) REFERENCES `civicrm_price_set`(`id`) ON DELETE CASCADE +) + ENGINE=InnoDB; + +-- /******************************************************* +-- * +-- * civicrm_twingle_product +-- * +-- * This table contains the Twingle Product data. +-- * +-- *******************************************************/ +CREATE TABLE `civicrm_twingle_product` ( + `id` int unsigned NOT NULL AUTO_INCREMENT COMMENT 'Unique TwingleProduct ID', + `external_id` int unsigned NOT NULL COMMENT 'The ID of this product in the Twingle database', + `price_field_id` int unsigned NOT NULL COMMENT 'FK to Price Field', + `twingle_shop_id` int unsigned COMMENT 'FK to Twingle Shop', + `created_at` datetime NOT NULL DEFAULT CURRENT_TIMESTAMP COMMENT 'Timestamp of when the product was created in the database', + `updated_at` datetime NOT NULL COMMENT 'Timestamp of when the product was last updated in the Twingle database', + PRIMARY KEY (`id`), + CONSTRAINT FK_civicrm_twingle_product_price_field_id FOREIGN KEY (`price_field_id`) REFERENCES `civicrm_price_field`(`id`) ON DELETE CASCADE, + CONSTRAINT FK_civicrm_twingle_product_twingle_shop_id FOREIGN KEY (`twingle_shop_id`) REFERENCES `civicrm_twingle_shop`(`id`) ON DELETE CASCADE +) + ENGINE=InnoDB; diff --git a/templates/CRM/Twingle/Form/Profile.hlp b/templates/CRM/Twingle/Form/Profile.hlp index 125e276..5e1a401 100644 --- a/templates/CRM/Twingle/Form/Profile.hlp +++ b/templates/CRM/Twingle/Form/Profile.hlp @@ -12,10 +12,86 @@ | written permission from the original author(s). | +-------------------------------------------------------------*} +{crmScope extensionKey='de.systopia.twingle'} {htxt id='id-location_type_id'} {ts domain="de.systopia.twingle"}Select which location type to use for addresses for individuals, either when no organisation name is specified, or an organisation address can not be shared with the individual contact.{/ts} {/htxt} -{htxt id='id-location_type_id_organisation'} - {ts domain="de.systopia.twingle"}Select which location type to use for addresses for organisations and shared organisation addresses for individual contacts{/ts} +{htxt id='id-project_ids'} + {ts domain="de.systopia.twingle"}Put your project's Twingle ID in here, to activate this profile for that project.{/ts} + {ts domain="de.systopia.twingle"}You can also provide multiple project IDs separated by a comma.{/ts} {/htxt} + +{htxt id='id-xcm_profile'} + {ts domain="de.systopia.twingle"}The Contact Matcher (XCM) manages the identification or creation of the related contact.{/ts} + {ts domain="de.systopia.twingle"}We recommend creating a new XCM profile only to be used with the Twingle API.{/ts} +{/htxt} + +{htxt id='id-location_type_id_organisation'} + {ts domain="de.systopia.twingle"}Select which location type to use for addresses for organisations and shared organisation addresses for individual contacts.{/ts} +{/htxt} + +{htxt id='id-financial_type_id'} + {ts domain="de.systopia.twingle"}Select which financial type to use for one-time contributions.{/ts} +{/htxt} + +{htxt id='id-financial_type_id_recur'} + {ts domain="de.systopia.twingle"}Select which financial type to use for recurring contributions.{/ts} +{/htxt} + +{htxt id='id-newsletter-double-opt-in'} +

{ts domain="de.systopia.twingle"}Select whether to use CiviCRM's Double-Opt-In feature for subscribing to mailing lists. Note that this only works for public mailing lists. Any non-public mailing list selected above will be ignored when this setting is enabled.{/ts}

+

{ts domain="de.systopia.twingle"}Also, do not forget to disable Twingle's own Double Opt-In option in the Twingle Manager to avoid subscribers receiving multiple confirmation e-mails. Only one or the other option should be enabled.{/ts}

+{/htxt} + +{htxt id='id-membership-postprocessing-call'} + {ts domain="de.systopia.twingle"}Some organisations have specific conventions on how a membership should be created. Since the Twingle-API can only create a "bare bone" membership object, you can enter a API Call (as 'Entity.Action') to adjust any newly created membership to your organisation's needs.{/ts} + {ts domain="de.systopia.twingle"}The API call would receive the following parameters:
    +
  • membership_id: The ID of the newly created membership
    • +
  • contact_id: The ID of the contact involved
    • +
  • organization_id: The ID of the contact's organisation, potentially empty
    • +
  • contribution_id: The ID contribution received, potentially empty
    • +
  • recurring_contribution_id: The ID of the recurring contribution. If empty, this was only a one-off donation.
    • +
{/ts} +{/htxt} + +{htxt id='id-required_address_components'} +

{ts}Select the address components that must be present to create or update an address for the contact.{/ts}

+

{ts}Depending on your XCM settings, the transferred address might replace an existing one.{/ts}

+

{ts}Since in some cases Twingle send the country of the user as the only address parameter, depending on your XCM configuration, not declaring other address components as required might lead to the current user address being overwritten with an address containing the country only.{/ts}

+{/htxt} + +{htxt id='id-custom_field_mapping'} + {ts domain="de.systopia.twingle"}

Map Twingle custom fields to CiviCRM fields using the following format (each assignment in a separate line):

+ 
twingle_field_1=custom_123
twingle_field_2=custom_789
+

Always use the custom_[id] notation for CiviCRM custom fields.

+

This works for fields that Twingle themselves provide in the custom_fields parameter, and for any other parameter (e.g. user_extrafield)

+

Only custom fields extending one of the following CiviCRM entities are allowed:

+
    +
  • Contact – Will be set on the Individual contact
    • +
  • Individual – Will be set on the Individual contact
    • +
  • Organization – Will be set on the Organization contact, if an organisation name was submitted
    • +
  • Contribution – Will be set on the contribution
    • +
  • ContributionRecur – Will be set on the recurring contribution and deriving single contributions
    • +
{/ts} +{/htxt} + +{htxt id='id-map_as_contribution_notes'} + {ts domain="de.systopia.twingle"}

Create a contribution note for each field specified in this selection.

+

Tip: You can enable or disable this fields in the TwingleMANAGER.

{/ts} +{/htxt} + +{htxt id='id-map_as_contact_notes'} + {ts domain="de.systopia.twingle"}

Create a contact note for each field specified in this selection.

+

Tip: You can enable or disable this fields in the TwingleMANAGER.

{/ts} +{/htxt} + +{htxt id='id-enable_shop_integration'} +

{ts domain="de.systopia.twingle"}Enable the processing of orders via Twingle Shop for this profile. The ordered products will then appear as line items in the contribution.{/ts}

+{/htxt} + +{htxt id='id-shop_map_products'} +

{ts domain="de.systopia.twingle"}If this option is enabled, all Twingle Shop products corresponding to the specified project IDs will be retrieved from Twingle and mapped as price sets and price fields. Each Twingle Shop is mapped as a price set with its products as price fields.{/ts}

+

{ts domain="de.systopia.twingle"}This allows you to manually create contributions with the same line items for phone orders, for example, as would be the case for orders placed through the Twingle Shop.{/ts}

+{/htxt} +{/crmScope} diff --git a/templates/CRM/Twingle/Form/Profile.tpl b/templates/CRM/Twingle/Form/Profile.tpl index 502404b..8224e84 100644 --- a/templates/CRM/Twingle/Form/Profile.tpl +++ b/templates/CRM/Twingle/Form/Profile.tpl @@ -14,7 +14,7 @@
- {if $op == 'create' or $op == 'edit'} + {if $op == 'create' or $op == 'edit' or $op == 'copy'}
@@ -28,8 +28,47 @@ - {$form.selector.label} - {$form.selector.html} + {if not $is_default} + {$form.selector.label} + + + {$form.selector.html} + {/if} + + + + {$form.xcm_profile.label} + + + {$form.xcm_profile.html} @@ -77,10 +116,70 @@ - {$form.financial_type_id.label} + {$form.required_address_components.label} + + + {$form.required_address_components.html} + + + + + {$form.financial_type_id.label} + + {$form.financial_type_id.html} + + + {$form.financial_type_id_recur.label} + + + {$form.financial_type_id_recur.html} + + {if isset($form.sepa_creditor_id)} {$form.sepa_creditor_id.label} @@ -89,16 +188,16 @@ {/if} - {$form.gender_male.label} - {$form.gender_male.html} + {ts domain="de.systopia.twingle"}Gender/Prefix for value 'male'{/ts} + {$form.gender_male.html} / {$form.prefix_male.html} - {$form.gender_female.label} - {$form.gender_female.html} + {ts domain="de.systopia.twingle"}Gender/Prefix for value 'female'{/ts} + {$form.gender_female.html} / {$form.prefix_female.html} - {$form.gender_other.label} - {$form.gender_other.html} + {ts domain="de.systopia.twingle"}Gender/Prefix for value 'other'{/ts} + {$form.gender_other.html} / {$form.prefix_other.html} @@ -112,8 +211,14 @@ {foreach key=pi_name item=pi_label from=$payment_instruments} + + + {capture assign="pi_contribution_status"}{$pi_name}_status{/capture} + + + {/foreach}
{$form.$pi_name.label} {$form.$pi_name.html}{$form.$pi_contribution_status.label}{$form.$pi_contribution_status.html}
@@ -122,7 +227,7 @@
- {ts domain="de.systopia.twingle"}Groups{/ts} + {ts domain="de.systopia.twingle"}Groups and Correlations{/ts} @@ -131,6 +236,28 @@ + + + + + @@ -146,13 +273,151 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
{$form.newsletter_groups.html}
+ {$form.newsletter_double_opt_in.label} + + {$form.newsletter_double_opt_in.html}
{$form.postinfo_groups.label} {$form.postinfo_groups.html}{$form.campaign.html}
{$form.campaign_targets.label}{$form.campaign_targets.html}
{$form.membership_type_id.label}{$form.membership_type_id.html}
{$form.membership_type_id_recur.label}{$form.membership_type_id_recur.html}
+ {$form.membership_postprocess_call.label} + + {$form.membership_postprocess_call.html}
{$form.contribution_source.label} {$form.contribution_source.html}
+ {$form.map_as_contribution_notes.label} + {help id="id-map_as_contribution_notes" title=$form.map_as_contribution_notes.label} + {$form.map_as_contribution_notes.html}
+ {$form.map_as_contact_notes.label} + {help id="id-map_as_contact_notes" title=$form.map_as_contact_notes.label} + {$form.map_as_contact_notes.html}
+ {$form.custom_field_mapping.label} + + {$form.custom_field_mapping.html}
+ {if $twingle_use_shop eq 1} + + {ts domain="de.systopia.twingle"}Shop Integration{/ts} + + + + + + + + + + + + + + + + + + + + + +
+ {$form.enable_shop_integration.label} + + {$form.enable_shop_integration.html}
{$form.shop_financial_type.label}{$form.shop_financial_type.html}
{$form.shop_donation_financial_type.label}{$form.shop_donation_financial_type.html}
{$form.shop_map_products.label} + {$form.shop_map_products.html} + +
+
+
+
+ + {/if} +
{elseif $op == 'delete'} @@ -173,3 +438,34 @@
+ +{literal} + +{/literal} diff --git a/templates/CRM/Twingle/Form/Settings.hlp b/templates/CRM/Twingle/Form/Settings.hlp index 2f0a45a..fe0d483 100644 --- a/templates/CRM/Twingle/Form/Settings.hlp +++ b/templates/CRM/Twingle/Form/Settings.hlp @@ -15,3 +15,23 @@ {htxt id='id-twingle_use_sepa'} {ts domain="de.systopia.twingle" 1="CiviSEPA (org.project60.sepa) extension"}When the %1 is enabled and one of its payment instruments is assigned to a Twingle payment method (practically the debit_manual payment method), submitting a Twingle donation through the API will create a SEPA mandate with the given data.{/ts} {/htxt} + +{htxt id='id-twingle_dont_use_reference'} + {ts domain="de.systopia.twingle" 1="CiviSEPA (org.project60.sepa) extension"}When the %1 is enabled, you can activate this to use your own references instead of the ones submitted by Twingle.{/ts} +{/htxt} + +{htxt id='id-twingle_protect_recurring'} + {ts domain="de.systopia.twingle"}Will protect all recurring contributions created by Twingle from termination, since this does NOT terminate the Twingle collection process{/ts} +{/htxt} + +{htxt id='id-twingle_prefix'} + {ts domain="de.systopia.twingle"}You can use this setting to add a prefix to the Twingle transaction ID, in order to avoid collisions with other transaction ids.{/ts} +{/htxt} + +{htxt id='id-twingle_use_shop'} + {ts domain="de.systopia.twingle"}If you enable Twingle Shop integration, you can configure Twingle API profiles to include products ordered through Twingle Shop as line items in the created contribution.{/ts} +{/htxt} + +{htxt id='id-twingle_access_key'} + {ts domain="de.systopia.twingle"}Enter your twingle API access key.{/ts} +{/htxt} diff --git a/templates/CRM/Twingle/Form/Settings.tpl b/templates/CRM/Twingle/Form/Settings.tpl index 6f57d37..b13760a 100644 --- a/templates/CRM/Twingle/Form/Settings.tpl +++ b/templates/CRM/Twingle/Form/Settings.tpl @@ -14,29 +14,118 @@
- {* HEADER *} -
- {include file="CRM/common/formButtons.tpl" location="top"} -
+

Twingle API - Generic Settings

- {foreach from=$elementNames item=elementName} - - + + - {/foreach} + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
{$form.$elementName.label}  
+ {$form.twingle_use_sepa.label} + {help id="id-twingle_use_sepa" title=$form.twingle_use_sepa.label} + - {$form.$elementName.html} -
- - {$formElements.$elementName.description} - + {$form.twingle_use_sepa.html}
+ {$form.twingle_dont_use_reference.label} + {help id="id-twingle_dont_use_reference" title=$form.twingle_dont_use_reference.label} + + {$form.twingle_dont_use_reference.html} +
{$form.twingle_prefix.label} + {help id="id-twingle_prefix" title=$form.twingle_prefix.label} + + {$form.twingle_prefix.html} +
{$form.twingle_protect_recurring.label} + {help id="id-twingle_protect_recurring" title=$form.twingle_protect_recurring.label} + + {$form.twingle_protect_recurring.html} +
{$form.twingle_protect_recurring_activity_type.label} + {$form.twingle_protect_recurring_activity_type.html} +
{$form.twingle_protect_recurring_activity_subject.label} + {$form.twingle_protect_recurring_activity_subject.html} +
{$form.twingle_protect_recurring_activity_status.label} + {$form.twingle_protect_recurring_activity_status.html} +
{$form.twingle_protect_recurring_activity_assignee.label} + {$form.twingle_protect_recurring_activity_assignee.html} +
+ +

Twingle Shop Integration

+ + + + + + + + + +
{$form.twingle_use_shop.label} + {help id="id-twingle_use_shop" title=$form.twingle_use_shop.label} + {$form.twingle_use_shop.html}
{$form.twingle_access_key.label} + {help id="id-twingle_access_key" title=$form.twingle_access_key.label} + {$form.twingle_access_key.html}
- {* FOOTER *}
{include file="CRM/common/formButtons.tpl" location="bottom"}
+ +{literal} + +{/literal} diff --git a/templates/CRM/Twingle/Page/Profiles.tpl b/templates/CRM/Twingle/Page/Profiles.tpl index 3b935a7..1ef751b 100644 --- a/templates/CRM/Twingle/Page/Profiles.tpl +++ b/templates/CRM/Twingle/Page/Profiles.tpl @@ -25,26 +25,43 @@ {ts domain="de.systopia.twingle"}Profile name{/ts} - {ts domain="de.systopia.twingle"}Properties{/ts} + {ts domain="de.systopia.twingle"}Selectors{/ts} + {if $twingle_use_shop eq 1} + {ts domain="de.systopia.twingle"}Shop Integration{/ts} + {/if} + {ts domain="de.systopia.twingle"}Used{/ts} + {ts domain="de.systopia.twingle"}Last Used{/ts} {ts domain="de.systopia.twingle"}Operations{/ts} {foreach from=$profiles item=profile} + {assign var="profile_id" value=$profile.id} {assign var="profile_name" value=$profile.name} - + {$profile.name} -
{ts domain="de.systopia.twingle"}Selector{/ts}: {$profile.selector}
+ {if not $profile.is_default} +
    + {foreach from=$profile.selectors item=selector} +
  • {$selector}
    • + {/foreach} +
+ {/if} + {if $twingle_use_shop eq 1} + {if $profile.enable_shop_integration}{ts domain="de.systopia.twingle"}enabled{/ts}{else}{ts domain="de.systopia.twingle"}disabled{/ts}{/if} + {/if} + {ts domain="de.systopia.twingle"}{$profile_stats.$profile_name.access_counter_txt}{/ts} + {ts domain="de.systopia.twingle"}{$profile_stats.$profile_name.last_access_txt}{/ts} - {ts domain="de.systopia.twingle"}Edit{/ts} + {ts domain="de.systopia.twingle"}Edit{/ts} + {ts domain="de.systopia.twingle"}Copy{/ts} {if $profile_name == 'default'} - {ts domain="de.systopia.twingle"}Reset{/ts} + {ts domain="de.systopia.twingle"}Reset{/ts} {else} - {ts domain="de.systopia.twingle"}Delete{/ts} + {ts domain="de.systopia.twingle"}Delete{/ts} {/if} - {/foreach} diff --git a/tests/docker-compose.yml b/tests/docker-compose.yml new file mode 100644 index 0000000..840130d --- /dev/null +++ b/tests/docker-compose.yml @@ -0,0 +1,33 @@ +version: "3" +services: + civicrm: + image: michaelmcandrew/civicrm:${CIVICRM_IMAGE_TAG:-5-drupal-php8.1} + environment: + - PROJECT_NAME=test + - BASE_URL=http://localhost + - CIVICRM_DB_NAME=test + - CIVICRM_DB_USER=root + - CIVICRM_DB_PASS=secret + - CIVICRM_DB_HOST=mysql + - CIVICRM_DB_PORT=3306 + - DRUPAL_DB_NAME=test + - DRUPAL_DB_USER=root + - DRUPAL_DB_PASS=secret + - DRUPAL_DB_HOST=mysql + - DRUPAL_DB_PORT=3306 + - PHP_DATE_TIMEZONE=UTC + - DEBUG=ON + - SMTP_HOST=localhost + - SMTP_MAILDOMAIN=example.org + volumes: + - ../:/var/www/html/sites/default/files/civicrm/ext/de.systopia.twingle:${BIND_VOLUME_PERMISSIONS:-ro} + - /var/www/html/sites/default/files/civicrm/ext/de.systopia.twingle/vendor + - /var/www/html/sites/default/files/civicrm/ext/de.systopia.twingle/tools/phpunit/vendor + # Don't start Apache HTTP Server, but keep container running + command: ["tail", "-f", "/dev/null"] + stop_signal: SIGKILL + mysql: + image: mariadb + environment: + MARIADB_ROOT_PASSWORD: secret + MARIADB_DATABASE: test diff --git a/tests/docker-phpunit.sh b/tests/docker-phpunit.sh new file mode 100755 index 0000000..2b0fc69 --- /dev/null +++ b/tests/docker-phpunit.sh @@ -0,0 +1,19 @@ +#!/bin/bash +set -eu -o pipefail + +SCRIPT_DIR=$(realpath "$(dirname "$0")") +EXT_DIR=$(dirname "$SCRIPT_DIR") + +cd "$EXT_DIR" +if [ ! -e tools/phpunit/vendor/bin ]; then + "$SCRIPT_DIR/docker-prepare.sh" +fi + +export XDEBUG_MODE=coverage +# TODO: Remove when not needed, anymore. +# In Docker container with CiviCRM 5.5? all deprecations are reported as direct +# deprecations so "disabling" check of deprecation count is necessary for the +# tests to pass (if baselineFile does not contain all deprecations). +export SYMFONY_DEPRECATIONS_HELPER="max[total]=99999&baselineFile=./tests/ignored-deprecations.json" + +composer phpunit -- --cache-result-file=/tmp/.phpunit.result.cache "$@" diff --git a/tests/docker-prepare.sh b/tests/docker-prepare.sh new file mode 100755 index 0000000..a293c74 --- /dev/null +++ b/tests/docker-prepare.sh @@ -0,0 +1,45 @@ +#!/bin/bash +set -eu -o pipefail + +EXT_DIR=$(dirname "$(dirname "$(realpath "$0")")") +EXT_NAME=$(basename "$EXT_DIR") + +i=0 +while ! mysql -h "$CIVICRM_DB_HOST" -P "$CIVICRM_DB_PORT" -u "$CIVICRM_DB_USER" --password="$CIVICRM_DB_PASS" -e 'SELECT 1;' >/dev/null 2>&1; do + i=$((i+1)) + if [ $i -gt 10 ]; then + echo "Failed to connect to database" >&2 + exit 1 + fi + + echo -n . + sleep 1 +done + +echo + +export XDEBUG_MODE=off +if mysql -h "$CIVICRM_DB_HOST" -P "$CIVICRM_DB_PORT" -u "$CIVICRM_DB_USER" --password="$CIVICRM_DB_PASS" "$CIVICRM_DB_NAME" -e 'SELECT 1 FROM civicrm_setting LIMIT 1;' >/dev/null 2>&1; then + cv flush +else + # For headless tests it is required that CIVICRM_UF is defined using the corresponding env variable. + sed -E "s/define\('CIVICRM_UF', '([^']+)'\);/define('CIVICRM_UF', getenv('CIVICRM_UF') ?: '\1');/g" \ + -i /var/www/html/sites/default/civicrm.settings.php + civicrm-docker-install + + # Avoid this error: + # The autoloader expected class "Civi\ActionSchedule\Mapping" to be defined in + # file "[...]/Civi/ActionSchedule/Mapping.php". The file was found but the + # class was not in it, the class name or namespace probably has a typo. + rm -f /var/www/html/sites/all/modules/civicrm/Civi/ActionSchedule/Mapping.php + + # For headless tests these files need to exist. + touch /var/www/html/sites/all/modules/civicrm/sql/test_data.mysql + touch /var/www/html/sites/all/modules/civicrm/sql/test_data_second_domain.mysql + + cv ext:enable "$EXT_NAME" +fi + +cd "$EXT_DIR" +composer update --no-progress --prefer-dist --optimize-autoloader --no-dev +composer composer-phpunit -- update --no-progress --prefer-dist diff --git a/tests/ignored-deprecations.json b/tests/ignored-deprecations.json new file mode 100644 index 0000000..fe51488 --- /dev/null +++ b/tests/ignored-deprecations.json @@ -0,0 +1 @@ +[] diff --git a/tests/phpunit/api/v3/TwingleProduct/CreateTest.php b/tests/phpunit/api/v3/TwingleProduct/CreateTest.php new file mode 100644 index 0000000..7d489aa --- /dev/null +++ b/tests/phpunit/api/v3/TwingleProduct/CreateTest.php @@ -0,0 +1,54 @@ +installMe(__DIR__) + ->apply(); + } + + /** + * The setup() method is executed before the test is executed (optional). + */ + public function setUp() { + parent::setUp(); + } + + /** + * The tearDown() method is executed after the test was executed (optional) + * This can be used for cleanup. + */ + public function tearDown() { + parent::tearDown(); + } + + /** + * Simple example test case. + * + * Note how the function name begins with the word "test". + */ + public function testApiExample() { + $result = civicrm_api3('TwingleProduct', 'create', array('magicword' => 'sesame')); + $this->assertEquals('Twelve', $result['values'][12]['name']); + } + +} diff --git a/tests/phpunit/api/v3/TwingleProduct/DeleteTest.php b/tests/phpunit/api/v3/TwingleProduct/DeleteTest.php new file mode 100644 index 0000000..7edac01 --- /dev/null +++ b/tests/phpunit/api/v3/TwingleProduct/DeleteTest.php @@ -0,0 +1,54 @@ +installMe(__DIR__) + ->apply(); + } + + /** + * The setup() method is executed before the test is executed (optional). + */ + public function setUp() { + parent::setUp(); + } + + /** + * The tearDown() method is executed after the test was executed (optional) + * This can be used for cleanup. + */ + public function tearDown() { + parent::tearDown(); + } + + /** + * Simple example test case. + * + * Note how the function name begins with the word "test". + */ + public function testApiExample() { + $result = civicrm_api3('TwingleProduct', 'delete', array('magicword' => 'sesame')); + $this->assertEquals('Twelve', $result['values'][12]['name']); + } + +} diff --git a/tests/phpunit/api/v3/TwingleProduct/GetTest.php b/tests/phpunit/api/v3/TwingleProduct/GetTest.php new file mode 100644 index 0000000..670de99 --- /dev/null +++ b/tests/phpunit/api/v3/TwingleProduct/GetTest.php @@ -0,0 +1,54 @@ +installMe(__DIR__) + ->apply(); + } + + /** + * The setup() method is executed before the test is executed (optional). + */ + public function setUp() { + parent::setUp(); + } + + /** + * The tearDown() method is executed after the test was executed (optional) + * This can be used for cleanup. + */ + public function tearDown() { + parent::tearDown(); + } + + /** + * Simple example test case. + * + * Note how the function name begins with the word "test". + */ + public function testApiExample() { + $result = civicrm_api3('TwingleProduct', 'get', array('magicword' => 'sesame')); + $this->assertEquals('Twelve', $result['values'][12]['name']); + } + +} diff --git a/tests/phpunit/api/v3/TwingleProduct/GetsingleTest.php b/tests/phpunit/api/v3/TwingleProduct/GetsingleTest.php new file mode 100644 index 0000000..1bf43da --- /dev/null +++ b/tests/phpunit/api/v3/TwingleProduct/GetsingleTest.php @@ -0,0 +1,54 @@ +installMe(__DIR__) + ->apply(); + } + + /** + * The setup() method is executed before the test is executed (optional). + */ + public function setUp() { + parent::setUp(); + } + + /** + * The tearDown() method is executed after the test was executed (optional) + * This can be used for cleanup. + */ + public function tearDown() { + parent::tearDown(); + } + + /** + * Simple example test case. + * + * Note how the function name begins with the word "test". + */ + public function testApiExample() { + $result = civicrm_api3('TwingleProduct', 'getsingle', array('magicword' => 'sesame')); + $this->assertEquals('Twelve', $result['values'][12]['name']); + } + +} diff --git a/tests/phpunit/api/v3/TwingleShop/CreateTest.php b/tests/phpunit/api/v3/TwingleShop/CreateTest.php new file mode 100644 index 0000000..12ccac6 --- /dev/null +++ b/tests/phpunit/api/v3/TwingleShop/CreateTest.php @@ -0,0 +1,54 @@ +installMe(__DIR__) + ->apply(); + } + + /** + * The setup() method is executed before the test is executed (optional). + */ + public function setUp() { + parent::setUp(); + } + + /** + * The tearDown() method is executed after the test was executed (optional) + * This can be used for cleanup. + */ + public function tearDown() { + parent::tearDown(); + } + + /** + * Simple example test case. + * + * Note how the function name begins with the word "test". + */ + public function testApiExample() { + $result = civicrm_api3('TwingleShop', 'create', array('magicword' => 'sesame')); + $this->assertEquals('Twelve', $result['values'][12]['name']); + } + +} diff --git a/tests/phpunit/api/v3/TwingleShop/DeleteTest.php b/tests/phpunit/api/v3/TwingleShop/DeleteTest.php new file mode 100644 index 0000000..8e1a9ca --- /dev/null +++ b/tests/phpunit/api/v3/TwingleShop/DeleteTest.php @@ -0,0 +1,54 @@ +installMe(__DIR__) + ->apply(); + } + + /** + * The setup() method is executed before the test is executed (optional). + */ + public function setUp() { + parent::setUp(); + } + + /** + * The tearDown() method is executed after the test was executed (optional) + * This can be used for cleanup. + */ + public function tearDown() { + parent::tearDown(); + } + + /** + * Simple example test case. + * + * Note how the function name begins with the word "test". + */ + public function testApiExample() { + $result = civicrm_api3('TwingleShop', 'delete', array('magicword' => 'sesame')); + $this->assertEquals('Twelve', $result['values'][12]['name']); + } + +} diff --git a/tests/phpunit/api/v3/TwingleShop/GetTest.php b/tests/phpunit/api/v3/TwingleShop/GetTest.php new file mode 100644 index 0000000..e9fa453 --- /dev/null +++ b/tests/phpunit/api/v3/TwingleShop/GetTest.php @@ -0,0 +1,54 @@ +installMe(__DIR__) + ->apply(); + } + + /** + * The setup() method is executed before the test is executed (optional). + */ + public function setUp() { + parent::setUp(); + } + + /** + * The tearDown() method is executed after the test was executed (optional) + * This can be used for cleanup. + */ + public function tearDown() { + parent::tearDown(); + } + + /** + * Simple example test case. + * + * Note how the function name begins with the word "test". + */ + public function testApiExample() { + $result = civicrm_api3('TwingleShop', 'get', array('magicword' => 'sesame')); + $this->assertEquals('Twelve', $result['values'][12]['name']); + } + +} diff --git a/tests/phpunit/api/v3/TwingleShop/GetsingleTest.php b/tests/phpunit/api/v3/TwingleShop/GetsingleTest.php new file mode 100644 index 0000000..96a4efa --- /dev/null +++ b/tests/phpunit/api/v3/TwingleShop/GetsingleTest.php @@ -0,0 +1,54 @@ +installMe(__DIR__) + ->apply(); + } + + /** + * The setup() method is executed before the test is executed (optional). + */ + public function setUp() { + parent::setUp(); + } + + /** + * The tearDown() method is executed after the test was executed (optional) + * This can be used for cleanup. + */ + public function tearDown() { + parent::tearDown(); + } + + /** + * Simple example test case. + * + * Note how the function name begins with the word "test". + */ + public function testApiExample() { + $result = civicrm_api3('TwingleShop', 'getsingle', array('magicword' => 'sesame')); + $this->assertEquals('Twelve', $result['values'][12]['name']); + } + +} diff --git a/tests/phpunit/bootstrap.php b/tests/phpunit/bootstrap.php new file mode 100644 index 0000000..eaa8379 --- /dev/null +++ b/tests/phpunit/bootstrap.php @@ -0,0 +1,65 @@ +add('CRM_', [__DIR__ . '/../..', __DIR__]); +$loader->addPsr4('Civi\\', [__DIR__ . '/../../Civi', __DIR__ . '/Civi']); +$loader->add('api_', [__DIR__ . '/../..', __DIR__]); +$loader->addPsr4('api\\', [__DIR__ . '/../../api', __DIR__ . '/api']); + +$loader->register(); + +/** + * Call the "cv" command. + * + * @param string $cmd + * The rest of the command to send. + * @param string $decode + * Ex: 'json' or 'phpcode'. + * @return mixed + * Response output (if the command executed normally). + * For 'raw' or 'phpcode', this will be a string. For 'json', it could be any JSON value. + * @throws \RuntimeException + * If the command terminates abnormally. + */ +function cv(string $cmd, string $decode = 'json') { + $cmd = 'cv ' . $cmd; + $descriptorSpec = [0 => ['pipe', 'r'], 1 => ['pipe', 'w'], 2 => STDERR]; + $oldOutput = getenv('CV_OUTPUT'); + putenv('CV_OUTPUT=json'); + + // Execute `cv` in the original folder. This is a work-around for + // phpunit/codeception, which seem to manipulate PWD. + $cmd = sprintf('cd %s; %s', escapeshellarg(getenv('PWD')), $cmd); + + $process = proc_open($cmd, $descriptorSpec, $pipes, __DIR__); + putenv("CV_OUTPUT=$oldOutput"); + fclose($pipes[0]); + $result = stream_get_contents($pipes[1]); + fclose($pipes[1]); + if (proc_close($process) !== 0) { + throw new RuntimeException("Command failed ($cmd):\n$result"); + } + switch ($decode) { + case 'raw': + return $result; + + case 'phpcode': + // If the last output is /*PHPCODE*/, then we managed to complete execution. + if (substr(trim($result), 0, 12) !== '/*BEGINPHP*/' || substr(trim($result), -10) !== '/*ENDPHP*/') { + throw new \RuntimeException("Command failed ($cmd):\n$result"); + } + return $result; + + case 'json': + return json_decode($result, 1); + + default: + throw new RuntimeException("Bad decoder format ($decode)"); + } +} diff --git a/tools/phpcs/composer.json b/tools/phpcs/composer.json new file mode 100644 index 0000000..980e4b9 --- /dev/null +++ b/tools/phpcs/composer.json @@ -0,0 +1,11 @@ +{ + "repositories": [ + { + "type": "git", + "url": "https://github.com/civicrm/coder.git" + } + ], + "require": { + "drupal/coder": "dev-8.x-2.x-civi" + } +} diff --git a/tools/phpstan/composer.json b/tools/phpstan/composer.json new file mode 100644 index 0000000..218fa72 --- /dev/null +++ b/tools/phpstan/composer.json @@ -0,0 +1,18 @@ +{ + "require": { + "phpstan/extension-installer": "^1.1", + "phpstan/phpstan": "^1.7", + "phpstan/phpstan-deprecation-rules": "^1.0", + "phpstan/phpstan-phpunit": "^1.1", + "phpstan/phpstan-strict-rules": "^1.2", + "phpstan/phpstan-webmozart-assert": "^1.2", + "thecodingmachine/phpstan-strict-rules": "^1.0", + "voku/phpstan-rules": "^3.0" + }, + "config": { + "allow-plugins": { + "phpstan/extension-installer": true + }, + "sort-packages": true + } +} diff --git a/tools/phpunit/composer.json b/tools/phpunit/composer.json new file mode 100644 index 0000000..ab13d43 --- /dev/null +++ b/tools/phpunit/composer.json @@ -0,0 +1,13 @@ +{ + "require": { + "symfony/phpunit-bridge": "^6.1" + }, + "scripts": { + "post-install-cmd": [ + "@php vendor/bin/simple-phpunit install" + ], + "post-update-cmd": [ + "@php vendor/bin/simple-phpunit install" + ] + } +} diff --git a/twingle.civix.php b/twingle.civix.php index fc0be31..c207adf 100644 --- a/twingle.civix.php +++ b/twingle.civix.php @@ -7,9 +7,9 @@ * extension. */ class CRM_Twingle_ExtensionUtil { - const SHORT_NAME = "twingle"; - const LONG_NAME = "de.systopia.twingle"; - const CLASS_PREFIX = "CRM_Twingle"; + const SHORT_NAME = 'twingle'; + const LONG_NAME = 'de.systopia.twingle'; + const CLASS_PREFIX = 'CRM_Twingle'; /** * Translate a string using the extension's domain. @@ -24,9 +24,9 @@ class CRM_Twingle_ExtensionUtil { * Translated text. * @see ts */ - public static function ts($text, $params = array()) { + public static function ts($text, $params = []): string { if (!array_key_exists('domain', $params)) { - $params['domain'] = array(self::LONG_NAME, NULL); + $params['domain'] = [self::LONG_NAME, NULL]; } return ts($text, $params); } @@ -41,7 +41,7 @@ class CRM_Twingle_ExtensionUtil { * Ex: 'http://example.org/sites/default/ext/org.example.foo'. * Ex: 'http://example.org/sites/default/ext/org.example.foo/css/foo.css'. */ - public static function url($file = NULL) { + public static function url($file = NULL): string { if ($file === NULL) { return rtrim(CRM_Core_Resources::singleton()->getUrl(self::LONG_NAME), '/'); } @@ -82,288 +82,61 @@ use CRM_Twingle_ExtensionUtil as E; /** * (Delegated) Implements hook_civicrm_config(). * - * @link http://wiki.civicrm.org/confluence/display/CRMDOC/hook_civicrm_config + * @link https://docs.civicrm.org/dev/en/latest/hooks/hook_civicrm_config */ -function _twingle_civix_civicrm_config(&$config = NULL) { +function _twingle_civix_civicrm_config($config = NULL) { static $configured = FALSE; if ($configured) { return; } $configured = TRUE; - $template =& CRM_Core_Smarty::singleton(); - - $extRoot = dirname(__FILE__) . DIRECTORY_SEPARATOR; - $extDir = $extRoot . 'templates'; - - if (is_array($template->template_dir)) { - array_unshift($template->template_dir, $extDir); - } - else { - $template->template_dir = array($extDir, $template->template_dir); - } - + $extRoot = __DIR__ . DIRECTORY_SEPARATOR; $include_path = $extRoot . PATH_SEPARATOR . get_include_path(); set_include_path($include_path); -} - -/** - * (Delegated) Implements hook_civicrm_xmlMenu(). - * - * @param $files array(string) - * - * @link http://wiki.civicrm.org/confluence/display/CRMDOC/hook_civicrm_xmlMenu - */ -function _twingle_civix_civicrm_xmlMenu(&$files) { - foreach (_twingle_civix_glob(__DIR__ . '/xml/Menu/*.xml') as $file) { - $files[] = $file; - } + // Based on , this does not currently require mixin/polyfill.php. } /** * Implements hook_civicrm_install(). * - * @link http://wiki.civicrm.org/confluence/display/CRMDOC/hook_civicrm_install + * @link https://docs.civicrm.org/dev/en/latest/hooks/hook_civicrm_install */ function _twingle_civix_civicrm_install() { _twingle_civix_civicrm_config(); - if ($upgrader = _twingle_civix_upgrader()) { - $upgrader->onInstall(); - } -} - -/** - * Implements hook_civicrm_postInstall(). - * - * @link http://wiki.civicrm.org/confluence/display/CRMDOC/hook_civicrm_postInstall - */ -function _twingle_civix_civicrm_postInstall() { - _twingle_civix_civicrm_config(); - if ($upgrader = _twingle_civix_upgrader()) { - if (is_callable(array($upgrader, 'onPostInstall'))) { - $upgrader->onPostInstall(); - } - } -} - -/** - * Implements hook_civicrm_uninstall(). - * - * @link http://wiki.civicrm.org/confluence/display/CRMDOC/hook_civicrm_uninstall - */ -function _twingle_civix_civicrm_uninstall() { - _twingle_civix_civicrm_config(); - if ($upgrader = _twingle_civix_upgrader()) { - $upgrader->onUninstall(); - } + // Based on , this does not currently require mixin/polyfill.php. } /** * (Delegated) Implements hook_civicrm_enable(). * - * @link http://wiki.civicrm.org/confluence/display/CRMDOC/hook_civicrm_enable + * @link https://docs.civicrm.org/dev/en/latest/hooks/hook_civicrm_enable */ -function _twingle_civix_civicrm_enable() { +function _twingle_civix_civicrm_enable(): void { _twingle_civix_civicrm_config(); - if ($upgrader = _twingle_civix_upgrader()) { - if (is_callable(array($upgrader, 'onEnable'))) { - $upgrader->onEnable(); - } - } -} - -/** - * (Delegated) Implements hook_civicrm_disable(). - * - * @link http://wiki.civicrm.org/confluence/display/CRMDOC/hook_civicrm_disable - * @return mixed - */ -function _twingle_civix_civicrm_disable() { - _twingle_civix_civicrm_config(); - if ($upgrader = _twingle_civix_upgrader()) { - if (is_callable(array($upgrader, 'onDisable'))) { - $upgrader->onDisable(); - } - } -} - -/** - * (Delegated) Implements hook_civicrm_upgrade(). - * - * @param $op string, the type of operation being performed; 'check' or 'enqueue' - * @param $queue CRM_Queue_Queue, (for 'enqueue') the modifiable list of pending up upgrade tasks - * - * @return mixed based on op. for 'check', returns array(boolean) (TRUE if upgrades are pending) - * for 'enqueue', returns void - * - * @link http://wiki.civicrm.org/confluence/display/CRMDOC/hook_civicrm_upgrade - */ -function _twingle_civix_civicrm_upgrade($op, CRM_Queue_Queue $queue = NULL) { - if ($upgrader = _twingle_civix_upgrader()) { - return $upgrader->onUpgrade($op, $queue); - } -} - -/** - * @return CRM_Twingle_Upgrader - */ -function _twingle_civix_upgrader() { - if (!file_exists(__DIR__ . '/CRM/Twingle/Upgrader.php')) { - return NULL; - } - else { - return CRM_Twingle_Upgrader_Base::instance(); - } -} - -/** - * Search directory tree for files which match a glob pattern - * - * Note: Dot-directories (like "..", ".git", or ".svn") will be ignored. - * Note: In Civi 4.3+, delegate to CRM_Utils_File::findFiles() - * - * @param $dir string, base dir - * @param $pattern string, glob pattern, eg "*.txt" - * @return array(string) - */ -function _twingle_civix_find_files($dir, $pattern) { - if (is_callable(array('CRM_Utils_File', 'findFiles'))) { - return CRM_Utils_File::findFiles($dir, $pattern); - } - - $todos = array($dir); - $result = array(); - while (!empty($todos)) { - $subdir = array_shift($todos); - foreach (_twingle_civix_glob("$subdir/$pattern") as $match) { - if (!is_dir($match)) { - $result[] = $match; - } - } - if ($dh = opendir($subdir)) { - while (FALSE !== ($entry = readdir($dh))) { - $path = $subdir . DIRECTORY_SEPARATOR . $entry; - if ($entry{0} == '.') { - } - elseif (is_dir($path)) { - $todos[] = $path; - } - } - closedir($dh); - } - } - return $result; -} -/** - * (Delegated) Implements hook_civicrm_managed(). - * - * Find any *.mgd.php files, merge their content, and return. - * - * @link http://wiki.civicrm.org/confluence/display/CRMDOC/hook_civicrm_managed - */ -function _twingle_civix_civicrm_managed(&$entities) { - $mgdFiles = _twingle_civix_find_files(__DIR__, '*.mgd.php'); - foreach ($mgdFiles as $file) { - $es = include $file; - foreach ($es as $e) { - if (empty($e['module'])) { - $e['module'] = E::LONG_NAME; - } - $entities[] = $e; - if (empty($e['params']['version'])) { - $e['params']['version'] = '3'; - } - } - } -} - -/** - * (Delegated) Implements hook_civicrm_caseTypes(). - * - * Find any and return any files matching "xml/case/*.xml" - * - * Note: This hook only runs in CiviCRM 4.4+. - * - * @link http://wiki.civicrm.org/confluence/display/CRMDOC/hook_civicrm_caseTypes - */ -function _twingle_civix_civicrm_caseTypes(&$caseTypes) { - if (!is_dir(__DIR__ . '/xml/case')) { - return; - } - - foreach (_twingle_civix_glob(__DIR__ . '/xml/case/*.xml') as $file) { - $name = preg_replace('/\.xml$/', '', basename($file)); - if ($name != CRM_Case_XMLProcessor::mungeCaseType($name)) { - $errorMessage = sprintf("Case-type file name is malformed (%s vs %s)", $name, CRM_Case_XMLProcessor::mungeCaseType($name)); - CRM_Core_Error::fatal($errorMessage); - // throw new CRM_Core_Exception($errorMessage); - } - $caseTypes[$name] = array( - 'module' => E::LONG_NAME, - 'name' => $name, - 'file' => $file, - ); - } -} - -/** - * (Delegated) Implements hook_civicrm_angularModules(). - * - * Find any and return any files matching "ang/*.ang.php" - * - * Note: This hook only runs in CiviCRM 4.5+. - * - * @link http://wiki.civicrm.org/confluence/display/CRMDOC/hook_civicrm_angularModules - */ -function _twingle_civix_civicrm_angularModules(&$angularModules) { - if (!is_dir(__DIR__ . '/ang')) { - return; - } - - $files = _twingle_civix_glob(__DIR__ . '/ang/*.ang.php'); - foreach ($files as $file) { - $name = preg_replace(':\.ang\.php$:', '', basename($file)); - $module = include $file; - if (empty($module['ext'])) { - $module['ext'] = E::LONG_NAME; - } - $angularModules[$name] = $module; - } -} - -/** - * Glob wrapper which is guaranteed to return an array. - * - * The documentation for glob() says, "On some systems it is impossible to - * distinguish between empty match and an error." Anecdotally, the return - * result for an empty match is sometimes array() and sometimes FALSE. - * This wrapper provides consistency. - * - * @link http://php.net/glob - * @param string $pattern - * @return array, possibly empty - */ -function _twingle_civix_glob($pattern) { - $result = glob($pattern); - return is_array($result) ? $result : array(); + // Based on , this does not currently require mixin/polyfill.php. } /** * Inserts a navigation menu item at a given place in the hierarchy. * * @param array $menu - menu hierarchy - * @param string $path - path where insertion should happen (ie. Administer/System Settings) - * @param array $item - menu you need to insert (parent/child attributes will be filled for you) + * @param string $path - path to parent of this item, e.g. 'my_extension/submenu' + * 'Mailing', or 'Administer/System Settings' + * @param array $item - the item to insert (parent/child attributes will be + * filled for you) + * + * @return bool */ function _twingle_civix_insert_navigation_menu(&$menu, $path, $item) { // If we are done going down the path, insert menu if (empty($path)) { - $menu[] = array( - 'attributes' => array_merge(array( - 'label' => CRM_Utils_Array::value('name', $item), - 'active' => 1, - ), $item), - ); + $menu[] = [ + 'attributes' => array_merge([ + 'label' => $item['name'] ?? NULL, + 'active' => 1, + ], $item), + ]; return TRUE; } else { @@ -374,9 +147,9 @@ function _twingle_civix_insert_navigation_menu(&$menu, $path, $item) { foreach ($menu as $key => &$entry) { if ($entry['attributes']['name'] == $first) { if (!isset($entry['child'])) { - $entry['child'] = array(); + $entry['child'] = []; } - $found = _twingle_civix_insert_navigation_menu($entry['child'], implode('/', $path), $item, $key); + $found = _twingle_civix_insert_navigation_menu($entry['child'], implode('/', $path), $item); } } return $found; @@ -387,7 +160,7 @@ function _twingle_civix_insert_navigation_menu(&$menu, $path, $item) { * (Delegated) Implements hook_civicrm_navigationMenu(). */ function _twingle_civix_navigationMenu(&$nodes) { - if (!is_callable(array('CRM_Core_BAO_Navigation', 'fixNavigationMenu'))) { + if (!is_callable(['CRM_Core_BAO_Navigation', 'fixNavigationMenu'])) { _twingle_civix_fixNavigationMenu($nodes); } } @@ -425,21 +198,3 @@ function _twingle_civix_fixNavigationMenuItems(&$nodes, &$maxNavID, $parentID) { } } } - -/** - * (Delegated) Implements hook_civicrm_alterSettingsFolders(). - * - * @link http://wiki.civicrm.org/confluence/display/CRMDOC/hook_civicrm_alterSettingsFolders - */ -function _twingle_civix_civicrm_alterSettingsFolders(&$metaDataFolders = NULL) { - static $configured = FALSE; - if ($configured) { - return; - } - $configured = TRUE; - - $settingsDir = __DIR__ . DIRECTORY_SEPARATOR . 'settings'; - if (is_dir($settingsDir) && !in_array($settingsDir, $metaDataFolders)) { - $metaDataFolders[] = $settingsDir; - } -} diff --git a/twingle.php b/twingle.php index c2a064e..9c20db1 100644 --- a/twingle.php +++ b/twingle.php @@ -3,6 +3,40 @@ require_once 'twingle.civix.php'; use CRM_Twingle_ExtensionUtil as E; +/** + * Implements hook_civicrm_pre(). + * + * @throws \Civi\Twingle\Shop\Exceptions\ProductException + * @throws \CRM_Core_Exception + * @throws \Civi\Twingle\Shop\Exceptions\ShopException + */ +function twingle_civicrm_pre($op, $objectName, $id, &$params) { + if ($objectName == 'ContributionRecur' && $op == 'edit') { + CRM_Twingle_Tools::checkRecurringContributionChange((int) $id, $params); + } + + // Create/delete PriceField and PriceFieldValue for TwingleProduct + elseif ($objectName == 'TwingleProduct') { + $twingle_product = new CRM_Twingle_BAO_TwingleProduct(); + $twingle_product->load($params); + if ($op == 'create' || $op == 'edit') { + $twingle_product->createPriceField(); + } + elseif ($op == 'delete') { + $twingle_product->deletePriceField(); + } + $params = $twingle_product->getAttributes(); + } + + // Create PriceSet for TwingleShop + elseif ($objectName == 'TwingleShop' && ($op == 'create' || $op == 'edit')) { + $twingle_shop = new CRM_Twingle_BAO_TwingleShop(); + $twingle_shop->load($params); + $twingle_shop->createPriceSet(); + $params = $twingle_shop->getAttributes(); + } +} + /** * Implements hook_civicrm_config(). * @@ -12,15 +46,6 @@ function twingle_civicrm_config(&$config) { _twingle_civix_civicrm_config($config); } -/** - * Implements hook_civicrm_xmlMenu(). - * - * @link http://wiki.civicrm.org/confluence/display/CRMDOC/hook_civicrm_xmlMenu - */ -function twingle_civicrm_xmlMenu(&$files) { - _twingle_civix_civicrm_xmlMenu($files); -} - /** * Implements hook_civicrm_install(). * @@ -30,24 +55,6 @@ function twingle_civicrm_install() { _twingle_civix_civicrm_install(); } -/** - * Implements hook_civicrm_postInstall(). - * - * @link http://wiki.civicrm.org/confluence/display/CRMDOC/hook_civicrm_postInstall - */ -function twingle_civicrm_postInstall() { - _twingle_civix_civicrm_postInstall(); -} - -/** - * Implements hook_civicrm_uninstall(). - * - * @link http://wiki.civicrm.org/confluence/display/CRMDOC/hook_civicrm_uninstall - */ -function twingle_civicrm_uninstall() { - _twingle_civix_civicrm_uninstall(); -} - /** * Implements hook_civicrm_enable(). * @@ -57,79 +64,16 @@ function twingle_civicrm_enable() { _twingle_civix_civicrm_enable(); } -/** - * Implements hook_civicrm_disable(). - * - * @link http://wiki.civicrm.org/confluence/display/CRMDOC/hook_civicrm_disable - */ -function twingle_civicrm_disable() { - _twingle_civix_civicrm_disable(); -} - -/** - * Implements hook_civicrm_upgrade(). - * - * @link http://wiki.civicrm.org/confluence/display/CRMDOC/hook_civicrm_upgrade - */ -function twingle_civicrm_upgrade($op, CRM_Queue_Queue $queue = NULL) { - return _twingle_civix_civicrm_upgrade($op, $queue); -} - -/** - * Implements hook_civicrm_managed(). - * - * Generate a list of entities to create/deactivate/delete when this module - * is installed, disabled, uninstalled. - * - * @link http://wiki.civicrm.org/confluence/display/CRMDOC/hook_civicrm_managed - */ -function twingle_civicrm_managed(&$entities) { - _twingle_civix_civicrm_managed($entities); -} - -/** - * Implements hook_civicrm_caseTypes(). - * - * Generate a list of case-types. - * - * Note: This hook only runs in CiviCRM 4.4+. - * - * @link http://wiki.civicrm.org/confluence/display/CRMDOC/hook_civicrm_caseTypes - */ -function twingle_civicrm_caseTypes(&$caseTypes) { - _twingle_civix_civicrm_caseTypes($caseTypes); -} - -/** - * Implements hook_civicrm_angularModules(). - * - * Generate a list of Angular modules. - * - * Note: This hook only runs in CiviCRM 4.5+. It may - * use features only available in v4.6+. - * - * @link http://wiki.civicrm.org/confluence/display/CRMDOC/hook_civicrm_angularModules - */ -function twingle_civicrm_angularModules(&$angularModules) { - _twingle_civix_civicrm_angularModules($angularModules); -} - -/** - * Implements hook_civicrm_alterSettingsFolders(). - * - * @link http://wiki.civicrm.org/confluence/display/CRMDOC/hook_civicrm_alterSettingsFolders - */ -function twingle_civicrm_alterSettingsFolders(&$metaDataFolders = NULL) { - _twingle_civix_civicrm_alterSettingsFolders($metaDataFolders); -} - /** * Implements hook_civicrm_permission(). * * @link http://wiki.civicrm.org/confluence/display/CRMDOC/hook_civicrm_permission */ function twingle_civicrm_permission(&$permissions) { - $permissions['access Twingle API'] = 'Twingle API: Access Twingle API'; + $permissions['access Twingle API'] = [ + 'label' => E::ts('Twingle API: Access Twingle API'), + 'description' => E::ts('Allows access to the Twingle API actions.'), + ]; } /** @@ -144,6 +88,18 @@ function twingle_civicrm_alterAPIPermissions($entity, $action, &$params, &$permi $permissions['twingle_donation']['endrecurring'] = array('access Twingle API'); } +/** + * Make sure, that the last_access and access_counter column is not logged + * + * @param array $logTableSpec + */ +function twingle_civicrm_alterLogTables(&$logTableSpec) +{ + if (isset($logTableSpec['civicrm_twingle_profile'])) { + $logTableSpec['civicrm_twingle_profile']['exceptions'] = ['last_access', 'access_counter']; + } +} + // --- Functions below this ship commented out. Uncomment as required. --- /** @@ -151,9 +107,8 @@ function twingle_civicrm_alterAPIPermissions($entity, $action, &$params, &$permi * * @link http://wiki.civicrm.org/confluence/display/CRMDOC/hook_civicrm_preProcess * -function twingle_civicrm_preProcess($formName, &$form) { -} // */ + // */ /** * Implements hook_civicrm_navigationMenu(). diff --git a/xml/Menu/twingle.xml b/xml/Menu/twingle.xml index 80529df..f1bc0a9 100644 --- a/xml/Menu/twingle.xml +++ b/xml/Menu/twingle.xml @@ -6,7 +6,7 @@ Twingle API Configuration administer CiviCRM Configure the Twingle API extension - System Settings + CiviContribute admin/option.png diff --git a/xml/schema/CRM/Twingle/TwingleProduct.entityType.php b/xml/schema/CRM/Twingle/TwingleProduct.entityType.php new file mode 100644 index 0000000..153d50b --- /dev/null +++ b/xml/schema/CRM/Twingle/TwingleProduct.entityType.php @@ -0,0 +1,10 @@ + 'TwingleProduct', + 'class' => 'CRM_Twingle_DAO_TwingleProduct', + 'table' => 'civicrm_twingle_product', + ], +]; diff --git a/xml/schema/CRM/Twingle/TwingleProduct.xml b/xml/schema/CRM/Twingle/TwingleProduct.xml new file mode 100644 index 0000000..4b6e48a --- /dev/null +++ b/xml/schema/CRM/Twingle/TwingleProduct.xml @@ -0,0 +1,75 @@ + + + + CRM/Twingle + TwingleProduct + civicrm_twingle_product + This table contains the Twingle Product data. + false + + + + id + int unsigned + true + true + Unique TwingleProduct ID + + Number + + + + id + true + + + + external_id + int unsigned + true + The ID of this product in the Twingle database + + Number + + + + + price_field_id + int unsigned + FK to Price Field + true + + + price_field_id +
civicrm_contact
+ id + CASCADE + + + + twingle_shop_id + int unsigned + true + FK to Twingle Shop + + + twingle_shop_id + civicrm_twingle_shop
+ id + CASCADE + + + + created_at + datetime + true + Timestamp of when the product was created in the database + + + + updated_at + datetime + true + Timestamp of when the product was last updated in the database + + diff --git a/xml/schema/CRM/Twingle/TwingleShop.entityType.php b/xml/schema/CRM/Twingle/TwingleShop.entityType.php new file mode 100644 index 0000000..5fe53ea --- /dev/null +++ b/xml/schema/CRM/Twingle/TwingleShop.entityType.php @@ -0,0 +1,10 @@ + 'TwingleShop', + 'class' => 'CRM_Twingle_DAO_TwingleShop', + 'table' => 'civicrm_twingle_shop', + ], +]; diff --git a/xml/schema/CRM/Twingle/TwingleShop.xml b/xml/schema/CRM/Twingle/TwingleShop.xml new file mode 100644 index 0000000..5b45a77 --- /dev/null +++ b/xml/schema/CRM/Twingle/TwingleShop.xml @@ -0,0 +1,73 @@ + + + + CRM/Twingle + TwingleShop + civicrm_twingle_shop + This table contains the Twingle Shop data. Each Twingle Shop is linked to a corresponding Price Set. + false + + + + id + int unsigned + true + true + Unique TwingleShop ID + + Number + + + + id + true + + + + project_identifier + varchar + 32 + true + true + Twingle Project Identifier + + Text + + + + + numerical_project_id + int unsigned + true + true + Numerical Twingle Project Identifier + + Number + + + + + price_set_id + int unsigned + true + FK to Price Set + + + price_set_id +
civicrm_price_set
+ id + CASCADE + + + + name + varchar + false + 64 + true + name of the shop + + Text + + +