CalyxFile Members

Navigation: CS File Writer for PHP > CalyxFile Class >

CalyxFile Overview

Public Instance Constructors

CalyxFile Constructor Creates and instance of the CalyxFile

Public Instance Properties

  FilePath ( string ) Gets the full file path of the Calyx Point® file you have instantiated.

  GUID ( string ) Gets the Calyx File GUID. This GUID is generated by Calyx Point®.

  LastUpdated ( DateTime ) Gets the last time this file was updated in Calyx Point®.

  Fields ( $key => $value array ) Gets or sets the fields obtained from the Calyx Point® file.

Public Instance Methods

GetFieldValue Gets the Calyx Point® field value for the field id passed to the method.

SetFieldValue Sets the Calyx Point® field value for the field id passed to the method.

SaveFile Saves the Calyx Point® file with all updates set by the SetFieldValue method and the original values of the Calyx Point® file.

SaveFileWithBackup Creates a backup of the original file with an extension of ".bak" in the same directory the Calyx Point file was instantiated from. It then performs the same function as the SaveFile method.

FilePath ( string )	Gets the full file path of the Calyx Point® file you have instantiated.
GUID ( string )	Gets the Calyx File GUID. This GUID is generated by Calyx Point®.
LastUpdated ( DateTime )	Gets the last time this file was updated in Calyx Point®.
Fields ( $key => $value array )	Gets or sets the fields obtained from the Calyx Point® file.

GetFieldValue	Gets the Calyx Point® field value for the field id passed to the method.
SetFieldValue	Sets the Calyx Point® field value for the field id passed to the method.
SaveFile	Saves the Calyx Point® file with all updates set by the SetFieldValue method and the original values of the Calyx Point® file.
SaveFileWithBackup	Creates a backup of the original file with an extension of ".bak" in the same directory the Calyx Point file was instantiated from. It then performs the same function as the SaveFile method.