new option to ignore invalid functions by the scanner

Author: Oscar Otero

CHANGELOG.md

@@ -7,6 +7,10 @@ and this project adheres to [Semantic Versioning](http://semver.org/).
 
 Previous releases are documented in [github releases](https://github.com/oscarotero/Gettext/releases)
 
+## [5.0.1] - Unreleased
+### Added
+- New function `CodeScanner::ignoreInvalidFunctions()` to ignore invalid functions instead throw an exception
+
 ## [5.0.0] - 2019-11-04
 ### Added
 - New interfaces: `ScannerInterface` and `FunctionsScannerInterface`.
@@ -172,6 +176,7 @@ Previous releases are documented in [github releases](https://github.com/oscarot
 [#230]: https://github.com/oscarotero/Gettext/issues/230
 [#231]: https://github.com/oscarotero/Gettext/issues/231
 
+[5.0.1]: https://github.com/oscarotero/Gettext/compare/v5.0.0...HEAD
 [5.0.0]: https://github.com/oscarotero/Gettext/compare/v4.8.0...v5.0.0
 [4.8.0]: https://github.com/oscarotero/Gettext/compare/v4.7.0...v4.8.0
 [4.7.0]: https://github.com/oscarotero/Gettext/compare/v4.6.3...v4.7.0

src/Scanner/CodeScanner.php

@@ -12,6 +12,8 @@
  */
 abstract class CodeScanner extends Scanner
 {
+    protected $ignoreInvalidFunctions = false;
+
     protected $functions = [
         'gettext' => 'gettext',
         '__' => 'gettext',
@@ -51,6 +53,13 @@ public function getFunctions(): array
         return $this->functions;
     }
 
+    public function ignoreInvalidFunctions($ignore = true): self
+    {
+        $this->ignoreInvalidFunctions = $ignore;
+
+        return $this;
+    }
+
     public function scanString(string $string, string $filename): void
     {
         $functionsScanner = $this->getFunctionsScanner();
@@ -81,71 +90,83 @@ protected function handleFunction(ParsedFunction $function)
 
     protected function gettext(ParsedFunction $function): ?Translation
     {
-        static::checkArguments($function, 1);
+        if (!$this->checkFunction($function, 1)) {
+            return null;
+        }
         list($original) = $function->getArguments();
-
         return $this->saveTranslation(null, null, $original);
     }
 
     protected function ngettext(ParsedFunction $function): ?Translation
     {
-        static::checkArguments($function, 2);
+        if (!$this->checkFunction($function, 2)) {
+            return null;
+        }
         list($original, $plural) = $function->getArguments();
-
         return $this->saveTranslation(null, null, $original, $plural);
     }
 
     protected function pgettext(ParsedFunction $function): ?Translation
     {
-        static::checkArguments($function, 2);
+        if (!$this->checkFunction($function, 2)) {
+            return null;
+        }
         list($context, $original) = $function->getArguments();
-
         return $this->saveTranslation(null, $context, $original);
     }
 
     protected function dgettext(ParsedFunction $function): ?Translation
     {
-        static::checkArguments($function, 2);
+        if (!$this->checkFunction($function, 2)) {
+            return null;
+        }
         list($domain, $original) = $function->getArguments();
-
         return $this->saveTranslation($domain, null, $original);
     }
 
     protected function dpgettext(ParsedFunction $function): ?Translation
     {
-        static::checkArguments($function, 3);
+        if (!$this->checkFunction($function, 3)) {
+            return null;
+        }
         list($domain, $context, $original) = $function->getArguments();
-
         return $this->saveTranslation($domain, $context, $original);
     }
 
     protected function npgettext(ParsedFunction $function): ?Translation
     {
-        static::checkArguments($function, 3);
+        if (!$this->checkFunction($function, 3)) {
+            return null;
+        }
         list($context, $original, $plural) = $function->getArguments();
-
         return $this->saveTranslation(null, $context, $original, $plural);
     }
 
     protected function dngettext(ParsedFunction $function): ?Translation
     {
-        static::checkArguments($function, 3);
+        if (!$this->checkFunction($function, 3)) {
+            return null;
+        }
         list($domain, $original, $plural) = $function->getArguments();
-
         return $this->saveTranslation($domain, null, $original, $plural);
     }
 
     protected function dnpgettext(ParsedFunction $function): ?Translation
     {
-        static::checkArguments($function, 4);
+        if (!$this->checkFunction($function, 4)) {
+            return null;
+        }
         list($domain, $context, $original, $plural) = $function->getArguments();
-
         return $this->saveTranslation($domain, $context, $original, $plural);
     }
 
-    protected static function checkArguments(ParsedFunction $function, int $minLength)
+    protected function checkFunction(ParsedFunction $function, int $minLength): bool
     {
         if ($function->countArguments() < $minLength) {
+            if ($this->ignoreInvalidFunctions) {
+                return false;
+            }
+
             throw new Exception(
                 sprintf(
                     'Invalid gettext function in %s:%d. At least %d arguments are required',
@@ -159,6 +180,10 @@ protected static function checkArguments(ParsedFunction $function, int $minLengt
         $arguments = array_slice($function->getArguments(), 0, $minLength);
 
         if (in_array(null, $arguments, true)) {
+            if ($this->ignoreInvalidFunctions) {
+                return false;
+            }
+
             throw new Exception(
                 sprintf(
                     'Invalid gettext function in %s:%d. Some required arguments are not valid',
@@ -167,5 +192,7 @@ protected static function checkArguments(ParsedFunction $function, int $minLengt
                 )
             );
         }
+
+        return true;
     }
 }