diff --git a/.gitattributes b/.gitattributes
new file mode 100644
index 0000000000000000000000000000000000000000..9ab59b180fb670006ac910a2bc4524a1376dcea0
--- /dev/null
+++ b/.gitattributes
@@ -0,0 +1,15 @@
+
+# Ignore developer files when exporting
+.gitattributes export-ignore
+.gitignore export-ignore
+.gitlab-ci.yml export-ignore
+.phive export-ignore
+captainhook.json export-ignore
+phpcs.xml.dist export-ignore
+phpstan-baseline.neon export-ignore
+phpstan.dist.neon export-ignore
+phpunit.dist.xml export-ignore
+tests export-ignore
+
+# Explicitly set file type and line endings for PHP files, improves git diff output
+*.php text eol=lf diff=php
\ No newline at end of file
diff --git a/.gitignore b/.gitignore
index 5d49cc71d98b16e2ed3cc08be94e85f83584b1e5..a708841abb3c83ea2ba84c9f3a1fb8966eea8e46 100644
--- a/.gitignore
+++ b/.gitignore
@@ -2,3 +2,11 @@ tools/
phpstan.neon
.phpunit.result.cache
phpunit.xml
+
+tools/
+
+phpstan.neon
+
+.phpunit.result.cache
+
+phpunit.xml
diff --git a/.gitlab-ci.yml b/.gitlab-ci.yml
index b8d20acb6c365ad8036a7b36d47dabd876d08efa..b5a64b401e554341447c74d7cf93a89ac95a3fdb 100644
--- a/.gitlab-ci.yml
+++ b/.gitlab-ci.yml
@@ -1,3 +1,17 @@
include:
- - project: 'quiqqer/stabilization/semantic-release'
- file: '/ci-templates/.gitlab-ci.yml'
+ - component: dev.quiqqer.com/quiqqer/stabilization/ci-cd-components/quiqqer-package-bundle/quiqqer-package-bundle@main
+
+# Remove the entire phpunit-php8.1 block, to allow PHPUnit to run on PHP 8.1 in your pipeline
+phpunit-php8.1:
+ rules:
+ - when: never
+
+# Remove the entire phpunit-php8.2 block, to allow PHPUnit to run on PHP 8.2 in your pipeline
+phpunit-php8.2:
+ rules:
+ - when: never
+
+# Remove the entire phpunit-php8.3 block, to allow PHPUnit to run on PHP 8.3 in your pipeline
+phpunit-php8.3:
+ rules:
+ - when: never
\ No newline at end of file
diff --git a/.phive/phars.xml b/.phive/phars.xml
index a1315a09b4adad780a9c5e52f74835c708c5c7d5..5bfa092bfad10dad9d23240281a5a2041acb815b 100644
--- a/.phive/phars.xml
+++ b/.phive/phars.xml
@@ -1,4 +1,8 @@
<?xml version="1.0" encoding="UTF-8"?>
<phive xmlns="https://phar.io/phive">
- <phar name="phpstan" version="^1.10.67" installed="1.10.67" location="./tools/phpstan" copy="false"/>
+ <phar name="phpstan" version="1.11.8" installed="1.11.8" location="./tools/phpstan" copy="false"/>
+ <phar name="phpunit" version="^10.5.20" installed="10.5.20" location="./tools/phpunit" copy="false"/>
+ <phar name="phpcs" version="^3.10.1" installed="3.10.1" location="./tools/phpcs" copy="false"/>
+ <phar name="phpcbf" version="^3.10.1" installed="3.10.1" location="./tools/phpcbf" copy="false"/>
+ <phar name="captainhook" version="^5.23.3" installed="5.23.3" location="./tools/captainhook" copy="false"/>
</phive>
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
new file mode 100644
index 0000000000000000000000000000000000000000..4a69a59b440e5beec561eca1e341509bd5a18688
--- /dev/null
+++ b/CONTRIBUTING.md
@@ -0,0 +1,3 @@
+# Contributing
+
+This package follows the [QUIQQER contribution guidelines](https://dev.quiqqer.com/quiqqer/stabilization/documentation/-/wikis/home).
\ No newline at end of file
diff --git a/captainhook.json b/captainhook.json
new file mode 100644
index 0000000000000000000000000000000000000000..3702e1a358868bedd5ff4c7eae40bb1abb589267
--- /dev/null
+++ b/captainhook.json
@@ -0,0 +1,13 @@
+{
+ "pre-commit": {
+ "enabled": true,
+ "actions": [
+ {
+ "action": "\\CaptainHook\\App\\Hook\\PHP\\Action\\Linting"
+ },
+ {
+ "action": "composer test"
+ }
+ ]
+ }
+}
\ No newline at end of file
diff --git a/composer.json b/composer.json
index 3413d89ad38e065189c7f518065942eb2dd479ea..116e88b11a104130c5e7c64ecaa811659b669ea7 100644
--- a/composer.json
+++ b/composer.json
@@ -35,5 +35,47 @@
"psr-4": {
"QUI\\ERP\\": "src/QUI/ERP"
}
+ },
+ "scripts": {
+ "test": [
+ "@dev:lint",
+ "@dev:phpunit"
+ ],
+ "dev:phpunit": "./tools/phpunit",
+ "dev:lint": [
+ "@dev:lint:phpstan",
+ "@dev:lint:style"
+ ],
+ "dev:lint:phpstan": "./tools/phpstan",
+ "dev:lint:style": "./tools/phpcs",
+ "dev:lint:style:fix": "./tools/phpcbf",
+ "dev:init": [
+ "@dev:init:check-requirements",
+ "@dev:init:tools",
+ "@dev:init:git-hooks"
+ ],
+ "dev:init:check-requirements": [
+ "which composer > /dev/null || (echo 'Error: composer has to be globally installed'; exit 1)",
+ "which phive > /dev/null || (echo 'Error: PHIVE has to be globally installed'; exit 1)"
+ ],
+ "dev:init:tools": "phive install --temporary",
+ "dev:init:git-hooks": "./tools/captainhook install --only-enabled --force"
+ },
+ "scripts-aliases": {
+ "test": [
+ "dev:test"
+ ]
+ },
+ "scripts-descriptions": {
+ "test": "Runs linting, static analysis, and unit tests.",
+ "dev:phpunit": "Run PHPUnit test suites",
+ "dev:lint": "Run PHPStan and code style check",
+ "dev:lint:phpstan": "Run PHPStan",
+ "dev:lint:style": "Run code style check (PHP_CodeSniffer)",
+ "dev:lint:style:fix": "Try to fix code style errors automatically",
+ "dev:init": "Initialize the developer tooling (tools and git hooks)",
+ "dev:init:check-requirements": "Check if the necessary requirements are met",
+ "dev:init:tools": "Install all developer tools (requires PHIVE)",
+ "dev:init:git-hooks": "Install all git hooks (may require tools to be installed)"
}
}
diff --git a/phpstan-baseline.neon b/phpstan-baseline.neon
index e69de29bb2d1d6434b8b29ae775ad8c2e48c5391..2f8fdeb646618252a4ab8099991d71bec9926215 100644
--- a/phpstan-baseline.neon
+++ b/phpstan-baseline.neon
@@ -0,0 +1,166 @@
+parameters:
+ ignoreErrors:
+ -
+ message: "#^Parameter \\#6 \\$User of static method QUI\\\\ERP\\\\Accounting\\\\Payments\\\\Transactions\\\\Factory\\:\\:createPaymentTransaction\\(\\) expects null, QUI\\\\Interfaces\\\\Users\\\\User given\\.$#"
+ count: 1
+ path: ajax/invoices/addPayment.php
+
+ -
+ message: "#^Call to static method getInstance\\(\\) on an unknown class QUI\\\\ERP\\\\Order\\\\Handler\\.$#"
+ count: 1
+ path: src/QUI/ERP/Accounting/Invoice/EventHandler.php
+
+ -
+ message: "#^PHPDoc tag @throws has invalid value \\(\\)\\: Unexpected token \"\\\\n \", expected type at offset 212$#"
+ count: 1
+ path: src/QUI/ERP/Accounting/Invoice/Factory.php
+
+ -
+ message: "#^Class QUI\\\\Database\\\\Exception referenced with incorrect case\\: QUI\\\\DataBase\\\\Exception\\.$#"
+ count: 1
+ path: src/QUI/ERP/Accounting/Invoice/Invoice.php
+
+ -
+ message: "#^Method QUI\\\\ERP\\\\Accounting\\\\Invoice\\\\Invoice\\:\\:getShipping\\(\\) has invalid return type QUI\\\\ERP\\\\Shipping\\\\Types\\\\ShippingUnique\\.$#"
+ count: 2
+ path: src/QUI/ERP/Accounting/Invoice/Invoice.php
+
+ -
+ message: "#^Method QUI\\\\ERP\\\\Accounting\\\\Invoice\\\\Invoice\\:\\:getShipping\\(\\) should return int\\|QUI\\\\ERP\\\\Shipping\\\\Types\\\\ShippingUnique\\|null but returns QUI\\\\ERP\\\\Shipping\\\\Api\\\\ShippingInterface\\|null\\.$#"
+ count: 2
+ path: src/QUI/ERP/Accounting/Invoice/Invoice.php
+
+ -
+ message: "#^PHPDoc tag @param references unknown parameter\\: \\$globalProcessId$#"
+ count: 1
+ path: src/QUI/ERP/Accounting/Invoice/Invoice.php
+
+ -
+ message: "#^PHPDoc tag @throws has invalid value \\(\\)\\: Unexpected token \"\\\\n \", expected type at offset 174$#"
+ count: 1
+ path: src/QUI/ERP/Accounting/Invoice/Invoice.php
+
+ -
+ message: "#^PHPDoc tag @throws has invalid value \\(\\)\\: Unexpected token \"\\\\n \", expected type at offset 86$#"
+ count: 1
+ path: src/QUI/ERP/Accounting/Invoice/Invoice.php
+
+ -
+ message: "#^Property QUI\\\\ERP\\\\Accounting\\\\Invoice\\\\Invoice\\:\\:\\$Shipping \\(QUI\\\\ERP\\\\Shipping\\\\Api\\\\ShippingInterface\\|null\\) does not accept QUI\\\\ERP\\\\Shipping\\\\Types\\\\ShippingUnique\\.$#"
+ count: 2
+ path: src/QUI/ERP/Accounting/Invoice/Invoice.php
+
+ -
+ message: "#^Property QUI\\\\ERP\\\\Accounting\\\\Invoice\\\\Invoice\\:\\:\\$Shipping has unknown class QUI\\\\ERP\\\\Shipping\\\\Api\\\\ShippingInterface as its type\\.$#"
+ count: 2
+ path: src/QUI/ERP/Accounting/Invoice/Invoice.php
+
+ -
+ message: "#^Call to method getId\\(\\) on an unknown class QUI\\\\ERP\\\\Shipping\\\\Api\\\\ShippingInterface\\.$#"
+ count: 1
+ path: src/QUI/ERP/Accounting/Invoice/InvoiceTemporary.php
+
+ -
+ message: "#^Call to method getId\\(\\) on an unknown class QUI\\\\ERP\\\\Shipping\\\\Types\\\\ShippingEntry\\.$#"
+ count: 2
+ path: src/QUI/ERP/Accounting/Invoice/InvoiceTemporary.php
+
+ -
+ message: "#^Call to method toJSON\\(\\) on an unknown class QUI\\\\ERP\\\\Shipping\\\\Types\\\\ShippingEntry\\.$#"
+ count: 2
+ path: src/QUI/ERP/Accounting/Invoice/InvoiceTemporary.php
+
+ -
+ message: "#^Call to static method getInstance\\(\\) on an unknown class QUI\\\\ERP\\\\Order\\\\Handler\\.$#"
+ count: 1
+ path: src/QUI/ERP/Accounting/Invoice/InvoiceTemporary.php
+
+ -
+ message: "#^Method QUI\\\\ERP\\\\Accounting\\\\Invoice\\\\InvoiceTemporary\\:\\:getShipping\\(\\) has invalid return type QUI\\\\ERP\\\\Shipping\\\\Types\\\\ShippingEntry\\.$#"
+ count: 2
+ path: src/QUI/ERP/Accounting/Invoice/InvoiceTemporary.php
+
+ -
+ message: "#^PHPDoc tag @throws has invalid value \\(\\)\\: Unexpected token \"\\\\n \", expected type at offset 86$#"
+ count: 1
+ path: src/QUI/ERP/Accounting/Invoice/InvoiceTemporary.php
+
+ -
+ message: "#^Parameter \\$Shipping of method QUI\\\\ERP\\\\Accounting\\\\Invoice\\\\InvoiceTemporary\\:\\:setShipping\\(\\) has invalid type QUI\\\\ERP\\\\Shipping\\\\Api\\\\ShippingInterface\\.$#"
+ count: 2
+ path: src/QUI/ERP/Accounting/Invoice/InvoiceTemporary.php
+
+ -
+ message: "#^Else branch is unreachable because previous condition is always true\\.$#"
+ count: 1
+ path: src/QUI/ERP/Accounting/Invoice/InvoiceView.php
+
+ -
+ message: "#^Unreachable statement \\- code above always terminates\\.$#"
+ count: 1
+ path: src/QUI/ERP/Accounting/Invoice/InvoiceView.php
+
+ -
+ message: "#^Call to an undefined method QUI\\\\ERP\\\\Accounting\\\\ArticleListUnique\\:\\:setUser\\(\\)\\.$#"
+ count: 1
+ path: src/QUI/ERP/Accounting/Invoice/Output/OutputProviderInvoice.php
+
+ -
+ message: "#^Call to an undefined method QUI\\\\ERP\\\\Accounting\\\\ArticleListUnique\\:\\:toUniqueList\\(\\)\\.$#"
+ count: 1
+ path: src/QUI/ERP/Accounting/Invoice/Output/OutputProviderInvoice.php
+
+ -
+ message: "#^Call to static method getInstance\\(\\) on an unknown class QUI\\\\ERP\\\\Order\\\\Handler\\.$#"
+ count: 1
+ path: src/QUI/ERP/Accounting/Invoice/Output/OutputProviderInvoice.php
+
+ -
+ message: "#^Parameter \\#2 \\$key of method QUI\\\\Config\\:\\:setValue\\(\\) expects string\\|null, int given\\.$#"
+ count: 1
+ path: src/QUI/ERP/Accounting/Invoice/ProcessingStatus/Factory.php
+
+ -
+ message: "#^Parameter \\#2 \\$key of method QUI\\\\Config\\:\\:del\\(\\) expects string\\|null, int given\\.$#"
+ count: 1
+ path: src/QUI/ERP/Accounting/Invoice/ProcessingStatus/Handler.php
+
+ -
+ message: "#^Parameter \\#2 \\$key of method QUI\\\\Config\\:\\:setValue\\(\\) expects string\\|null, int given\\.$#"
+ count: 1
+ path: src/QUI/ERP/Accounting/Invoice/ProcessingStatus/Handler.php
+
+ -
+ message: "#^Call to static method getInstance\\(\\) on an unknown class QUI\\\\ERP\\\\Order\\\\Handler\\.$#"
+ count: 1
+ path: src/QUI/ERP/Accounting/Invoice/Search/InvoiceSearch.php
+
+ -
+ message: "#^Expression on left side of \\?\\? is not nullable\\.$#"
+ count: 1
+ path: src/QUI/ERP/Accounting/Invoice/Search/InvoiceSearch.php
+
+ -
+ message: "#^Parameter \\#1 \\$haystack of function str_starts_with expects string, int given\\.$#"
+ count: 1
+ path: src/QUI/ERP/Accounting/Invoice/Search/InvoiceSearch.php
+
+ -
+ message: "#^Parameter \\#1 \\$string of function strlen expects string, int given\\.$#"
+ count: 1
+ path: src/QUI/ERP/Accounting/Invoice/Search/InvoiceSearch.php
+
+ -
+ message: "#^Parameter \\#1 \\$string of function substr_replace expects array\\|string, int given\\.$#"
+ count: 1
+ path: src/QUI/ERP/Accounting/Invoice/Search/InvoiceSearch.php
+
+ -
+ message: "#^Result of && is always false\\.$#"
+ count: 1
+ path: src/QUI/ERP/Accounting/Invoice/Utils/Invoice.php
+
+ -
+ message: "#^Result of \\|\\| is always true\\.$#"
+ count: 1
+ path: src/QUI/ERP/Accounting/Invoice/Utils/Invoice.php
diff --git a/phpstan.dist.neon b/phpstan.dist.neon
index 58e6293cee8eb9a9f99cd767870203e7870bcd9c..9cfddef902aa2f94909657dfd494aa39e3b01cfb 100644
--- a/phpstan.dist.neon
+++ b/phpstan.dist.neon
@@ -2,10 +2,13 @@ includes:
- phpstan-baseline.neon
parameters:
- level: 1
+ level: 5
paths:
- src
- ajax
+ excludePaths:
+ # Requires the optional 'quiqqer/rest' package
+ - src/QUI/ERP/Accounting/Invoice/RestApi/Provider.php
bootstrapFiles:
- tests/phpstan-bootstrap.php
treatPhpDocTypesAsCertain: false
diff --git a/phpunit.dist.xml b/phpunit.dist.xml
new file mode 100644
index 0000000000000000000000000000000000000000..f6c7becf0c12757beb871a9333e2d81e02aa7cae
--- /dev/null
+++ b/phpunit.dist.xml
@@ -0,0 +1,8 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<phpunit bootstrap="tests/phpunit-bootstrap.php">
+ <testsuites>
+ <testsuite name="Tests">
+ <directory>tests/</directory>
+ </testsuite>
+ </testsuites>
+</phpunit>
diff --git a/src/QUI/ERP/Accounting/Invoice/Invoice.php b/src/QUI/ERP/Accounting/Invoice/Invoice.php
index 5e48297a0fd5eabf744da1859cef3eb292df2934..4f94de8c54e92c468a4a426e2a7530588d9fd54a 100644
--- a/src/QUI/ERP/Accounting/Invoice/Invoice.php
+++ b/src/QUI/ERP/Accounting/Invoice/Invoice.php
@@ -671,7 +671,7 @@ public function reversal(
'quiqqer/invoice',
'message.invoice.cancellationInvoice.additionalInvoiceText',
[
- 'id' => $this->getUUID(),
+ 'id' => $this->getPrefixedNumber(),
'date' => $Formatter->format($currentDate)
]
);
@@ -1179,7 +1179,7 @@ public function createReversal(
'quiqqer/invoice',
'message.invoice.reversal.additionalInvoiceText.creditNote',
[
- 'id' => $this->getUUID(),
+ 'id' => $this->getPrefixedNumber(),
'date' => $Formatter->format($currentDate)
]
);
@@ -1188,7 +1188,7 @@ public function createReversal(
'quiqqer/invoice',
'message.invoice.reversal.additionalInvoiceText',
[
- 'id' => $this->getUUID(),
+ 'id' => $this->getPrefixedNumber(),
'date' => $Formatter->format($currentDate)
]
);
diff --git a/src/QUI/ERP/Accounting/Invoice/InvoiceTemporary.php b/src/QUI/ERP/Accounting/Invoice/InvoiceTemporary.php
index 823c8697285e318de29bcd0ce517b05a04a0ea9a..0bef58669b68d8074f76adcf988499de430a4ea5 100644
--- a/src/QUI/ERP/Accounting/Invoice/InvoiceTemporary.php
+++ b/src/QUI/ERP/Accounting/Invoice/InvoiceTemporary.php
@@ -2073,7 +2073,7 @@ public function addComment(string $message): void
false,
'quiqqer/invoice',
Factory::ERP_INVOICE_ICON,
- false,
+ false,
$this->getUUID()
);
diff --git a/tests/phpunit-bootstrap.php b/tests/phpunit-bootstrap.php
new file mode 100644
index 0000000000000000000000000000000000000000..eca92fd67bed8ae4ec424ed82d300119d792f042
--- /dev/null
+++ b/tests/phpunit-bootstrap.php
@@ -0,0 +1,11 @@
+<?php
+
+if (!defined('QUIQQER_SYSTEM')) {
+ define('QUIQQER_SYSTEM', true);
+}
+
+if (!defined('QUIQQER_AJAX')) {
+ define('QUIQQER_AJAX', true);
+}
+
+require_once __DIR__ . '/../../../../bootstrap.php';