Csv PHP ActiveX Reference Documentation
Csv
Current Version: 10.1.2
A class for reading and updating CSV files. Provides methods for accessing cell contents by name or index, updating cells, reading and setting column names, etc.
Object Creation
Chilkat v10.0.0 or greater:
$obj = new COM("Chilkat.Csv");
Chilkat v9.5.0.*:
$obj = new COM("Chilkat_9_5_0.Csv");
Properties
AutoTrim
If true, then the strings returned by GetCell and GetCellByName are auto-trimmed of whitespace from both ends.
topCrlf
If true, then CRLF line endings are used when saving the CSV to a file or to a string (i.e. for the methods SaveFile, SaveFile2, SaveToString). If false then bare LF line-endings are used.
topDebugLogFilePath
If set to a file path, this property logs the LastErrorText of each Chilkat method or property call to the specified file. This logging helps identify the context and history of Chilkat calls leading up to any crash or hang, aiding in debugging.
Enabling the VerboseLogging property provides more detailed information. This property is mainly used for debugging rare instances where a Chilkat method call causes a hang or crash, which should generally not happen.
Possible causes of hangs include:
- A timeout property set to 0, indicating an infinite timeout.
- A hang occurring within an event callback in the application code.
- An internal bug in the Chilkat code causing the hang.
Delimiter
The character that separates fields in a record. It is a comma by default. If the Delimiter property is not explicitly set, the CSV component will detect the delimiter when loading a CSV. (Semicolons are typically used in locales where the comma is used as a decimal point.)
Note 1: If the default comma delimiter is not desired when creating a new CSV, make sure to set this property before adding rows/columns to the CSV.
Note 2: If the application explicitly sets the delimiter to the vertical bar character ("|"), and if the EnableQuotes property was never explicitly set, then EnableQuotes will default to false. This is because when vertical bars are used, quotes are most likely to be treated the same as other characters.
topEnableQuotes
If true, then the double-quote characters cause the quoted content, including CR's, LF's, and delimiter chars to be treated as normal text when reading/writing CSVs. The default is true.
EscapeBackslash
If true, then the backslash character is treated as an escape character when reading/writing CSVs. The default is false.
topHasColumnNames
Set to true prior to loading a CSV if the 1st record contains column names. This allows the CSV parser to correctly load the column names and not treat them as data.
LastBinaryResult
This property is mainly used in SQL Server stored procedures to retrieve binary data from the last method call that returned binary data. It is only accessible if Chilkat.Global.KeepBinaryResult is set to true. This feature allows for the retrieval of large varbinary results in an SQL Server environment, which has restrictions on returning large data via method calls, though temp tables can handle binary properties.
topLastErrorHtml
Provides HTML-formatted information about the last called method or property. If a method call fails or behaves unexpectedly, check this property for details. Note that information is available regardless of the method call's success.
topLastErrorText
Provides plain text information about the last called method or property. If a method call fails or behaves unexpectedly, check this property for details. Note that information is available regardless of the method call's success.
LastErrorXml
Provides XML-formatted information about the last called method or property. If a method call fails or behaves unexpectedly, check this property for details. Note that information is available regardless of the method call's success.
topLastMethodSuccess
Indicates the success or failure of the most recent method call: true means success, false means failure. This property remains unchanged by property setters or getters. This method is present to address challenges in checking for null or Nothing returns in certain programming languages.
topLastStringResult
In SQL Server stored procedures, this property holds the string return value of the most recent method call that returns a string. It is accessible only when Chilkat.Global.KeepStringResult is set to TRUE. SQL Server has limitations on string lengths returned from methods and properties, but temp tables can be used to access large strings.
LastStringResultLen
The length, in characters, of the string contained in the LastStringResult property.
topNumColumns
The number of columns in the 1st row, which may be the row containing column names if HasColumnNames is true.
topNumRows
The number of data rows. If the CSV has column names, the 1st row is not included in the count. Also, empty lines containing only whitespace characters that follow the last non-empty row are not included.
topUncommonOptions
This is a catch-all property to be used for uncommon needs. Chilkat may from time to time define keywords, which if present, change behavior in some way. If multiple keywords are needed, set this property to the comma separated list of keywords.
The following keywords are defined:
- QuotedCells (v9.5.0.96) Forces all cell contents to be double-quoted when emitting the CSV to a file or string
- QuotedColumnNames (v9.5.0.96) Forces all column names to be double-quoted when emitting the CSV to a file or string
- EMIT_BOM (v9.5.0.93) Causes Chilkat to emit the utf-8 BOM (byte order mark) when writing the CSV to a file (assuming the CSV is written using utf-8).
VerboseLogging
If set to true, then the contents of LastErrorText (or LastErrorXml, or LastErrorHtml) may contain more verbose information. The default value is false. Verbose logging should only be used for debugging. The potentially large quantity of logged information may adversely affect peformance.
topVersion
Methods
DeleteColumn
Deletes the Nth column. (The 1st column is at index 0.)
Returns true for success, false for failure.
DeleteColumnByName
Deletes a column specified by name.
Returns true for success, false for failure.
DeleteRow
Deletes the entire Nth row. (The 1st row is at index 0.)
Returns true for success, false for failure.
GetCell
Returns the contents of the cell at row, col. Indexing begins at 0. (The topmost/leftmost cell is at 0,0)
Returns null on failure
GetCellByName
The same as GetCell, but the column is specified by name instead of by index.
Returns null on failure
GetColumnName
GetIndex
Returns the column index for a given column. Returns -1 if no column exists with the columnName.
topGetNumCols
Returns the number of columns for a specific row. If the row is larger than the number of rows in the CSV, a zero is returned.
topInsertColumn
Inserts a new and empty column before the Nth column. (The 1st column is at index 0.)
Returns true for success, false for failure.
LoadFile
Loads a CSV from a file. It is assumed that the CSV file contains ANSI characters.
Returns true for success, false for failure.
topLoadFile2
Loads a CSV from a file. The charset specifies the character encoding of the CSV file. A list of supported character encodings may be found on this page: Supported Charsets.
Returns true for success, false for failure.
LoadFromString
Loads a CSV document from an in-memory string variable.
Returns true for success, false for failure.
RowMatches
Compares the contents of an entire row to a wildcarded match pattern where "*" can be used any number of times to match 0 or more of any character. Returns true if a match was found, otherwise returns false. If caseSensitive is true, then the pattern match is case sensitive, otherwise it is case insensitive.
topSaveFile
Saves a CSV to a file. The output file is written using the ANSI character encoding.
Returns true for success, false for failure.
topSaveFile2
Saves a CSV to a file. The charset specifies the character encoding to use for the CSV file. The text data is converted to this charset when saving. A list of supported character encodings may be found on this page: Supported Charsets.
Returns true for success, false for failure.
SaveToSb
Clears the contents of sb and writes the entire CSV into sb.
Returns true for success, false for failure.
topSaveToString
SetCell
Sets the contents for a single cell in the CSV. The content may include any characters including CRLF's, double-quotes, and the delimiter character. The Save* methods automatically double-quote fields with special chars when saving. The Load* methods automatically parse double-quoted and/or escaped fields correctly when loading.
Returns true for success, false for failure.
SetCellByName
The same as SetCell, except the column is specified by name instead of by index.
Returns true for success, false for failure.
SetColumnName
Sets the name of the Nth column. The first column is at index 0. This method would only return false if an invalid index is passed (such as a negative number).
Returns true for success, false for failure.
SortByColumn
Sorts the rows in the CSV by the contents of a specific column. If ascending is true, the sort is in ascending order, otherwise descending order. If caseSensitive is true then the sorting is case sensitive.
Returns true for success, false for failure.
topSortByColumnIndex
Sorts the rows in the CSV by the contents of a specific column index. If ascending is true, the sort is in ascending order, otherwise descending order. If caseSensitive is true then the sorting is case sensitive.
Returns true for success, false for failure.
top