# \CGExtensions\querytxtfilequery

A class to generate a query object from a text file.

descendents of this class should implement at least the limit, and offset parameters to allow the pagination class to work.

This class supports accessing members as either object members with the -> operator, or as array members with the [] operator.

## Summary

Methods
Properties
Constants
__construct()
execute()
OffsetGet()
OffsetSet()
OffsetExists()
OffsetUnset()
$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.txtfilequery.php
Class hierarchy
  \CGExtensions\query\query
  \CGExtensions\query\txtfilequery

## Tags

todo |

## Properties

### $limit

    $limit : int

The limit of records to use

#### Type

int

#

## Tags

None found

### $offset

    $offset : int

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

#### Type

int

#

## Tags

None found

### $filename

    $filename : string

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

#### Type

string

#

## 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.txtfilequery.php