Rss PHP Extension Reference Documentation

CkRss

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

Current Version: 10.1.2

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

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.

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.

NumChannels

(read-only)
int get_NumChannels()

The number of channels in the RSS document.

NumItems

(read-only)
int get_NumItems()

The number of items in the channel.

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

AddNewChannel

CkRss AddNewChannel();

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

Returns null on failure

AddNewImage

CkRss AddNewImage();

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

Returns null on failure

AddNewItem

CkRss AddNewItem();

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

Returns null on failure

DownloadRss

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.

More Information and Examples

Example: Read RSS Feed

DownloadRssAsync ⁽¹⁾

CkTask DownloadRssAsync(string url);

Creates an asynchronous task to call the DownloadRss method with the arguments provided.

Returns null on failure

GetAttr

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.

GetChannel

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.

Returns null on failure

GetCount

int GetCount(string tag);

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

GetDateStr

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.

GetImage

CkRss GetImage();

Return the image associated with the channel.

Returns null on failure

GetInt

int GetInt(string tag);

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

GetItem

CkRss GetItem(int index);

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

Returns null on failure

GetString

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.

LoadRssFile

bool LoadRssFile(string filePath);

Load an RSS document from a file.

Returns true for success, false for failure.

LoadRssString

bool LoadRssString(string rssString);

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

Returns true for success, false for failure.

LoadTaskCaller

bool LoadTaskCaller(CkTask task);

Introduced in version 9.5.0.80

Loads the caller of the task's async method.

Returns true for success, false for failure.

MGetAttr

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.

MGetString

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

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

Returns true for success, false for failure.

MSetAttr

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

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

Returns true for success, false for failure.

MSetString

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

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

Returns true for success, false for failure.

NewRss

void NewRss();

Clears the RSS document.

Remove

void Remove(string tag);

Removes a sub-element from the RSS document.

SetAttr

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

Sets the value of a sub-element attribute.

SetDateNow

void SetDateNow(string tag);

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

SetDateStr

void SetDateStr(string tag, string dateTimeStr);

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

SetInt

void SetInt(string tag, int value);

Sets the value of an integer sub-element.

SetString

void SetString(string tag, string value);

Sets the value of a sub-element.

ToXmlString

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

Returns the RSS document as an XML string.

Returns true for success, false for failure.