new TownshipSet - jcobban/Genealogy GitHub Wiki
new TownshipSet($parms)
Up: class TownshipSet
:
The constructor for an instance of TownshipSet
takes one parameter:
parameter | description |
---|---|
$parms | identifies the database records to be associated with this instance. This is an array. |
$parms may be:
- an associative array of
fieldname => value pairs
to define the subset of the records in the SQL table that are represented by this instance. - an array of instances of the class Township to be converted into a
RecordSet
. - If this parameter is omitted, or is
null
, the object is empty. That is$set->count()
is zero.
The field names that may be specified in the associative array format include:
field name | description | synonyms |
---|---|---|
'limit' | maximum number of entries to return | |
'offset' | offset for retrieving part of the response set | |
'orderby' | value of the ORDER BY clause to override the default from class Township |
|
'groupby' | value of the GROUP BY clause |
For example:
$set = new TownshipSet(array('surname' => 'Grover'));
returns all instances of Township
for the specified surname.
The constructor adds error messages to $record->msg
if it is unable to complete due to bad parameters.
Next: class User