From cc851e64514f367d22c571f621586b66776293e9 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Patrick=20M=C3=BCller?= <p.mueller@pcsg.de>
Date: Tue, 28 Sep 2021 10:33:53 +0200
Subject: [PATCH] feat: invoice processing status 'preventInvoicePosting'
option and general options API
---
ajax/processingStatus/create.php | 17 +--
ajax/processingStatus/update.php | 17 +--
bin/backend/classes/Invoices.js | 19 +++
bin/backend/classes/ProcessingStatus.js | 12 +-
.../controls/settings/ProcessingStatus.html | 27 +++-
.../controls/settings/ProcessingStatus.js | 56 +++++++--
locale.xml | 29 +++++
.../ERP/Accounting/Invoice/EventHandler.php | 4 +
src/QUI/ERP/Accounting/Invoice/Invoice.php | 115 +++++++++++++++++-
.../Invoice/ProcessingStatus/Factory.php | 9 +-
.../Invoice/ProcessingStatus/Handler.php | 19 ++-
.../Invoice/ProcessingStatus/Status.php | 75 +++++++++++-
.../Accounting/Invoice/RestApi/Provider.php | 64 +++++++++-
.../ERP/Accounting/Invoice/Utils/Invoice.php | 23 +++-
14 files changed, 435 insertions(+), 51 deletions(-)
diff --git a/ajax/processingStatus/create.php b/ajax/processingStatus/create.php
index 8438caa..0ecb3b3 100644
--- a/ajax/processingStatus/create.php
+++ b/ajax/processingStatus/create.php
@@ -1,9 +1,5 @@
<?php
-/**
- * This file contains package_quiqqer_invoice_ajax_processingStatus_create
- */
-
use QUI\ERP\Accounting\Invoice\ProcessingStatus\Factory;
/**
@@ -11,13 +7,20 @@
*/
QUI::$Ajax->registerFunction(
'package_quiqqer_invoice_ajax_processingStatus_create',
- function ($id, $color, $title) {
+ function ($id, $color, $title, $options) {
+ if (!empty($options)) {
+ $options = \json_decode($options, true);
+ } else {
+ $options = [];
+ }
+
Factory::getInstance()->createProcessingStatus(
$id,
$color,
- \json_decode($title, true)
+ \json_decode($title, true),
+ $options
);
},
- array('id', 'color', 'title'),
+ ['id', 'color', 'title', 'options'],
'Permission::checkAdminUser'
);
diff --git a/ajax/processingStatus/update.php b/ajax/processingStatus/update.php
index 9542cb5..83ae11b 100644
--- a/ajax/processingStatus/update.php
+++ b/ajax/processingStatus/update.php
@@ -1,9 +1,5 @@
<?php
-/**
- * This file contains package_quiqqer_invoice_ajax_processingStatus_update
- */
-
use QUI\ERP\Accounting\Invoice\ProcessingStatus\Handler;
/**
@@ -11,13 +7,20 @@
*/
QUI::$Ajax->registerFunction(
'package_quiqqer_invoice_ajax_processingStatus_update',
- function ($id, $color, $title) {
+ function ($id, $color, $title, $options) {
+ if (!empty($options)) {
+ $options = \json_decode($options, true);
+ } else {
+ $options = [];
+ }
+
Handler::getInstance()->updateProcessingStatus(
$id,
$color,
- \json_decode($title, true)
+ \json_decode($title, true),
+ $options
);
},
- ['id', 'color', 'title'],
+ ['id', 'color', 'title', 'options'],
'Permission::checkAdminUser'
);
diff --git a/bin/backend/classes/Invoices.js b/bin/backend/classes/Invoices.js
index 8804a97..22eddc1 100644
--- a/bin/backend/classes/Invoices.js
+++ b/bin/backend/classes/Invoices.js
@@ -600,6 +600,25 @@ define('package/quiqqer/invoice/bin/backend/classes/Invoices', [
showError: false
});
});
+ },
+
+ /**
+ * Set invoice customer files
+ *
+ * @param {Number} invoiceId
+ * @param {String} customerFiles (JSON)
+ * @return {Promise}
+ */
+ setCustomerFiles: function (invoiceId, customerFiles) {
+ return new Promise(function (resolve, reject) {
+ QUIAjax.post('package_quiqqer_invoice_ajax_invoices_setCustomerFiles', resolve, {
+ 'package' : 'quiqqer/invoice',
+ invoiceId : invoiceId,
+ customerFiles: customerFiles,
+ onError : reject,
+ showError : false
+ });
+ });
}
});
});
diff --git a/bin/backend/classes/ProcessingStatus.js b/bin/backend/classes/ProcessingStatus.js
index ff49fca..a05e27c 100644
--- a/bin/backend/classes/ProcessingStatus.js
+++ b/bin/backend/classes/ProcessingStatus.js
@@ -54,9 +54,12 @@ define('package/quiqqer/invoice/bin/backend/classes/ProcessingStatus', [
* @param {String|Number} id - Processing Status ID
* @param {String} color
* @param {Object} title - {de: '', en: ''}
+ * @param {Object} [Options]
* @return {Promise}
*/
- createProcessingStatus: function (id, color, title) {
+ createProcessingStatus: function (id, color, title, Options) {
+ Options = Options || {};
+
return new Promise(function (resolve, reject) {
QUIAjax.post('package_quiqqer_invoice_ajax_processingStatus_create', function (result) {
require([
@@ -71,6 +74,7 @@ define('package/quiqqer/invoice/bin/backend/classes/ProcessingStatus', [
id : id,
color : color,
title : JSON.encode(title),
+ options : JSON.encode(Options),
onError : reject
});
});
@@ -122,15 +126,19 @@ define('package/quiqqer/invoice/bin/backend/classes/ProcessingStatus', [
* @param {String|Number} id - Processing Status ID
* @param {String} color
* @param {Object} title - {de: '', en: ''}
+ * @param {Object} [Options]
* @return {Promise}
*/
- updateProcessingStatus: function (id, color, title) {
+ updateProcessingStatus: function (id, color, title, Options) {
+ Options = Options || {};
+
return new Promise(function (resolve, reject) {
QUIAjax.post('package_quiqqer_invoice_ajax_processingStatus_update', resolve, {
'package': 'quiqqer/invoice',
id : id,
color : color,
title : JSON.encode(title),
+ options : JSON.encode(Options),
onError : reject
});
});
diff --git a/bin/backend/controls/settings/ProcessingStatus.html b/bin/backend/controls/settings/ProcessingStatus.html
index 6c9a296..9980557 100644
--- a/bin/backend/controls/settings/ProcessingStatus.html
+++ b/bin/backend/controls/settings/ProcessingStatus.html
@@ -4,8 +4,8 @@
<tr>
<td>
<label class="field-container">
- <span class="field-container-item" title="">
- Title
+ <span class="field-container-item" title="{{labelTitle}}">
+ {{labelTitle}}
</span>
<input name="title" data-qui="controls/lang/InputMultiLang"/>
</label>
@@ -14,8 +14,8 @@
<tr>
<td>
<label class="field-container">
- <span class="field-container-item" title="">
- Status Nr.
+ <span class="field-container-item" title="{{labelId}}">
+ {{labelId}}
</span>
<input type="number" name="id" min="0" class="field-container-field"/>
</label>
@@ -24,13 +24,28 @@
<tr>
<td>
<label class="field-container">
- <span class="field-container-item" title="">
- Farbe
+ <span class="field-container-item" title="{{labelColor}}">
+ {{labelColor}}
</span>
<input type="color" name="color" class="field-container-field"/>
</label>
</td>
</tr>
+ <tr>
+ <td>
+ <label class="field-container">
+ <span class="field-container-item" title="">
+ {{labelPreventInvoicePosting}}
+ </span>
+ <span class="field-container-field">
+ <input type="checkbox" name="preventInvoicePosting"/>
+ </span>
+ </label>
+ <div class="field-container-item-desc">
+ {{{descPreventInvoicePosting}}}
+ </div>
+ </td>
+ </tr>
</tbody>
</table>
</form>
\ No newline at end of file
diff --git a/bin/backend/controls/settings/ProcessingStatus.js b/bin/backend/controls/settings/ProcessingStatus.js
index cac29b3..00faee2 100644
--- a/bin/backend/controls/settings/ProcessingStatus.js
+++ b/bin/backend/controls/settings/ProcessingStatus.js
@@ -56,13 +56,19 @@ define('package/quiqqer/invoice/bin/backend/controls/settings/ProcessingStatus',
ProcessingStatus.getList().then(function (result) {
for (var i = 0, len = result.data.length; i < len; i++) {
- result.data[i].colorNode = new Element('span', {
- html : result.data[i].color,
+ const Status = result.data[i];
+
+ Status.colorNode = new Element('span', {
+ html : Status.color,
'class': 'quiqqer-invoice-processing-status-color',
styles : {
- backgroundColor: result.data[i].color
+ backgroundColor: Status.color
}
});
+
+ Status.preventInvoicePosting = new Element('span', {
+ 'class': Status.options.preventInvoicePosting ? 'fa fa-check' : 'fa fa-close'
+ });
}
self.$Grid.setData(result);
@@ -141,6 +147,11 @@ define('package/quiqqer/invoice/bin/backend/controls/settings/ProcessingStatus',
dataIndex: 'title',
dataType : 'integer',
width : 200
+ }, {
+ header : QUILocale.get(lg, 'processingStatus.grid.preventInvoicePosting'),
+ dataIndex: 'preventInvoicePosting',
+ dataType : 'node',
+ width : 120
}]
});
@@ -189,7 +200,7 @@ define('package/quiqqer/invoice/bin/backend/controls/settings/ProcessingStatus',
new QUIConfirm({
icon : 'fa fa-plus',
title : QUILocale.get(lg, 'dialog.processingStatus.create.title'),
- maxHeight: 400,
+ maxHeight: 500,
maxWidth : 600,
autoclose: false,
events : {
@@ -199,7 +210,14 @@ define('package/quiqqer/invoice/bin/backend/controls/settings/ProcessingStatus',
Win.Loader.show();
Content.addClass('quiqqer-invoice-processing-status-window');
- Content.set('html', Mustache.render(template));
+
+ Content.set('html', Mustache.render(template, {
+ labelTitle : QUILocale.get(lg, 'processingStatus.tpl.labelTitle'),
+ labelId : QUILocale.get(lg, 'processingStatus.tpl.labelId'),
+ labelColor : QUILocale.get(lg, 'processingStatus.tpl.labelColor'),
+ labelPreventInvoicePosting: QUILocale.get(lg, 'processingStatus.tpl.labelPreventInvoicePosting'),
+ descPreventInvoicePosting : QUILocale.get(lg, 'processingStatus.tpl.descPreventInvoicePosting')
+ }));
var Form = Content.getElement('form');
@@ -229,10 +247,16 @@ define('package/quiqqer/invoice/bin/backend/controls/settings/ProcessingStatus',
} catch (e) {
}
+ // Options
+ const Options = {
+ preventInvoicePosting: data.preventInvoicePosting
+ };
+
ProcessingStatus.createProcessingStatus(
data.id,
data.color,
- title
+ title,
+ Options
).then(function () {
return Win.close();
}).then(function () {
@@ -264,7 +288,7 @@ define('package/quiqqer/invoice/bin/backend/controls/settings/ProcessingStatus',
new QUIConfirm({
icon : 'fa fa-edit',
title : QUILocale.get(lg, 'dialog.processingStatus.edit.title'),
- maxHeight: 400,
+ maxHeight: 500,
maxWidth : 600,
autoclose: false,
ok_button: {
@@ -278,7 +302,13 @@ define('package/quiqqer/invoice/bin/backend/controls/settings/ProcessingStatus',
Win.Loader.show();
Content.addClass('quiqqer-invoice-processing-status-window');
- Content.set('html', Mustache.render(template));
+ Content.set('html', Mustache.render(template, {
+ labelTitle : QUILocale.get(lg, 'processingStatus.tpl.labelTitle'),
+ labelId : QUILocale.get(lg, 'processingStatus.tpl.labelId'),
+ labelColor : QUILocale.get(lg, 'processingStatus.tpl.labelColor'),
+ labelPreventInvoicePosting: QUILocale.get(lg, 'processingStatus.tpl.labelPreventInvoicePosting'),
+ descPreventInvoicePosting : QUILocale.get(lg, 'processingStatus.tpl.descPreventInvoicePosting')
+ }));
var Form = Content.getElement('form');
@@ -287,6 +317,9 @@ define('package/quiqqer/invoice/bin/backend/controls/settings/ProcessingStatus',
Form.elements.color.value = details.color;
Form.elements.title.value = JSON.encode(details.title);
+ // Options
+ Form.elements.preventInvoicePosting.checked = details.options.preventInvoicePosting;
+
return QUI.parse(Content);
}).then(function () {
Win.Loader.hide();
@@ -310,11 +343,16 @@ define('package/quiqqer/invoice/bin/backend/controls/settings/ProcessingStatus',
} catch (e) {
}
+ // Options
+ const Options = {
+ preventInvoicePosting: data.preventInvoicePosting
+ };
ProcessingStatus.updateProcessingStatus(
data.id,
data.color,
- title
+ title,
+ Options
).then(function () {
return Win.close();
}).then(function () {
diff --git a/locale.xml b/locale.xml
index f0aa9e9..7726048 100644
--- a/locale.xml
+++ b/locale.xml
@@ -1225,6 +1225,10 @@
<de><![CDATA[Farbe]]></de>
<en><![CDATA[Color]]></en>
</locale>
+ <locale name="processingStatus.grid.preventInvoicePosting">
+ <de><![CDATA[verhindert Buchung]]></de>
+ <en><![CDATA[prevents posting]]></en>
+ </locale>
<locale name="dialog.processingStatus.delete.title">
<de><![CDATA[Rechnungsstatus entfernen]]></de>
@@ -1248,6 +1252,26 @@
The invoice status is not recoverable.
]]></en>
</locale>
+ <locale name="processingStatus.tpl.labelTitle">
+ <de><![CDATA[Titel]]></de>
+ <en><![CDATA[Title]]></en>
+ </locale>
+ <locale name="processingStatus.tpl.labelId">
+ <de><![CDATA[Status-Nr.]]></de>
+ <en><![CDATA[Status no.]]></en>
+ </locale>
+ <locale name="processingStatus.tpl.labelColor">
+ <de><![CDATA[Farbe]]></de>
+ <en><![CDATA[Color]]></en>
+ </locale>
+ <locale name="processingStatus.tpl.labelPreventInvoicePosting">
+ <de><![CDATA[Buchen von Rechnungsentwürfen verhindern]]></de>
+ <en><![CDATA[Prevents posting of invoice drafts]]></en>
+ </locale>
+ <locale name="processingStatus.tpl.descPreventInvoicePosting">
+ <de><![CDATA[Rechnungsentwürfe mit diesem Status können <b>nicht gebucht</b> werden, solange sie diesen Status innehaben. Sinnvoll für Status, die eine manuelle Überprüfung einer Rechnung erfordern.]]></de>
+ <en><![CDATA[Draft invoices with this status can <b>not be posted</b> as long as they have this status. Useful for statuses that require manual review of an invoice.]]></en>
+ </locale>
<locale name="dialog.processingStatus.create.title">
<de><![CDATA[Rechnungsstatus hinzufügen]]></de>
@@ -1846,6 +1870,11 @@
<de><![CDATA[Die Rechnung besitzt keine Bezahlmethode.]]></de>
<en><![CDATA[The invoice has no payment method.]]></en>
</locale>
+ <locale name="exception.invoice.verification.status_prevents_posting">
+ <de><![CDATA[Der aktuelle Status der Rechnung verhindert eine Buchung. Bitte prüfe die Rechnung.]]></de>
+ <en><![CDATA[The current status of the invoice prevents posting. Please check the invoice.]]></en>
+ </locale>
+
<locale name="exception.invoice.not.found" html="true">
<de><![CDATA[Die gewünschte Rechnung wurde leider nicht gefunden.]]></de>
<en><![CDATA[The desired invoice was unfortunately not found.]]></en>
diff --git a/src/QUI/ERP/Accounting/Invoice/EventHandler.php b/src/QUI/ERP/Accounting/Invoice/EventHandler.php
index 9db5ea6..561ccb9 100644
--- a/src/QUI/ERP/Accounting/Invoice/EventHandler.php
+++ b/src/QUI/ERP/Accounting/Invoice/EventHandler.php
@@ -295,6 +295,10 @@ public static function onQuiqqerErpOutputSendMailBefore(
$customerFiles = $Invoice->getCustomerFiles();
foreach ($customerFiles as $entry) {
+ if (empty($entry['options']['attachToEmail'])) {
+ continue;
+ }
+
$file = QUI\ERP\Customer\CustomerFiles::getFileByHash($Invoice->getCustomer()->getId(), $entry['hash']);
if ($file) {
diff --git a/src/QUI/ERP/Accounting/Invoice/Invoice.php b/src/QUI/ERP/Accounting/Invoice/Invoice.php
index e421e94..cf646a2 100644
--- a/src/QUI/ERP/Accounting/Invoice/Invoice.php
+++ b/src/QUI/ERP/Accounting/Invoice/Invoice.php
@@ -7,6 +7,7 @@
namespace QUI\ERP\Accounting\Invoice;
use QUI;
+use QUI\ERP\Customer\CustomerFiles;
use QUI\Permissions\Permission;
use QUI\ERP\Money\Price;
use QUI\ERP\Accounting\ArticleListUnique;
@@ -45,10 +46,10 @@ class Invoice extends QUI\QDOM
// const PAYMENT_STATUS_STORNO = 3; // Alias for cancel
// const PAYMENT_STATUS_CREATE_CREDIT = 5;
- const DUNNING_LEVEL_OPEN = 0; // No Dunning -> Keine Mahnung
- const DUNNING_LEVEL_REMIND = 1; // Payment reminding -> Zahlungserinnerung
- const DUNNING_LEVEL_DUNNING = 2; // Dunning -> Erste Mahnung
- const DUNNING_LEVEL_DUNNING2 = 3; // Second dunning -> Zweite Mahnung
+ const DUNNING_LEVEL_OPEN = 0; // No Dunning -> Keine Mahnung
+ const DUNNING_LEVEL_REMIND = 1; // Payment reminding -> Zahlungserinnerung
+ const DUNNING_LEVEL_DUNNING = 2; // Dunning -> Erste Mahnung
+ const DUNNING_LEVEL_DUNNING2 = 3; // Second dunning -> Zweite Mahnung
const DUNNING_LEVEL_COLLECTION = 4; // Collection -> Inkasso
/**
@@ -1504,4 +1505,110 @@ public function getData(string $key)
}
//endregion
+
+ // region Attached customer files
+
+ /**
+ * Add a customer file to this invoice
+ *
+ * @param string $fileHash - SHA256 hash of the file basename
+ * @param array $options (optional) - File options; see $defaultOptions in code for what's possible
+ *
+ * @throws Exception
+ * @throws QUI\Exception
+ */
+ public function addCustomerFile(string $fileHash, array $options = [])
+ {
+ $Customer = $this->getCustomer();
+
+ if (empty($Customer)) {
+ throw new Exception(
+ QUI::getLocale()->get('quiqqer/invoice', 'exception.Invoice.addCustomerFile.no_customer')
+ );
+ }
+
+ $file = CustomerFiles::getFileByHash($Customer->getId(), $fileHash);
+
+ if (empty($file)) {
+ throw new Exception(
+ QUI::getLocale()->get('quiqqer/invoice', 'exception.Invoice.addCustomerFile.file_not_found')
+ );
+ }
+
+ $defaultOptions = [
+ 'attachToEmail' => false
+ ];
+
+ // set default options
+ foreach ($defaultOptions as $k => $v) {
+ if (!isset($options[$k])) {
+ $options[$k] = $v;
+ }
+ }
+
+ // cleanup
+ foreach ($options as $k => $v) {
+ if (!isset($defaultOptions[$k])) {
+ unset($options[$k]);
+ }
+ }
+
+ $fileEntry = [
+ 'hash' => $fileHash,
+ 'options' => $options
+ ];
+
+ $customerFiles = $this->getCustomerFiles();
+ $customerFiles[] = $fileEntry;
+
+ $this->data['customer_files'] = $customerFiles;
+
+ QUI::getDataBase()->update(
+ Handler::getInstance()->invoiceTable(),
+ [
+ 'data' => \json_encode($this->data)
+ ],
+ [
+ 'id' => $this->getCleanId()
+ ]
+ );
+ }
+
+ /**
+ * Clear customer files
+ *
+ * @return void
+ */
+ public function clearCustomerFiles(): void
+ {
+ $this->data['customer_files'] = [];
+
+ QUI::getDataBase()->update(
+ Handler::getInstance()->invoiceTable(),
+ [
+ 'data' => \json_encode($this->data)
+ ],
+ [
+ 'id' => $this->getCleanId()
+ ]
+ );
+ }
+
+ /**
+ * Get customer files that are attached to this invoice.
+ *
+ * @return array - Contains file hash and file options
+ */
+ public function getCustomerFiles(): array
+ {
+ $customerFiles = $this->getData('customer_files');
+
+ if (empty($customerFiles)) {
+ return [];
+ }
+
+ return $customerFiles;
+ }
+
+ // endregion
}
diff --git a/src/QUI/ERP/Accounting/Invoice/ProcessingStatus/Factory.php b/src/QUI/ERP/Accounting/Invoice/ProcessingStatus/Factory.php
index 8ff5639..bbe6e0e 100644
--- a/src/QUI/ERP/Accounting/Invoice/ProcessingStatus/Factory.php
+++ b/src/QUI/ERP/Accounting/Invoice/ProcessingStatus/Factory.php
@@ -22,10 +22,11 @@ class Factory extends QUI\Utils\Singleton
* @param string|integer $id - processing ID
* @param string $color - color of the status
* @param array $title - title
+ * @param array $options (optional) - Status options
* @throws Exception|QUI\Exception
* @todo permissions
*/
- public function createProcessingStatus($id, $color, array $title)
+ public function createProcessingStatus($id, $color, array $title, array $options = [])
{
$list = Handler::getInstance()->getList();
$id = (int)$id;
@@ -42,7 +43,11 @@ public function createProcessingStatus($id, $color, array $title)
$Package = QUI::getPackage('quiqqer/invoice');
$Config = $Package->getConfig();
- $Config->setValue('processing_status', $id, $color);
+ $Config->setValue('processing_status', $id, \json_encode([
+ 'color' => $color,
+ 'options' => $options
+ ]));
+
$Config->save();
// translations
diff --git a/src/QUI/ERP/Accounting/Invoice/ProcessingStatus/Handler.php b/src/QUI/ERP/Accounting/Invoice/ProcessingStatus/Handler.php
index 9e2c0c2..8e5fe44 100644
--- a/src/QUI/ERP/Accounting/Invoice/ProcessingStatus/Handler.php
+++ b/src/QUI/ERP/Accounting/Invoice/ProcessingStatus/Handler.php
@@ -18,6 +18,11 @@
*/
class Handler extends QUI\Utils\Singleton
{
+ /**
+ * Status options
+ */
+ const STATUS_OPTION_PREVENT_INVOICE_POSTING = 'preventInvoicePosting';
+
/**
* @var array
*/
@@ -64,9 +69,9 @@ public function getProcessingStatusList()
$list = $this->getList();
$result = [];
- foreach ($list as $entry => $color) {
+ foreach ($list as $statusId => $v) {
try {
- $result[] = $this->getProcessingStatus($entry);
+ $result[] = $this->getProcessingStatus($statusId);
} catch (Exception $Exception) {
}
}
@@ -123,13 +128,14 @@ public function deleteProcessingStatus($id)
* @param int|string $id
* @param int|string $color
* @param array $title
+ * @param array $options (optional)
*
* @throws Exception
* @throws QUI\Exception
*
* @todo permissions
*/
- public function updateProcessingStatus($id, $color, array $title)
+ public function updateProcessingStatus($id, $color, array $title, array $options = [])
{
$Status = $this->getProcessingStatus($id);
@@ -158,12 +164,15 @@ public function updateProcessingStatus($id, $color, array $title)
QUI\Translator::publish('quiqqer/invoice');
-
// update config
$Package = QUI::getPackage('quiqqer/invoice');
$Config = $Package->getConfig();
- $Config->setValue('processing_status', $Status->getId(), $color);
+ $Config->setValue('processing_status', $Status->getId(), \json_encode([
+ 'color' => $color,
+ 'options' => $options
+ ]));
+
$Config->save();
}
}
diff --git a/src/QUI/ERP/Accounting/Invoice/ProcessingStatus/Status.php b/src/QUI/ERP/Accounting/Invoice/ProcessingStatus/Status.php
index 400b68f..c275871 100644
--- a/src/QUI/ERP/Accounting/Invoice/ProcessingStatus/Status.php
+++ b/src/QUI/ERP/Accounting/Invoice/ProcessingStatus/Status.php
@@ -25,6 +25,15 @@ class Status
*/
protected $color;
+ /**
+ * Default options.
+ *
+ * @var array
+ */
+ protected array $options = [
+ Handler::STATUS_OPTION_PREVENT_INVOICE_POSTING => false
+ ];
+
/**
* Status constructor.
*
@@ -42,8 +51,21 @@ public function __construct($id)
]);
}
- $this->id = (int)$id;
- $this->color = $list[$id];
+ $this->id = (int)$id;
+ $data = $list[$id];
+
+ // Fallback for old data structure
+ if (\mb_strpos($data, '#') === 0) {
+ $this->color = $data;
+ } else {
+ $data = \json_decode($data, true);
+
+ $this->color = $data['color'];
+
+ foreach ($data['options'] as $k => $v) {
+ $this->setOption($k, $v);
+ }
+ }
}
//region Getter
@@ -85,6 +107,48 @@ public function getColor()
//endregion
+ // region Options
+
+ /**
+ * Set status option
+ *
+ * @param string $key - See $this->options for available options
+ * @param $value
+ */
+ public function setOption(string $key, $value)
+ {
+ if (\array_key_exists($key, $this->options)) {
+ $this->options[$key] = $value;
+ }
+ }
+
+ /**
+ * Get status option
+ *
+ * @param string $key
+ * @return mixed|null - Option value or NULL if option does not exist
+ */
+ public function getOption(string $key)
+ {
+ if (\array_key_exists($key, $this->options)) {
+ return $this->options[$key];
+ }
+
+ return null;
+ }
+
+ /**
+ * Get all status options
+ *
+ * @return array
+ */
+ public function getOptions(): array
+ {
+ return $this->options;
+ }
+
+ // endregion
+
/**
* Status as array
*
@@ -110,9 +174,10 @@ public function toArray($Locale = null)
}
return [
- 'id' => $this->getId(),
- 'title' => $title,
- 'color' => $this->getColor()
+ 'id' => $this->getId(),
+ 'title' => $title,
+ 'color' => $this->getColor(),
+ 'options' => $this->getOptions()
];
}
}
diff --git a/src/QUI/ERP/Accounting/Invoice/RestApi/Provider.php b/src/QUI/ERP/Accounting/Invoice/RestApi/Provider.php
index 6bd1c02..1d127d9 100644
--- a/src/QUI/ERP/Accounting/Invoice/RestApi/Provider.php
+++ b/src/QUI/ERP/Accounting/Invoice/RestApi/Provider.php
@@ -11,6 +11,7 @@
use QUI\REST\Utils\RequestUtils;
use QUI\ERP\Accounting\Invoice\Factory as InvoiceFactory;
use QUI\ERP\Currency\Handler as CurrencyHandler;
+use QUI\ERP\Accounting\Invoice\ProcessingStatus\Handler as ProcessingStatuses;
/**
* Class Provider
@@ -94,7 +95,9 @@ public function createInvoice(RequestInterface $Request, ResponseInterface $Resp
'currency' => false,
'payment_method' => false,
- 'additional_invoice_text' => false
+ 'additional_invoice_text' => false,
+ 'files' => false,
+ 'processing_status' => false,
];
// Remove unknown fields
@@ -148,9 +151,9 @@ public function createInvoice(RequestInterface $Request, ResponseInterface $Resp
$InvoiceDraft = $Factory->createInvoice($SystemUser);
// Customer
- if (!empty($invoiceData['customer_no'])) {
- $User = false;
+ $User = false;
+ if (!empty($invoiceData['customer_no'])) {
try {
$User = QUI\ERP\Customer\Customers::getInstance()->getCustomerByCustomerNo($invoiceData['customer_no']);
$InvoiceDraft->setAttribute('customer_id', $User->getId());
@@ -272,6 +275,61 @@ public function createInvoice(RequestInterface $Request, ResponseInterface $Resp
$InvoiceDraft->addArticle($Article);
}
+ // Files
+ if ($User && !empty($invoiceData['files'])) {
+ $fileDir = QUI::getPackage('quiqqer/invoice')->getVarDir().'/uploads/'.$InvoiceDraft->getId();
+ QUI\Utils\System\File::mkdir($fileDir);
+
+ $fileCounter = 0;
+
+ foreach ($invoiceData['files'] as $file) {
+ if (!\is_array($file) || !isset($file['name']) || !isset($file['content'])) {
+ continue;
+ }
+
+ // Write file data to file
+ $localFile = $fileDir;
+
+ if (!empty($file['name'])) {
+ $localFile .= $file['name'];
+ } else {
+ $localFile .= 'file_'.++$fileCounter;
+ }
+
+ \file_put_contents($localFile, \hex2bin($file['content']));
+
+ $fileInfo = \pathinfo($localFile);
+ $fileHash = \hash('sha256', $fileInfo['basename']);
+
+ try {
+ QUI\ERP\Customer\CustomerFiles::addFileToCustomer($User->getId(), $localFile);
+
+ $fileOptions = [];
+
+ if (!empty($file['options'])) {
+ $fileOptions = $file['options'];
+ }
+
+ $InvoiceDraft->addCustomerFile($fileHash, $fileOptions);
+ } catch (\Exception $Exception) {
+ QUI\System\Log::writeException($Exception);
+ }
+ }
+ }
+
+ // Processing status
+ if (!empty($invoiceData['processing_status'])) {
+ $statusId = (int)$invoiceData['processing_status'];
+ $StatusHandler = ProcessingStatuses::getInstance();
+
+ try {
+ $StatusHandler->getProcessingStatus($statusId);
+ $InvoiceDraft->setAttribute('processing_status', $statusId);
+ } catch (\Exception $Exception) {
+ QUI\System\Log::writeException($Exception);
+ }
+ }
+
try {
$InvoiceDraft->update($SystemUser);
} catch (\Exception $Exception) {
diff --git a/src/QUI/ERP/Accounting/Invoice/Utils/Invoice.php b/src/QUI/ERP/Accounting/Invoice/Utils/Invoice.php
index 74efd01..2dbd8bc 100644
--- a/src/QUI/ERP/Accounting/Invoice/Utils/Invoice.php
+++ b/src/QUI/ERP/Accounting/Invoice/Utils/Invoice.php
@@ -10,6 +10,7 @@
use QUI\ERP\Accounting\Invoice\Exception;
use QUI\ERP\Accounting\Invoice\InvoiceTemporary;
use QUI\ERP\Accounting\Payments\Transactions\Transaction;
+use QUI\ERP\Accounting\Invoice\ProcessingStatus\Handler as ProcessingStatuses;
/**
* Class Invoice
@@ -104,7 +105,7 @@ public static function getMissingAttributes(InvoiceTemporary $Invoice): array
self::getMissingAddressFields($Invoice)
);
- //articles
+ // articles
if (!$Articles->count()) {
$missing[] = 'article';
}
@@ -117,6 +118,23 @@ public static function getMissingAttributes(InvoiceTemporary $Invoice): array
$missing[] = 'payment';
}
+ // Status that prevents posting
+ $statusId = $Invoice->getAttribute('processing_status');
+
+ if (!empty($statusId)) {
+ try {
+ $Status = ProcessingStatuses::getInstance()->getProcessingStatus(
+ $statusId
+ );
+
+ if ($Status->getOption(ProcessingStatuses::STATUS_OPTION_PREVENT_INVOICE_POSTING)) {
+ $missing[] = 'status_prevents_posting';
+ }
+ } catch (\Exception $Exception) {
+ QUI\System\Log::writeException($Exception);
+ }
+ }
+
// api
QUI::getEvents()->fireEvent('onQuiqqerInvoiceMissingAttributes', [$Invoice, &$missing]);
@@ -269,6 +287,9 @@ public static function getMissingAttributeMessage(string $missingAttribute): str
case 'invoice_address_country':
return $Locale->get($lg, 'exception.invoice.verification.country');
+
+ case 'status_prevents_posting':
+ return $Locale->get($lg, 'exception.invoice.verification.status_prevents_posting');
}
$message = false;
--
GitLab