remove deprecated methods

Author: nyamsprod

CHANGELOG.md

@@ -6,18 +6,20 @@ All Notable changes to `League\Csv` will be documented in this file
 ### Added
 - Stream Filter API in `League\Csv\AbstractCsv`
 - named constructors `createFromPath` and `createFromFileObject` in `League\Csv\AbstractCsv` to ease CSV object instantiation
-- `detectDelimiters` in `League\Csv\AbstractCsv` to replace and remove the use of `Exception` in `detectDelimiter`
-- `setEncodingFrom` and `setDecodingFrom` in `League\Csv\AbstractCsv`
+- `detectDelimiterList` in `League\Csv\AbstractCsv` to replace and remove the use of `Exception` in `detectDelimiter`
+- `setEncodingFrom` and `setDecodingFrom` in `League\Csv\AbstractCsv` to replace `setEncoding` and `getEncoding` for naming consistency
 
 ### Deprecated
-- `detectDelimiter` in `League\Csv\AbstractCsv` in favor of `detectDelimiters`
-- `setEncoding` and `getEncoding` in `League\Csv\AbstractCsv` replaced by `setEncodingFrom` and `setDecodingFrom` for naming consistency
+- Nothing
 
 ### Fixed
 - `League\Csv\Reader::each` more stric `$callable` MUST returns true
 
 ### Remove
-- Nothing
+- `detectDelimiter`
+- `setEncoding` and `getEncoding`
+- `League\Csv\Reader::setSortBy`
+- `League\Csv\Reader::setFilter`
 
 ### Security
 - Nothing
@@ -126,7 +128,7 @@ All Notable changes to `League\Csv` will be documented in this file
 - Nothing
 
 ### Remove
-- Change namespace from `Bakame\Csv` to `League\Csv`
+- Nothing
 
 ### Security
 - Nothing

src/AbstractCsv.php

@@ -4,23 +4,20 @@
 *
 * @license http://opensource.org/licenses/MIT
 * @link https://github.com/thephpleague/csv/
-* @version 5.5.0
+* @version 6.0.0
 * @package League.csv
 *
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 */
 namespace League\Csv;
 
-use CallbackFilterIterator;
 use DomDocument;
 use InvalidArgumentException;
 use IteratorAggregate;
 use JsonSerializable;
 use League\Csv\Config\Controls;
 use League\Csv\Config\StreamFilter;
-use LimitIterator;
-use RuntimeException;
 use SplFileInfo;
 use SplFileObject;
 use SplTempFileObject;
@@ -243,86 +240,6 @@ public function newReader($open_mode = 'r+')
         return $this->newInstance('\League\Csv\Reader', $open_mode);
     }
 
-    /**
-     * detect the actual number of row according to a delimiter
-     *
-     * @param string  $delimiter a CSV delimiter
-     * @param integer $nb_rows   the number of row to consider
-     *
-     * @return integer
-     */
-    protected function fetchRowsCountByDelimiter($delimiter, $nb_rows = 1)
-    {
-        $iterator = $this->getIterator();
-        $iterator->setCsvControl($delimiter, $this->enclosure, $this->escape);
-        //"reduce" the csv length to a maximum of $nb_rows
-        $iterator = new LimitIterator($iterator, 0, $nb_rows);
-        //return the parse rows
-        $iterator = new CallbackFilterIterator($iterator, function ($row) {
-            return is_array($row) && count($row) > 1;
-        });
-
-        return count(iterator_to_array($iterator, false));
-    }
-
-    /**
-     * Detect the CSV file delimiter
-     *
-     * @param integer  $nb_rows
-     * @param string[] $delimiters additional delimiters
-     *
-     * @return string[]
-     *
-     * @throws \InvalidArgumentException If $nb_rows value is invalid
-     */
-    public function detectDelimiters($nb_rows = 1, array $delimiters = [])
-    {
-        $nb_rows = filter_var($nb_rows, FILTER_VALIDATE_INT, ['options' => ['min_range' => 1]]);
-        if (! $nb_rows) {
-            throw new InvalidArgumentException('`$nb_rows` must be a valid positive integer');
-        }
-
-        $delimiters = array_filter($delimiters, function ($str) {
-            return 1 == mb_strlen($str);
-        });
-        $delimiters = array_merge([$this->delimiter, ',', ';', "\t"], $delimiters);
-        $delimiters = array_unique($delimiters);
-        $res = array_fill_keys($delimiters, 0);
-        array_walk($res, function (&$value, $delim) use ($nb_rows) {
-            $value = $this->fetchRowsCountByDelimiter($delim, $nb_rows);
-        });
-
-        arsort($res, SORT_NUMERIC);
-
-        return array_keys(array_filter($res));
-    }
-
-    /**
-     * DEPRECATION WARNING! This method will be removed in the next major point release
-     *
-     * @deprecated deprecated since version 5.5
-     *
-     * Detect the CSV file delimiter
-     *
-     * @param integer  $nb_rows
-     * @param string[] $delimiters additional delimiters
-     *
-     * @return null|string
-     *
-     * @throws \InvalidArgumentException If $nb_rows value is invalid
-     * @throws \RuntimeException         If too many delimiters are found
-     */
-    public function detectDelimiter($nb_rows = 1, array $delimiters = [])
-    {
-        $res = $this->detectDelimiters($nb_rows, $delimiters);
-        if (! $res) {
-            return null;
-        } elseif (1 == count($res)) {
-            return $res[0];
-        }
-        throw new RuntimeException('too many delimiters were found: `'.implode('`,`', $res).'`');
-    }
-
     /**
      * Return the CSV Iterator
      *
@@ -430,4 +347,16 @@ public function toHTML($class_name = 'table-csv-data')
 
         return $doc->saveHTML($doc->documentElement);
     }
+
+    /**
+    * Validate a variable to be stringable
+    *
+    * @param mixed $str
+    *
+    * @return boolean
+    */
+    public static function isValidString($str)
+    {
+        return is_scalar($str) || (is_object($str) && method_exists($str, '__toString'));
+    }
 }

