From a1e3a9b7c30abf4a77cbd4d970d43fcf40ccce75 Mon Sep 17 00:00:00 2001
From: Jaap Jansma <jaap.jansma@civicoop.org>
Date: Fri, 9 Aug 2019 11:56:35 +0200
Subject: [PATCH] Added simple calcuation fields
---
CHANGELOG.md | 1 +
Civi/DataProcessor/Factory.php | 3 +-
.../CalculationFieldOutputHandler.php | 235 ++++++++++++++++++
.../SubtractFieldOutputHandler.php | 32 +++
.../Calculations/TotalFieldOutputHandler.php | 25 ++
.../CalculationFieldOutputHandler.tpl | 35 +++
6 files changed, 330 insertions(+), 1 deletion(-)
create mode 100644 Civi/DataProcessor/FieldOutputHandler/Calculations/CalculationFieldOutputHandler.php
create mode 100644 Civi/DataProcessor/FieldOutputHandler/Calculations/SubtractFieldOutputHandler.php
create mode 100644 Civi/DataProcessor/FieldOutputHandler/Calculations/TotalFieldOutputHandler.php
create mode 100644 templates/CRM/Dataprocessor/Form/Field/Configuration/CalculationFieldOutputHandler.tpl
diff --git a/CHANGELOG.md b/CHANGELOG.md
index 55cece34..72e42c8f 100644
--- a/CHANGELOG.md
+++ b/CHANGELOG.md
@@ -4,6 +4,7 @@
* Allow to specify "Is Empty" for various filters.
* Allow to limit ContactFilter to only show contacts from specific groups.
* it is now also possible to output a data processor on CiviCRMs dahsboard.
+* Added field outputs for simple calculations (substract and total).
# Version 1.0.2
diff --git a/Civi/DataProcessor/Factory.php b/Civi/DataProcessor/Factory.php
index 0735aaae..d7a7eb54 100644
--- a/Civi/DataProcessor/Factory.php
+++ b/Civi/DataProcessor/Factory.php
@@ -140,7 +140,8 @@ class Factory {
$this->addOutputHandler('groups_of_contact', 'Civi\DataProcessor\FieldOutputHandler\GroupsOfContactFieldOutputHandler', E::ts('Display the groups of a contact'));
$this->addOutputHandler('event_repeating_info', 'Civi\DataProcessor\FieldOutputHandler\EventRepeatingInfoFieldOutputHandler', E::ts('Display info about repeating event'));
$this->addOutputHandler('event_participants', 'Civi\DataProcessor\FieldOutputHandler\EventParticipantsFieldOutputHandler', E::ts('List participants'));
-
+ $this->addOutputHandler('calculations_substract', 'Civi\DataProcessor\FieldOutputHandler\Calculations\SubtractFieldOutputHandler', E::ts('Calculation: Subtract'));
+ $this->addOutputHandler('calculations_total', 'Civi\DataProcessor\FieldOutputHandler\Calculations\TotalFieldOutputHandler', E::ts('Calculation: Total'));
}
/**
diff --git a/Civi/DataProcessor/FieldOutputHandler/Calculations/CalculationFieldOutputHandler.php b/Civi/DataProcessor/FieldOutputHandler/Calculations/CalculationFieldOutputHandler.php
new file mode 100644
index 00000000..48e20265
--- /dev/null
+++ b/Civi/DataProcessor/FieldOutputHandler/Calculations/CalculationFieldOutputHandler.php
@@ -0,0 +1,235 @@
+<?php
+/**
+ * @author Jaap Jansma <jaap.jansma@civicoop.org>
+ * @license AGPL-3.0
+ */
+
+namespace Civi\DataProcessor\FieldOutputHandler\Calculations;
+
+use Civi\DataProcessor\DataSpecification\FieldSpecification;
+use Civi\DataProcessor\FieldOutputHandler\AbstractFieldOutputHandler;
+
+use Civi\DataProcessor\FieldOutputHandler\FieldOutput;
+use CRM_Dataprocessor_ExtensionUtil as E;
+
+abstract class CalculationFieldOutputHandler extends AbstractFieldOutputHandler {
+
+ /**
+ * @var \Civi\DataProcessor\DataSpecification\FieldSpecification
+ */
+ protected $outputFieldSpec;
+
+ /**
+ * @var \Civi\DataProcessor\DataSpecification\FieldSpecification[]
+ */
+ protected $inputFieldSpecs = array();
+
+ protected $prefix = '';
+
+ protected $suffix = '';
+
+ protected $number_of_decimals = '';
+
+ protected $decimal_sep = '';
+
+ protected $thousand_sep = '';
+
+ /**
+ * @param array $values
+ * @return int|float
+ */
+ abstract protected function doCalculation($values);
+
+ /**
+ * @return \Civi\DataProcessor\DataSpecification\FieldSpecification
+ */
+ public function getOutputFieldSpecification() {
+ return $this->outputFieldSpec;
+ }
+
+ /**
+ * Returns the data type of this field
+ *
+ * @return String
+ */
+ protected function getType() {
+ return 'Float';
+ }
+
+ /**
+ * Initialize the processor
+ *
+ * @param String $alias
+ * @param String $title
+ * @param array $configuration
+ * @param \Civi\DataProcessor\ProcessorType\AbstractProcessorType $processorType
+ */
+ public function initialize($alias, $title, $configuration) {
+ foreach($configuration['fields'] as $fieldAndDataSource) {
+ list($datasourceName, $field) = explode('::', $fieldAndDataSource, 2);
+ $dataSource = $this->dataProcessor->getDataSourceByName($datasourceName);
+ if (!$dataSource) {
+ throw new DataSourceNotFoundException(E::ts("Field %1 requires data source '%2' which could not be found. Did you rename or deleted the data source?", array(1=>$title, 2=>$datasourceName)));
+ }
+ $inputFieldSpec = $dataSource->getAvailableFields()
+ ->getFieldSpecificationByName($field);
+ if (!$inputFieldSpec) {
+ throw new FieldNotFoundException(E::ts("Field %1 requires a field with the name '%2' in the data source '%3'. Did you change the data source type?", [
+ 1 => $title,
+ 2 => $field,
+ 3 => $datasourceName
+ ]));
+ }
+ $dataSource->ensureFieldInSource($inputFieldSpec);
+ $this->inputFieldSpecs[] = $inputFieldSpec;
+ }
+
+ $this->outputFieldSpec = new FieldSpecification($alias, 'Float', $title, null, $alias);
+
+ if (isset($configuration['number_of_decimals'])) {
+ $this->number_of_decimals = $configuration['number_of_decimals'];
+ }
+ if (isset($configuration['decimal_separator'])) {
+ $this->decimal_sep = $configuration['decimal_separator'];
+ }
+ if (isset($configuration['thousand_separator'])) {
+ $this->thousand_sep = $configuration['thousand_separator'];
+ }
+ if (isset($configuration['prefix'])) {
+ $this->prefix = $configuration['prefix'];
+ }
+ if (isset($configuration['suffix'])) {
+ $this->suffix = $configuration['suffix'];
+ }
+ }
+
+ /**
+ * Returns true when this handler has additional configuration.
+ *
+ * @return bool
+ */
+ public function hasConfiguration() {
+ return true;
+ }
+
+ /**
+ * When this handler has additional configuration you can add
+ * the fields on the form with this function.
+ *
+ * @param \CRM_Core_Form $form
+ * @param array $field
+ */
+ public function buildConfigurationForm(\CRM_Core_Form $form, $field=array()) {
+ $fieldSelect = $this->getFieldOptions($field['data_processor_id']);
+
+ $form->add('select', 'fields', E::ts('Fields'), $fieldSelect, true, array(
+ 'style' => 'min-width:250px',
+ 'class' => 'crm-select2 huge data-processor-field-for-name',
+ 'placeholder' => E::ts('- select -'),
+ 'multiple' => true,
+ ));
+ $form->add('text', 'number_of_decimals', E::ts('Number of decimals'), false);
+ $form->add('text', 'decimal_separator', E::ts('Decimal separator'), false);
+ $form->add('text', 'thousand_separator', E::ts('Thousand separator'), false);
+ $form->add('text', 'prefix', E::ts('Prefix (e.g. €)'), false);
+ $form->add('text', 'suffix', E::ts('Suffix (e.g. $)'), false);
+ if (isset($field['configuration'])) {
+ $configuration = $field['configuration'];
+ $defaults = array();
+ if (isset($configuration['fields'])) {
+ $defaults['fields'] = $configuration['fields'];
+ }
+ if (isset($configuration['number_of_decimals'])) {
+ $defaults['number_of_decimals'] = $configuration['number_of_decimals'];
+ }
+ if (isset($configuration['decimal_separator'])) {
+ $defaults['decimal_separator'] = $configuration['decimal_separator'];
+ }
+ if (isset($configuration['thousand_separator'])) {
+ $defaults['thousand_separator'] = $configuration['thousand_separator'];
+ }
+ if (isset($configuration['prefix'])) {
+ $defaults['prefix'] = $configuration['prefix'];
+ }
+ if (isset($configuration['suffix'])) {
+ $defaults['suffix'] = $configuration['suffix'];
+ }
+ $form->setDefaults($defaults);
+ }
+ }
+
+ /**
+ * When this handler has configuration specify the template file name
+ * for the configuration form.
+ *
+ * @return false|string
+ */
+ public function getConfigurationTemplateFileName() {
+ return "CRM/Dataprocessor/Form/Field/Configuration/CalculationFieldOutputHandler.tpl";
+ }
+
+
+ /**
+ * Process the submitted values and create a configuration array
+ *
+ * @param $submittedValues
+ * @return array
+ */
+ public function processConfiguration($submittedValues) {
+ $configuration['fields'] = $submittedValues['fields'];
+ $configuration['number_of_decimals'] = $submittedValues['number_of_decimals'];
+ $configuration['decimal_separator'] = $submittedValues['decimal_separator'];
+ $configuration['thousand_separator'] = $submittedValues['thousand_separator'];
+ $configuration['prefix'] = $submittedValues['prefix'];
+ $configuration['suffix'] = $submittedValues['suffix'];
+ return $configuration;
+ }
+
+ /**
+ * Returns all possible fields
+ *
+ * @param $data_processor_id
+ *
+ * @return array
+ * @throws \Exception
+ */
+ protected function getFieldOptions($data_processor_id) {
+ $fieldSelect = \CRM_Dataprocessor_Utils_DataSourceFields::getAvailableFieldsInDataSources($data_processor_id, array($this, 'isFieldValid'));
+ return $fieldSelect;
+ }
+
+ /**
+ * Callback function for determining whether this field could be handled by this output handler.
+ *
+ * @param \Civi\DataProcessor\DataSpecification\FieldSpecification $field
+ * @return bool
+ */
+ public function isFieldValid(FieldSpecification $field) {
+ return true;
+ }
+
+ /**
+ * Returns the formatted value
+ *
+ * @param $rawRecord
+ * @param $formattedRecord
+ *
+ * @return \Civi\DataProcessor\FieldOutputHandler\FieldOutput
+ */
+ public function formatField($rawRecord, $formattedRecord) {
+ $values = array();
+ foreach($this->inputFieldSpecs as $inputFieldSpec) {
+ $values[] = $rawRecord[$inputFieldSpec->alias];
+ }
+ $value = $this->doCalculation($values);
+ $formattedValue = $value;
+ if (is_numeric($this->number_of_decimals)) {
+ $formattedValue = number_format($value, $this->number_of_decimals, $this->decimal_sep, $this->thousand_sep);
+ }
+ $formattedValue = $this->prefix.$formattedValue.$this->suffix;
+ $output = new FieldOutput($value);
+ $output->formattedValue = $formattedValue;
+ return $output;
+ }
+
+}
\ No newline at end of file
diff --git a/Civi/DataProcessor/FieldOutputHandler/Calculations/SubtractFieldOutputHandler.php b/Civi/DataProcessor/FieldOutputHandler/Calculations/SubtractFieldOutputHandler.php
new file mode 100644
index 00000000..a7f81410
--- /dev/null
+++ b/Civi/DataProcessor/FieldOutputHandler/Calculations/SubtractFieldOutputHandler.php
@@ -0,0 +1,32 @@
+<?php
+/**
+ * @author Jaap Jansma <jaap.jansma@civicoop.org>
+ * @license AGPL-3.0
+ */
+
+namespace Civi\DataProcessor\FieldOutputHandler\Calculations;
+
+use Civi\Api4\Phone;
+use Civi\DataProcessor\FieldOutputHandler\FieldOutput;
+
+class SubtractFieldOutputHandler extends CalculationFieldOutputHandler {
+
+ /**
+ * @param array $values
+ * @return int|float
+ */
+ protected function doCalculation($values) {
+ $value = 0;
+ $i =0;
+ foreach($values as $v) {
+ if ($i == 0) {
+ $value = $v;
+ } else {
+ $value = $value - $v;
+ }
+ $i++;
+ }
+ return $value;
+ }
+
+}
\ No newline at end of file
diff --git a/Civi/DataProcessor/FieldOutputHandler/Calculations/TotalFieldOutputHandler.php b/Civi/DataProcessor/FieldOutputHandler/Calculations/TotalFieldOutputHandler.php
new file mode 100644
index 00000000..8548376e
--- /dev/null
+++ b/Civi/DataProcessor/FieldOutputHandler/Calculations/TotalFieldOutputHandler.php
@@ -0,0 +1,25 @@
+<?php
+/**
+ * @author Jaap Jansma <jaap.jansma@civicoop.org>
+ * @license AGPL-3.0
+ */
+
+namespace Civi\DataProcessor\FieldOutputHandler\Calculations;
+
+use Civi\DataProcessor\FieldOutputHandler\FieldOutput;
+
+class TotalFieldOutputHandler extends CalculationFieldOutputHandler {
+
+ /**
+ * @param array $values
+ * @return int|float
+ */
+ protected function doCalculation($values) {
+ $value = 0;
+ foreach($values as $v) {
+ $value = $value + $v;
+ }
+ return $value;
+ }
+
+}
\ No newline at end of file
diff --git a/templates/CRM/Dataprocessor/Form/Field/Configuration/CalculationFieldOutputHandler.tpl b/templates/CRM/Dataprocessor/Form/Field/Configuration/CalculationFieldOutputHandler.tpl
new file mode 100644
index 00000000..c642c482
--- /dev/null
+++ b/templates/CRM/Dataprocessor/Form/Field/Configuration/CalculationFieldOutputHandler.tpl
@@ -0,0 +1,35 @@
+{crmScope extensionKey='dataprocessor'}
+ <div class="crm-section">
+ <div class="label">{$form.fields.label}</div>
+ <div class="content">{$form.fields.html}</div>
+ <div class="clear"></div>
+ </div>
+
+ <div class="crm-section">
+ <div class="label">{$form.number_of_decimals.label}</div>
+ <div class="content">{$form.number_of_decimals.html}
+ <p class="description">{ts}Leave empty for no formatting{/ts}</p>
+ </div>
+ <div class="clear"></div>
+ </div>
+ <div class="crm-section">
+ <div class="label">{$form.decimal_separator.label}</div>
+ <div class="content">{$form.decimal_separator.html}</div>
+ <div class="clear"></div>
+ </div>
+ <div class="crm-section">
+ <div class="label">{$form.thousand_separator.label}</div>
+ <div class="content">{$form.thousand_separator.html}</div>
+ <div class="clear"></div>
+ </div>
+ <div class="crm-section">
+ <div class="label">{$form.prefix.label}</div>
+ <div class="content">{$form.prefix.html}</div>
+ <div class="clear"></div>
+ </div>
+ <div class="crm-section">
+ <div class="label">{$form.suffix.label}</div>
+ <div class="content">{$form.suffix.html}</div>
+ <div class="clear"></div>
+ </div>
+{/crmScope}
\ No newline at end of file
--
GitLab