Final touches before v3

gasparesganga · Aug 30, 2019 · c56d8f5 · c56d8f5
1 parent 043926b
commit c56d8f5
Show file tree

Hide file tree

Showing 3 changed files with 10 additions and 3 deletions.
diff --git a/.gitignore b/.gitignore
@@ -4,4 +4,5 @@ gulpfile.js
 header.txt
 package.json
 package-lock.json
+documentation/
 node_modules/
diff --git a/src/Shapefile/Shapefile.php b/src/Shapefile/Shapefile.php
@@ -851,7 +851,7 @@ protected function getPRJ()
      * Sets PRJ well-known-text.
      *
      * @param   string  $prj    PRJ well-known-text.
-     *                          Pass a falsy value (ie. false or "") to delete it.
+     *                          Pass a falsy value (eg. false or "") to delete it.
      */
     protected function setPRJ($prj)
     {
@@ -873,7 +873,7 @@ protected function getCharset()
      * Sets or resets DBF charset.
      *
      * @param   mixed   $charset    Name of the charset.
-     *                              Pass a falsy value (ie. false or "") to reset it to default.
+     *                              Pass a falsy value (eg. false or "") to reset it to default.
      */
     protected function setCharset($charset)
     {

diff --git a/src/Shapefile/ShapefileWriter.php b/src/Shapefile/ShapefileWriter.php
@@ -129,6 +129,7 @@ public function addField($name, $type, $size, $decimals, $flag_sanitize_name = t
 
     /**
      * Adds a char field to the Shapefile definition.
+     * Returns the effective field name after eventual sanitization.
      * 
      * @param   string  $name               Name of the field. Maximum 10 characters.
      *                                      Only letters, numbers and underscores are allowed.
@@ -145,6 +146,7 @@ public function addCharField($name, $size = 254, $flag_sanitize_name = true)
 
     /**
      * Adds a date field to the Shapefile definition.
+     * Returns the effective field name after eventual sanitization.
      * 
      * @param   string  $name               Name of the field. Maximum 10 characters.
      *                                      Only letters, numbers and underscores are allowed.
@@ -160,6 +162,7 @@ public function addDateField($name, $flag_sanitize_name = true)
 
     /**
      * Adds a logical/boolean field to the Shapefile definition.
+     * Returns the effective field name after eventual sanitization.
      * 
      * @param   string  $name               Name of the field. Maximum 10 characters.
      *                                      Only letters, numbers and underscores are allowed.
@@ -175,6 +178,7 @@ public function addLogicalField($name, $flag_sanitize_name = true)
 
     /**
      * Adds a memo field to the Shapefile definition.
+     * Returns the effective field name after eventual sanitization.
      * 
      * @param   string  $name               Name of the field. Maximum 10 characters.
      *                                      Only letters, numbers and underscores are allowed.
@@ -190,6 +194,7 @@ public function addMemoField($name, $flag_sanitize_name = true)
 
     /**
      * Adds numeric to the Shapefile definition.
+     * Returns the effective field name after eventual sanitization.
      * 
      * @param   string  $name               Name of the field. Maximum 10 characters.
      *                                      Only letters, numbers and underscores are allowed.
@@ -207,6 +212,7 @@ public function addNumericField($name, $size = 10, $decimals = 0, $flag_sanitize
 
     /**
      * Adds floating point to the Shapefile definition.
+     * Returns the effective field name after eventual sanitization.
      * 
      * @param   string  $name               Name of the field. Maximum 10 characters.
      *                                      Only letters, numbers and underscores are allowed.
@@ -976,7 +982,7 @@ private function encodeFieldValue($type, $size, $decimals, $value)
                         $errors     = \DateTime::getLastErrors();
                     }
                     if ($errors['warning_count'] || $errors['error_count']) {
-                        $value = $this->getOption(Shapefile::OPTION_DBF_NULLIFY_INVALID_DATES) ? null : $this->truncateOrPadString(preg_replace('/[^0-9]/', '', $value), $size);
+                        $value = $this->getOption(Shapefile::OPTION_DBF_NULLIFY_INVALID_DATES) ? null : $this->truncateOrPadString($this->sanitizeNumber($value), $size);
                     } else {
                         $value = $DateTime->format('Ymd');
                     }