parsecsv/parsecsv-for-php
1
0
Fork 0
mirror of https://github.com/parsecsv/parsecsv-for-php.git synced 2026-02-19 08:36:39 +00:00
Code Issues Packages Projects Releases Wiki Activity

Formated code using PhpStorm 2019.2.1 - only DocBlocks changed

Browse Source
This commit is contained in:
Fonata
2019-09-14 01:04:53 +02:00
parent a286556c16
commit 62ae4e5fc3
1 changed files with 38 additions and 38 deletions
Download Patch File Download Diff File Expand all files Collapse all files

76
src/Csv.php
View File

@@ -299,14 +299,14 @@ class Csv {
* Constructor * Constructor
* Class constructor * Class constructor
* *
* @param string|null $input The CSV string or a direct file path * @param string|null $input The CSV string or a direct file path
* @param integer|null $offset Number of rows to ignore from the * @param integer|null $offset Number of rows to ignore from the
* beginning of the data * beginning of the data
* @param integer|null $limit Limits the number of returned rows * @param integer|null $limit Limits the number of returned rows
* to specified amount * to specified amount
* @param string|null $conditions Basic SQL-like conditions for row * @param string|null $conditions Basic SQL-like conditions for row
* matching * matching
* @param null|true $keep_file_data Keep raw file data in memory after * @param null|true $keep_file_data Keep raw file data in memory after
* successful parsing * successful parsing
* (useful for debugging) * (useful for debugging)
*/ */
@@ -319,13 +319,13 @@ class Csv {
} }
/** /**
* @param integer|null $offset Number of rows to ignore from the * @param integer|null $offset Number of rows to ignore from the
* beginning of the data * beginning of the data
* @param integer|null $limit Limits the number of returned rows * @param integer|null $limit Limits the number of returned rows
* to specified amount * to specified amount
* @param string|null $conditions Basic SQL-like conditions for row * @param string|null $conditions Basic SQL-like conditions for row
* matching * matching
* @param null|true $keep_file_data Keep raw file data in memory after * @param null|true $keep_file_data Keep raw file data in memory after
* successful parsing * successful parsing
* (useful for debugging) * (useful for debugging)
*/ */
@@ -355,12 +355,12 @@ class Csv {
* Parse * Parse
* Parse a CSV file or string * Parse a CSV file or string
* *
* @param string|null $input The CSV string or a direct file path * @param string|null $input The CSV string or a direct file path
* @param integer $offset Number of rows to ignore from the * @param integer $offset Number of rows to ignore from the
* beginning of the data * beginning of the data
* @param integer $limit Limits the number of returned rows to * @param integer $limit Limits the number of returned rows to
* specified amount * specified amount
* @param string $conditions Basic SQL-like conditions for row * @param string $conditions Basic SQL-like conditions for row
* matching * matching
* *
* @return bool True on success * @return bool True on success
@@ -392,11 +392,11 @@ class Csv {
* Save * Save
* Save changes, or write a new file and/or data * Save changes, or write a new file and/or data
* *
* @param string $file File location to save to * @param string $file File location to save to
* @param array $data 2D array of data * @param array $data 2D array of data
* @param bool $append Append current data to end of target CSV, if file * @param bool $append Append current data to end of target CSV, if file
* exists * exists
* @param array $fields Field names. Sets the header. If it is not set * @param array $fields Field names. Sets the header. If it is not set
* $this->titles would be used instead. * $this->titles would be used instead.
* *
* @return bool * @return bool
@@ -416,16 +416,16 @@ class Csv {
* Output * Output
* Generate a CSV based string for output. * Generate a CSV based string for output.
* *
* @param string|null $filename If a filename is specified here or in the * @param string|null $filename If a filename is specified here or in the
* object, headers and data will be output * object, headers and data will be output
* directly to browser as a downloadable * directly to browser as a downloadable
* file. This file doesn't have to exist on * file. This file doesn't have to exist on
* the server; the parameter only affects * the server; the parameter only affects
* how the download is called to the * how the download is called to the
* browser. * browser.
* @param array[] $data 2D array with data * @param array[] $data 2D array with data
* @param array $fields Field names * @param array $fields Field names
* @param string|null $delimiter character used to separate data * @param string|null $delimiter character used to separate data
* *
* @return string The resulting CSV string * @return string The resulting CSV string
*/ */
@@ -461,8 +461,8 @@ class Csv {
* Encoding * Encoding
* Convert character encoding * Convert character encoding
* *
* @param string $input Input character encoding, uses default if left blank * @param string $input Input character encoding, uses default if left blank
* @param string $output Output character encoding, uses default if left blank * @param string $output Output character encoding, uses default if left blank
*/ */
public function encoding($input = null, $output = null) { public function encoding($input = null, $output = null) {
$this->convert_encoding = true; $this->convert_encoding = true;
@@ -480,11 +480,11 @@ class Csv {
* Auto-Detect Delimiter: Find delimiter by analyzing a specific number of * Auto-Detect Delimiter: Find delimiter by analyzing a specific number of
* rows to determine most probable delimiter character * rows to determine most probable delimiter character
* *
* @param string|null $file Local CSV file * @param string|null $file Local CSV file
* @param bool $parse True/false parse file directly * @param bool $parse True/false parse file directly
* @param int $search_depth Number of rows to analyze * @param int $search_depth Number of rows to analyze
* @param string $preferred Preferred delimiter characters * @param string $preferred Preferred delimiter characters
* @param string|null $enclosure Enclosure character, default is double quote ("). * @param string|null $enclosure Enclosure character, default is double quote (").
* *
* @return string The detected field delimiter * @return string The detected field delimiter
*/ */
@@ -575,7 +575,7 @@ class Csv {
* Parse File * Parse File
* Read file to string and call _parse_string() * Read file to string and call _parse_string()
* *
* @param string|null $file Local CSV file * @param string|null $file Local CSV file
* *
* @return array|bool * @return array|bool
*/ */
@@ -1105,7 +1105,7 @@ class Csv {
/** /**
* Check file data * Check file data
* *
* @param string|null $file local filename * @param string|null $file local filename
* *
* @return bool * @return bool
*/ */
@@ -1125,10 +1125,10 @@ class Csv {
* Check if passed info might be delimiter * Check if passed info might be delimiter
* Only used by find_delimiter * Only used by find_delimiter
* *
* @param string $char Potential field separating character * @param string $char Potential field separating character
* @param array $array Frequency * @param array $array Frequency
* @param int $depth Number of analyzed rows * @param int $depth Number of analyzed rows
* @param string $preferred Preferred delimiter characters * @param string $preferred Preferred delimiter characters
* *
* @return string|false special string used for delimiter selection, or false * @return string|false special string used for delimiter selection, or false
*/ */
@@ -1185,10 +1185,10 @@ class Csv {
/** /**
* Write to local file * Write to local file
* *
* @param string $file local filename * @param string $file local filename
* @param string $content data to write to file * @param string $content data to write to file
* @param string $mode fopen() mode * @param string $mode fopen() mode
* @param int $lock flock() mode * @param int $lock flock() mode
* *
* @return true or false * @return true or false
*/ */