\CGExtensions\querycsvfilequery

A class that represents the contents of a csv file as a query.

This class does not provide for filtering of the contents of the csv file

Summary

Methods
Properties
Constants
__construct()
execute()
OffsetSet()
OffsetExists()
OffsetUnset()
$delimiter
$enclosure
$map
$limit
$offset
$filename
No constants found
No protected methods found
No protected properties found
N/A
No private methods found
No private properties found
N/A

Properties

$delimiter

$delimiter : string

The field delimiter for the csv file. The default value is a commma (,)

Type

string

$enclosure

$enclosure : string

The enclosure that field contents may be enclosed in (particularly if the delimiter may be present in the field contents). The default value is the double quote (")

Type

string

$map

$map : array

An array that can be used to rename all of the columns of the input file from the standard col_ format to real names.

Type

array

$limit

$limit : int

The limit of records to use

Type

int

$offset

$offset : int

The start record (line) to use in the report.

Type

int

$filename

$filename : string

The absolute path to the file to use in the report.

Type

string

Methods

__construct()

__construct(array $parms)

Constructor.

This method accepts an array of parameters, and sets internal data for the query object. Identically to calling $this['key'] = $val multiple times.

Parameters

array $parms

OffsetSet()

OffsetSet(string $key, mixed $value)

Set a value into the query object.

Parameters

string $key
mixed $value

OffsetExists()

OffsetExists(string $key) : bool

Test if the key is set in the data object.

Parameters

string $key

Returns

bool

OffsetUnset()

OffsetUnset(string $key)

Unset a variable in the object

Parameters

string $key