# \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()
OffsetGet()
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

File
  lib/query/class.csvfilequery.php
Class hierarchy
  \CGExtensions\query\query
  \CGExtensions\query\txtfilequery
  \CGExtensions\query\csvfilequery

## Tags

todo |

## Properties

### $delimiter

    $delimiter : string

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

#### Type

string

#

## Tags

None found

### $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

#

## Tags

None found

### $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

#

## Tags

None found

### $limit

    $limit : int

The limit of records to use

#### Type

int

#

Inherited from
  \CGExtensions\query\txtfilequery

## Tags

None found

### $offset

    $offset : int

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

#### Type

int

#

Inherited from
  \CGExtensions\query\txtfilequery

## Tags

None found

### $filename

    $filename : string

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

#### Type

string

#

Inherited from
  \CGExtensions\query\txtfilequery

## Tags

None found

## 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 |

#

abstract

Inherited from
  \CGExtensions\query\query

## Tags

todo |

### execute()

    execute() : \CGExtensions\query\resultset

Execute the query and return the resultset

#### Returns

\CGExtensions\query\resultset

#

abstract

Inherited from
  \CGExtensions\query\query

## Tags

todo |

### OffsetGet()

    OffsetGet(string $key) : mixed

Return the value of a currently set variable.

#### Parameters

string | $key |

#### Returns

mixed

#

abstract

Inherited from
  \CGExtensions\query\query

## Tags

todo |

### OffsetSet()

    OffsetSet(string $key, mixed $value)

Set a value into the query object.

#### Parameters

string | $key |
mixed | $value |

#

abstract

Inherited from
  \CGExtensions\query\query

## Tags

todo |

### OffsetExists()

    OffsetExists(string $key) : bool

Test if the key is set in the data object.

#### Parameters

string | $key |

#### Returns

bool

#

abstract

Inherited from
  \CGExtensions\query\query

## Tags

todo |

### OffsetUnset()

    OffsetUnset(string $key)

Unset a variable in the object

#### Parameters

string | $key |

#

Inherited from
  \CGExtensions\query\query

## Tags

todo |

### class.csvfilequery.php