CGContacts 1.2.2
\
CGContacts

\CGContactscontact_query

This class contains all of the parameters required to collect a series of contacts matching a criteria.

Summary

Methods
Properties
Constants
__construct()
execute()
$idlist
$limit
$offset
$sortby
$sortorder
$category
$modified_since
$
$
$catchildren
No constants found
No protected methods found
No protected properties found
N/A
No private methods found
No private properties found
N/A

Properties

$idlist

$idlist : int[]

Array of integer ids to return. If set, the name, fullname, category, and catchildren properties are reset.

Type

int[]

$limit

$limit : int

The maximum number of records to return. The default value is 500.

Type

int

$offset

$offset : int

The start position within the matched values to return. The default value is 0

Type

int

$sortby

$sortby : string

The column to sort on. Possible values are: modified,fullname,nickname,display_name,title,company,role. The default value is modified.

Type

string

$sortorder

$sortorder : string

The sort order. Possible values are ASC and DESC. Default value is 'ASC';

Type

string

$category

$category : string

A comma separated list of category names, or ids to filter upon.

Type

string

$modified_since

$modified_since : int

Filter all contacts that were last modified after this unix timestamp.

Type

int

$

$ : string

propclass[0-9]

Type

string

$

$ : string

propval[0-9]

Type

string

$catchildren

$catchildren : bool

Optionally include, or exclude the children categories of the specified categories from the results. Default value is false.

Type

bool

Methods

__construct()

__construct(array $parms)

Constructor.

Parameters

array $parms

An array of properties for this object.