CkDirTree PHP Extension Reference Documentation

CkDirTree

Current Version: 9.5.0.75

API for iterating over the files and sub-directories in a directory tree. The intent of this class is to provide a simplified, non-recursive way to iterate over an entire directory tree.

Object Creation

$obj = new CkDirTree();

Properties

BaseDir
string baseDir();
void put_BaseDir(string strVal);

Begin iterating from this directory.

top
DebugLogFilePath
string debugLogFilePath();
void put_DebugLogFilePath(string strVal);

If set to a file path, causes each Chilkat method or property call to automatically append it's LastErrorText to the specified log file. The information is appended such that if a hang or crash occurs, it is possible to see the context in which the problem occurred, as well as a history of all Chilkat calls up to the point of the problem. The VerboseLogging property can be set to provide more detailed information.

This property is typically used for debugging the rare cases where a Chilkat method call hangs or generates an exception that halts program execution (i.e. crashes). A hang or crash should generally never happen. The typical causes of a hang are:

  1. a timeout related property was set to 0 to explicitly indicate that an infinite timeout is desired,
  2. the hang is actually a hang within an event callback (i.e. it is a hang within the application code), or
  3. there is an internal problem (bug) in the Chilkat code that causes the hang.

top
DoneIterating
(read-only)
bool get_DoneIterating()

Set to true when the last file or sub-directory has been iterated.

top
FileSize32
(read-only)
int get_FileSize32()

The file size of the current file in the iteration. (0 if it is a directory.)

top
FileSize64
(read-only)
int64 get_FileSize64()

The file size as a 64-bit integer of the current file in the iteration. (0 if it is a directory.)

top
FullPath
(read-only)
string fullPath();

The absolute directory path of the current file or sub-directory.

top
FullUncPath
(read-only)
string fullUncPath();

The absolute UNC directory path of the current file or sub-directory.

top
IsDirectory
(read-only)
bool get_IsDirectory()

true if the current position is a sub-directory, false if it is a file.

top
LastErrorHtml
(read-only)
string lastErrorHtml();

Provides information in HTML format about the last method/property called. If a method call returns a value indicating failure, or behaves unexpectedly, examine this property to get more information.

top
LastErrorText
(read-only)
string lastErrorText();

Provides information in plain-text format about the last method/property called. If a method call returns a value indicating failure, or behaves unexpectedly, examine this property to get more information.

top
LastErrorXml
(read-only)
string lastErrorXml();

Provides information in XML format about the last method/property called. If a method call returns a value indicating failure, or behaves unexpectedly, examine this property to get more information.

top
LastMethodSuccess
bool get_LastMethodSuccess()
void put_LastMethodSuccess(bool boolVal);
Introduced in version 9.5.0.52

Indicate whether the last method call succeeded or failed. A value of true indicates success, a value of false indicates failure. This property is automatically set for method calls. It is not modified by property accesses. The property is automatically set to indicate success for the following types of method calls:

  • Any method that returns a string.
  • Any method returning a Chilkat object, binary bytes, or a date/time.
  • Any method returning a standard boolean status value where success = true and failure = false.
  • Any method returning an integer where failure is defined by a return value less than zero.

Note: Methods that do not fit the above requirements will always set this property equal to true. For example, a method that returns no value (such as a "void" in C++) will technically always succeed.

top
Recurse
bool get_Recurse()
void put_Recurse(bool boolVal);

If true, the iteration will be recursive. If false the iteration is non-recursive. The default value is true.

top
RelativePath
(read-only)
string relativePath();

The relative directory path of the current file or sub-directory. (Relative to the BaseDir)

top
Utf8
bool get_Utf8()
void put_Utf8(bool boolVal);

When set to true, all "const char *" arguments are interpreted as utf-8 strings. If set to false (the default), then "const char *" arguments are interpreted as ANSI strings. Also, when set to true, and Chilkat method returning a "const char *" is returning the utf-8 representation. If set to false, all "const char *" return values are ANSI strings.

top
VerboseLogging
bool get_VerboseLogging()
void put_VerboseLogging(bool boolVal);

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.

top
Version
(read-only)
string version();

Version of the component/library, such as "9.5.0.63"

top

Methods

AdvancePosition
bool AdvancePosition();

Advances the current position in the directory tree traversal to the next file or sub-directory.

Important: If AdvancePosition returns false, it can be an error, or it could be that there are no more files and directories. To distinguish between the two cases, examine the DoneIterating property. If DoneIterating is true, then the false return value is not an error, but instead indicates that the end has been reached.

Returns true for success, false for failure.

top
BeginIterate
bool BeginIterate();

Begins a directory tree traversal. After calling this method, the various property values such as Fullpath, FileSize32, etc. can be retrieved for the 1st file / sub-directory in the traversal.

Important: If BeginIterate returns false, it can be an error, or it could be that there are 0 files and directories. To distinguish between the two cases, examine the DoneIterating property. If DoneIterating is true, then the false return value is not an error, but instead indicates 0 files/directories.

Returns true for success, false for failure.

top
SaveLastError
bool SaveLastError(string path);

Saves the last-error information (the contents of LastErrorXml) to an XML formatted file.

Returns true for success, false for failure.

top