CkRss PHP Extension Reference Documentation

CkRss

Represents an RSS document or sub-part of a document such as a channel, image, or item. The RSS API allows one to download, create and modify RSS documents.

Object Creation

$obj = new CkRss();

Properties

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.

(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.

(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.

(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.

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.

(read-only)
int get_NumChannels()

The number of channels in the RSS document.

(read-only)
int get_NumItems()

The number of items in the channel.

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.

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.

(read-only)
string version();

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

Methods

CkRss AddNewChannel();

Adds a new channel to the RSS document. Returns the Rss object representing the Channel which can then be edited.

CkRss AddNewImage();

Adds a new image to the RSS document. Returns the Rss object representing the image, which can then be edited.

CkRss AddNewItem();

Adds a new Item to an Rss channel. Returns the Rss object representing the item which can then be edited.

bool DownloadRss(string url);

Downloads an RSS document from the Internet and populates the Rss object with the contents.

Returns true for success, false for failure.

Example: Read RSS Feed

CkTask DownloadRssAsync(string url);

Creates an asynchronous task to call the DownloadRss method with the arguments provided. (Async methods are available starting in Chilkat v9.5.0.52.)

How to Run an Asynchronous Task

bool GetAttr(string tag, string attrName, CkString outStr);
string getAttr(string tag, string attrName);

Returns the value of a sub-element attribute. For example, to get the value of the "isPermaLink" attribute of the "guid" sub-element, call item.GetAttr("guid","isPermaLink").

Returns true for success, false for failure.

CkRss GetChannel(int index);

Returns the Nth channel of an RSS document. Usually there is only 1 channel per document, so the index argument should be set to 0.

int GetCount(string tag);

Return the number of sub-elements with a specific tag.

bool GetDateStr(string tag, CkString outStr);
string getDateStr(string tag);

The same as GetDate, except the date/time is returned in RFC822 string format.

Returns true for success, false for failure.

CkRss GetImage();

Return the image associated with the channel.

int GetInt(string tag);

Return the value of a numeric sub-element as an integer.

CkRss GetItem(int index);

Return the Nth item of a channel as an RSS object.

bool GetString(string tag, CkString outStr);
string getString(string tag);

Return the value of an sub-element as a string.

Returns true for success, false for failure.

bool LoadRssFile(string filePath);

Load an RSS document from a file.

Returns true for success, false for failure.

bool LoadRssString(string rssString);

Loads an RSS feed document from an in-memory string.

Returns true for success, false for failure.

bool MGetAttr(string tag, int index, string attrName, CkString outStr);
string mGetAttr(string tag, int index, string attrName);

Get an attribute value for the Nth sub-element having a specific tag. As an example, an RSS item may have several "category" sub-elements. To get the value of the "domain" attribute for the 3rd category, call MGetAttr("category",2,"domain").

Returns true for success, false for failure.

bool MGetString(string tag, int index, CkString outStr);
string mGetString(string tag, int index);

Get the value of the Nth occurance of a sub-element. Indexing begins at 0.

Returns true for success, false for failure.

bool MSetAttr(string tag, int idx, string attrName, string value);

Set an attribute on the Nth occurance of a sub-element.

Returns true for success, false for failure.

bool MSetString(string tag, int idx, string value);

Set the value of the Nth occurance of a sub-element. Indexing begins at 0.

Returns true for success, false for failure.

void NewRss();

Clears the RSS document.

void Remove(string tag);

Removes a sub-element from the RSS document.

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.

void SetAttr(string tag, string attrName, string value);

Sets the value of a sub-element attribute.

void SetDateNow(string tag);

Sets the value of a date/time sub-element to the current system date/time.

void SetDateStr(string tag, string dateTimeStr);

The same as SetDate, except the date/time is passed as an RFC822 string.

void SetInt(string tag, int value);

Sets the value of an integer sub-element.

void SetString(string tag, string value);

Sets the value of a sub-element.

bool ToXmlString(CkString outStr);
string toXmlString();

Returns the RSS document as an XML string.

Returns true for success, false for failure.