Helpers in Base and Message arer moved to Segments trait,

removed sender and receiver from Base (use Interchange),
rename a test,
improve composition so that before encoding the objects can be inspected from Interchange (Interchange may contain a group of Messages which can contain Segments)

Author: sabas

.gitattributes

@@ -11,3 +11,4 @@
 /phpunit.gitlab.xml   export-ignore
 /gitlab-test-mysql.sh  export-ignore
 /.gitlab-ci.yml        export-ignore
+codeCoverage/

.gitignore

@@ -11,5 +11,6 @@ coverage
 coverage.xml
 phpunit.local.xml
 .phpunit.result.cache
+.phpunit.cache/
 composer.lock
 /tests/_output

composer.json

@@ -15,8 +15,8 @@
         "codestyle:lint": "vendor/bin/php-cs-fixer fix --dry-run"
     },
     "require-dev": {
-        "sabas/edifact": "^0.4.1",
-        "phpunit/phpunit": "~8.0",
+        "sabas/edifact": "^1.0",
+        "phpunit/phpunit": "~11.0",
         "friendsofphp/php-cs-fixer": "^3.9.5"
     }
 }

phpunit.xml

@@ -1,21 +1,13 @@
 <?xml version="1.0" encoding="UTF-8"?>
-<phpunit backupGlobals="false"
-         backupStaticAttributes="false"
-         bootstrap="vendor/autoload.php"
-         colors="true"
-         convertErrorsToExceptions="true"
-         convertNoticesToExceptions="true"
-         convertWarningsToExceptions="true"
-         processIsolation="false"
-         stopOnFailure="false">
-    <testsuites>
-        <testsuite name="EdiFact-Generator">
-            <directory>./tests/GeneratorTest</directory>
-        </testsuite>
-    </testsuites>
-    <filter>
-        <whitelist processUncoveredFilesFromWhitelist="true">
-            <directory suffix=".php">./src</directory>
-        </whitelist>
-    </filter>
+<phpunit xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="https://schema.phpunit.de/11.4/phpunit.xsd" bootstrap="vendor/autoload.php" colors="true" processIsolation="false" stopOnFailure="false" cacheDirectory=".phpunit.cache" requireCoverageMetadata="false" beStrictAboutCoverageMetadata="true" displayDetailsOnTestsThatTriggerDeprecations="true" displayDetailsOnTestsThatTriggerErrors="true" displayDetailsOnTestsThatTriggerNotices="true" displayDetailsOnTestsThatTriggerWarnings="true">
+  <testsuites>
+    <testsuite name="EdiFact-Generator">
+      <directory>./tests/GeneratorTest</directory>
+    </testsuite>
+  </testsuites>
+  <source>
+    <include>
+      <directory suffix=".php">./src</directory>
+    </include>
+  </source>
 </phpunit>

src/Generator/Base.php

@@ -2,25 +2,23 @@
 
 namespace EDI\Generator;
 
+use EDI\Generator\Traits\Segments;
+
 /**
  * Class Base
  *
  * @package EDI\Generator
  */
 class Base
 {
+    use Segments;
+
     /** @var array */
     protected $messageContent = [];
 
     /** @var array */
     protected $composed;
 
-    /** @var string */
-    protected $sender;
-
-    /** @var string */
-    protected $receiver;
-
     /** @var string */
     //    protected $managingOrganisation = '89';
 
@@ -33,7 +31,7 @@ public function addKeyToCompose($keyName)
     }
 
     /**
-     * compose message by keys givven in an ordered array
+     * compose message by keys given in an ordered array
      *
      * @param array $keys
      *
@@ -74,46 +72,6 @@ public function getComposed()
         return $this->composed;
     }
 
-    /**
-     * @return string
-     */
-    public function getSender()
-    {
-        return $this->sender;
-    }
-
-    /**
-     * @param string $sender
-     *
-     * @return $this
-     */
-    public function setSender($sender)
-    {
-        $this->sender = $sender;
-
-        return $this;
-    }
-
-    /**
-     * @return string
-     */
-    public function getReceiver()
-    {
-        return $this->receiver;
-    }
-
-    /**
-     * @param string $receiver
-     *
-     * @return $this
-     */
-    public function setReceiver($receiver)
-    {
-        $this->receiver = $receiver;
-
-        return $this;
-    }
-
     /**
      * Crop String to max char length
      *
@@ -151,86 +109,4 @@ protected function isAllowed($value, $array, $errorMessage = null)
         }
     }
 
-    /**
-     * SEGMENT UTILITIES
-     */
-
-    /**
-     * @param string, $functionCode
-     * @param $identifier
-     *
-     * @return array|bool
-     */
-    protected static function addRFFSegment($functionCode, $identifier)
-    {
-        if (empty($identifier)) {
-            return false;
-        }
-
-        return [
-            'RFF',
-            [
-                $functionCode,
-                self::maxChars($identifier, 35),
-            ],
-        ];
-    }
-
-    /**
-     * @param string|\DateTime $date
-     * @param string $type
-     * @param int $formatQualifier
-     *
-     * @return array
-     * @throws EdifactException
-     * @see http://www.unece.org/trade/untdid/d96a/trsd/trsddtm.htm
-     */
-    protected static function addDTMSegment($date, $type, $formatQualifier = EdifactDate::DATE)
-    {
-        $data = [];
-        $data[] = (string) $type;
-        if (!empty($date)) {
-            $data[] = EdifactDate::get($date, $formatQualifier);
-            $data[] = (string) $formatQualifier;
-        }
-
-        return ['DTM', $data];
-    }
-
-    /**
-     * @param $documentNumber
-     * @param $type
-     *
-     * @return array
-     */
-    public static function addBGMSegment($documentNumber, $type)
-    {
-        return [
-            'BGM',
-            [
-                $type,
-                '',
-                '89',
-            ],
-            $documentNumber,
-        ];
-    }
-
-    /**
-     * @param $qualifier
-     * @param $value
-     *
-     * @return array
-     */
-    public static function addMOASegment($qualifier, $value)
-    {
-        return [
-            'MOA',
-            [
-                '',
-                (string) $qualifier,
-                EdiFactNumber::convert($value),
-            ],
-        ];
-    }
 }

src/Generator/Interchange.php

@@ -65,14 +65,19 @@ public function setCharset($identifier, $version)
         return $this;
     }
 
+    /**
+     * Set the application reference
+     * $appref Application reference
+     * @param $appref
+     * @return $this
+     */
     public function setApplicationReference($appref)
     {
         $this->appref = $appref;
 
         return $this;
     }
 
-
     /**
      * Add a Message to the Interchange
      * @param $msg
@@ -85,6 +90,15 @@ public function addMessage($msg)
         return $this;
     }
 
+    /**
+     * Return the messages array
+     * @return array
+     */
+    public function getMessages()
+    {
+        return $this->messages;
+    }
+
     /**
      * Format the Interchange segments
      * @return $this
@@ -94,12 +108,17 @@ public function compose()
         $temp = [];
         $unb = ['UNB', $this->charset, $this->sender, $this->receiver, [$this->date, $this->time], $this->interchangeCode];
         if ($this->appref !== null) {
+            $unb[] = '';
             $unb[] = $this->appref;
         }
 
         $temp[] = $unb;
         foreach ($this->messages as $msg) {
-            foreach ($msg->getComposed() as $i) {
+            $msgContent = $msg->getComposed();
+            if ($msgContent === null) {
+                $msgContent = $msg->compose()->getComposed();
+            }
+            foreach ($msgContent as $i) {
                 $temp[] = $i;
             }
         }