src/Config/Controls.php

@@ -4,16 +4,18 @@
 *
 * @license http://opensource.org/licenses/MIT
 * @link https://github.com/thephpleague/csv/
-* @version 5.5.0
+* @version 6.0.0
 * @package League.csv
 *
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 */
 namespace League\Csv\Config;
 
+use CallbackFilterIterator;
 use InvalidArgumentException;
 use League\Csv\Iterator\MapIterator;
+use LimitIterator;
 use SplFileObject;
 use Traversable;
 
@@ -66,7 +68,7 @@ trait Controls
      *
      * @param string $delimiter
      *
-     * @return self
+     * @return $this
      *
      * @throws \InvalidArgumentException If $delimeter is not a single character
      */
@@ -90,12 +92,73 @@ public function getDelimiter()
         return $this->delimiter;
     }
 
+    /**
+     * detect the actual number of row according to a delimiter
+     *
+     * @param string  $delimiter a CSV delimiter
+     * @param integer $nb_rows   the number of row to consider
+     *
+     * @return integer
+     */
+    protected function fetchRowsCountByDelimiter($delimiter, $nb_rows = 1)
+    {
+        $iterator = $this->getIterator();
+        $iterator->setCsvControl($delimiter, $this->enclosure, $this->escape);
+        //"reduce" the csv length to a maximum of $nb_rows
+        $iterator = new LimitIterator($iterator, 0, $nb_rows);
+        //return the parse rows
+        $iterator = new CallbackFilterIterator($iterator, function ($row) {
+            return is_array($row) && count($row) > 1;
+        });
+
+        return count(iterator_to_array($iterator, false));
+    }
+
+    /**
+     * Detect the CSV file delimiter
+     *
+     * @param integer  $nb_rows
+     * @param string[] $delimiters additional delimiters
+     *
+     * @return string[]
+     *
+     * @throws \InvalidArgumentException If $nb_rows value is invalid
+     */
+    public function detectDelimiterList($nb_rows = 1, array $delimiters = [])
+    {
+        $nb_rows = filter_var($nb_rows, FILTER_VALIDATE_INT, ['options' => ['min_range' => 1]]);
+        if (! $nb_rows) {
+            throw new InvalidArgumentException('`$nb_rows` must be a valid positive integer');
+        }
+
+        $delimiters = array_filter($delimiters, function ($str) {
+            return 1 == mb_strlen($str);
+        });
+        $delimiters = array_merge([$this->delimiter, ',', ';', "\t"], $delimiters);
+        $delimiters = array_unique($delimiters);
+        $res = array_fill_keys($delimiters, 0);
+        array_walk($res, function (&$value, $delim) use ($nb_rows) {
+            $value = $this->fetchRowsCountByDelimiter($delim, $nb_rows);
+        });
+
+        arsort($res, SORT_NUMERIC);
+
+        return array_keys(array_filter($res));
+    }
+
+    /**
+     * return a SplFileOjbect
+     *
+     * @return \SplFileOjbect
+     */
+    abstract public function getIterator();
+
     /**
      * set the field enclosure
      *
      * @param string $enclosure
      *
-     * @return self
+     * @return $this
      *
      * @throws \InvalidArgumentException If $enclosure is not a single character
      */
@@ -124,7 +187,7 @@ public function getEnclosure()
      *
      * @param string $escape
      *
-     * @return self
+     * @return $this
      *
      * @throws \InvalidArgumentException If $escape is not a single character
      */
@@ -153,7 +216,7 @@ public function getEscape()
      *
      * @param integer $flags
      *
-     * @return self
+     * @return $this
      *
      * @throws \InvalidArgumentException If the argument is not a valid integer
      */
@@ -178,38 +241,12 @@ public function getFlags()
         return $this->flags;
     }
 
-    /**
-     * DEPRECATION WARNING! This method will be removed in the next major point release
-     *
-     * @deprecated deprecated since version 5.5
-     *
-     * @param string $str
-     *
-     * @return static The invoked object
-     */
-    public function setEncoding($str)
-    {
-        return $this->setEncodingFrom($str);
-    }
-
-    /**
-     * DEPRECATION WARNING! This method will be removed in the next major point release
-     *
-     * @deprecated deprecated since version 5.5
-     *
-     * @return string
-     */
-    public function getEncoding()
-    {
-        return $this->getEncodingFrom();
-    }
-
     /**
      * Set the CSV encoding charset
      *
      * @param string $str
      *
-     * @return self
+     * @return $this
      */
     public function setEncodingFrom($str)
     {
@@ -253,16 +290,4 @@ protected function convertToUtf8(Traversable $iterator)
             return $row;
         });
     }
-
-    /**
-    * Validate a variable to be stringable
-    *
-    * @param mixed $str
-    *
-    * @return boolean
-    */
-    public static function isValidString($str)
-    {
-        return is_scalar($str) || (is_object($str) && method_exists($str, '__toString'));
-    }
 }

src/Config/StreamFilter.php

@@ -4,7 +4,7 @@
 *
 * @license http://opensource.org/licenses/MIT
 * @link https://github.com/thephpleague/csv/
-* @version 5.5.0
+* @version 6.0.0
 * @package League.csv
 *
 * For the full copyright and license information, please view the LICENSE