Chilkat_9_5_0.Rss PHP ActiveX Reference Documentation

Chilkat_9_5_0.Rss

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 COM("Chilkat_9_5_0.Rss");

Properties

string DebugLogFilePath

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.

VARIANT LastBinaryResult (read-only)

Introduced in version 9.5.0.52

The binary data returned by the last (binary data returning) method called. Only available if Chilkat.Global.KeepBinaryResult is set to true. This provides a means for obtaining large varbinary results in the SQL Server environment (where limitations exist in getting large amounts of data returned by method calls, but where temp tables can be used for binary properties).

string LastErrorHtml (read-only)

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.

string LastErrorText (read-only)

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.

string LastErrorXml (read-only)

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 LastMethodSuccess

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.

string LastStringResult (read-only)

Introduced in version 9.5.0.52

The string return value of the last (string returning) method called. Only available if Chilkat.Global.KeepStringResult is set to true. This provides a means for obtaining large string results in the SQL Server environment (where limitations exist in getting long strings returned by method calls, but where temp tables can be used for string properties).

Long Strings Returned by ActiveX Methods in SQL Server

int LastStringResultLen (read-only)

Introduced in version 9.5.0.53

The length, in characters, of the string contained in the LastStringResult property.

int NumChannels (read-only)

The number of channels in the RSS document.

int NumItems (read-only)

The number of items in the channel.

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

string Version (read-only)

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

Methods

Chilkat_9_5_0.Rss AddNewChannel()

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

Chilkat_9_5_0.Rss AddNewImage()

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

Chilkat_9_5_0.Rss 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

Chilkat_9_5_0.Task 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

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 null on failure

Chilkat_9_5_0.Rss 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.

Date GetDate(string tag)

This method is deprecated. It will be removed in a future version.

Return the value of a sub-element in date/time format.

string GetDateStr(string tag)

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

Returns null on failure

Chilkat_9_5_0.Rss GetImage()

Return the image associated with the channel.

int GetInt(string tag)

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

Chilkat_9_5_0.Rss GetItem(int index)

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

string GetString(string tag)

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

Returns null on 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.

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 null on failure

string MGetString(string tag, int index)

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

Returns null on 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.

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

Sets the value of a sub-element attribute.

void SetDate(string tag, Date dateTime)

This method is deprecated. It will be removed in a future version.

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

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.

string ToXmlString()

Returns the RSS document as an XML string.

Returns null on failure