CGExtensions 1.65.1
\
CGExtensions
Email
jsloader
LinkDefinition
query
reports

\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 : integer

The limit of records to use

Type

integer

$offset

$offset : integer

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

Type

integer

$filename

$filename : string

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

Type

string

Methods

__construct()

__construct(array  $params = array())

Constructor

Parameters

array $params

The default properties for this query.

OffsetSet()

OffsetSet(string  $key, mixed  $value)

Set a value into the query object.

Parameters

string $key
mixed $value

OffsetExists()

OffsetExists(string  $key) : boolean

Test if the key is set in the data object.

Parameters

string $key

Returns

boolean

OffsetUnset()

OffsetUnset(string  $key)

Unset a variable in the object

Parameters

string $key