Merge pull request #40 from FriendsOfCXML/php_8.4

Php 8.4

Author: mathielen

.github/workflows/ci.yml

@@ -19,6 +19,7 @@ jobs:
         php-version: [
           '8.2',
           '8.3',
+          '8.4'
         ]
 
     steps:

rector.php

@@ -4,6 +4,7 @@
 
 use Rector\Caching\ValueObject\Storage\FileCacheStorage;
 use Rector\Config\RectorConfig;
+use Rector\Php84\Rector\Param\ExplicitNullableParamTypeRector;
 use Rector\PHPUnit\Set\PHPUnitSetList;
 use Rector\Set\ValueObject\SetList;
 use Rector\Symfony\Set\JMSSetList;
@@ -13,9 +14,13 @@
         __DIR__ . '/src',
         __DIR__ . '/tests',
     ])
+    ->withPhpVersion(Rector\ValueObject\PhpVersion::PHP_84) //need this to enable PHP 8.4 features although lower requirement in composer
+    ->withRules([
+        ExplicitNullableParamTypeRector::class, // php8.4 feature, compatible with php8.0
+    ])
     ->withSets([
         JMSSetList::ANNOTATIONS_TO_ATTRIBUTES,
-        PHPUnitSetList::PHPUNIT_100,
+        PHPUnitSetList::PHPUNIT_110,
         PHPUnitSetList::PHPUNIT_CODE_QUALITY,
         PHPUnitSetList::ANNOTATIONS_TO_ATTRIBUTES,
         SetList::TYPE_DECLARATION,
@@ -33,9 +38,10 @@
         \Rector\DeadCode\Rector\ClassMethod\RemoveUnusedPromotedPropertyRector::class,
         //allow to use promoted properties that only purpose is to get serialized
         \Rector\DeadCode\Rector\ClassMethod\RemoveEmptyClassMethodRector::class,
-        //this is stupid and makes code unreadable
+        //this makes code unreadable
         \Rector\Strict\Rector\Ternary\BooleanInTernaryOperatorRuleFixerRector::class,
-        \Rector\Strict\Rector\BooleanNot\BooleanInBooleanNotRuleFixerRector::class
+        \Rector\Strict\Rector\BooleanNot\BooleanInBooleanNotRuleFixerRector::class,
+        \Rector\Php81\Rector\Property\ReadOnlyPropertyRector::class,
     ])
     ->withFileExtensions(['php'])
     ->withCache(

src/CXml/Builder.php

@@ -123,17 +123,17 @@ class Builder
 
     private ?Status $status = null;
 
-    private function __construct(private ?string $senderUserAgent, private readonly ?string $locale = null, PayloadIdentityFactoryInterface $payloadIdentityFactory = null)
+    private function __construct(private ?string $senderUserAgent, private readonly ?string $locale = null, ?PayloadIdentityFactoryInterface $payloadIdentityFactory = null)
     {
         $this->payloadIdentityFactory = $payloadIdentityFactory ?? new DefaultPayloadIdentityFactory();
     }
 
-    public static function create(string $senderUserAgent = 'cxml-php UserAgent', string $locale = null, PayloadIdentityFactoryInterface $payloadIdentityFactory = null): self
+    public static function create(string $senderUserAgent = 'cxml-php UserAgent', ?string $locale = null, ?PayloadIdentityFactoryInterface $payloadIdentityFactory = null): self
     {
         return new self($senderUserAgent, $locale, $payloadIdentityFactory);
     }
 
-    public function payload(PayloadInterface $payload = null): self
+    public function payload(?PayloadInterface $payload = null): self
     {
         $this->payload = $payload;
 
@@ -199,7 +199,7 @@ private function buildHeader(): Header
     /**
      * @throws CXmlException
      */
-    public function build(string $deploymentMode = null): CXml
+    public function build(?string $deploymentMode = null): CXml
     {
         switch (true) {
             case $this->payload instanceof RequestPayloadInterface:

src/CXml/Builder/OrderRequestBuilder.php

@@ -78,9 +78,9 @@ public static function create(
 
     public static function fromPunchOutOrderMessage(
         PunchOutOrderMessage $punchOutOrderMessage,
-        string $currency = null,
-        string $orderId = null,
-        DateTimeInterface $orderDate = null,
+        ?string $currency = null,
+        ?string $orderId = null,
+        ?DateTimeInterface $orderDate = null,
         string $language = 'en',
     ): self {
         if (($supplierOrderInfo = $punchOutOrderMessage->getPunchOutOrderMessageHeader()->getSupplierOrderInfo()) instanceof SupplierOrderInfo) {
@@ -126,13 +126,13 @@ public static function fromPunchOutOrderMessage(
 
     public function billTo(
         string $name,
-        PostalAddress $postalAddress = null,
-        string $addressId = null,
-        string $addressIdDomain = null,
-        string $email = null,
-        Phone $phone = null,
-        string $fax = null,
-        string $url = null,
+        ?PostalAddress $postalAddress = null,
+        ?string $addressId = null,
+        ?string $addressIdDomain = null,
+        ?string $email = null,
+        ?Phone $phone = null,
+        ?string $fax = null,
+        ?string $url = null,
     ): self {
         $this->billTo = new BillTo(
             new Address(
@@ -154,8 +154,8 @@ public function shipTo(
         string $name,
         PostalAddress $postalAddress,
         array $carrierIdentifiers = [],
-        string $carrierAccountNo = null,
-        string $carrierShippingMethod = null,
+        ?string $carrierAccountNo = null,
+        ?string $carrierShippingMethod = null,
     ): self {
         $transportInformation = null;
         if (null !== $carrierAccountNo || null != $carrierShippingMethod) {
@@ -263,7 +263,7 @@ public function addItem(
         return $item;
     }
 
-    public function addComment(string $value = null, string $type = null, string $lang = null, string $attachmentUrl = null): self
+    public function addComment(?string $value = null, ?string $type = null, ?string $lang = null, ?string $attachmentUrl = null): self
     {
         $this->comments[] = new Comment(
             $value,

src/CXml/Builder/ProductActivityMessageBuilder.php

@@ -29,7 +29,7 @@ public static function create(string $messageId, string $warehouseCodeDomain): s
         return new self($messageId, $warehouseCodeDomain);
     }
 
-    public function addProductActivityDetail(string $sku, string $warehouseCode, int $stockLevel, array $extrinsics = null): self
+    public function addProductActivityDetail(string $sku, string $warehouseCode, int $stockLevel, ?array $extrinsics = null): self
     {
         $inventory = Inventory::create()
             ->setStockOnHandQuantity(new InventoryQuantity($stockLevel, 'EA'));

src/CXml/Builder/PunchOutOrderMessageBuilder.php

@@ -47,12 +47,12 @@ private function __construct(private readonly string $language, private readonly
     {
     }
 
-    public static function create(string $language, string $buyerCookie, string $currency, string $operationAllowed = null): self
+    public static function create(string $language, string $buyerCookie, string $currency, ?string $operationAllowed = null): self
     {
         return new self($language, $buyerCookie, $currency, $operationAllowed);
     }
 
-    public function orderReference(string $orderId, DateTimeInterface $orderDate = null): self
+    public function orderReference(string $orderId, ?DateTimeInterface $orderDate = null): self
     {
         $this->orderId = $orderId;
         $this->orderDate = $orderDate;
@@ -64,8 +64,8 @@ public function shipTo(
         string $name,
         PostalAddress $postalAddress,
         array $carrierIdentifiers = [],
-        string $carrierAccountNo = null,
-        string $carrierShippingMethod = null,
+        ?string $carrierAccountNo = null,
+        ?string $carrierShippingMethod = null,
     ): self {
         $transportInformation = null;
         if (null !== $carrierAccountNo || null != $carrierShippingMethod) {
@@ -124,10 +124,10 @@ public function addPunchoutOrderMessageItem(
         string $unitOfMeasure,
         int $unitPrice,
         array $classifications,
-        string $manufacturerPartId = null,
-        string $manufacturerName = null,
-        int $leadTime = null,
-        array $extrinsics = null,
+        ?string $manufacturerPartId = null,
+        ?string $manufacturerName = null,
+        ?int $leadTime = null,
+        ?array $extrinsics = null,
     ): self {
         $itemDetail = ItemDetail::create(
             new Description(

src/CXml/Endpoint.php

@@ -21,7 +21,7 @@ public function __construct(
         private Serializer $serializer,
         private DtdValidator $dtdValidator,
         private Processor $processor,
-        LoggerInterface $logger = null,
+        ?LoggerInterface $logger = null,
     ) {
         $this->logger = $logger ?? new NullLogger();
     }
@@ -30,7 +30,7 @@ public function __construct(
      * @throws CXmlException
      * @throws CXmlInvalidException
      */
-    public function parseAndProcessStringAsCXml(string $xml, Context $context = null): ?CXml
+    public function parseAndProcessStringAsCXml(string $xml, ?Context $context = null): ?CXml
     {
         $this->logger->info('Processing incoming CXml message', ['xml' => $xml]);
 

src/CXml/Exception/CXmlCredentialInvalidException.php

@@ -9,7 +9,7 @@
 
 class CXmlCredentialInvalidException extends CXmlExpectationFailedException
 {
-    public function __construct(string $message, private readonly ?Credential $credential = null, Throwable $previous = null)
+    public function __construct(string $message, private readonly ?Credential $credential = null, ?Throwable $previous = null)
     {
         parent::__construct($message . ($credential instanceof Credential ? "\nCredential was:" . $credential : ''), $previous);
     }

src/CXml/Exception/CXmlException.php

@@ -9,7 +9,7 @@
 
 class CXmlException extends Exception
 {
-    public function __construct(string $message, Throwable $previous = null)
+    public function __construct(string $message, ?Throwable $previous = null)
     {
         parent::__construct($message, 0, $previous);
     }

src/CXml/Handler/Exception/CXmlHandlerNotFoundException.php

@@ -11,7 +11,7 @@
 
 class CXmlHandlerNotFoundException extends CXmlNotImplementedException
 {
-    public function __construct(string $handlerId, Throwable $previous = null)
+    public function __construct(string $handlerId, ?Throwable $previous = null)
     {
         parent::__construct(sprintf('Handler for %s not found. Register first.', $handlerId), $previous);
     }