CGContacts 1.2.2
\
CGContacts

\CGContactscontact_resultset

This class represents the results of a query from contact_query.

Summary

Methods
Properties
Constants
__construct()
get_query()
RecordCount()
MoveNext()
MoveFirst()
Rewind()
MoveLast()
EOF()
Close()
TotalMatches()
get_object()
get_contact()
get_pagination()
No public properties found
No constants found
No protected methods found
No protected properties found
N/A
No private methods found
No private properties found
N/A

Methods

get_query()

get_query() : \CGContacts\contact_query

Get the query used to construct this object.

Returns

\CGContacts\contact_query

RecordCount()

RecordCount() : int

Get the number of records returned in this resultset.

Returns

int

MoveNext()

MoveNext()

Move to the next record in the resultset.

MoveFirst()

MoveFirst()

Move to the first record in the resultset.

Rewind()

Rewind()

Move to the first record in the resultset.

MoveLast()

MoveLast()

Move to the last record in the resultset.

EOF()

EOF() : bool

Test if we are at the end of the resultset.

Returns

bool

Close()

Close()

Close the resultset.

TotalMatches()

TotalMatches() : int

Return the total number of records that match the query (not only in this recordset).

Returns

int

get_object()

get_object() : \CGContacts\contact

Get the contact object for the current record.

Returns

\CGContacts\contact

get_contact()

get_contact() : \CGContacts\contact

Get the contact object for the current record.

This is a convenience wrapper for get_object.

Returns

\CGContacts\contact

get_pagination()

get_pagination() : \CGContacts\contact_pagination

Get an object to aide in scrolling through the different pages of objects that match this query.

Returns

\CGContacts\contact_pagination