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

Only improved PHPDoc blocks, including sentance for output()

Browse Source
This commit is contained in:
Fonata
2018-03-17 11:40:31 +01:00
parent 7498a963ac
commit ffed7ffdc0
1 changed files with 28 additions and 18 deletions
Download Patch File Download Diff File Expand all files Collapse all files

46
src/Csv.php
View File

@@ -298,14 +298,15 @@ class Csv {
* Class constructor * Class constructor
* *
* @param string|null $input The CSV string or a direct filepath * @param string|null $input The CSV string or a direct filepath
* @param integer|null $offset Number of rows to ignore from the beginning * @param integer|null $offset Number of rows to ignore from the
* of the data * beginning of the data
* @param integer|null $limit Limits the number of returned rows to * @param integer|null $limit Limits the number of returned rows
* 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 (useful for debugging) * successful parsing
* (useful for debugging)
*/ */
public function __construct($input = null, $offset = null, $limit = null, $conditions = null, $keep_file_data = null) { public function __construct($input = null, $offset = null, $limit = null, $conditions = null, $keep_file_data = null) {
$this->init($offset, $limit, $conditions, $keep_file_data); $this->init($offset, $limit, $conditions, $keep_file_data);
@@ -316,14 +317,15 @@ class Csv {
} }
/** /**
* @param integer|null $offset Number of rows to ignore from the beginning * @param integer|null $offset Number of rows to ignore from the
* of the data * beginning of the data
* @param integer|null $limit Limits the number of returned rows to * @param integer|null $limit Limits the number of returned rows
* 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 (useful for debugging) * successful parsing
* (useful for debugging)
*/ */
public function init($offset = null, $limit = null, $conditions = null, $keep_file_data = null) { public function init($offset = null, $limit = null, $conditions = null, $keep_file_data = null) {
if (!is_null($offset)) { if (!is_null($offset)) {
@@ -352,9 +354,12 @@ class Csv {
* Parse a CSV file or string * Parse a CSV file or string
* *
* @param string|null $input The CSV string or a direct filepath * @param string|null $input The CSV string or a direct filepath
* @param integer $offset Number of rows to ignore from the beginning of the data * @param integer $offset Number of rows to ignore from the
* @param integer $limit Limits the number of returned rows to specified amount * beginning of the data
* @param string $conditions Basic SQL-like conditions for row matching * @param integer $limit Limits the number of returned rows to
* specified amount
* @param string $conditions Basic SQL-like conditions for row
* matching
* *
* @return bool True on success * @return bool True on success
*/ */
@@ -394,8 +399,10 @@ class Csv {
* *
* @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 exists * @param bool $append Append current data to end of target CSV, if file
* @param array $fields Field names. Sets the header. If it is not set $this->titles would be used instead. * exists
* @param array $fields Field names. Sets the header. If it is not set
* $this->titles would be used instead.
* *
* @return bool * @return bool
*/ */
@@ -417,7 +424,10 @@ class Csv {
* @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. * file. This file doesn't have to exist on
* the server; the parameter only affects
* how the download is called to the
* 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
@@ -525,8 +535,8 @@ class Csv {
} }
/** /**
* Get total number of data rows (exclusive heading line if present) in csv * Get total number of data rows (exclusive heading line if present) in CSV
* without parsing whole data. * without parsing the whole data string.
* *
* @return bool|int * @return bool|int
*/ */