Class FileMaker_Command_CompoundFind

Description

A set of find requests, also known as a compound find set.

Located in /FileMaker/Command/CompoundFind.php (line 27)

FileMaker_Command
   |
   --FileMaker_Command_CompoundFind
Method Summary
FileMaker_Command_CompoundFind FileMaker_Command_CompoundFind (FileMaker_Implementation $fm, string $layout)
void add (int $precedence, findrequest $findrequest)
void addSortRule (string $fieldname, integer $precedence, [mixed $order = null])
void clearSortRules ()
array getRange ()
void setRange (integer $skip, [integer $max = null])
Methods
Constructor FileMaker_Command_CompoundFind (line 43)

Find set constructor.

FileMaker_Command_CompoundFind FileMaker_Command_CompoundFind (FileMaker_Implementation $fm, string $layout)
  • FileMaker_Implementation $fm: The FileMaker_Implementation object the request was created by.
  • string $layout: The layout to find records in.
add (line 54)

Add a find request to the find set.

void add (int $precedence, findrequest $findrequest)
  • int $precedence: defines the priority in which the find requests are added to the set.
  • findrequest $findrequest: is the find request being added to the compound find set.
addSortRule (line 66)

Add a sorting rule to the find request.

void addSortRule (string $fieldname, integer $precedence, [mixed $order = null])
  • string $fieldname: The field to sort by.
  • integer $precedence: 1-9, should we sort by this field first, last, etc.
  • mixed $order: FILEMAKER_SORT_ASCEND, FILEMAKER_SORT_DESCEND, or a custom value list.
clearSortRules (line 74)

Clear all existing sorting rules.

void clearSortRules ()
getRange (line 98)

Return the current range settings.

  • return: An associative array with two keys: 'skip' for the current skip setting, and 'max' for the current maximum number of records. If either key does not have a value it will be set to NULL.
array getRange ()
setRange (line 85)

Request only part of the result set.

void setRange (integer $skip, [integer $max = null])
  • integer $skip: The number of records to skip past.
  • integer $max: The maximum number of records to return.

Inherited Methods

Inherited From FileMaker_Command

FileMaker_Command::execute()
FileMaker_Command::setPreCommandScript()
FileMaker_Command::setPreSortScript()
FileMaker_Command::setRecordClass()
FileMaker_Command::setRecordId()
FileMaker_Command::setResultLayout()
FileMaker_Command::setScript()
FileMaker_Command::validate()

Documentation generated on Thu, 06 Jul 2006 15:52:26 -0700 by phpDocumentor 1.2.3