Docs For Class FileMaker

Class FileMaker

Description

Base FileMaker class.

Located in /FileMaker.php (line 69)

Method Summary

FileMaker FileMaker ([string $database = NULL], [string $hostspec = NULL], [string $username = NULL], [string $password = NULL])

FileMaker_Record &createRecord (string $layout, [array $fieldValues = array()])

string getAPIVersion ()

string getContainerData (string $url)

FileMaker_Layout|FileMaker_Error &getLayout (string $layout)

string getMinServerVersion ()

array getProperties ()

string getProperty (string $prop)

FileMaker_Record|FileMaker_Error &getRecordById (string $layout, integer $recordId)

boolean isError (mixed $variable)

array|FileMaker_Error listDatabases ()

array|FileMaker_Error listLayouts ()

array|FileMaker_Error listScripts ()

FileMaker_Command_Add &newAddCommand (string $layout, [array $values = array()])

FileMaker_Compound_Find_Set &newCompoundFindCommand (string $layout)

FileMaker_Command_Delete &newDeleteCommand (string $layout, integer $recordId)

FileMaker_Command_Duplicate &newDuplicateCommand (string $layout, integer $recordId)

FileMaker_Command_Edit &newEditCommand (string $layout, integer $recordId, [mixed $updatedValues = array()], array $values)

FileMaker_Command_FindAll &newFindAllCommand (string $layout)

FileMaker_Command_FindAny &newFindAnyCommand (string $layout)

FileMaker_Command_Find &newFindCommand (string $layout)

FileMaker_Command_FindRequest &newFindRequest (string $layout)

FileMaker_Command_PerformScript &newPerformScriptCommand (string $layout, string $scriptName, [string $scriptParameters = null])

void setLogger (Log &$logger)

void setProperty (string $prop, string $value)

Methods

Constructor FileMaker (line 121)

FileMaker object constructor.

FileMaker FileMaker ([string $database = NULL], [string $hostspec = NULL], [string $username = NULL], [string $password = NULL])

string $database: The name of the database to use
string $hostspec: Hostspec to use
string $username: Username to login into database as
string $password: Password for username

createRecord (line 319)

Creates a new FileMaker_Record object. This method does not

save the new record to the database. The record is not created on the server until you call its commit() method. You must specify a layout name, and you can optionally specify an array of field values. Values can be set on the new record object individually as well.

return: The new record object.

FileMaker_Record &createRecord (string $layout, [array $fieldValues = array()])

string $layout: The layout to create a new record for.
array $fieldValues: Initial values for the new record's fields.

getAPIVersion (line 97)

Returns the API version.

return: The API version.
static:

string getAPIVersion ()

getContainerData (line 394)

Get the data for a given container field.

return: The raw field data.

string getContainerData (string $url)

string $url: The location of the data.

getLayout (line 346)

Get a Layout object describing $layout.

return: The layout description object or an error.

FileMaker_Layout|FileMaker_Error &getLayout (string $layout)

string $layout: The name of the layout to describe.

getMinServerVersion (line 108)

Return the minimum server version this API will work with.

return: The minimum server version.
static:

string getMinServerVersion ()

getProperties (line 156)

Get an associative array of property name => property value for all current properties and the values currently in effect. This allows introspection and debugging when necessary.

return: All current properties.

array getProperties ()

getProperty (line 144)

Returns the currently set value of $prop.

return: The property's current value.

string getProperty (string $prop)

string $prop: The name of the property.

getRecordById (line 334)

Returns a single FileMaker_Record object matching the given layout and record ID, or a FileMaker_Error object if the fetch fails.

return: Either a record object or an error.

FileMaker_Record|FileMaker_Error &getRecordById (string $layout, integer $recordId)

string $layout: The layout $recordId is in.
integer $recordId: The record id to fetch.

isError (line 86)

Test for whether or not a variable is a FileMaker API Error.

return: Whether or not the variable is a FileMaker API Error.
static:

boolean isError (mixed $variable)

mixed $variable

listDatabases (line 358)

Obtain a list of databases that are available with the current server settings and the current username and password credentials.

return: Either an array of database names or an error.

array|FileMaker_Error listDatabases ()

listLayouts (line 382)

Obtain a list of layouts from the current database that are available with the current server settings and the current username and password credentials.

return: Either an array of layout names or an error.

array|FileMaker_Error listLayouts ()

listScripts (line 370)

Obtain a list of scripts from the current database that are available with the current server settings and the current username and password credentials.

return: Either an array of script names or an error.

array|FileMaker_Error listScripts ()

newAddCommand (line 182)

Create a new FileMaker_Command_Add object.

return: The new add command.

FileMaker_Command_Add &newAddCommand (string $layout, [array $values = array()])

string $layout: The layout to add to.
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.

newCompoundFindCommand (line 249)

Create a new FileMaker_Compound_Find_Set object.

return: The new find set.

FileMaker_Compound_Find_Set &newCompoundFindCommand (string $layout)

string $layout: The layout to find records in.

newDeleteCommand (line 211)

Create a new FileMaker_Command_Delete object.

return: The new delete command.

FileMaker_Command_Delete &newDeleteCommand (string $layout, integer $recordId)

string $layout: The layout to delete from.
integer $recordId: The id of the record to delete.

newDuplicateCommand (line 224)

Create a new FileMaker_Command_Duplicate object.

return: The new duplicate command.

FileMaker_Command_Duplicate &newDuplicateCommand (string $layout, integer $recordId)

string $layout: The layout the record to duplicate is in.
integer $recordId: The id of the record to duplicate.

newEditCommand (line 198)

Create a new FileMaker_Command_Edit object.

return: The new edit command.

FileMaker_Command_Edit &newEditCommand (string $layout, integer $recordId, [mixed $updatedValues = array()], array $values)

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.

newFindAllCommand (line 287)

Create a new FileMaker_Command_FindAll object.

return: The new find-all command.

FileMaker_Command_FindAll &newFindAllCommand (string $layout)

string $layout: The layout to find all records in.

newFindAnyCommand (line 275)

Create a new FileMaker_Command_FindAny object.

return: The new find-any command.

FileMaker_Command_FindAny &newFindAnyCommand (string $layout)

string $layout: The layout to find a random record from.

newFindCommand (line 236)

Create a new FileMaker_Command_Find object.

return: The new find command.

FileMaker_Command_Find &newFindCommand (string $layout)

string $layout: The layout to find records in.

newFindRequest (line 263)

Create a new FileMaker_Command_FindRequest object. Each of these individual finds are added to a Compound Find Set.

return: The new find request command.

FileMaker_Command_FindRequest &newFindRequest (string $layout)

string $layout: The layout to find records in.

newPerformScriptCommand (line 301)

Create a new FileMaker_Command_PerformScript object.

return: The new perform-script command.

FileMaker_Command_PerformScript &newPerformScriptCommand (string $layout, string $scriptName, [string $scriptParameters = null])

string $layout: The layout to use for script context.
string $scriptName: The name of the script to run.
string $scriptParameters: Any parameters to pass to the script.

setLogger (line 167)

Associate a PEAR Log object with the API for logging requests and responses.

void setLogger (Log &$logger)

Log &$logger

setProperty (line 132)

Set $prop to a new value for all API calls.

void setProperty (string $prop, string $value)

string $prop: The name of the property
string $value: Its new value.

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