Class FileMaker_Command

Description

Base Command object.

Located in /FileMaker/Command.php (line 26)


	
			
Direct descendents
Class Description
FileMaker_Command_Add Add a new record.
FileMaker_Command_CompoundFind A set of find requests, also known as a compound find set.
FileMaker_Command_Delete Delete a single record.
FileMaker_Command_Duplicate Duplicates a single record.
FileMaker_Command_Edit Edit a single record and/or some of its child records.
FileMaker_Command_Find Find records.
FileMaker_Command_FindRequest Individual find requests that belong to a compound find.
FileMaker_Command_PerformScript Perform a script.
Method Summary
void setPreCommandScript (string $scriptName, [string $scriptParameters = null])
void setPreSortScript (string $scriptName, [string $scriptParameters = null])
void setRecordClass (string $className)
void setRecordId (integer $recordId)
void setResultLayout (string $layout)
void setScript (string $scriptName, [string $scriptParameters = null])
void validate ([string $fieldName = null])
Methods
execute (line 123)

Run the command.

  • return: A result object.
FileMaker_Result &execute ()
setPreCommandScript (line 65)

Set a script to be run after the result set is generated.

void setPreCommandScript (string $scriptName, [string $scriptParameters = null])
  • string $scriptName: The name of the script to run.
  • string $scriptParameters: Any parameters to pass to the script.
setPreSortScript (line 76)

Set a script to be run after the result set is generated.

void setPreSortScript (string $scriptName, [string $scriptParameters = null])
  • string $scriptName: The name of the script to run.
  • string $scriptParameters: Any parameters to pass to the script.
setRecordClass (line 92)

Set the PHP class that will be instantiated to represent

records returned in any result set. The default is to use the provided FileMaker_Record class. Any substitute classes must provide the same API that FileMaker_Record does, either by extending it or re-implementing the necessary methods. The user is responsible for defining any custom class before the API will need to instantiate it.

void setRecordClass (string $className)
  • string $className
setRecordId (line 136)

Set the record id for this command. For Edit, Delete, and Duplicate commands a record id must be specified. It is also possible to find a single record by specifying its record id. This method will be ignored by Add and FindAny commands.

void setRecordId (integer $recordId)
  • integer $recordId: The record id.
setResultLayout (line 43)

Request the result to be returned in a layout different than the one being queried against.

void setResultLayout (string $layout)
  • string $layout: The layout to return results using.
setScript (line 54)

Set a script to be run after the result set is generated.

void setScript (string $scriptName, [string $scriptParameters = null])
  • string $scriptName: The name of the script to run.
  • string $scriptParameters: Any parameters to pass to the script.
validate (line 113)

Validates either a single field or the whole command against

the validation rules that are enforceable on the PHP side - type rules, ranges, four-digit dates, etc. Rules such as unique or existing, or validation by calculation field, cannot be pre-validated.

If the optional $fieldName argument is passed, only that field will be validated. Otherwise the command will be validated just as if execute() were called with prevalidation turned on in the API properties. validate() returns TRUE if validation passes, or a FileMaker_Error_Validation object containing details about what failed to validate.

void validate ([string $fieldName = null])
  • string $fieldName: Only validate this field. If empty, validate the whole record.

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