diff options
Diffstat (limited to 'src/Config')
| -rw-r--r-- | src/Config/Controls.php | 36 | ||||
| -rw-r--r-- | src/Config/StreamFilter.php | 22 |
2 files changed, 26 insertions, 32 deletions
diff --git a/src/Config/Controls.php b/src/Config/Controls.php index 96ae302..fb2dd7e 100644 --- a/src/Config/Controls.php +++ b/src/Config/Controls.php @@ -4,7 +4,7 @@ * * @license http://opensource.org/licenses/MIT * @link https://github.com/thephpleague/csv/ -* @version 6.0.0 +* @version 6.0.1 * @package League.csv * * For the full copyright and license information, please view the LICENSE @@ -50,7 +50,7 @@ trait Controls /** * the \SplFileObject flags holder * - * @var integer + * @var int */ protected $flags = SplFileObject::READ_CSV; @@ -66,9 +66,9 @@ trait Controls * * @param string $delimiter * - * @return $this - * * @throws \InvalidArgumentException If $delimeter is not a single character + * + * @return $this */ public function setDelimiter($delimiter = ',') { @@ -93,10 +93,10 @@ trait Controls /** * 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 + * @param string $delimiter a CSV delimiter + * @param int $nb_rows the number of row to consider * - * @return integer + * @return int */ protected function fetchRowsCountByDelimiter($delimiter, $nb_rows = 1) { @@ -115,12 +115,12 @@ trait Controls /** * Detect the CSV file delimiter * - * @param integer $nb_rows + * @param int $nb_rows * @param string[] $delimiters additional delimiters * - * @return string[] - * * @throws \InvalidArgumentException If $nb_rows value is invalid + * + * @return string[] */ public function detectDelimiterList($nb_rows = 1, array $delimiters = []) { @@ -149,9 +149,9 @@ trait Controls * * @param string $enclosure * - * @return $this - * * @throws \InvalidArgumentException If $enclosure is not a single character + * + * @return $this */ public function setEnclosure($enclosure = '"') { @@ -178,9 +178,9 @@ trait Controls * * @param string $escape * - * @return $this - * * @throws \InvalidArgumentException If $escape is not a single character + * + * @return $this */ public function setEscape($escape = "\\") { @@ -205,11 +205,11 @@ trait Controls /** * Set the Flags associated to the CSV SplFileObject * - * @param integer $flags - * - * @return $this + * @param int $flags * * @throws \InvalidArgumentException If the argument is not a valid integer + * + * @return $this */ public function setFlags($flags) { @@ -225,7 +225,7 @@ trait Controls /** * Returns the file Flags * - * @return integer + * @return int */ public function getFlags() { diff --git a/src/Config/StreamFilter.php b/src/Config/StreamFilter.php index 7e02fcc..72e88f8 100644 --- a/src/Config/StreamFilter.php +++ b/src/Config/StreamFilter.php @@ -4,7 +4,7 @@ * * @license http://opensource.org/licenses/MIT * @link https://github.com/thephpleague/csv/ -* @version 6.0.0 +* @version 6.0.1 * @package League.csv * * For the full copyright and license information, please view the LICENSE @@ -36,7 +36,7 @@ trait StreamFilter /** * Stream filtering mode to apply on all filters * - * @var integer + * @var int */ protected $stream_filter_mode = STREAM_FILTER_ALL; @@ -56,8 +56,6 @@ trait StreamFilter * a path to a file * * @param \SplFileObject|string $path The file path - * - * @return void */ protected function initStreamFilter($path) { @@ -75,8 +73,6 @@ trait StreamFilter * Extract Available stream settings from $path * * @param string $path the file path - * - * @return void */ protected function extractStreamSettings($path) { @@ -105,8 +101,6 @@ trait StreamFilter /** * Check if the trait methods can be used * - * @return void - * * @throws \LogicException If the API can not be use */ protected function assertStreamable() @@ -119,7 +113,7 @@ trait StreamFilter /** * Tells whether the stream filter capabilities can be used * - * @return boolean + * @return bool */ public function isActiveStreamFilter() { @@ -132,11 +126,11 @@ trait StreamFilter * Set the new Stream Filter mode and remove all * previously attached stream filters * - * @param integer $mode - * - * @return $this + * @param int $mode * * @throws \OutOfBoundsException If the mode is invalid + * + * @return $this */ public function setStreamFilterMode($mode) { @@ -154,7 +148,7 @@ trait StreamFilter /** * stream filter mode getter * - * @return integer + * @return int */ public function getStreamFilterMode() { @@ -213,7 +207,7 @@ trait StreamFilter * * @param string $filter_name * - * @return boolean + * @return bool */ public function hasStreamFilter($filter_name) { |