Cgi PHP Extension Reference Documentation

CkCgi

Deprecated To be removed in a future version, and should no longer be used.

Current Version: 10.1.3

Provides the ability to receive HTTP requests and all associated parameters, HTTP header fields, etc. A common use is for receiving HTTP uploads. Provides the ability to receive uploads that stream directly to disk, eliminating memory requirements for large files. Also provides the ability to receive uploaded files directly in memory.

Object Creation

$obj = new CkCgi();

Properties

AsyncBytesRead

(read-only)
int get_AsyncBytesRead()

To be documented soon...

AsyncInProgress

(read-only)
bool get_AsyncInProgress()

To be documented soon...

AsyncPostSize

(read-only)
int get_AsyncPostSize()

To be documented soon...

AsyncSuccess

(read-only)
bool get_AsyncSuccess()

To be documented soon...

DebugLogFilePath

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

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.

More Information and Examples

Example showing how to use DebugLogFilePath.

IdleTimeoutMs

int get_IdleTimeoutMs()
void put_IdleTimeoutMs(int intVal);

To be documented soon...

LastErrorHtml

(read-only)
string lastErrorHtml();

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.

LastErrorText

(read-only)
string lastErrorText();

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.

More Information and Examples

Concept of LastErrorText LastErrorText Standard Information

LastErrorXml

(read-only)
string 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.

LastMethodSuccess

bool get_LastMethodSuccess()
void put_LastMethodSuccess(bool boolVal);

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.

NumParams

(read-only)
int get_NumParams()

To be documented soon...

NumUploadFiles

(read-only)
int get_NumUploadFiles()

To be documented soon...

ReadChunkSize

int get_ReadChunkSize()
void put_ReadChunkSize(int intVal);

To be documented soon...

SizeLimitKB

int get_SizeLimitKB()
void put_SizeLimitKB(int intVal);

To be documented soon...

StreamToUploadDir

bool get_StreamToUploadDir()
void put_StreamToUploadDir(bool boolVal);

To be documented soon...

UploadDir

string uploadDir();
void put_UploadDir(string strVal);

To be documented soon...

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.

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.

Version

(read-only)
string version();

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

More Information and Examples

How to get the Chilkat version at runtime.

Methods

AbortAsync

void AbortAsync();

To be documented soon...

AsyncReadRequest

bool AsyncReadRequest();

To be documented soon...

GetEnv

bool GetEnv(string varName, CkString outStr);
string getEnv(string varName);

To be documented soon...

Returns true for success, false for failure.

GetParam

bool GetParam(string paramName, CkString outStr);
string getParam(string paramName);

To be documented soon...

Returns true for success, false for failure.

GetParamName

bool GetParamName(int index, CkString outStr);
string getParamName(int index);

To be documented soon...

Returns true for success, false for failure.

GetParamValue

bool GetParamValue(int index, CkString outStr);
string getParamValue(int index);

To be documented soon...

Returns true for success, false for failure.

GetRawPostData

bool GetRawPostData(CkByteData outData);

To be documented soon...

Returns true for success, false for failure.

GetUploadData

bool GetUploadData(int index, CkByteData outData);

To be documented soon...

Returns true for success, false for failure.

GetUploadFilename

bool GetUploadFilename(int index, CkString outStr);
string getUploadFilename(int index);

To be documented soon...

Returns true for success, false for failure.

GetUploadSize

int GetUploadSize(int index);

To be documented soon...

IsGet

bool IsGet();

To be documented soon...

IsHead

bool IsHead();

To be documented soon...

IsPost

bool IsPost();

To be documented soon...

IsUpload

bool IsUpload();

To be documented soon...

ReadRequest

bool ReadRequest();

To be documented soon...

SaveNthToUploadDir

bool SaveNthToUploadDir(int index);

To be documented soon...

SleepMs

void SleepMs(int millisec);

To be documented soon...

TestConsumeAspUpload

bool TestConsumeAspUpload(string path);

To be documented soon...