parse documentation

This commit is contained in:
William Knauss
2014-02-05 18:37:23 -05:00
parent d6a070ce08
commit 585a0d472e

View File

@@ -201,10 +201,17 @@ class parseCSV {
// ----- [ Main Functions ] --------------------- // ----- [ Main Functions ] ---------------------
// ============================================== // ==============================================
/** /**
* Parse CSV file or string * Parse
* @param input CSV file or string * Parse a CSV file or string
* @return nothing *
* @access public
* @param [string] input The CSV string or a direct filepath
* @param [integer] offset Number of rows to ignore from the beginning of the data
* @param [integer] limit Limits the number of returned rows to specified amount
* @param [string] conditions Basic SQL-like conditions for row matching
* @return [bool]
*/ */
public function parse ($input = null, $offset = null, $limit = null, $conditions = null) { public function parse ($input = null, $offset = null, $limit = null, $conditions = null) {
if ($input===null) { if ($input===null) {
@@ -229,7 +236,7 @@ class parseCSV {
} }
else { else {
$this->file_data = &$input; $this->file_data = &$input;
$this->data = $this->parse_string(); $this->data = $this->parse_string();
} }
if ($this->data===false) { if ($this->data===false) {