Merge pull request #43 from gersonfs/master

robmachado · web-flow · commit 79e176e0cd5b · 2025-05-30T17:26:54.000-03:00
Atualizando tabela de prefixos GS1
diff --git a/README.md b/README.md
@@ -144,6 +144,10 @@ Este pacote é aderente com os [PSR-1], [PSR-2] e [PSR-4]. Se você observar neg
 
 Não deixe de se cadastrar no [grupo de discussão do NFePHP](http://groups.google.com/group/nfephp) para acompanhar o desenvolvimento e participar das discussões e tirar dúvidas!
 
+## Atualizando a tabela de prefixos GS1
+
+Faça o download da tabela do site https://www.nfe.fazenda.gov.br/ e exporte a planilha com os prefixos em formato UTF-8 CSV pelo Excel.
+
 ## Install
 
 **Este pacote está listado no [Packgist](https://packagist.org/) foi desenvolvido para uso do [Composer](https://getcomposer.org/), portanto não será explicitada nenhuma alternativa de instalação.**
diff --git a/src/Gtin.php b/src/Gtin.php
@@ -42,10 +42,11 @@ final class Gtin
      * Length of GTIN
      */
     protected int $lenght;
+
     /**
-     * Prefixes collection
+     * Tabela de prefixos GS1 baixado do site nfe.fazenda.gov.br e convertido em CSV
      */
-    protected array $stdPrefixCollection;
+    protected array $tabelaPrefixoGs1 = [];
     /**
      * Validation of prefix of GTIN
      */
@@ -84,9 +85,11 @@ public function __construct(?string $gtin = null, ?Certificate $certificate = nu
             $this->validPrefix = true;
             return;
         }
-        $this->stdPrefixCollection = json_decode(
-            file_get_contents(__DIR__.'/prefixcollection.json')
-        );
+
+        $linhas = file(__DIR__ . '/Tabela_Prefixo_GS1.csv', FILE_IGNORE_NEW_LINES);
+        unset($linhas[0]); //Remove o header
+        $this->tabelaPrefixoGs1 = $linhas;
+
         if (empty($gtin)) {
             throw new \InvalidArgumentException("Um numero GTIN deve ser passado.");
         }
@@ -279,8 +282,9 @@ protected function getCheckDigit(): int
 
     protected function getPrefixDefinition(string $prefix): ?PrefixDefinition
     {
-        foreach ($this->stdPrefixCollection as $std) {
-            $definition = new PrefixDefinition($std);
+        foreach ($this->tabelaPrefixoGs1 as $registro) {
+            [$nIni, $nFim, $restrito, $regiao] = explode(';', $registro);
+            $definition = new PrefixDefinition($nIni, $nFim, $restrito, $regiao);
             if ($definition->hasPrefix($prefix)) {
                 return $definition;
             }
diff --git a/src/PrefixDefinition.php b/src/PrefixDefinition.php
@@ -4,29 +4,35 @@
 
 class PrefixDefinition
 {
-    private \stdClass $std;
 
-    public function __construct(\stdClass $std)
+    private string $nIni;
+    private string $nFim;
+    private string $restricted;
+    private string $region;
+    public function __construct(string $nIni, string $nFim, string $restricted, string $region)
     {
-        $this->std = $std;
+        $this->nIni = $nIni;
+        $this->nFim = $nFim;
+        $this->restricted = $restricted;
+        $this->region = $region;
     }
 
     public function getRegion(): string
     {
-        return (string)$this->std->region;
+        return $this->region;
     }
 
     public function hasPrefix(string $prefix): bool
     {
         $pf = (int) $prefix;
-        $nI = (int) $this->std->nIni;
-        $nF = (int) $this->std->nFim;
+        $nI = (int) $this->nIni;
+        $nF = (int) $this->nFim;
         return $pf >= $nI && $pf <= $nF;
     }
 
     public function isRestricted(): bool
     {
-        return $this->std->restricted == "1";
+        return $this->restricted == '1';
     }
 
 }
diff --git a/src/Tabela_Prefixo_GS1.csv b/src/Tabela_Prefixo_GS1.csv
@@ -0,0 +1,128 @@
+﻿fxPrefixIni;fxPrefixFim;indEsp;fxPais_Nome
+000;019;0;GS1 US
+020;029;1;Números de circulação restrita dentro da região
+030;039;0;GS1 US
+040;049;1;GS1 Números de circulação restrita dentro da empresa
+050;059;1;GS1 US reserved for future use
+060;139;0;GS1 US
+200;299;1;GS1 Números de circulação restrita dentro da região
+300;379;0;GS1 France
+380;380;0;GS1 Bulgaria
+383;383;0;GS1 Slovenija
+385;385;0;GS1 Croatia
+387;387;0;GS1 BIH (Bosnia-Herzegovina)
+389;389;0;GS1 Montenegro
+400;440;0;GS1 Germany
+450;459;0;GS1 Japan
+490;499;0;GS1 Japan
+460;469;0;GS1 Russia
+470;470;0;GS1 Kyrgyzstan
+471;471;0;GS1 Taiwan
+474;474;0;GS1 Estonia
+475;475;0;GS1 Latvia
+476;476;0;GS1 Azerbaijan
+477;477;0;GS1 Lithuania
+478;478;0;GS1 Uzbekistan
+479;479;0;GS1 Sri Lanka
+480;480;0;GS1 Philippines
+481;481;0;GS1 Belarus
+482;482;0;GS1 Ukraine
+483;483;0;GS1 Turkmenistan
+484;484;0;GS1 Moldova
+485;485;0;GS1 Armenia
+486;486;0;GS1 Georgia
+487;487;0;GS1 Kazakstan
+488;488;0;GS1 Tajikistan
+489;489;0;GS1 Hong Kong
+500;509;0;GS1 UK
+520;521;0;GS1 Association Greece
+528;528;0;GS1 Lebanon
+529;529;0;GS1 Cyprus
+530;530;0;GS1 Albania
+531;531;0;GS1 Macedonia
+535;535;0;GS1 Malta
+539;539;0;GS1 Ireland
+540;549;0;GS1 Belgium & Luxembourg
+560;560;0;GS1 Portugal
+569;569;0;GS1 Iceland
+570;579;0;GS1 Denmark
+590;590;0;GS1 Poland
+594;594;0;GS1 Romania
+599;599;0;GS1 Hungary
+600;601;0;GS1 South Africa
+603;603;0;GS1 Ghana
+604;604;0;GS1 Senegal
+608;608;0;GS1 Bahrain
+609;609;0;GS1 Mauritius
+611;611;0;GS1 Morocco
+613;613;0;GS1 Algeria
+615;615;0;GS1 Nigeria
+616;616;0;GS1 Kenya
+618;618;0;GS1 Ivory Coast
+619;619;0;GS1 Tunisia
+620;620;0;GS1 Tanzania
+621;621;0;GS1 Syria
+622;622;0;GS1 Egypt
+623;623;0;GS1 Brunei
+624;624;0;GS1 Libya
+625;625;0;GS1 Jordan
+626;626;0;GS1 Iran
+627;627;0;GS1 Kuwait
+628;628;0;GS1 Saudi Arabia
+629;629;0;GS1 Emirates
+640;649;0;GS1 Finland
+690;699;0;GS1 China
+700;709;0;GS1 Norway
+729;729;0;GS1 Israel
+730;739;0;GS1 Sweden
+740;740;0;GS1 Guatemala
+741;741;0;GS1 El Salvador
+742;742;0;GS1 Honduras
+743;743;0;GS1 Nicaragua
+744;744;0;GS1 Costa Rica
+745;745;0;GS1 Panama
+746;746;0;GS1 Republica Dominicana
+750;750;0;GS1 Mexico
+754;755;0;GS1 Canada
+759;759;0;GS1 Venezuela
+760;769;0;GS1 Schweiz, Suisse, Svizzera
+770;771;0;GS1 Colombia
+773;773;0;GS1 Uruguay
+775;775;0;GS1 Peru
+777;777;0;GS1 Bolivia
+778;779;0;GS1 Argentina
+780;780;0;GS1 Chile
+784;784;0;GS1 Paraguay
+786;786;0;GS1 Ecuador
+789;790;0;GS1 Brasil
+800;839;0;GS1 Italy
+840;849;0;GS1 Spain
+850;850;0;GS1 Cuba
+858;858;0;GS1 Slovakia
+859;859;0;GS1 Czech
+860;860;0; GS1 Serbia
+865;865;0;GS1 Mongolia
+867;867;0;GS1 North Korea
+868;869;0;GS1 Turkey
+870;879;0;GS1 Netherlands
+880;880;0;GS1 South Korea
+884;884;0;GS1 Cambodia
+885;885;0;GS1 Thailand
+888;888;0;GS1 Singapore
+890;890;0;GS1 India
+893;893;0;GS1 Vietnam
+896;896;0;GS1 Pakistan
+899;899;0;GS1 Indonesia
+900;919;0;GS1 Austria
+930;939;0;GS1 Australia
+940;949;0;GS1 New Zealand
+950;950;1;GS1 Global Office
+951;951;1;Numera‡Æo para EPC Tag Data Standard
+955;955;0;GS1 Malaysia
+958;958;0;GS1 Macau
+960;969;1;Global Office (GTIN-8s)
+977;977;1;Serial publications (ISSN)
+978;979;1;Bookland (ISBN)
+980;980;1;Refund receipts
+981;984;1;GS1 Coupon identification for common currency areas
+990;999;1;GS1 Coupon identification
diff --git a/src/prefixcollection.json b/src/prefixcollection.json
diff --git a/tests/GtinTest.php b/tests/GtinTest.php
@@ -244,8 +244,15 @@ public function test_is_restricted(): void
 
     public function test_is_restricted_invalid_prefix(): void
     {
-        $this->expectErrorMessage("510 is not a valid prefix!");
+        $this->expectExceptionMessage("510 is not a valid prefix!");
         $gtin = new Gtin('5109907267612');
         $gtin->isRestricted();
     }
+
+    public function test_invalid_prefix(): void
+    {
+        $this->expectExceptionMessage("O prefixo 606 do GTIN é INVALIDO [Not Found].");
+        $gtin = new Gtin('6065299511600');
+        $gtin->isValid();
+    }
 }
diff --git a/tests/PrefixDefinitionTest.php b/tests/PrefixDefinitionTest.php
@@ -10,45 +10,25 @@ class PrefixDefinitionTest extends TestCase
 
     public function test_is_restricted(): void
     {
-        $definition = new PrefixDefinition((object)[
-            "nIni" => "000",
-            "nFim" => "019",
-            "restricted" => "0",
-            "region" => "GS1 US"
-        ]);
+        $definition = new PrefixDefinition("000", "019", "0", "GS1 US");
         $this->assertFalse($definition->isRestricted());
     }
 
     public function test_is_not_restricted(): void
     {
-        $definition = new PrefixDefinition((object)[
-            "nIni" => "020",
-            "nFim" => "029",
-            "restricted" => "1",
-            "region" => "Números de circulação restrita dentro da região"
-        ]);
+        $definition = new PrefixDefinition("020", "029", "1", "Números de circulação restrita dentro da região");
         $this->assertTrue($definition->isRestricted());
     }
 
     public function test_get_region(): void
     {
-        $definition = new PrefixDefinition((object)[
-            "nIni" => "020",
-            "nFim" => "029",
-            "restricted" => "1",
-            "region" => "Números de circulação restrita dentro da região"
-        ]);
+        $definition = new PrefixDefinition("020", "029", "1", "Números de circulação restrita dentro da região");
         $this->assertEquals("Números de circulação restrita dentro da região", $definition->getRegion());
     }
 
     public function testHasPrefix(): void
     {
-        $definition = new PrefixDefinition((object)[
-            "nIni" => "020",
-            "nFim" => "029",
-            "restricted" => "1",
-            "region" => "Números de circulação restrita dentro da região"
-        ]);
+        $definition = new PrefixDefinition("020", "029", "1", "Números de circulação restrita dentro da região");
 
         $this->assertFalse($definition->hasPrefix("999"));
         $this->assertFalse($definition->hasPrefix("030"));

Original file line number	Diff line number	Diff line change
`@@ -4,29 +4,35 @@`
`4`	`4`
`5`	`5`	`class PrefixDefinition`
`6`	`6`	`{`
`7`		`- private \stdClass $std;`
`8`	`7`
`9`		`- public function __construct(\stdClass $std)`
	`8`	`+ private string $nIni;`
	`9`	`+ private string $nFim;`
	`10`	`+ private string $restricted;`
	`11`	`+ private string $region;`
	`12`	`+ public function __construct(string $nIni, string $nFim, string $restricted, string $region)`
`10`	`13`	`{`
`11`		`- $this->std = $std;`
	`14`	`+ $this->nIni = $nIni;`
	`15`	`+ $this->nFim = $nFim;`
	`16`	`+ $this->restricted = $restricted;`
	`17`	`+ $this->region = $region;`
`12`	`18`	`}`
`13`	`19`
`14`	`20`	`public function getRegion(): string`
`15`	`21`	`{`
`16`		`- return (string)$this->std->region;`
	`22`	`+ return $this->region;`
`17`	`23`	`}`
`18`	`24`
`19`	`25`	`public function hasPrefix(string $prefix): bool`
`20`	`26`	`{`
`21`	`27`	`$pf = (int) $prefix;`
`22`		`- $nI = (int) $this->std->nIni;`
`23`		`- $nF = (int) $this->std->nFim;`
	`28`	`+ $nI = (int) $this->nIni;`
	`29`	`+ $nF = (int) $this->nFim;`
`24`	`30`	`return $pf >= $nI && $pf <= $nF;`
`25`	`31`	`}`
`26`	`32`
`27`	`33`	`public function isRestricted(): bool`
`28`	`34`	`{`
`29`		`- return $this->std->restricted == "1";`
	`35`	`+ return $this->restricted == '1';`
`30`	`36`	`}`
`31`	`37`
`32`	`38`	`}`
Original file line number	Diff line number	Diff line change
`@@ -244,8 +244,15 @@ public function test_is_restricted(): void`
`244`	`244`
`245`	`245`	`public function test_is_restricted_invalid_prefix(): void`
`246`	`246`	`{`
`247`		`- $this->expectErrorMessage("510 is not a valid prefix!");`
	`247`	`+ $this->expectExceptionMessage("510 is not a valid prefix!");`
`248`	`248`	`$gtin = new Gtin('5109907267612');`
`249`	`249`	`$gtin->isRestricted();`
`250`	`250`	`}`
	`251`	`+`
	`252`	`+ public function test_invalid_prefix(): void`
	`253`	`+ {`
	`254`	`+ $this->expectExceptionMessage("O prefixo 606 do GTIN é INVALIDO [Not Found].");`
	`255`	`+ $gtin = new Gtin('6065299511600');`
	`256`	`+ $gtin->isValid();`
	`257`	`+ }`
`251`	`258`	`}`