Skip to content
Code-Schnipsel Gruppen Projekte
Commit e5ed940a erstellt von Henning Leutz's avatar Henning Leutz :martial_arts_uniform:
Dateien durchsuchen

fix(phpstan): improve type handling and method returns 

This commit includes several changes to improve type handling and the returns of various methods.
It includes changes in files related to Shipping rules and status, as well as tracking. Notable
changes include:

- Refactoring of method signatures and corresponding usages to use type hinting for better error
handling.
- Fixed return types in Factory.php to return more specific types (ShippingRule and ShippingEntry).
- Adjusted the createShippingStatus method to convert `id` to string before passing it to setValue
method in Config.
- Fixed active carrier filtering in Tracking for boolean conversion.
- Modified handling and events related to shipping in ShippingEntry.php and Factory.php.
- Other minor cleanups and refactorings.

Related: #55
Übergeordneter ac6dda13
No related branches found
No related tags found
2 Merge Requests!46Update 'next-3.x' with latest changes from 'main',!45fix(phpstan): allow null as parameter in various functions
Pipeline #15587 fehlgeschlagen mit Phase
Phase:
    in 2 Minuten und 31 Sekunden
    Leerzeichenänderungen ausblenden
    Inline Nebeneinander
    werden angezeigt mit 21 Ergänzungen und 281 Löschungen
    phpstan-baseline.neon
    + 0
    − 261
    Zeige Datei @ e5ed940a
    parameters:
    ignoreErrors:
    -
    message: "#^Parameter \\#2 \\$callback of function usort expects callable\\(array, array\\)\\: int, Closure\\(mixed, mixed\\)\\: bool given\\.$#"
    count: 1
    path: ajax/backend/rules/getRules.php
    -
    message: "#^Call to an undefined method QUI\\\\ERP\\\\Shipping\\\\Api\\\\AbstractShippingEntry\\:\\:setTitle\\(\\)\\.$#"
    count: 1
    path: ajax/backend/rules/update.php
    -
    message: "#^Call to an undefined method QUI\\\\ERP\\\\Shipping\\\\Api\\\\AbstractShippingEntry\\:\\:setWorkingTitle\\(\\)\\.$#"
    count: 1
    path: ajax/backend/rules/update.php
    -
    message: "#^Parameter \\$Invoice of method QUI\\\\ERP\\\\Shipping\\\\Api\\\\AbstractShippingEntry\\:\\:getInvoiceInformationText\\(\\) has invalid type QUI\\\\ERP\\\\Accounting\\\\Invoice\\\\Invoice\\.$#"
    count: 2
    path: src/QUI/ERP/Shipping/Api/AbstractShippingEntry.php
    -
    message: "#^Parameter \\$Invoice of method QUI\\\\ERP\\\\Shipping\\\\Api\\\\AbstractShippingEntry\\:\\:getInvoiceInformationText\\(\\) has invalid type QUI\\\\ERP\\\\Accounting\\\\Invoice\\\\InvoiceTemporary\\.$#"
    count: 2
    path: src/QUI/ERP/Shipping/Api/AbstractShippingEntry.php
    -
    message: "#^Parameter \\$Invoice of method QUI\\\\ERP\\\\Shipping\\\\Api\\\\AbstractShippingEntry\\:\\:getInvoiceInformationText\\(\\) has invalid type QUI\\\\ERP\\\\Accounting\\\\Invoice\\\\InvoiceView\\.$#"
    count: 2
    path: src/QUI/ERP/Shipping/Api/AbstractShippingEntry.php
    -
    message: "#^Call to an undefined method QUI\\\\ERP\\\\Order\\\\AbstractOrder\\:\\:save\\(\\)\\.$#"
    count: 5
    path: src/QUI/ERP/Shipping/EventHandler.php
    -
    message: "#^Call to method addCustomDataEntry\\(\\) on an unknown class QUI\\\\ERP\\\\Accounting\\\\Invoice\\\\InvoiceTemporary\\.$#"
    count: 1
    path: src/QUI/ERP/Shipping/EventHandler.php
    -
    message: "#^Call to method addCustomDataEntry\\(\\) on an unknown class QUI\\\\ERP\\\\Accounting\\\\Offers\\\\AbstractOffer\\.$#"
    count: 1
    path: src/QUI/ERP/Shipping/EventHandler.php
    -
    message: "#^Call to method getArticles\\(\\) on an unknown class QUI\\\\ERP\\\\Accounting\\\\Invoice\\\\InvoiceTemporary\\.$#"
    count: 1
    path: src/QUI/ERP/Shipping/EventHandler.php
    -
    message: "#^Call to method getArticles\\(\\) on an unknown class QUI\\\\ERP\\\\Accounting\\\\Offers\\\\AbstractOffer\\.$#"
    count: 1
    path: src/QUI/ERP/Shipping/EventHandler.php
    -
    message: "#^Call to method getArticles\\(\\) on an unknown class QUI\\\\ERP\\\\SalesOrders\\\\SalesOrder\\.$#"
    count: 1
    path: src/QUI/ERP/Shipping/EventHandler.php
    -
    message: "#^Call to method getCustomDataEntry\\(\\) on an unknown class QUI\\\\ERP\\\\Accounting\\\\Invoice\\\\InvoiceTemporary\\.$#"
    count: 1
    path: src/QUI/ERP/Shipping/EventHandler.php
    -
    message: "#^Call to method getCustomDataEntry\\(\\) on an unknown class QUI\\\\ERP\\\\Accounting\\\\Offers\\\\AbstractOffer\\.$#"
    count: 1
    path: src/QUI/ERP/Shipping/EventHandler.php
    -
    message: "#^Call to method getGlobalProcessId\\(\\) on an unknown class QUI\\\\ERP\\\\Accounting\\\\Invoice\\\\InvoiceTemporary\\.$#"
    count: 1
    path: src/QUI/ERP/Shipping/EventHandler.php
    -
    message: "#^Call to method getGlobalProcessId\\(\\) on an unknown class QUI\\\\ERP\\\\Accounting\\\\Offers\\\\AbstractOffer\\.$#"
    count: 1
    path: src/QUI/ERP/Shipping/EventHandler.php
    -
    message: "#^Call to method getGlobalProcessId\\(\\) on an unknown class QUI\\\\ERP\\\\SalesOrders\\\\SalesOrder\\.$#"
    count: 1
    path: src/QUI/ERP/Shipping/EventHandler.php
    -
    message: "#^Call to method update\\(\\) on an unknown class QUI\\\\ERP\\\\Accounting\\\\Invoice\\\\InvoiceTemporary\\.$#"
    count: 1
    path: src/QUI/ERP/Shipping/EventHandler.php
    -
    message: "#^Call to method update\\(\\) on an unknown class QUI\\\\ERP\\\\Accounting\\\\Offers\\\\AbstractOffer\\.$#"
    count: 1
    path: src/QUI/ERP/Shipping/EventHandler.php
    -
    message: "#^Call to method update\\(\\) on an unknown class QUI\\\\ERP\\\\SalesOrders\\\\SalesOrder\\.$#"
    count: 1
    path: src/QUI/ERP/Shipping/EventHandler.php
    -
    message: "#^Negated boolean expression is always false\\.$#"
    count: 2
    path: src/QUI/ERP/Shipping/EventHandler.php
    -
    message: "#^Offset 'options' does not exist on array\\{title\\: array\\{de\\: 'Lieferzeit', en\\: 'Delivery time'\\}, type\\: 'shipping…', public\\: true, standard\\: true\\}\\.$#"
    count: 1
    path: src/QUI/ERP/Shipping/EventHandler.php
    -
    message: "#^Offset 'options' on array\\{title\\: array\\{de\\: 'Lieferzeit', en\\: 'Delivery time'\\}, type\\: 'shipping…', public\\: true, standard\\: true\\} in empty\\(\\) does not exist\\.$#"
    count: 1
    path: src/QUI/ERP/Shipping/EventHandler.php
    -
    message: "#^Offset 'public' on array\\{title\\: array\\{de\\: 'Lieferzeit', en\\: 'Delivery time'\\}, type\\: 'shipping…', public\\: true, standard\\: true\\} in empty\\(\\) always exists and is not falsy\\.$#"
    count: 1
    path: src/QUI/ERP/Shipping/EventHandler.php
    -
    message: "#^Offset 'standard' on array\\{title\\: array\\{de\\: 'Lieferzeit', en\\: 'Delivery time'\\}, type\\: 'shipping…', public\\: true, standard\\: true\\} in empty\\(\\) always exists and is not falsy\\.$#"
    count: 1
    path: src/QUI/ERP/Shipping/EventHandler.php
    -
    message: "#^Parameter \\#1 \\$Locale of method QUI\\\\ERP\\\\Shipping\\\\Types\\\\ShippingEntry\\:\\:toPriceFactor\\(\\) expects null, QUI\\\\Locale given\\.$#"
    count: 1
    path: src/QUI/ERP/Shipping/EventHandler.php
    -
    message: "#^Parameter \\$Offer of method QUI\\\\ERP\\\\Shipping\\\\EventHandler\\:\\:onQuiqqerOffersCreated\\(\\) has invalid type QUI\\\\ERP\\\\Accounting\\\\Offers\\\\AbstractOffer\\.$#"
    count: 2
    path: src/QUI/ERP/Shipping/EventHandler.php
    -
    message: "#^Parameter \\$Sales of method QUI\\\\ERP\\\\Shipping\\\\EventHandler\\:\\:onQuiqqerSalesOrdersCreated\\(\\) has invalid type QUI\\\\ERP\\\\SalesOrders\\\\SalesOrder\\.$#"
    count: 2
    path: src/QUI/ERP/Shipping/EventHandler.php
    -
    message: "#^Parameter \\$TemporaryInvoice of method QUI\\\\ERP\\\\Shipping\\\\EventHandler\\:\\:onQuiqqerInvoiceTemporaryInvoiceCreated\\(\\) has invalid type QUI\\\\ERP\\\\Accounting\\\\Invoice\\\\InvoiceTemporary\\.$#"
    count: 2
    path: src/QUI/ERP/Shipping/EventHandler.php
    -
    message: "#^Negated boolean expression is always false\\.$#"
    count: 1
    path: src/QUI/ERP/Shipping/Methods/Digital/ShippingType.php
    -
    message: "#^Negated boolean expression is always false\\.$#"
    count: 1
    path: src/QUI/ERP/Shipping/Methods/Standard/ShippingType.php
    -
    message: "#^Call to an undefined method QUI\\\\ERP\\\\Order\\\\AbstractOrder\\:\\:save\\(\\)\\.$#"
    count: 2
    path: src/QUI/ERP/Shipping/Order/Shipping.php
    -
    message: "#^Method QUI\\\\ERP\\\\Shipping\\\\Products\\\\Fields\\\\ShippingTimeFrontendView\\:\\:getValue\\(\\) should return array\\|string but returns null\\.$#"
    count: 1
    path: src/QUI/ERP/Shipping/Products/Fields/ShippingTimeFrontendView.php
    -
    message: "#^Variable \\$Field in PHPDoc tag @var does not match assigned variable \\$value\\.$#"
    count: 1
    path: src/QUI/ERP/Shipping/Products/Fields/ShippingTimeFrontendView.php
    -
    message: "#^Return type \\(QUI\\\\ERP\\\\Shipping\\\\Products\\\\Fields\\\\ShippingTimeFrontendView\\) of method QUI\\\\ERP\\\\Shipping\\\\Products\\\\Fields\\\\ShippingTimePeriod\\:\\:getFrontendView\\(\\) should be compatible with return type \\(QUI\\\\ERP\\\\Products\\\\Field\\\\Types\\\\UnitSelectFrontendView\\) of method QUI\\\\ERP\\\\Products\\\\Field\\\\Types\\\\TimePeriod\\:\\:getFrontendView\\(\\)$#"
    count: 1
    path: src/QUI/ERP/Shipping/Products/Fields/ShippingTimePeriod.php
    -
    message: "#^Method QUI\\\\ERP\\\\Shipping\\\\Rules\\\\Factory\\:\\:createChild\\(\\) should return QUI\\\\ERP\\\\Shipping\\\\Rules\\\\ShippingRule but returns QUI\\\\CRUD\\\\Child\\.$#"
    count: 1
    path: src/QUI/ERP/Shipping/Rules/Factory.php
    -
    message: "#^Method QUI\\\\ERP\\\\Shipping\\\\Rules\\\\Factory\\:\\:getChild\\(\\) should return QUI\\\\ERP\\\\Shipping\\\\Api\\\\AbstractShippingEntry but returns QUI\\\\CRUD\\\\Child\\.$#"
    count: 1
    path: src/QUI/ERP/Shipping/Rules/Factory.php
    -
    message: "#^Call to an undefined method QUI\\\\ERP\\\\ErpEntityInterface\\:\\:count\\(\\)\\.$#"
    count: 1
    path: src/QUI/ERP/Shipping/Rules/ShippingRule.php
    -
    message: "#^Parameter \\#1 \\$precision of method QUI\\\\ERP\\\\Accounting\\\\CalculationValue\\:\\:precision\\(\\) expects bool, int given\\.$#"
    count: 1
    path: src/QUI/ERP/Shipping/Rules/ShippingRule.php
    -
    message: "#^Parameter \\#2 \\$key of method QUI\\\\Config\\:\\:setValue\\(\\) expects string\\|null, int given\\.$#"
    count: 1
    path: src/QUI/ERP/Shipping/ShippingStatus/Factory.php
    -
    message: "#^Parameter \\#2 \\$key of method QUI\\\\Config\\:\\:del\\(\\) expects string\\|null, int given\\.$#"
    count: 1
    path: src/QUI/ERP/Shipping/ShippingStatus/Handler.php
    -
    message: "#^Parameter \\#2 \\$key of method QUI\\\\Config\\:\\:setValue\\(\\) expects string\\|null, int given\\.$#"
    count: 2
    path: src/QUI/ERP/Shipping/ShippingStatus/Handler.php
    -
    message: "#^Parameter \\#2 \\$callback of function array_filter expects \\(callable\\(mixed\\)\\: bool\\)\\|null, Closure\\(mixed\\)\\: int given\\.$#"
    count: 1
    path: src/QUI/ERP/Shipping/Tracking/Tracking.php
    -
    message: "#^Call to an undefined method QUI\\\\CRUD\\\\Child\\:\\:getShippingType\\(\\)\\.$#"
    count: 2
    path: src/QUI/ERP/Shipping/Types/Factory.php
    -
    message: "#^Method QUI\\\\ERP\\\\Shipping\\\\Types\\\\Factory\\:\\:createChild\\(\\) should return QUI\\\\ERP\\\\Shipping\\\\Types\\\\ShippingEntry but returns QUI\\\\CRUD\\\\Child\\.$#"
    count: 1
    path: src/QUI/ERP/Shipping/Types/Factory.php
    -
    message: "#^Method QUI\\\\ERP\\\\Shipping\\\\Types\\\\Factory\\:\\:getChild\\(\\) should return QUI\\\\ERP\\\\Shipping\\\\Types\\\\ShippingEntry but returns QUI\\\\CRUD\\\\Child\\.$#"
    count: 1
    path: src/QUI/ERP/Shipping/Types/Factory.php
    -
    message: "#^Call to an undefined method QUI\\\\ERP\\\\Shipping\\\\Api\\\\AbstractShippingEntry\\:\\:canUsedIn\\(\\)\\.$#"
    count: 1
    path: src/QUI/ERP/Shipping/Types/ShippingEntry.php
    -
    message: "#^Call to an undefined method QUI\\\\ERP\\\\Shipping\\\\Api\\\\AbstractShippingEntry\\:\\:getPriority\\(\\)\\.$#"
    count: 2
    path: src/QUI/ERP/Shipping/Types/ShippingEntry.php
    -
    message: "#^Call to an undefined method QUI\\\\ERP\\\\Shipping\\\\Api\\\\AbstractShippingEntry\\:\\:isValid\\(\\)\\.$#"
    count: 1
    path: src/QUI/ERP/Shipping/Types/ShippingEntry.php
    -
    message: "#^Call to an undefined method QUI\\\\ERP\\\\Shipping\\\\Api\\\\AbstractShippingEntry\\:\\:noRulesAfter\\(\\)\\.$#"
    count: 1
    path: src/QUI/ERP/Shipping/Types/ShippingEntry.php
    -
    message: "#^Method QUI\\\\ERP\\\\Shipping\\\\Types\\\\ShippingEntry\\:\\:getShippingRules\\(\\) should return array\\<QUI\\\\ERP\\\\Shipping\\\\Rules\\\\ShippingRule\\> but returns array\\<int\\<0, max\\>, QUI\\\\ERP\\\\Shipping\\\\Api\\\\AbstractShippingEntry\\>\\.$#"
    count: 1
    path: src/QUI/ERP/Shipping/Types/ShippingEntry.php
    -
    message: "#^Parameter \\#1 \\$Rule of method QUI\\\\ERP\\\\Shipping\\\\Types\\\\ShippingEntry\\:\\:addShippingRule\\(\\) expects QUI\\\\ERP\\\\Shipping\\\\Rules\\\\ShippingRule, QUI\\\\ERP\\\\Shipping\\\\Api\\\\AbstractShippingEntry given\\.$#"
    count: 1
    path: src/QUI/ERP/Shipping/Types/ShippingEntry.php
    src/QUI/ERP/Shipping/Rules/Factory.php
    + 6
    − 6
    Zeige Datei @ e5ed940a
    ......@@ -285,13 +285,13 @@ public function getChildAttributes(): array
    /**
    * @param int $id
    *
    * @return QUI\ERP\Shipping\Api\AbstractShippingEntry
    * @return ShippingRule
    *
    * @throws QUI\Exception
    */
    public function getChild($id): QUI\CRUD\Child
    public function getChild($id): ShippingRule
    {
    /* @var QUI\ERP\Shipping\Api\AbstractShippingEntry $Shipping */
    /* @var ShippingRule $Shipping */
    $Shipping = parent::getChild($id);
    return $Shipping;
    ......@@ -300,10 +300,10 @@ public function getChild($id): QUI\CRUD\Child
    /**
    * Creates a locale
    *
    * @param $var
    * @param $title
    * @param string $var
    * @param string $title
    */
    protected function createShippingLocale($var, $title): void
    protected function createShippingLocale(string $var, string $title): void
    {
    $current = QUI::getLocale()->getCurrent();
    ......
    src/QUI/ERP/Shipping/ShippingStatus/Factory.php
    + 2
    − 2
    Zeige Datei @ e5ed940a
    ......@@ -32,7 +32,7 @@ class Factory extends QUI\Utils\Singleton
    *
    * @todo permissions
    */
    public function createShippingStatus(int|string $id, string $color, array $title): void
    public function createShippingStatus(int | string $id, string $color, array $title): void
    {
    $list = Handler::getInstance()->getList();
    $id = (int)$id;
    ......@@ -49,7 +49,7 @@ public function createShippingStatus(int|string $id, string $color, array $title
    $Package = QUI::getPackage('quiqqer/shipping');
    $Config = $Package->getConfig();
    $Config->setValue('shipping_status', $id, $color);
    $Config->setValue('shipping_status', (string)$id, $color);
    $Config->save();
    // translations
    ......
    src/QUI/ERP/Shipping/ShippingStatus/Handler.php
    + 3
    − 3
    Zeige Datei @ e5ed940a
    ......@@ -146,7 +146,7 @@ public function deleteShippingStatus(int | string $id): void
    $Package = QUI::getPackage('quiqqer/shipping');
    $Config = $Package->getConfig();
    $Config->del('shipping_status', $Status->getId());
    $Config->del('shipping_status', (string)$Status->getId());
    $Config->save();
    }
    ......@@ -168,7 +168,7 @@ public function setShippingStatusNotification(int $id, bool $notify): void
    $Package = QUI::getPackage('quiqqer/shipping');
    $Config = $Package->getConfig();
    $Config->setValue('shipping_status_notification', $Status->getId(), $notify ? "1" : "0");
    $Config->setValue('shipping_status_notification', (string)$Status->getId(), $notify ? "1" : "0");
    $Config->save();
    }
    ......@@ -216,7 +216,7 @@ public function updateShippingStatus(int $id, int | string $color, array $title)
    $Package = QUI::getPackage('quiqqer/shipping');
    $Config = $Package->getConfig();
    $Config->setValue('shipping_status', $Status->getId(), $color);
    $Config->setValue('shipping_status', (string)$Status->getId(), $color);
    $Config->save();
    }
    ......
    src/QUI/ERP/Shipping/Tracking/Tracking.php
    + 1
    − 1
    Zeige Datei @ e5ed940a
    ......@@ -131,7 +131,7 @@ public static function getActiveCarriers(): array
    );
    return array_filter($data, function ($entry) {
    return (int)$entry['active'];
    return (bool)(int)$entry['active'];
    });
    }
    ......
    src/QUI/ERP/Shipping/Types/Factory.php
    + 9
    − 7
    Zeige Datei @ e5ed940a
    ......@@ -44,7 +44,7 @@ public function __construct()
    * @throws QUI\ERP\Shipping\Exception
    * @throws QUI\Exception
    */
    public function createChild(array $data = []): QUI\CRUD\Child
    public function createChild(array $data = []): ShippingEntry
    {
    if (!isset($data['active']) || !is_integer($data['active'])) {
    $data['active'] = 0;
    ......@@ -64,17 +64,17 @@ public function createChild(array $data = []): QUI\CRUD\Child
    QUI::getEvents()->fireEvent('shippingCreateBegin', [$data['shipping_type']]);
    /* @var $NewChild ShippingEntry */
    /* @var ShippingEntry $NewChild */
    $NewChild = parent::createChild($data);
    $this->createShippingLocale(
    'shipping.' . $NewChild->getId() . '.title',
    $NewChild->getShippingType()->getTitle()
    $NewChild->getShippingType()->getTitle() // @phpstan-ignore-line
    );
    $this->createShippingLocale(
    'shipping.' . $NewChild->getId() . '.workingTitle',
    $NewChild->getShippingType()->getTitle() . ' - ' . $NewChild->getId()
    $NewChild->getShippingType()->getTitle() . ' - ' . $NewChild->getId() // @phpstan-ignore-line
    );
    // description
    ......@@ -88,6 +88,7 @@ public function createChild(array $data = []): QUI\CRUD\Child
    QUI::getEvents()->fireEvent('shippingCreateEnd', [$NewChild]);
    // @phpstan-ignore-next-line
    return $NewChild;
    }
    ......@@ -130,15 +131,16 @@ public function getChildAttributes(): array
    /**
    * @param int $id
    *
    * @return QUI\ERP\Shipping\Types\ShippingEntry
    * @return ShippingEntry
    *
    * @throws QUI\Exception
    */
    public function getChild($id): QUI\CRUD\Child
    public function getChild($id): ShippingEntry
    {
    /* @var QUI\ERP\Shipping\Types\ShippingEntry $Shipping */
    /* @var ShippingEntry $Shipping */
    $Shipping = parent::getChild($id);
    // @phpstan-ignore-next-line
    return $Shipping;
    }
    ......
    src/QUI/ERP/Shipping/Types/ShippingEntry.php
    + 0
    − 1
    Zeige Datei @ e5ed940a
    ......@@ -609,7 +609,6 @@ public function addShippingRule(ShippingRule $Rule): void
    */
    public function addShippingRuleId(int $shippingRuleId): void
    {
    /* @var $Rule ShippingRule */
    $Rule = RuleFactory::getInstance()->getChild($shippingRuleId);
    $this->addShippingRule($Rule);
    }
    ......
    0% oder .
    You are about to add 0 people to the discussion. Proceed with caution.
    Bearbeitung dieser Nachricht zuerst beenden!
    Bitte registrieren oder zum Kommentieren

    PCSG & QUIQQER support and DEV System - GitLab