[FileMaker] element index

All elements
a c d e f g h i j l n p r s v
a
top
add
Add a find request to the find set.
addError
Add an error.
addFindCriterion
Add a find criterion.
addFindCriterion
Add a find criterion.
addSortRule
Add a sorting rule to the find command.
addSortRule
Add a sorting rule to the find request.
Add.php
Add.php in Add.php
c
top
clearFindCriteria
Clear all existing find criteria.
clearFindCriteria
Clear all existing find criteria.
clearSortRules
Clear all existing sorting rules.
clearSortRules
Clear all existing sorting rules.
commit
Save any changes to this record back to the server.
createRecord
FileMaker::createRecord() in FileMaker.php
Creates a new FileMaker_Record object. This method does not
CompoundFind.php
CompoundFind.php in CompoundFind.php
Command.php
Command.php in Command.php
d
top
delete
Delete this record from the server.
describeLocalValidationRules
Return an array of arrays containing the extra information for
describeValidationRule
Returns any additional information for a given rule. Used for range rules and other rules that have additional validation parameters.
describeValidationRules
Returns all additional information for all validation rules.
Delete.php
Delete.php in Delete.php
Duplicate.php
Duplicate.php in Duplicate.php
de.php
de.php in de.php
e
top
execute
Run the command.
Edit.php
Edit.php in Edit.php
en.php
en.php in en.php
Error.php
Error.php in Error.php
f
top
FileMaker
FileMaker::FileMaker() in FileMaker.php
FileMaker object constructor.
FileMaker
FileMaker in FileMaker.php
Base FileMaker class.
FindAll.php
FindAll.php in FindAll.php
FindAny.php
FindAny.php in FindAny.php
FindRequest.php
FindRequest.php in FindRequest.php
Find.php
Find.php in Find.php
filemaker-api.php
filemaker-api.php in filemaker-api.php
fr.php
fr.php in fr.php
Field.php
Field.php in Field.php
FileMaker.php
FileMaker.php in FileMaker.php
FileMaker_Command
FileMaker_Command in Command.php
Base Command object.
FileMaker_Command_Add
Add command constructor.
FileMaker_Command_Add
Add a new record.
FileMaker_Command_CompoundFind
FileMaker_Command_CompoundFind in CompoundFind.php
A set of find requests, also known as a compound find set.
FileMaker_Command_CompoundFind
Find set constructor.
FileMaker_Command_Delete
Delete command constructor.
FileMaker_Command_Delete
Delete a single record.
FileMaker_Command_Duplicate
Duplicates a single record.
FileMaker_Command_Duplicate
Duplicate command constructor.
FileMaker_Command_Edit
Edit a single record and/or some of its child records.
FileMaker_Command_Edit
Edit command constructor.
FileMaker_Command_Find
Find command constructor.
FileMaker_Command_Find
Find records.
FileMaker_Command_FindAll
FindAll command constructor.
FileMaker_Command_FindAll
Find all records in a layout.
FileMaker_Command_FindAny
Find a random record.
FileMaker_Command_FindAny
FindAny command constructor.
FileMaker_Command_FindRequest
Individual find requests that belong to a compound find.
FileMaker_Command_FindRequest
Find request constructor.
FileMaker_Command_PerformScript
PerformScript command constructor.
FileMaker_Command_PerformScript
FileMaker_Command_PerformScript in PerformScript.php
Perform a script.
FileMaker_Error
Overloaded constructor.
FileMaker_Error
FileMaker_Error in Error.php
Extension of PEAR_Error for use in all FileMaker classes.
FileMaker_Error_Validation
FileMaker_Error_Validation in Validation.php
Extension of FileMaker_Error for adding additional information about validation errors.
FileMaker_Field
Field Constructor.
FileMaker_Field
FileMaker_Field in Field.php
Field description class. Contains all the information about a specific field in a layout.
FILEMAKER_FIND_AND
FILEMAKER_FIND_AND in FileMaker.php
Find logical operator constants.
FILEMAKER_FIND_CHAR
FILEMAKER_FIND_CHAR in FileMaker.php
FILEMAKER_FIND_CHAR_WILDCARD
FILEMAKER_FIND_DIGIT
FILEMAKER_FIND_DIGIT in FileMaker.php
FILEMAKER_FIND_DUPLICATES
FILEMAKER_FIND_DUPLICATES in FileMaker.php
FILEMAKER_FIND_FIELDMATCH
FILEMAKER_FIND_FIELDMATCH in FileMaker.php
FILEMAKER_FIND_GT
FILEMAKER_FIND_GT in FileMaker.php
FILEMAKER_FIND_GTE
FILEMAKER_FIND_GTE in FileMaker.php
FILEMAKER_FIND_INVALID_DATETIME
FILEMAKER_FIND_LITERAL
FILEMAKER_FIND_LITERAL in FileMaker.php
FILEMAKER_FIND_LT
FILEMAKER_FIND_LT in FileMaker.php
Find constants.
FILEMAKER_FIND_LTE
FILEMAKER_FIND_LTE in FileMaker.php
FILEMAKER_FIND_OR
FILEMAKER_FIND_OR in FileMaker.php
FILEMAKER_FIND_RANGE
FILEMAKER_FIND_RANGE in FileMaker.php
FILEMAKER_FIND_RELAXED
FILEMAKER_FIND_RELAXED in FileMaker.php
FILEMAKER_FIND_TODAY
FILEMAKER_FIND_TODAY in FileMaker.php
FileMaker_Layout
Layout constructor.
FileMaker_Layout
FileMaker_Layout in Layout.php
Layout description class. Contains all the information about a specific layout. Can be requested directly, or returned as part of a result set.
FILEMAKER_LOG_DEBUG
FILEMAKER_LOG_DEBUG in FileMaker.php
FILEMAKER_LOG_ERR
FILEMAKER_LOG_ERR in FileMaker.php
Logging constants.
FILEMAKER_LOG_INFO
FILEMAKER_LOG_INFO in FileMaker.php
FileMaker_Record
FileMaker_Record in Record.php
This is the default Record class for representing each member of a
FileMaker_Record
Record constructor.
FileMaker_RelatedSet
FileMaker_RelatedSet in RelatedSet.php
Related set description class. Contains all the information about a specific related set.
FileMaker_RelatedSet
Related set constructor.
FileMaker_Result
Result constructor.
FileMaker_Result
FileMaker_Result in Result.php
Base Result object.
FILEMAKER_RULE_NOTEMPTY
FILEMAKER_RULE_NOTEMPTY in FileMaker.php
Validation rule constants.
FILEMAKER_SORT_ASCEND
FILEMAKER_SORT_ASCEND in FileMaker.php
Sort direction constants.
FILEMAKER_SORT_DESCEND
FILEMAKER_SORT_DESCEND in FileMaker.php
g
top
getAPIVersion
Returns the API version.
getContainerData
Get the data for a given container field.
getDatabase
Return the name of the database this layout is in.
getErrors
Returns an array of arrays describing the validation errors
getErrorString
Return the string representation of $this->code, in the language currently set on $this->_fm. You should call getMessage() in most cases if you are not sure that the error is an XML error with an error code.
getFetchCount
Returns the number of records in the set that was actually returned. If no range parameters were specified this will be equal to the result of getFoundSetCount(). It will always be equal to the value of count($response->getRecords()).
getField
Returns the FileMaker_Field object describing $fieldName.
getField
Get the value of $field.
getField
Returns the FileMaker_Field object describing $fieldName.
getFieldAsTimestamp
Return the value of the specified field (and repetition) as a
getFields
Return a list of the names of all fields in the records that are part of this response. Just the names are returned; if additional information is required then Layout object provided by getLayout() must be consulted.
getFields
Return a list of the names of all fields in the record. Just
getFields
Return an associative array with the names of all fields as keys, and the array values will be the associated FileMaker_Field objects.
getFields
Return an associative array with the names of all fields as keys, and the array values will be the associated FileMaker_Field objects.
getFoundSetCount
Returns the number of records in the entire found set.
getLayout
Get the FileMaker_Layout object describing the layout of this response.
getLayout
Return the FileMaker_Layout object that contains this field.
getLayout
Return the layout this record is part of.
getLayout
FileMaker::getLayout() in FileMaker.php
Get a Layout object describing $layout.
getLocalValidationRules
Returns an array of FILEMAKER_RULE_* constants for each rule set on this field that can be evaluated by PHP. Rules such as "unique" and "exists" can only be validated on the server and are not included in this list.
getMessage
Overload getMessage() to return XML error equivalents if no message is explicitly set and we have an error code.
getMinServerVersion
Return the minimum server version this API will work with.
getModificationId
Get the modification id of this object.
getName
Return the name of this field.
getName
Returns the name of the layout this object describes.
getName
Returns the name of the related set this object describes.
getParent
If this is a child record, return its parent.
getProperties
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.
getProperty
FileMaker::getProperty() in FileMaker.php
Returns the currently set value of $prop.
getRange
Return the current range settings.
getRange
Return the current range settings.
getRecordById
Returns a single FileMaker_Record object matching the given layout and record ID, or a FileMaker_Error object if the fetch fails.
getRecordId
Get the record id of this object.
getRecords
Returns an array containing each record in the result set. Each
getRelatedSet
Returns the FileMaker_RelatedSet object describing $relatedSet.
getRelatedSet
Get any objects in the related set (portal) $relatedSet.
getRelatedSets
Return an associative array with the names of all related sets as keys, and the array values will be the associated FileMaker_RelatedSet objects.
getRelatedSets
Return the names of all related sets present in this record.
getRepetitionCount
Return the maximum number of repetitions for this field.
getResult
Get the result type of this field - for example, 'text' or 'number'.
getStyleType
Loads FMPXMLLAYOUT data. Returns the type of this field - for example, 'EDITTEXT'.
getTableRecordCount
Returns the number of records in the table that was accessed.
getType
Returns the type of this field. Examples: 'normal', 'calculation'.
getValidationMask
Returns the full additive bitmask of validation rules for this field.
getValidationRules
Returns an array of FILEMAKER_RULE_* constants for each rule set on this field.
getValueList
Return the list of options in the named value list.
getValueList
Loads FMPXMLLAYOUT data. If this field is associated with a value list, return the list of choices in that value list. Otherwise returns NULL.
getValueLists
Return a multi-level associative array. The top-level array has names of value lists as keys and arrays as values. The second level arrays are the lists of choices from each value list.
h
top
hasValidationRule
Returns TRUE if the given FILEMAKER_RULE_* constant matches the field's validation bitmask, FALSE otherwise.
i
top
it.php
it.php in it.php
isAutoEntered
Return TRUE if this field is auto-entered and FALSE if it is set manually.
isError
FileMaker::isError() in FileMaker.php
Test for whether or not a variable is a FileMaker API Error.
isGlobal
Return TRUE if this field is global and FALSE if it is not.
isValidationError
Indicates whether or not the error is a detailed validation error message, or if it is a server message.
isValidationError
Indicates whether or not the error is a detailed validation error message, or if it is a server message.
j
top
jp.php
jp.php in jp.php
l
top
Layout.php
Layout.php in Layout.php
listDatabases
Obtain a list of databases that are available with the current server settings and the current username and password credentials.
listFields
Return an array with the string names of all fields in this related set.
listFields
Return an array with the string names of all fields in this layout.
listLayouts
FileMaker::listLayouts() in FileMaker.php
Obtain a list of layouts from the current database that are available with the current server settings and the current username and password credentials.
listRelatedSets
Return an array with the string names of all related sets in this layout.
listScripts
FileMaker::listScripts() in FileMaker.php
Obtain a list of scripts from the current database that are available with the current server settings and the current username and password credentials.
listValueLists
Return the names of any value lists associated with this layout.
loadExtendedInfo
Load extended (FMPXMLLAYOUT) layout information.
n
top
newAddCommand
Create a new FileMaker_Command_Add object.
newCompoundFindCommand
Create a new FileMaker_Compound_Find_Set object.
newDeleteCommand
Create a new FileMaker_Command_Delete object.
newDuplicateCommand
Create a new FileMaker_Command_Duplicate object.
newEditCommand
Create a new FileMaker_Command_Edit object.
newFindAllCommand
Create a new FileMaker_Command_FindAll object.
newFindAnyCommand
Create a new FileMaker_Command_FindAny object.
newFindCommand
Create a new FileMaker_Command_Find object.
newFindRequest
Create a new FileMaker_Command_FindRequest object. Each of these individual finds are added to a Compound Find Set.
newPerformScriptCommand
Create a new FileMaker_Command_PerformScript object.
newRelatedRecord
Create a new record in the related set (portal) named by $relatedSet.
numErrors
Return the number of validation rules that failed.
p
top
PerformScript.php
PerformScript.php in PerformScript.php
r
top
Record.php
Record.php in Record.php
RelatedSet.php
RelatedSet.php in RelatedSet.php
Result.php
Result.php in Result.php
s
top
se.php
se.php in se.php
setField
Set the value of $field.
setField
Set the new value for a field.
setField
Set the new value for a field.
setFieldFromTimestamp
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.
setFieldFromTimestamp
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.
setFieldFromTimestamp
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.
setLogger
FileMaker::setLogger() in FileMaker.php
Associate a PEAR Log object with the API for logging requests and responses.
setLogicalOperator
Switch between AND and OR searches.
setModificationId
Set the modification id for this command.
setOmit
Sets if the find request is an omit request.
setPreCommandScript
Set a script to be run after the result set is generated.
setPreSortScript
Set a script to be run after the result set is generated.
setProperty
FileMaker::setProperty() in FileMaker.php
Set $prop to a new value for all API calls.
setRange
Request only part of the result set.
setRange
Request only part of the result set.
setRecordClass
Set the PHP class that will be instantiated to represent
setRecordId
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.
setResultLayout
Request the result to be returned in a layout different than the one being queried against.
setScript
Set a script to be run after the result set is generated.
v
top
Validation.php
Validation.php in Validation.php
validate
Validates either a single field or the whole record against the
validate
Returns TRUE if $value is valid for this field, or a FileMaker_Error_Validation object describing how validation failed.
validate
Validates either a single field or the whole command against
a c d e f g h i j l n p r s v