Class FileMaker_Command_Edit

Description

Edit a single record and/or some of its child records.

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

FileMaker_Command
   |
   --FileMaker_Command_Edit
Method Summary
FileMaker_Command_Edit FileMaker_Command_Edit (FileMaker_Implementation $fm, string $layout, integer $recordId, [mixed $updatedValues = array()], array $values)
void setField (string $field, string $value, integer $repetition)
void setFieldFromTimestamp (string $field, string $timestamp, integer $repetition)
void setModificationId (integer $modificationId)
Methods
Constructor FileMaker_Command_Edit (line 47)

Edit command constructor.

FileMaker_Command_Edit FileMaker_Command_Edit (FileMaker_Implementation $fm, string $layout, integer $recordId, [mixed $updatedValues = array()], array $values)
  • FileMaker_Implementation $fm: The FileMaker_Implementation object the command was created by.
  • string $layout: The layout the record is part of.
  • integer $recordId: The id of the record to edit.
  • array $values: A hash of fieldname => value pairs. Repetions can be set by making the value for a field a numerically indexed array, with the numeric keys corresponding to the repetition number to set.
setField (line 60)

Set the new value for a field.

void setField (string $field, string $value, integer $repetition)
  • string $field: The field to set.
  • string $value: The value for the field.
  • integer $repetition: The repetition number to set, defaults to the first repetition.
setFieldFromTimestamp (line 79)

Set the new value for a date, time, or timestamp field from a unix timestamp value. If the field is not a date or time field, then an error is returned. Otherwise returns true.

If we haven't already loaded layout data for the target of this command, calling this method will cause it to be loaded so that the type of the field can be checked.

void setFieldFromTimestamp (string $field, string $timestamp, integer $repetition)
  • string $field: The field to set.
  • string $timestamp: The timestamp value.
  • integer $repetition: The repetition number to set, defaults to the first repetition.
setModificationId (line 89)

Set the modification id for this command.

void setModificationId (integer $modificationId)
  • integer $modificationId: The modification id.

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