Class FileMaker_Command_Find

Description

Find records.

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

FileMaker_Command
   |
   --FileMaker_Command_Find
Direct descendents
Class Description
FileMaker_Command_FindAll Find all records in a layout.
FileMaker_Command_FindAny Find a random record.
Method Summary
FileMaker_Command_Find FileMaker_Command_Find (FileMaker_Implementation $fm, string $layout)
void addFindCriterion (string $fieldname, string $testvalue)
void addSortRule (string $fieldname, integer $precedence, [mixed $order = null])
void clearSortRules ()
array getRange ()
void setLogicalOperator (integer $operator)
void setRange (integer $skip, [integer $max = null])
Methods
Constructor FileMaker_Command_Find (line 43)

Find command constructor.

FileMaker_Command_Find FileMaker_Command_Find (FileMaker_Implementation $fm, string $layout)
  • FileMaker_Implementation $fm: The FileMaker_Implementation object the command was created by.
  • string $layout: The layout to find records in.
addFindCriterion (line 54)

Add a find criterion.

void addFindCriterion (string $fieldname, string $testvalue)
  • string $fieldname: The field being tested.
  • string $testvalue: The value to test against.
addSortRule (line 74)

Add a sorting rule to the find command.

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.
clearFindCriteria (line 62)

Clear all existing find criteria.

void clearFindCriteria ()
clearSortRules (line 82)

Clear all existing sorting rules.

void clearSortRules ()
getRange (line 116)

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 ()
setLogicalOperator (line 92)

Switch between AND and OR searches.

void setLogicalOperator (integer $operator)
  • integer $operator: FILEMAKER_FIND_AND or FILEMAKER_FIND_OR.
setRange (line 103)

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:30 -0700 by phpDocumentor 1.2.3