RSS Class

Properties   Methods   Events   Config Settings   Errors  

The RSS Class is used to retrieve, parse, edit, and write RSS-syndicated content.

Class Name

IPWorks_RSS

Procedural Interface

 ipworks_rss_open();
 ipworks_rss_close($res);
 ipworks_rss_register_callback($res, $id, $function);
 ipworks_rss_get_last_error($res);
 ipworks_rss_get_last_error_code($res);
 ipworks_rss_set($res, $id, $index, $value);
 ipworks_rss_get($res, $id, $index);
 ipworks_rss_do_addcookie($res, $cookiename, $cookievalue);
 ipworks_rss_do_additem($res, $title, $description, $link);
 ipworks_rss_do_addnamespace($res, $prefix, $namespaceuri);
 ipworks_rss_do_config($res, $configurationstring);
 ipworks_rss_do_doevents($res);
 ipworks_rss_do_getfeed($res, $url);
 ipworks_rss_do_getproperty($res, $propertyname);
 ipworks_rss_do_geturl($res, $url);
 ipworks_rss_do_interrupt($res);
 ipworks_rss_do_opmlattr($res, $attrname);
 ipworks_rss_do_put($res, $url);
 ipworks_rss_do_readfile($res, $filename);
 ipworks_rss_do_readopml($res, $opmlfile);
 ipworks_rss_do_reset($res);
 ipworks_rss_do_setproperty($res, $propertyname, $propertyvalue);
 ipworks_rss_do_writefile($res, $filename);

Remarks

The RSS Class supports both plaintext and Secure Sockets Layer/Transport Layer Security (SSL/TLS) connections. When connecting over Secure Sockets Layer/Transport Layer Security (SSL/TLS) the SSLServerAuthentication event allows you to check the server identity and other security attributes. The SSLStatus event provides information about the SSL handshake. Additional SSL-related settings are also supported through the Config method.

The RSS Class implements a standard RSS newsreader with extended capabilities as specified at http://backend.userland.com/rss2.

The class contains a number of properties that map directly to RSS fields. To receive a feed, call the GetFeed method with the URL or file to retrieve as specified in the URL parameter. The RSS class also can generate RSS feeds, which can be retrieved through the RSSData property or written through the WriteFile method.

The RSS Class supports all RSS feed properties that are standard in versions 0.91, 0.92, and 2.0 of the RSS protocol through a number of class properties. It also supports nonstandard properties as specified in the RSS protocol through the Namespaces properties and the GetProperty and SetProperty methods.

Property List

The following is the full list of the properties of the class with short descriptions. Click on the links for further details.

Method List

The following is the full list of the methods of the class with short descriptions. Click on the links for further details.

Event List

The following is the full list of the events fired by the class with short descriptions. Click on the links for further details.

Config Settings

The following is a list of config settings for the class with short descriptions. Click on the links for further details.

Accept Property (IPWorks_RSS Class)

This property includes a list of acceptable MIME types for the request.

Object Oriented Interface

public function getAccept();
public function setAccept($value);

Procedural Interface

ipworks_rss_get($res, 1 );
ipworks_rss_set($res, 1, $value );

Default Value

''

Remarks

If this property contains a nonempty string, an HTTP Accept header is added to the request.

The Accept header is used for content negotiation. It provides the server with a comma-separated list of MIME types that are acceptable for its response.

Data Type

String

Authorization Property (IPWorks_RSS Class)

This property includes the Authorization string to be sent to the server.

Object Oriented Interface

public function getAuthorization();
public function setAuthorization($value);

Procedural Interface

ipworks_rss_get($res, 2 );
ipworks_rss_set($res, 2, $value );

Default Value

''

Remarks

If the Authorization property contains a nonempty string, an Authorization HTTP request header is added to the request. This header conveys Authorization information to the server.

A common use for this property is to specify OAuth authorization string.

This property is provided so that the HTTP class can be extended with other security schemes in addition to the authorization schemes already implemented by the class.

The AuthScheme property defines the authentication scheme used. In the case of HTTP Basic Authentication (default), every time User and Password are set, they are Base64 encoded, and the result is put in the Authorization property in the form "Basic [encoded-user-password]".

Data Type

String

AuthScheme Property (IPWorks_RSS Class)

This property specifies the authentication scheme to use when server authentication is required.

Object Oriented Interface

public function getAuthScheme();
public function setAuthScheme($value);

Procedural Interface

ipworks_rss_get($res, 3 );
ipworks_rss_set($res, 3, $value );

Default Value

0

Remarks

This property will tell the class which type of authorization to perform when the User and Password properties are set.

This property should be set to authNone (3) when no authentication is to be performed.

By default, this property is authBasic (0), and if the User and Password properties are set, the class will attempt HTTP Basic Authentication. If AuthScheme is set to authDigest (1), authNtlm (4), or authNegotiate (5), then Digest, NTLM, or Windows Negotiate (Kerberos) authentication will be attempted instead.

If AuthScheme is set to authProprietary (2), then the authorization token must be supplied through the Authorization property.

If AuthScheme is set to authOAuth (6), then the authorization string must be supplied through the Authorization property.

Note: If you set the Authorization property and AuthScheme is not authProprietary or authOAuth, then the AuthScheme will be set automatically to authProprietary (2) by the class.

For security, changing the value of this property will cause the class to clear the values of User, Password, and Authorization.

Data Type

Integer

ChannelCategory Property (IPWorks_RSS Class)

The value of this property is a forward-slash-separated string that identifies a hierarchical location in a particular hierarchy.

Object Oriented Interface

public function getChannelCategory();
public function setChannelCategory($value);

Procedural Interface

ipworks_rss_get($res, 4 );
ipworks_rss_set($res, 4, $value );

Default Value

''

Remarks

The value of this property is a forward-slash-separated string that identifies a hierarchical location in a particular hierarchy. The conventions used to interpret an RSS channel's category depend upon the processor.

Data Type

String

ChannelCategoryDomain Property (IPWorks_RSS Class)

This property contains the URL indicating the definition of the current RSS channel's category.

Object Oriented Interface

public function getChannelCategoryDomain();
public function setChannelCategoryDomain($value);

Procedural Interface

ipworks_rss_get($res, 5 );
ipworks_rss_set($res, 5, $value );

Default Value

''

Remarks

This property contains the URL indicating the definition of the current RSS channel's category. This points to a location that defines the category indicated by the ChannelCategory property.

This property is not available at design time.

Data Type

String

ChannelCopyright Property (IPWorks_RSS Class)

This property contains the copyright information for the current RSS channel (500 character maximum).

Object Oriented Interface

public function getChannelCopyright();
public function setChannelCopyright($value);

Procedural Interface

ipworks_rss_get($res, 6 );
ipworks_rss_set($res, 6, $value );

Default Value

''

Remarks

This property contains the copyright information for the current RSS channel (500 character maximum).

Data Type

String

ChannelDescription Property (IPWorks_RSS Class)

This property contains a textual description of the current RSS feed (500 character maximum required).

Object Oriented Interface

public function getChannelDescription();
public function setChannelDescription($value);

Procedural Interface

ipworks_rss_get($res, 7 );
ipworks_rss_set($res, 7, $value );

Default Value

''

Remarks

This property contains a textual description of the current RSS feed (500 character maximum required).

This property is filled in automatically after calling GetFeed.

Required fields for building RSS feeds include the Channel's ChannelLink, ChannelTitle, and ChannelDescription fields.

Data Type

String

ChannelDocs Property (IPWorks_RSS Class)

This property should contain the URL for the documentation describing the format that was used to create the current RSS channel.

Object Oriented Interface

public function getChannelDocs();
public function setChannelDocs($value);

Procedural Interface

ipworks_rss_get($res, 8 );
ipworks_rss_set($res, 8, $value );

Default Value

'http://backend.userland.com/rss2'

Remarks

This property should contain the URL for the documentation describing the format that was used to create the current RSS channel. The default value points to the standard RSS 2.0 documentation found at "http://backend.userland.com/rss2".

Data Type

String

ChannelGenerator Property (IPWorks_RSS Class)

This property contains the name of the program that created the RSS feed.

Object Oriented Interface

public function getChannelGenerator();
public function setChannelGenerator($value);

Procedural Interface

ipworks_rss_get($res, 9 );
ipworks_rss_set($res, 9, $value );

Default Value

'IPWorks Version 8.0 RSS Component'

Remarks

This property contains the name of the program that created the RSS feed.

Data Type

String

ChannelImageDescription Property (IPWorks_RSS Class)

This property is used to specify text that is included in the title attribute of the image's link formed in the HTML rendering.

Object Oriented Interface

public function getChannelImageDescription();
public function setChannelImageDescription($value);

Procedural Interface

ipworks_rss_get($res, 10 );
ipworks_rss_set($res, 10, $value );

Default Value

''

Remarks

This property is used to specify text that is included in the title attribute of the image's link formed in the HTML rendering.

Data Type

String

ChannelImageHeight Property (IPWorks_RSS Class)

This property contains the height of the image in pixels.

Object Oriented Interface

public function getChannelImageHeight();
public function setChannelImageHeight($value);

Procedural Interface

ipworks_rss_get($res, 11 );
ipworks_rss_set($res, 11, $value );

Default Value

''

Remarks

This property contains the height of the image in pixels.

Data Type

String

ChannelImageLink Property (IPWorks_RSS Class)

This property contains the URL associated with the channel's associated image.

Object Oriented Interface

public function getChannelImageLink();
public function setChannelImageLink($value);

Procedural Interface

ipworks_rss_get($res, 12 );
ipworks_rss_set($res, 12, $value );

Default Value

''

Remarks

This property contains the URL associated with the channel's associated image.

Images are required for RSS channels that conform to versions 0.91 and 0.92 of the RSS protocol. The following properties are required for an image:

Data Type

String

ChannelImageTitle Property (IPWorks_RSS Class)

This property contains the title of the channel's associated image.

Object Oriented Interface

public function getChannelImageTitle();
public function setChannelImageTitle($value);

Procedural Interface

ipworks_rss_get($res, 13 );
ipworks_rss_set($res, 13, $value );

Default Value

''

Remarks

This property contains the title of the channel's associated image.

Images are required for RSS channels that conform to versions 0.91 and 0.92 of the RSS protocol. The following properties are required for an image:

Data Type

String

ChannelImageUrl Property (IPWorks_RSS Class)

This property contains the URL location of the channel's associated image.

Object Oriented Interface

public function getChannelImageUrl();
public function setChannelImageUrl($value);

Procedural Interface

ipworks_rss_get($res, 14 );
ipworks_rss_set($res, 14, $value );

Default Value

''

Remarks

This property contains the URL location of the channel's associated image.

Images are required for RSS channels that conform to versions 0.91 and 0.92 of the RSS protocol. The following properties are required for an image:

Data Type

String

ChannelImageWidth Property (IPWorks_RSS Class)

This property contains the width of the image in pixels.

Object Oriented Interface

public function getChannelImageWidth();
public function setChannelImageWidth($value);

Procedural Interface

ipworks_rss_get($res, 15 );
ipworks_rss_set($res, 15, $value );

Default Value

''

Remarks

This property contains the width of the image in pixels.

Data Type

String

ChannelLanguage Property (IPWorks_RSS Class)

This property is required for feeds that conform to versions 0.

Object Oriented Interface

public function getChannelLanguage();
public function setChannelLanguage($value);

Procedural Interface

ipworks_rss_get($res, 16 );
ipworks_rss_set($res, 16, $value );

Default Value

''

Remarks

This property is required for feeds that conform to versions 0.91 of the RSS protocol. It contains the language code used to identify the language of the current RSS channel.

Example. Language Codes:

For a detailed explanation about language codes, please refer to RFC 1766.

Data Type

String

ChannelLastBuildDate Property (IPWorks_RSS Class)

This property contains the date of the current RSS channel's most recent content changes.

Object Oriented Interface

public function getChannelLastBuildDate();
public function setChannelLastBuildDate($value);

Procedural Interface

ipworks_rss_get($res, 17 );
ipworks_rss_set($res, 17, $value );

Default Value

''

Remarks

This property contains the date of the current RSS channel's most recent content changes. It should conform to the standards set in RFC 822, with the exception that years can be either two or four characters long.

Data Type

String

ChannelLink Property (IPWorks_RSS Class)

This property contains the URL that corresponds to the website where the RSS channel is located (500 character maximum required).

Object Oriented Interface

public function getChannelLink();
public function setChannelLink($value);

Procedural Interface

ipworks_rss_get($res, 18 );
ipworks_rss_set($res, 18, $value );

Default Value

''

Remarks

This property contains the URL that corresponds to the website where the RSS channel is located (500 character maximum required).

This property is filled in automatically after calling GetFeed.

Required fields for building RSS feeds include the Channel's ChannelLink, ChannelTitle, and ChannelDescription fields.

Data Type

String

ChannelManagingEditor Property (IPWorks_RSS Class)

This property contains the email address or contact information for the current RSS channel's editor.

Object Oriented Interface

public function getChannelManagingEditor();
public function setChannelManagingEditor($value);

Procedural Interface

ipworks_rss_get($res, 19 );
ipworks_rss_set($res, 19, $value );

Default Value

''

Remarks

This property contains the email address or contact information for the current RSS channel's editor.

Data Type

String

ChannelPubDate Property (IPWorks_RSS Class)

This property contains the date of the current RSS channel's most recent publication.

Object Oriented Interface

public function getChannelPubDate();
public function setChannelPubDate($value);

Procedural Interface

ipworks_rss_get($res, 20 );
ipworks_rss_set($res, 20, $value );

Default Value

''

Remarks

This property contains the date of the current RSS channel's most recent publication. It should conform to the standards set in RFC 822, with the exception that years can be either two or four characters long.

Data Type

String

ChannelSkipDays Property (IPWorks_RSS Class)

This property contains a list of days in which aggregators may skip reading the channel.

Object Oriented Interface

public function getChannelSkipDays();
public function setChannelSkipDays($value);

Procedural Interface

ipworks_rss_get($res, 21 );
ipworks_rss_set($res, 21, $value );

Default Value

''

Remarks

This property contains a list of days in which aggregators may skip reading the channel. When using this property, its value must contain "<day>" XML subelements. Each subelement's value must be a valid day of the week, such as Monday, Tuesday, Wednesday, and so on. Up to seven days may be specified for this property.

Data Type

String

ChannelSkipHours Property (IPWorks_RSS Class)

This property contains a list of hours in which aggregators may skip reading the channel.

Object Oriented Interface

public function getChannelSkipHours();
public function setChannelSkipHours($value);

Procedural Interface

ipworks_rss_get($res, 22 );
ipworks_rss_set($res, 22, $value );

Default Value

''

Remarks

This property contains a list of hours in which aggregators may skip reading the channel. When using this property, its value must contain "<hour>" XML subelements. Each subelement's value must be a valid hour between 0 and 23, representing a time in GMT. Up to 24 subelements may be specified for this property.

Note: Hour zero is the hour starting at midnight.

Data Type

String

ChannelTitle Property (IPWorks_RSS Class)

This property contains the title of the current RSS feed (40 character maximum required).

Object Oriented Interface

public function getChannelTitle();
public function setChannelTitle($value);

Procedural Interface

ipworks_rss_get($res, 23 );
ipworks_rss_set($res, 23, $value );

Default Value

''

Remarks

This property contains the title of the current RSS feed (40 character maximum required). Typically, the title of the channel is similar to that of the web page where the RSS content is hosted.

This property is filled in automatically after calling GetFeed.

Required fields for building RSS feeds include the Channel's ChannelLink, ChannelTitle, and ChannelDescription fields.

Data Type

String

ChannelTtl Property (IPWorks_RSS Class)

This property contains the number of minutes that represents how long the channel may be cached before it needs to be refreshed from the source.

Object Oriented Interface

public function getChannelTtl();
public function setChannelTtl($value);

Procedural Interface

ipworks_rss_get($res, 24 );
ipworks_rss_set($res, 24, $value );

Default Value

''

Remarks

This property contains the number of minutes that represents how long the channel may be cached before it needs to be refreshed from the source.

Data Type

String

ChannelWebMaster Property (IPWorks_RSS Class)

This property contains the email address or contact information for the current RSS channel's webmaster.

Object Oriented Interface

public function getChannelWebMaster();
public function setChannelWebMaster($value);

Procedural Interface

ipworks_rss_get($res, 25 );
ipworks_rss_set($res, 25, $value );

Default Value

''

Remarks

This property contains the email address or contact information for the current RSS channel's webmaster.

Data Type

String

Connected Property (IPWorks_RSS Class)

Whether the class is connected.

Object Oriented Interface

public function getConnected();

Procedural Interface

ipworks_rss_get($res, 26 );

Default Value

false

Remarks

This property is used to determine whether or not the class is connected to the remote host. Use the Connect and Disconnect methods to manage the connection.

This property is read-only and not available at design time.

Data Type

Boolean

CookieCount Property (IPWorks_RSS Class)

The number of records in the Cookie arrays.

Object Oriented Interface

public function getCookieCount();
public function setCookieCount($value);

Procedural Interface

ipworks_rss_get($res, 27 );
ipworks_rss_set($res, 27, $value );

Default Value

0

Remarks

This property controls the size of the following arrays:

• CookieDomain
• CookieExpiration
• CookieName
• CookiePath
• CookieSecure
• CookieValue

The array indices start at 0 and end at CookieCount - 1.

This property is not available at design time.

Data Type

Integer

CookieDomain Property (IPWorks_RSS Class)

The domain of a received cookie.

Object Oriented Interface

public function getCookieDomain($cookieindex);

Procedural Interface

ipworks_rss_get($res, 28 , $cookieindex);

Default Value

''

Remarks

The domain of a received cookie. This property contains a domain name to limit the cookie to (if provided by the server). If the server does not provide a domain name, this property will contain an empty string. The convention in this case is to use the server name specified by URLServer as the cookie domain.

The $cookieindex parameter specifies the index of the item in the array. The size of the array is controlled by the CookieCount property.

This property is read-only and not available at design time.

Data Type

String

CookieExpiration Property (IPWorks_RSS Class)

An expiration time for the cookie (if provided by the server).

Object Oriented Interface

public function getCookieExpiration($cookieindex);

Procedural Interface

ipworks_rss_get($res, 29 , $cookieindex);

Default Value

''

Remarks

An expiration time for the cookie (if provided by the server). The time format used is "Weekday, DD-Mon-YY HH:MM:SS GMT". If the server does not provide an expiration time, this property will contain an empty string. The convention is to drop the cookie at the end of the session.

The $cookieindex parameter specifies the index of the item in the array. The size of the array is controlled by the CookieCount property.

This property is read-only and not available at design time.

Data Type

String

CookieName Property (IPWorks_RSS Class)

The name of the cookie.

Object Oriented Interface

public function getCookieName($cookieindex);
public function setCookieName($cookieindex, $value);

Procedural Interface

ipworks_rss_get($res, 30 , $cookieindex);
ipworks_rss_set($res, 30, $value , $cookieindex);

Default Value

''

Remarks

The name of the cookie.

This property, along with CookieValue, stores the cookie that is to be sent to the server. The SetCookie event displays the cookies sent by the server and their properties.

The $cookieindex parameter specifies the index of the item in the array. The size of the array is controlled by the CookieCount property.

This property is not available at design time.

Data Type

String

CookiePath Property (IPWorks_RSS Class)

A path name to limit the cookie to (if provided by the server).

Object Oriented Interface

public function getCookiePath($cookieindex);

Procedural Interface

ipworks_rss_get($res, 31 , $cookieindex);

Default Value

''

Remarks

A path name to limit the cookie to (if provided by the server). If the server does not provide a cookie path, the path property will be an empty string. The convention in this case is to use the path specified by URLPath as the cookie path.

The $cookieindex parameter specifies the index of the item in the array. The size of the array is controlled by the CookieCount property.

This property is read-only and not available at design time.

Data Type

String

CookieSecure Property (IPWorks_RSS Class)

The security flag of the received cookie.

Object Oriented Interface

public function getCookieSecure($cookieindex);

Procedural Interface

ipworks_rss_get($res, 32 , $cookieindex);

Default Value

false

Remarks

The security flag of the received cookie. This property specifies whether the cookie is secure. If the value of this property is True, the cookie value must be submitted only through a secure (HTTPS) connection.

The $cookieindex parameter specifies the index of the item in the array. The size of the array is controlled by the CookieCount property.

This property is read-only and not available at design time.

Data Type

Boolean

CookieValue Property (IPWorks_RSS Class)

The value of the cookie.

Object Oriented Interface

public function getCookieValue($cookieindex);
public function setCookieValue($cookieindex, $value);

Procedural Interface

ipworks_rss_get($res, 33 , $cookieindex);
ipworks_rss_set($res, 33, $value , $cookieindex);

Default Value

''

Remarks

The value of the cookie. A corresponding value is associated with the cookie specified by CookieName. This property holds that value.

The SetCookie event provides the cookies set by the server.

The $cookieindex parameter specifies the index of the item in the array. The size of the array is controlled by the CookieCount property.

This property is not available at design time.

Data Type

String

FirewallAutoDetect Property (IPWorks_RSS Class)

Whether to automatically detect and use firewall system settings, if available.

Object Oriented Interface

public function getFirewallAutoDetect();
public function setFirewallAutoDetect($value);

Procedural Interface

ipworks_rss_get($res, 34 );
ipworks_rss_set($res, 34, $value );

Default Value

false

Remarks

Whether to automatically detect and use firewall system settings, if available.

Data Type

Boolean

FirewallType Property (IPWorks_RSS Class)

The type of firewall to connect through.

Object Oriented Interface

public function getFirewallType();
public function setFirewallType($value);

Procedural Interface

ipworks_rss_get($res, 35 );
ipworks_rss_set($res, 35, $value );

Default Value

0

Remarks

The type of firewall to connect through. The applicable values are as follows:

Data Type

Integer

FirewallHost Property (IPWorks_RSS Class)

The name or IP address of the firewall (optional).

Object Oriented Interface

public function getFirewallHost();
public function setFirewallHost($value);

Procedural Interface

ipworks_rss_get($res, 36 );
ipworks_rss_set($res, 36, $value );

Default Value

''

Remarks

The name or IP address of the firewall (optional). If a FirewallHost is given, the requested connections will be authenticated through the specified firewall when connecting.

If this property is set to a Domain Name, a DNS request is initiated. Upon successful termination of the request, this property is set to the corresponding address. If the search is not successful, the class fails with an error.

Data Type

String

FirewallPassword Property (IPWorks_RSS Class)

A password if authentication is to be used when connecting through the firewall.

Object Oriented Interface

public function getFirewallPassword();
public function setFirewallPassword($value);

Procedural Interface

ipworks_rss_get($res, 37 );
ipworks_rss_set($res, 37, $value );

Default Value

''

Remarks

A password if authentication is to be used when connecting through the firewall. If FirewallHost is specified, the FirewallUser and FirewallPassword properties are used to connect and authenticate to the given firewall. If the authentication fails, the class fails with an error.

Data Type

String

FirewallPort Property (IPWorks_RSS Class)

The Transmission Control Protocol (TCP) port for the firewall Host .

Object Oriented Interface

public function getFirewallPort();
public function setFirewallPort($value);

Procedural Interface

ipworks_rss_get($res, 38 );
ipworks_rss_set($res, 38, $value );

Default Value

0

Remarks

The Transmission Control Protocol (TCP) port for the firewall FirewallHost. See the description of the FirewallHost property for details.

Note: This property is set automatically when FirewallType is set to a valid value. See the description of the FirewallType property for details.

Data Type

Integer

FirewallUser Property (IPWorks_RSS Class)

A username if authentication is to be used when connecting through a firewall.

Object Oriented Interface

public function getFirewallUser();
public function setFirewallUser($value);

Procedural Interface

ipworks_rss_get($res, 39 );
ipworks_rss_set($res, 39, $value );

Default Value

''

Remarks

A username if authentication is to be used when connecting through a firewall. If FirewallHost is specified, this property and the FirewallPassword property are used to connect and authenticate to the given Firewall. If the authentication fails, the class fails with an error.

Data Type

String

FollowRedirects Property (IPWorks_RSS Class)

Determines what happens when the server issues a redirect.

Object Oriented Interface

public function getFollowRedirects();
public function setFollowRedirects($value);

Procedural Interface

ipworks_rss_get($res, 40 );
ipworks_rss_set($res, 40, $value );

Default Value

0

Remarks

This property determines what happens when the server issues a redirect. Normally, the class returns an error if the server responds with an "Object Moved" message. If this property is set to frAlways (1), the new URL for the object is retrieved automatically every time.

If this property is set to frSameScheme (2), the new URL is retrieved automatically only if the URLScheme is the same; otherwise, the class fails with an error.

Note: Following the HTTP specification, unless this property is set to frAlways (1), automatic redirects will be performed only for GET or HEAD requests. Other methods potentially could change the conditions of the initial request and create security vulnerabilities.

Furthermore, if either the new URL server or port are different from the existing one, User and Password are also reset to empty. If, however, this property is set to frAlways (1), the same credentials are used to connect to the new server.

A Redirect event is fired for every URL the product is redirected to. In the case of automatic redirections, the Redirect event is a good place to set properties related to the new connection (e.g., new authentication parameters).

The default value is frNever (0). In this case, redirects are never followed, and the class fails with an error instead.

Data Type

Integer

Idle Property (IPWorks_RSS Class)

The current status of the class.

Object Oriented Interface

public function getIdle();

Procedural Interface

ipworks_rss_get($res, 41 );

Default Value

true

Remarks

This property will be False if the component is currently busy (communicating or waiting for an answer), and True at all other times.

This property is read-only.

Data Type

Boolean

IfModifiedSince Property (IPWorks_RSS Class)

This property includes a date determining the maximum age of the desired document.

Object Oriented Interface

public function getIfModifiedSince();
public function setIfModifiedSince($value);

Procedural Interface

ipworks_rss_get($res, 42 );
ipworks_rss_set($res, 42, $value );

Default Value

''

Remarks

If this property contains a nonempty string, an If-Modified-Since HTTP header is added to the request. The value of this header is used to make the HTTP request conditional: If the requested documented has not been modified since the time specified in the field, a copy of the document will not be returned from the server; instead, a 304 (not modified) response will be returned by the server and the class fails with an error

The format of the date value for IfModifiedSince is detailed in the HTTP specs. An example is Sat, 29 Oct 1994 19:43:31 GMT.

This property is not available at design time.

Data Type

String

ItemCount Property (IPWorks_RSS Class)

The number of records in the Item arrays.

Object Oriented Interface

public function getItemCount();
public function setItemCount($value);

Procedural Interface

ipworks_rss_get($res, 43 );
ipworks_rss_set($res, 43, $value );

Default Value

0

Remarks

This property controls the size of the following arrays:

• ItemAuthor
• ItemCategory
• ItemCategoryDomain
• ItemComments
• ItemDescription
• ItemEnclosureLength
• ItemEnclosureType
• ItemEnclosureUrl
• ItemGuid
• ItemGuidIsPermaLink
• ItemLink
• ItemPubDate
• ItemSource
• ItemSourceURL
• ItemTitle
• ItemXML

The array indices start at 0 and end at ItemCount - 1.

This property is not available at design time.

Data Type

Integer

ItemAuthor Property (IPWorks_RSS Class)

This property contains the email address or contact information for the current item's author.

Object Oriented Interface

public function getItemAuthor($itemindex);
public function setItemAuthor($itemindex, $value);

Procedural Interface

ipworks_rss_get($res, 44 , $itemindex);
ipworks_rss_set($res, 44, $value , $itemindex);

Default Value

''

Remarks

This property contains the email address or contact information for the current item's author.

The $itemindex parameter specifies the index of the item in the array. The size of the array is controlled by the ItemCount property.

This property is not available at design time.

Data Type

String

ItemCategory Property (IPWorks_RSS Class)

This property contains the location of the current item within a hierarchy.

Object Oriented Interface

public function getItemCategory($itemindex);
public function setItemCategory($itemindex, $value);

Procedural Interface

ipworks_rss_get($res, 45 , $itemindex);
ipworks_rss_set($res, 45, $value , $itemindex);

Default Value

''

Remarks

This property contains the location of the current item within a hierarchy. The value of this property is a forward-slash-separated string that identifies a hierarchical location in a particular hierarchy. The conventions used to interpret an RSS item's category depend on the processor.

The $itemindex parameter specifies the index of the item in the array. The size of the array is controlled by the ItemCount property.

This property is not available at design time.

Data Type

String

ItemCategoryDomain Property (IPWorks_RSS Class)

This property contains the URL indicating the definition of the current item's category.

Object Oriented Interface

public function getItemCategoryDomain($itemindex);
public function setItemCategoryDomain($itemindex, $value);

Procedural Interface

ipworks_rss_get($res, 46 , $itemindex);
ipworks_rss_set($res, 46, $value , $itemindex);

Default Value

''

Remarks

This property contains the URL indicating the definition of the current item's category. This points to a location that defines the category indicated by the ItemCategory, which is provided in the Items properties.

The $itemindex parameter specifies the index of the item in the array. The size of the array is controlled by the ItemCount property.

This property is not available at design time.

Data Type

String

ItemComments Property (IPWorks_RSS Class)

If present, this property should point to the URL location of a page for comments related to the current item.

Object Oriented Interface

public function getItemComments($itemindex);
public function setItemComments($itemindex, $value);

Procedural Interface

ipworks_rss_get($res, 47 , $itemindex);
ipworks_rss_set($res, 47, $value , $itemindex);

Default Value

''

Remarks

If present, this property should point to the URL location of a page for comments related to the current item.

The $itemindex parameter specifies the index of the item in the array. The size of the array is controlled by the ItemCount property.

This property is not available at design time.

Data Type

String

ItemDescription Property (IPWorks_RSS Class)

This property contains the description of the content of the current item.

Object Oriented Interface

public function getItemDescription($itemindex);
public function setItemDescription($itemindex, $value);

Procedural Interface

ipworks_rss_get($res, 48 , $itemindex);
ipworks_rss_set($res, 48, $value , $itemindex);

Default Value

''

Remarks

This property contains the description of the content of the current item. For abstracts, ItemLink should point to the complete text of the item.

This property is required for RSS feeds that conform to version 0.91 of the RSS protocol. For later versions, an item must have either a ItemTitle or ItemDescription defined.

The $itemindex parameter specifies the index of the item in the array. The size of the array is controlled by the ItemCount property.

This property is not available at design time.

Data Type

String

ItemEnclosureLength Property (IPWorks_RSS Class)

This property indicates how large the enclosure is in bytes.

Object Oriented Interface

public function getItemEnclosureLength($itemindex);
public function setItemEnclosureLength($itemindex, $value);

Procedural Interface

ipworks_rss_get($res, 49 , $itemindex);
ipworks_rss_set($res, 49, $value , $itemindex);

Default Value

''

Remarks

This property indicates how large the enclosure is in bytes.

An enclosure specifies a media object that is attached to the item. The fields ItemEnclosureLength, ItemEnclosureType, and ItemEnclosureUrl all are required when specifying an enclosure.

The $itemindex parameter specifies the index of the item in the array. The size of the array is controlled by the ItemCount property.

This property is not available at design time.

Data Type

String

ItemEnclosureType Property (IPWorks_RSS Class)

This property specifies the type of enclosure.

Object Oriented Interface

public function getItemEnclosureType($itemindex);
public function setItemEnclosureType($itemindex, $value);

Procedural Interface

ipworks_rss_get($res, 50 , $itemindex);
ipworks_rss_set($res, 50, $value , $itemindex);

Default Value

''

Remarks

This property specifies the type of enclosure. This property must contain a standard MIME type, such as "audio/mpeg".

An enclosure specifies a media object that is attached to the item. The fields ItemEnclosureLength, ItemEnclosureType, and ItemEnclosureUrl all are required when specifying an enclosure.

The $itemindex parameter specifies the index of the item in the array. The size of the array is controlled by the ItemCount property.

This property is not available at design time.

Data Type

String

ItemEnclosureUrl Property (IPWorks_RSS Class)

This property contains the URL where the enclosure is located.

Object Oriented Interface

public function getItemEnclosureUrl($itemindex);
public function setItemEnclosureUrl($itemindex, $value);

Procedural Interface

ipworks_rss_get($res, 51 , $itemindex);
ipworks_rss_set($res, 51, $value , $itemindex);

Default Value

''

Remarks

This property contains the URL where the enclosure is located.

An enclosure specifies a media object that is attached to the item. The fields ItemEnclosureLength, ItemEnclosureType, and ItemEnclosureUrl all are required when specifying an enclosure.

The $itemindex parameter specifies the index of the item in the array. The size of the array is controlled by the ItemCount property.

This property is not available at design time.

Data Type

String

ItemGuid Property (IPWorks_RSS Class)

This property contains the globally unique identifier for the current item.

Object Oriented Interface

public function getItemGuid($itemindex);
public function setItemGuid($itemindex, $value);

Procedural Interface

ipworks_rss_get($res, 52 , $itemindex);
ipworks_rss_set($res, 52, $value , $itemindex);

Default Value

''

Remarks

This property contains the globally unique identifier for the current item. It is a string that uniquely identifies the item. Aggregators can use this property to determine whether or not an item is new.

Aggregators should view this value as a string, but it is up to the source of the feed to guarantee its uniqueness. The value may be the URL link to the full text of the item to help guarantee that it is unique.

The $itemindex parameter specifies the index of the item in the array. The size of the array is controlled by the ItemCount property.

This property is not available at design time.

Data Type

String

ItemGuidIsPermaLink Property (IPWorks_RSS Class)

When this property is set to True, the reader may assume that the guide is a permalink to the item.

Object Oriented Interface

public function getItemGuidIsPermaLink($itemindex);
public function setItemGuidIsPermaLink($itemindex, $value);

Procedural Interface

ipworks_rss_get($res, 53 , $itemindex);
ipworks_rss_set($res, 53, $value , $itemindex);

Default Value

true

Remarks

When this property is set to True, the reader may assume that the guide is a permalink to the item. A permalink is a URL that can be opened in a web browser, which contains the full item contents from the original RSS feed.

The $itemindex parameter specifies the index of the item in the array. The size of the array is controlled by the ItemCount property.

This property is not available at design time.

Data Type

Boolean

ItemXML Property (IPWorks_RSS Class)

This property contains the full XML contents of the item.

Object Oriented Interface

public function getItemXML($itemindex);
public function setItemXML($itemindex, $value);

Procedural Interface

ipworks_rss_get($res, 54 , $itemindex);
ipworks_rss_set($res, 54, $value , $itemindex);

Default Value

''

Remarks

This property contains the full XML contents of the item. Unless the properties of the RSS item are modified, this value will contain the original XML from the RSS feed.

Note: When setting this property, the entire contents of the item must be supplied, including the item tags. All previous item values will be lost.

The $itemindex parameter specifies the index of the item in the array. The size of the array is controlled by the ItemCount property.

This property is not available at design time.

Data Type

String

ItemLink Property (IPWorks_RSS Class)

For headline or abstract items, this property should be the location of the full text of the item.

Object Oriented Interface

public function getItemLink($itemindex);
public function setItemLink($itemindex, $value);

Procedural Interface

ipworks_rss_get($res, 55 , $itemindex);
ipworks_rss_set($res, 55, $value , $itemindex);

Default Value

''

Remarks

For headline or abstract items, this property should be the location of the full text of the item.

The $itemindex parameter specifies the index of the item in the array. The size of the array is controlled by the ItemCount property.

This property is not available at design time.

Data Type

String

ItemPubDate Property (IPWorks_RSS Class)

This property contains the date of the current item's most recent publication.

Object Oriented Interface

public function getItemPubDate($itemindex);
public function setItemPubDate($itemindex, $value);

Procedural Interface

ipworks_rss_get($res, 56 , $itemindex);
ipworks_rss_set($res, 56, $value , $itemindex);

Default Value

''

Remarks

This property contains the date of the current item's most recent publication. It should conform to the standards set in RFC 822, with the exception that years can be either two or four characters long.

The $itemindex parameter specifies the index of the item in the array. The size of the array is controlled by the ItemCount property.

This property is not available at design time.

Data Type

String

ItemSource Property (IPWorks_RSS Class)

This property contains the name of the RSS feed in which the item was originally published, derived from the feed's title.

Object Oriented Interface

public function getItemSource($itemindex);
public function setItemSource($itemindex, $value);

Procedural Interface

ipworks_rss_get($res, 57 , $itemindex);
ipworks_rss_set($res, 57, $value , $itemindex);

Default Value

''

Remarks

This property contains the name of the RSS feed in which the item was originally published, derived from the feed's title. If this property or ItemSourceURL are empty, they should be filled with the values contained in ItemTitle and ItemLink properties of the Channel before forwarding the feed from a news aggregator to a blog.

The $itemindex parameter specifies the index of the item in the array. The size of the array is controlled by the ItemCount property.

This property is not available at design time.

Data Type

String

ItemSourceURL Property (IPWorks_RSS Class)

This property contains the URL location of the XML-version of the current item's source.

Object Oriented Interface

public function getItemSourceURL($itemindex);
public function setItemSourceURL($itemindex, $value);

Procedural Interface

ipworks_rss_get($res, 58 , $itemindex);
ipworks_rss_set($res, 58, $value , $itemindex);

Default Value

''

Remarks

This property contains the URL location of the XML-version of the current item's source. This is required if ItemSource is defined. It is a URL that points to the XML representation of the source of the current item.

The $itemindex parameter specifies the index of the item in the array. The size of the array is controlled by the ItemCount property.

This property is not available at design time.

Data Type

String

ItemTitle Property (IPWorks_RSS Class)

This property contains the title or headline of the current item.

Object Oriented Interface

public function getItemTitle($itemindex);
public function setItemTitle($itemindex, $value);

Procedural Interface

ipworks_rss_get($res, 59 , $itemindex);
ipworks_rss_set($res, 59, $value , $itemindex);

Default Value

''

Remarks

This property contains the title or headline of the current item. This property is required for RSS feeds that conform to version 0.91 of the RSS protocol. For later versions, an item must have either ItemTitle or ItemDescription defined.

This property should contain a short description of the item, or a headline if ItemDescription is defined.

The $itemindex parameter specifies the index of the item in the array. The size of the array is controlled by the ItemCount property.

This property is not available at design time.

Data Type

String

LocalFile Property (IPWorks_RSS Class)

This property includes the path to a local file for downloading. If the file exists, it is overwritten.

Object Oriented Interface

public function getLocalFile();
public function setLocalFile($value);

Procedural Interface

ipworks_rss_get($res, 60 );
ipworks_rss_set($res, 60, $value );

Default Value

''

Remarks

This property is used when getting a document.

If this property is empty, then the received data are provided through TransferredData and the Transfer event.

Data Type

String

LocalHost Property (IPWorks_RSS Class)

The name of the local host or user-assigned IP interface through which connections are initiated or accepted.

Object Oriented Interface

public function getLocalHost();
public function setLocalHost($value);

Procedural Interface

ipworks_rss_get($res, 61 );
ipworks_rss_set($res, 61, $value );

Default Value

''

Remarks

This property contains the name of the local host as obtained by the gethostname() system call, or if the user has assigned an IP address, the value of that address.

In multihomed hosts (machines with more than one IP interface) setting LocalHost to the IP address of an interface will make the class initiate connections (or accept in the case of server classs) only through that interface. It is recommended to provide an IP address rather than a hostname when setting this property to ensure the desired interface is used.

If the class is connected, the LocalHost property shows the IP address of the interface through which the connection is made in internet dotted format (aaa.bbb.ccc.ddd). In most cases, this is the address of the local host, except for multihomed hosts (machines with more than one IP interface).

Note: LocalHost is not persistent. You must always set it in code, and never in the property window.

Data Type

String

NamespaceCount Property (IPWorks_RSS Class)

The number of records in the Namespace arrays.

Object Oriented Interface

public function getNamespaceCount();
public function setNamespaceCount($value);

Procedural Interface

ipworks_rss_get($res, 62 );
ipworks_rss_set($res, 62, $value );

Default Value

0

Remarks

This property controls the size of the following arrays:

• NamespacePrefix
• NamespaceURI

The array indices start at 0 and end at NamespaceCount - 1.

This property is not available at design time.

Data Type

Integer

NamespacePrefix Property (IPWorks_RSS Class)

This property contains the Prefix for the Namespace .

Object Oriented Interface

public function getNamespacePrefix($namespaceindex);
public function setNamespacePrefix($namespaceindex, $value);

Procedural Interface

ipworks_rss_get($res, 63 , $namespaceindex);
ipworks_rss_set($res, 63, $value , $namespaceindex);

Default Value

''

Remarks

This property contains the NamespacePrefix for the Namespace.

The $namespaceindex parameter specifies the index of the item in the array. The size of the array is controlled by the NamespaceCount property.

This property is not available at design time.

Data Type

String

NamespaceURI Property (IPWorks_RSS Class)

This property contains the namespace URI associated with the corresponding Prefix .

Object Oriented Interface

public function getNamespaceURI($namespaceindex);
public function setNamespaceURI($namespaceindex, $value);

Procedural Interface

ipworks_rss_get($res, 64 , $namespaceindex);
ipworks_rss_set($res, 64, $value , $namespaceindex);

Default Value

''

Remarks

This property contains the namespace URI associated with the corresponding NamespacePrefix. This URL is usually pointing to the XML schema for the namespace.

The $namespaceindex parameter specifies the index of the item in the array. The size of the array is controlled by the NamespaceCount property.

This property is not available at design time.

Data Type

String

OtherHeaders Property (IPWorks_RSS Class)

Other headers as determined by the user (optional).

Object Oriented Interface

public function getOtherHeaders();
public function setOtherHeaders($value);

Procedural Interface

ipworks_rss_get($res, 65 );
ipworks_rss_set($res, 65, $value );

Default Value

''

Remarks

This property can be set to a string of headers to be appended to the HTTP request headers created from other properties like ContentType and From.

The headers must follow the format Header: Value as described in the HTTP specifications. Header lines should be separated by CRLF ("\r\n") .

Use this property with caution. If this property contains invalid headers, HTTP requests may fail.

This property is useful for extending the functionality of the class beyond what is provided.

This property is not available at design time.

Data Type

String

ParsedHeaderCount Property (IPWorks_RSS Class)

The number of records in the ParsedHeader arrays.

Object Oriented Interface

public function getParsedHeaderCount();

Procedural Interface

ipworks_rss_get($res, 66 );

Default Value

0

Remarks

This property controls the size of the following arrays:

• ParsedHeaderField
• ParsedHeaderValue

The array indices start at 0 and end at ParsedHeaderCount - 1.

This property is read-only and not available at design time.

Data Type

Integer

ParsedHeaderField Property (IPWorks_RSS Class)

This property contains the name of the HTTP header (this is the same case as it is delivered).

Object Oriented Interface

public function getParsedHeaderField($parsedheaderindex);

Procedural Interface

ipworks_rss_get($res, 67 , $parsedheaderindex);

Default Value

''

Remarks

This property contains the name of the HTTP Header (this is the same case as it is delivered).

The $parsedheaderindex parameter specifies the index of the item in the array. The size of the array is controlled by the ParsedHeaderCount property.

This property is read-only and not available at design time.

Data Type

String

ParsedHeaderValue Property (IPWorks_RSS Class)

This property contains the header contents.

Object Oriented Interface

public function getParsedHeaderValue($parsedheaderindex);

Procedural Interface

ipworks_rss_get($res, 68 , $parsedheaderindex);

Default Value

''

Remarks

This property contains the Header contents.

The $parsedheaderindex parameter specifies the index of the item in the array. The size of the array is controlled by the ParsedHeaderCount property.

This property is read-only and not available at design time.

Data Type

String

Password Property (IPWorks_RSS Class)

This property includes a password if authentication is to be used.

Object Oriented Interface

public function getPassword();
public function setPassword($value);

Procedural Interface

ipworks_rss_get($res, 69 );
ipworks_rss_set($res, 69, $value );

Default Value

''

Remarks

This property contains a password if authentication is to be used. If AuthScheme is set to HTTP Basic Authentication, the User and Password are Base64 encoded and the result is put in the Authorization configuration setting in the form "Basic [encoded-user-password]".

If AuthScheme is set to HTTP Digest Authentication, the User and Password properties are used to respond to the HTTP Digest Authentication challenge from the server.

If AuthScheme is set to NTLM, NTLM authentication will be attempted. If AuthScheme is set to NTLM and User and Password are empty, the class will attempt to authenticate using the current user's credentials.

Data Type

String

ProxyAuthScheme Property (IPWorks_RSS Class)

The type of authorization to perform when connecting to the proxy.

Object Oriented Interface

public function getProxyAuthScheme();
public function setProxyAuthScheme($value);

Procedural Interface

ipworks_rss_get($res, 70 );
ipworks_rss_set($res, 70, $value );

Default Value

0

Remarks

The type of authorization to perform when connecting to the proxy. This is used only when the ProxyUser and ProxyPassword properties are set.

ProxyAuthScheme should be set to authNone (3) when no authentication is expected.

By default, ProxyAuthScheme is authBasic (0), and if the ProxyUser and ProxyPassword properties are set, the class will attempt basic authentication.

If ProxyAuthScheme is set to authDigest (1), digest authentication will be attempted instead.

If ProxyAuthScheme is set to authProprietary (2), then the authorization token will not be generated by the class. Look at the configuration file for the class being used to find more information about manually setting this token.

If ProxyAuthScheme is set to authNtlm (4), NTLM authentication will be used.

For security reasons, setting this property will clear the values of ProxyUser and ProxyPassword.

Data Type

Integer

ProxyAutoDetect Property (IPWorks_RSS Class)

Whether to automatically detect and use proxy system settings, if available.

Object Oriented Interface

public function getProxyAutoDetect();
public function setProxyAutoDetect($value);

Procedural Interface

ipworks_rss_get($res, 71 );
ipworks_rss_set($res, 71, $value );

Default Value

false

Remarks

Whether to automatically detect and use proxy system settings, if available. The default value is false.

Data Type

Boolean

ProxyPassword Property (IPWorks_RSS Class)

A password if authentication is to be used for the proxy.

Object Oriented Interface

public function getProxyPassword();
public function setProxyPassword($value);

Procedural Interface

ipworks_rss_get($res, 72 );
ipworks_rss_set($res, 72, $value );

Default Value

''

Remarks

A password if authentication is to be used for the proxy.

If ProxyAuthScheme is set to Basic Authentication, the ProxyUser and ProxyPassword properties are Base64 encoded and the proxy authentication token will be generated in the form Basic [encoded-user-password].

If ProxyAuthScheme is set to Digest Authentication, the ProxyUser and ProxyPassword properties are used to respond to the Digest Authentication challenge from the server.

If ProxyAuthScheme is set to NTLM Authentication, the ProxyUser and ProxyPassword properties are used to authenticate through NTLM negotiation.

Data Type

String

ProxyPort Property (IPWorks_RSS Class)

The Transmission Control Protocol (TCP) port for the proxy Server (default 80).

Object Oriented Interface

public function getProxyPort();
public function setProxyPort($value);

Procedural Interface

ipworks_rss_get($res, 73 );
ipworks_rss_set($res, 73, $value );

Default Value

80

Remarks

The Transmission Control Protocol (TCP) port for the proxy ProxyServer (default 80). See the description of the ProxyServer property for details.

Data Type

Integer

ProxyServer Property (IPWorks_RSS Class)

If a proxy Server is given, then the HTTP request is sent to the proxy instead of the server otherwise specified.

Object Oriented Interface

public function getProxyServer();
public function setProxyServer($value);

Procedural Interface

ipworks_rss_get($res, 74 );
ipworks_rss_set($res, 74, $value );

Default Value

''

Remarks

If a proxy ProxyServer is given, then the HTTP request is sent to the proxy instead of the server otherwise specified.

If the ProxyServer property is set to a domain name, a DNS request is initiated. Upon successful termination of the request, the ProxyServer property is set to the corresponding address. If the search is not successful, an error is returned.

Data Type

String

ProxySSL Property (IPWorks_RSS Class)

When to use a Secure Sockets Layer (SSL) for the connection to the proxy.

Object Oriented Interface

public function getProxySSL();
public function setProxySSL($value);

Procedural Interface

ipworks_rss_get($res, 75 );
ipworks_rss_set($res, 75, $value );

Default Value

0

Remarks

When to use a Secure Sockets Layer (SSL) for the connection to the proxy. The applicable values are as follows:

Data Type

Integer

ProxyUser Property (IPWorks_RSS Class)

A username if authentication is to be used for the proxy.

Object Oriented Interface

public function getProxyUser();
public function setProxyUser($value);

Procedural Interface

ipworks_rss_get($res, 76 );
ipworks_rss_set($res, 76, $value );

Default Value

''

Remarks

A username if authentication is to be used for the proxy.

If ProxyAuthScheme is set to Basic Authentication, the ProxyUser and ProxyPassword properties are Base64 encoded and the proxy authentication token will be generated in the form Basic [encoded-user-password].

If ProxyAuthScheme is set to Digest Authentication, the ProxyUser and ProxyPassword properties are used to respond to the Digest Authentication challenge from the server.

If ProxyAuthScheme is set to NTLM Authentication, the ProxyUser and ProxyPassword properties are used to authenticate through NTLM negotiation.

Data Type

String

Referer Property (IPWorks_RSS Class)

This property includes the referer URL/document (optional).

Object Oriented Interface

public function getReferer();
public function setReferer($value);

Procedural Interface

ipworks_rss_get($res, 77 );
ipworks_rss_set($res, 77, $value );

Default Value

''

Remarks

If this property contains a nonempty string, a Referer HTTP request header is added to the request. The purpose of the header is to show the document referring the requested URL.

This property is not available at design time.

Data Type

String

RSSData Property (IPWorks_RSS Class)

This property includes the complete text of the RSS XML file.

Object Oriented Interface

public function getRSSData();
public function setRSSData($value);

Procedural Interface

ipworks_rss_get($res, 78 );
ipworks_rss_set($res, 78, $value );

Default Value

''

Remarks

When retrieving RSS feeds through the GetFeed or HTML through the GetURL method, this property will contain the complete original text of the feed. When writing an RSS feed using the WriteFile method, the class RSSData will be generated from the existing properties.

This property is not available at design time.

Data Type

String

RSSVersion Property (IPWorks_RSS Class)

This property includes the RSS protocol version of the current RSS feed.

Object Oriented Interface

public function getRSSVersion();
public function setRSSVersion($value);

Procedural Interface

ipworks_rss_get($res, 79 );
ipworks_rss_set($res, 79, $value );

Default Value

3

Remarks

This property contains the protocol version to which the current RSS feed conforms. Each version has slightly different requirements and a different set of defined standard properties. When generating an RSS feed, the class will check this value and throw an error for missing required properties.

The following values are currently recognized by the class:

To set properties not defined in the given version, use the Namespaces properties, to list and define namespaces and the GetProperty and SetProperty methods, and to list and define each nonstandard property.

Data Type

Integer

SSLAcceptServerCertEffectiveDate Property (IPWorks_RSS Class)

The date on which this certificate becomes valid.

Object Oriented Interface

public function getSSLAcceptServerCertEffectiveDate();

Procedural Interface

ipworks_rss_get($res, 80 );

Default Value

''

Remarks

The date on which this certificate becomes valid. Before this date, it is not valid. The date is localized to the system's time zone. The following example illustrates the format of an encoded date:

23-Jan-2000 15:00:00.

This property is read-only.

Data Type

String

SSLAcceptServerCertExpirationDate Property (IPWorks_RSS Class)

The date on which the certificate expires.

Object Oriented Interface

public function getSSLAcceptServerCertExpirationDate();

Procedural Interface

ipworks_rss_get($res, 81 );

Default Value

''

Remarks

The date on which the certificate expires. After this date, the certificate will no longer be valid. The date is localized to the system's time zone. The following example illustrates the format of an encoded date:

23-Jan-2001 15:00:00.

This property is read-only.

Data Type

String

SSLAcceptServerCertExtendedKeyUsage Property (IPWorks_RSS Class)

A comma-delimited list of extended key usage identifiers.

Object Oriented Interface

public function getSSLAcceptServerCertExtendedKeyUsage();

Procedural Interface

ipworks_rss_get($res, 82 );

Default Value

''

Remarks

A comma-delimited list of extended key usage identifiers. These are the same as ASN.1 object identifiers (OIDs).

This property is read-only.

Data Type

String

SSLAcceptServerCertFingerprint Property (IPWorks_RSS Class)

The hex-encoded, 16-byte MD5 fingerprint of the certificate.

Object Oriented Interface

public function getSSLAcceptServerCertFingerprint();

Procedural Interface

ipworks_rss_get($res, 83 );

Default Value

''

Remarks

The hex-encoded, 16-byte MD5 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.

The following example illustrates the format: bc:2a:72:af:fe:58:17:43:7a:5f:ba:5a:7c:90:f7:02

This property is read-only.

Data Type

String

SSLAcceptServerCertFingerprintSHA1 Property (IPWorks_RSS Class)

The hex-encoded, 20-byte SHA-1 fingerprint of the certificate.

Object Oriented Interface

public function getSSLAcceptServerCertFingerprintSHA1();

Procedural Interface

ipworks_rss_get($res, 84 );

Default Value

''

Remarks

The hex-encoded, 20-byte SHA-1 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.

The following example illustrates the format: 30:7b:fa:38:65:83:ff:da:b4:4e:07:3f:17:b8:a4:ed:80:be:ff:84

This property is read-only.

Data Type

String

SSLAcceptServerCertFingerprintSHA256 Property (IPWorks_RSS Class)

The hex-encoded, 32-byte SHA-256 fingerprint of the certificate.

Object Oriented Interface

public function getSSLAcceptServerCertFingerprintSHA256();

Procedural Interface

ipworks_rss_get($res, 85 );

Default Value

''

Remarks

The hex-encoded, 32-byte SHA-256 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.

The following example illustrates the format: 6a:80:5c:33:a9:43:ea:b0:96:12:8a:64:96:30:ef:4a:8a:96:86:ce:f4:c7:be:10:24:8e:2b:60:9e:f3:59:53

This property is read-only.

Data Type

String

SSLAcceptServerCertIssuer Property (IPWorks_RSS Class)

The issuer of the certificate.

Object Oriented Interface

public function getSSLAcceptServerCertIssuer();

Procedural Interface

ipworks_rss_get($res, 86 );

Default Value

''

Remarks

The issuer of the certificate. This property contains a string representation of the name of the issuing authority for the certificate.

This property is read-only.

Data Type

String

SSLAcceptServerCertPrivateKey Property (IPWorks_RSS Class)

The private key of the certificate (if available).

Object Oriented Interface

public function getSSLAcceptServerCertPrivateKey();

Procedural Interface

ipworks_rss_get($res, 87 );

Default Value

''

Remarks

The private key of the certificate (if available). The key is provided as PEM/Base64-encoded data.

Note: The SSLAcceptServerCertPrivateKey may be available but not exportable. In this case, SSLAcceptServerCertPrivateKey returns an empty string.

This property is read-only.

Data Type

String

SSLAcceptServerCertPrivateKeyAvailable Property (IPWorks_RSS Class)

Whether a PrivateKey is available for the selected certificate.

Object Oriented Interface

public function getSSLAcceptServerCertPrivateKeyAvailable();

Procedural Interface

ipworks_rss_get($res, 88 );

Default Value

false

Remarks

Whether a SSLAcceptServerCertPrivateKey is available for the selected certificate. If SSLAcceptServerCertPrivateKeyAvailable is True, the certificate may be used for authentication purposes (e.g., server authentication).

This property is read-only.

Data Type

Boolean

SSLAcceptServerCertPrivateKeyContainer Property (IPWorks_RSS Class)

The name of the PrivateKey container for the certificate (if available).

Object Oriented Interface

public function getSSLAcceptServerCertPrivateKeyContainer();

Procedural Interface

ipworks_rss_get($res, 89 );

Default Value

''

Remarks

The name of the SSLAcceptServerCertPrivateKey container for the certificate (if available). This functionality is available only on Windows platforms.

This property is read-only.

Data Type

String

SSLAcceptServerCertPublicKey Property (IPWorks_RSS Class)

The public key of the certificate.

Object Oriented Interface

public function getSSLAcceptServerCertPublicKey();

Procedural Interface

ipworks_rss_get($res, 90 );

Default Value

''

Remarks

The public key of the certificate. The key is provided as PEM/Base64-encoded data.

This property is read-only.

Data Type

String

SSLAcceptServerCertPublicKeyAlgorithm Property (IPWorks_RSS Class)

The textual description of the certificate's public key algorithm.

Object Oriented Interface

public function getSSLAcceptServerCertPublicKeyAlgorithm();

Procedural Interface

ipworks_rss_get($res, 91 );

Default Value

''

Remarks

The textual description of the certificate's public key algorithm. The property contains either the name of the algorithm (e.g., "RSA" or "RSA_DH") or an object identifier (OID) string representing the algorithm.

This property is read-only.

Data Type

String

SSLAcceptServerCertPublicKeyLength Property (IPWorks_RSS Class)

The length of the certificate's public key (in bits).

Object Oriented Interface

public function getSSLAcceptServerCertPublicKeyLength();

Procedural Interface

ipworks_rss_get($res, 92 );

Default Value

0

Remarks

The length of the certificate's public key (in bits). Common values are 512, 1024, and 2048.

This property is read-only.

Data Type

Integer

SSLAcceptServerCertSerialNumber Property (IPWorks_RSS Class)

The serial number of the certificate encoded as a string.

Object Oriented Interface

public function getSSLAcceptServerCertSerialNumber();

Procedural Interface

ipworks_rss_get($res, 93 );

Default Value

''

Remarks

The serial number of the certificate encoded as a string. The number is encoded as a series of hexadecimal digits, with each pair representing a byte of the serial number.

This property is read-only.

Data Type

String

SSLAcceptServerCertSignatureAlgorithm Property (IPWorks_RSS Class)

The text description of the certificate's signature algorithm.

Object Oriented Interface

public function getSSLAcceptServerCertSignatureAlgorithm();

Procedural Interface

ipworks_rss_get($res, 94 );

Default Value

''

Remarks

The text description of the certificate's signature algorithm. The property contains either the name of the algorithm (e.g., "RSA" or "RSA_MD5RSA") or an object identifier (OID) string representing the algorithm.

This property is read-only.

Data Type

String

SSLAcceptServerCertStore Property (IPWorks_RSS Class)

The name of the certificate store for the client certificate.

Object Oriented Interface

public function getSSLAcceptServerCertStore();
public function setSSLAcceptServerCertStore($value);

Procedural Interface

ipworks_rss_get($res, 95 );
ipworks_rss_set($res, 95, $value );

Default Value

'MY'

Remarks

The name of the certificate store for the client certificate.

The SSLAcceptServerCertStoreType property denotes the type of the certificate store specified by SSLAcceptServerCertStore. If the store is password-protected, specify the password in SSLAcceptServerCertStorePassword.

SSLAcceptServerCertStore is used in conjunction with the SSLAcceptServerCertSubject property to specify client certificates. If SSLAcceptServerCertStore has a value, and SSLAcceptServerCertSubject or SSLAcceptServerCertEncoded is set, a search for a certificate is initiated. Please see the SSLAcceptServerCertSubject property for details.

Designations of certificate stores are platform dependent.

The following designations are the most common User and Machine certificate stores in Windows:

When the certificate store type is cstPFXFile, this property must be set to the name of the file. When the type is cstPFXBlob, the property must be set to the binary contents of a PFX file (i.e., PKCS#12 certificate store).

Data Type

Binary String

SSLAcceptServerCertStorePassword Property (IPWorks_RSS Class)

If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.

Object Oriented Interface

public function getSSLAcceptServerCertStorePassword();
public function setSSLAcceptServerCertStorePassword($value);

Procedural Interface

ipworks_rss_get($res, 96 );
ipworks_rss_set($res, 96, $value );

Default Value

''

Remarks

If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.

Data Type

String

SSLAcceptServerCertStoreType Property (IPWorks_RSS Class)

The type of certificate store for this certificate.

Object Oriented Interface

public function getSSLAcceptServerCertStoreType();
public function setSSLAcceptServerCertStoreType($value);

Procedural Interface

ipworks_rss_get($res, 97 );
ipworks_rss_set($res, 97, $value );

Default Value

0

Remarks

The type of certificate store for this certificate.

The class supports both public and private keys in a variety of formats. When the cstAuto value is used, the class will automatically determine the type. This property can take one of the following values:

Data Type

Integer

SSLAcceptServerCertSubjectAltNames Property (IPWorks_RSS Class)

Comma-separated lists of alternative subject names for the certificate.

Object Oriented Interface

public function getSSLAcceptServerCertSubjectAltNames();

Procedural Interface

ipworks_rss_get($res, 98 );

Default Value

''

Remarks

Comma-separated lists of alternative subject names for the certificate.

This property is read-only.

Data Type

String

SSLAcceptServerCertThumbprintMD5 Property (IPWorks_RSS Class)

The MD5 hash of the certificate.

Object Oriented Interface

public function getSSLAcceptServerCertThumbprintMD5();

Procedural Interface

ipworks_rss_get($res, 99 );

Default Value

''

Remarks

The MD5 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.

This property is read-only.

Data Type

String

SSLAcceptServerCertThumbprintSHA1 Property (IPWorks_RSS Class)

The SHA-1 hash of the certificate.

Object Oriented Interface

public function getSSLAcceptServerCertThumbprintSHA1();

Procedural Interface

ipworks_rss_get($res, 100 );

Default Value

''

Remarks

The SHA-1 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.

This property is read-only.

Data Type

String

SSLAcceptServerCertThumbprintSHA256 Property (IPWorks_RSS Class)

The SHA-256 hash of the certificate.

Object Oriented Interface

public function getSSLAcceptServerCertThumbprintSHA256();

Procedural Interface

ipworks_rss_get($res, 101 );

Default Value

''

Remarks

The SHA-256 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.

This property is read-only.

Data Type

String

SSLAcceptServerCertUsage Property (IPWorks_RSS Class)

The text description of UsageFlags .

Object Oriented Interface

public function getSSLAcceptServerCertUsage();

Procedural Interface

ipworks_rss_get($res, 102 );

Default Value

''

Remarks

The text description of SSLAcceptServerCertUsageFlags.

This value will be one or more of the following strings and will be separated by commas:

• Digital Signature
• Non-Repudiation
• Key Encipherment
• Data Encipherment
• Key Agreement
• Certificate Signing
• CRL Signing
• Encipher Only

If the provider is OpenSSL, the value is a comma-separated list of X.509 certificate extension names.

This property is read-only.

Data Type

String

SSLAcceptServerCertUsageFlags Property (IPWorks_RSS Class)

The flags that show intended use for the certificate.

Object Oriented Interface

public function getSSLAcceptServerCertUsageFlags();

Procedural Interface

ipworks_rss_get($res, 103 );

Default Value

0

Remarks

The flags that show intended use for the certificate. The value of SSLAcceptServerCertUsageFlags is a combination of the following flags:

Please see the SSLAcceptServerCertUsage property for a text representation of SSLAcceptServerCertUsageFlags.

This functionality currently is not available when the provider is OpenSSL.

This property is read-only.

Data Type

Integer

SSLAcceptServerCertVersion Property (IPWorks_RSS Class)

The certificate's version number.

Object Oriented Interface

public function getSSLAcceptServerCertVersion();

Procedural Interface

ipworks_rss_get($res, 104 );

Default Value

''

Remarks

The certificate's version number. The possible values are the strings "V1", "V2", and "V3".

This property is read-only.

Data Type

String

SSLAcceptServerCertSubject Property (IPWorks_RSS Class)

The subject of the certificate used for client authentication.

Object Oriented Interface

public function getSSLAcceptServerCertSubject();
public function setSSLAcceptServerCertSubject($value);

Procedural Interface

ipworks_rss_get($res, 105 );
ipworks_rss_set($res, 105, $value );

Default Value

''

Remarks

The subject of the certificate used for client authentication.

This property must be set after all other certificate properties are set. When this property is set, a search is performed in the current certificate store to locate a certificate with a matching subject.

If a matching certificate is found, the property is set to the full subject of the matching certificate.

If an exact match is not found, the store is searched for subjects containing the value of the property.

If a match is still not found, the property is set to an empty string, and no certificate is selected.

The special value "*" picks a random certificate in the certificate store.

The certificate subject is a comma-separated list of distinguished name fields and values. For instance, "CN=www.server.com, OU=test, C=US, E=support@nsoftware.com". Common fields and their meanings are as follows:

If a field value contains a comma, it must be quoted.

Data Type

String

SSLAcceptServerCertEncoded Property (IPWorks_RSS Class)

The certificate (PEM/Base64 encoded).

Object Oriented Interface

public function getSSLAcceptServerCertEncoded();
public function setSSLAcceptServerCertEncoded($value);

Procedural Interface

ipworks_rss_get($res, 106 );
ipworks_rss_set($res, 106, $value );

Default Value

''

Remarks

The certificate (PEM/Base64 encoded). This property is used to assign a specific certificate. The SSLAcceptServerCertStore and SSLAcceptServerCertSubject properties also may be used to specify a certificate.

When SSLAcceptServerCertEncoded is set, a search is initiated in the current SSLAcceptServerCertStore for the private key of the certificate. If the key is found, SSLAcceptServerCertSubject is updated to reflect the full subject of the selected certificate; otherwise, SSLAcceptServerCertSubject is set to an empty string.

This property is not available at design time.

Data Type

Binary String

SSLCertEffectiveDate Property (IPWorks_RSS Class)

The date on which this certificate becomes valid.

Object Oriented Interface

public function getSSLCertEffectiveDate();

Procedural Interface

ipworks_rss_get($res, 107 );

Default Value

''

Remarks

The date on which this certificate becomes valid. Before this date, it is not valid. The date is localized to the system's time zone. The following example illustrates the format of an encoded date:

23-Jan-2000 15:00:00.

This property is read-only.

Data Type

String

SSLCertExpirationDate Property (IPWorks_RSS Class)

The date on which the certificate expires.

Object Oriented Interface

public function getSSLCertExpirationDate();

Procedural Interface

ipworks_rss_get($res, 108 );

Default Value

''

Remarks

The date on which the certificate expires. After this date, the certificate will no longer be valid. The date is localized to the system's time zone. The following example illustrates the format of an encoded date:

23-Jan-2001 15:00:00.

This property is read-only.

Data Type

String

SSLCertExtendedKeyUsage Property (IPWorks_RSS Class)

A comma-delimited list of extended key usage identifiers.

Object Oriented Interface

public function getSSLCertExtendedKeyUsage();

Procedural Interface

ipworks_rss_get($res, 109 );

Default Value

''

Remarks

A comma-delimited list of extended key usage identifiers. These are the same as ASN.1 object identifiers (OIDs).

This property is read-only.

Data Type

String

SSLCertFingerprint Property (IPWorks_RSS Class)

The hex-encoded, 16-byte MD5 fingerprint of the certificate.

Object Oriented Interface

public function getSSLCertFingerprint();

Procedural Interface

ipworks_rss_get($res, 110 );

Default Value

''

Remarks

The hex-encoded, 16-byte MD5 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.

The following example illustrates the format: bc:2a:72:af:fe:58:17:43:7a:5f:ba:5a:7c:90:f7:02

This property is read-only.

Data Type

String

SSLCertFingerprintSHA1 Property (IPWorks_RSS Class)

The hex-encoded, 20-byte SHA-1 fingerprint of the certificate.

Object Oriented Interface

public function getSSLCertFingerprintSHA1();

Procedural Interface

ipworks_rss_get($res, 111 );

Default Value

''

Remarks

The hex-encoded, 20-byte SHA-1 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.

The following example illustrates the format: 30:7b:fa:38:65:83:ff:da:b4:4e:07:3f:17:b8:a4:ed:80:be:ff:84

This property is read-only.

Data Type

String

SSLCertFingerprintSHA256 Property (IPWorks_RSS Class)

The hex-encoded, 32-byte SHA-256 fingerprint of the certificate.

Object Oriented Interface

public function getSSLCertFingerprintSHA256();

Procedural Interface

ipworks_rss_get($res, 112 );

Default Value

''

Remarks

The hex-encoded, 32-byte SHA-256 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.

The following example illustrates the format: 6a:80:5c:33:a9:43:ea:b0:96:12:8a:64:96:30:ef:4a:8a:96:86:ce:f4:c7:be:10:24:8e:2b:60:9e:f3:59:53

This property is read-only.

Data Type

String

SSLCertIssuer Property (IPWorks_RSS Class)

The issuer of the certificate.

Object Oriented Interface

public function getSSLCertIssuer();

Procedural Interface

ipworks_rss_get($res, 113 );

Default Value

''

Remarks

The issuer of the certificate. This property contains a string representation of the name of the issuing authority for the certificate.

This property is read-only.

Data Type

String

SSLCertPrivateKey Property (IPWorks_RSS Class)

The private key of the certificate (if available).

Object Oriented Interface

public function getSSLCertPrivateKey();

Procedural Interface

ipworks_rss_get($res, 114 );

Default Value

''

Remarks

The private key of the certificate (if available). The key is provided as PEM/Base64-encoded data.

Note: The SSLCertPrivateKey may be available but not exportable. In this case, SSLCertPrivateKey returns an empty string.

This property is read-only.

Data Type

String

SSLCertPrivateKeyAvailable Property (IPWorks_RSS Class)

Whether a PrivateKey is available for the selected certificate.

Object Oriented Interface

public function getSSLCertPrivateKeyAvailable();

Procedural Interface

ipworks_rss_get($res, 115 );

Default Value

false

Remarks

Whether a SSLCertPrivateKey is available for the selected certificate. If SSLCertPrivateKeyAvailable is True, the certificate may be used for authentication purposes (e.g., server authentication).

This property is read-only.

Data Type

Boolean

SSLCertPrivateKeyContainer Property (IPWorks_RSS Class)

The name of the PrivateKey container for the certificate (if available).

Object Oriented Interface

public function getSSLCertPrivateKeyContainer();

Procedural Interface

ipworks_rss_get($res, 116 );

Default Value

''

Remarks

The name of the SSLCertPrivateKey container for the certificate (if available). This functionality is available only on Windows platforms.

This property is read-only.

Data Type

String

SSLCertPublicKey Property (IPWorks_RSS Class)

The public key of the certificate.

Object Oriented Interface

public function getSSLCertPublicKey();

Procedural Interface

ipworks_rss_get($res, 117 );

Default Value

''

Remarks

The public key of the certificate. The key is provided as PEM/Base64-encoded data.

This property is read-only.

Data Type

String

SSLCertPublicKeyAlgorithm Property (IPWorks_RSS Class)

The textual description of the certificate's public key algorithm.

Object Oriented Interface

public function getSSLCertPublicKeyAlgorithm();

Procedural Interface

ipworks_rss_get($res, 118 );

Default Value

''

Remarks

The textual description of the certificate's public key algorithm. The property contains either the name of the algorithm (e.g., "RSA" or "RSA_DH") or an object identifier (OID) string representing the algorithm.

This property is read-only.

Data Type

String

SSLCertPublicKeyLength Property (IPWorks_RSS Class)

The length of the certificate's public key (in bits).

Object Oriented Interface

public function getSSLCertPublicKeyLength();

Procedural Interface

ipworks_rss_get($res, 119 );

Default Value

0

Remarks

The length of the certificate's public key (in bits). Common values are 512, 1024, and 2048.

This property is read-only.

Data Type

Integer

SSLCertSerialNumber Property (IPWorks_RSS Class)

The serial number of the certificate encoded as a string.

Object Oriented Interface

public function getSSLCertSerialNumber();

Procedural Interface

ipworks_rss_get($res, 120 );

Default Value

''

Remarks

The serial number of the certificate encoded as a string. The number is encoded as a series of hexadecimal digits, with each pair representing a byte of the serial number.

This property is read-only.

Data Type

String

SSLCertSignatureAlgorithm Property (IPWorks_RSS Class)

The text description of the certificate's signature algorithm.

Object Oriented Interface

public function getSSLCertSignatureAlgorithm();

Procedural Interface

ipworks_rss_get($res, 121 );

Default Value

''

Remarks

The text description of the certificate's signature algorithm. The property contains either the name of the algorithm (e.g., "RSA" or "RSA_MD5RSA") or an object identifier (OID) string representing the algorithm.

This property is read-only.

Data Type

String

SSLCertStore Property (IPWorks_RSS Class)

The name of the certificate store for the client certificate.

Object Oriented Interface

public function getSSLCertStore();
public function setSSLCertStore($value);

Procedural Interface

ipworks_rss_get($res, 122 );
ipworks_rss_set($res, 122, $value );

Default Value

'MY'

Remarks

The name of the certificate store for the client certificate.

The SSLCertStoreType property denotes the type of the certificate store specified by SSLCertStore. If the store is password-protected, specify the password in SSLCertStorePassword.

SSLCertStore is used in conjunction with the SSLCertSubject property to specify client certificates. If SSLCertStore has a value, and SSLCertSubject or SSLCertEncoded is set, a search for a certificate is initiated. Please see the SSLCertSubject property for details.

Designations of certificate stores are platform dependent.

The following designations are the most common User and Machine certificate stores in Windows:

When the certificate store type is cstPFXFile, this property must be set to the name of the file. When the type is cstPFXBlob, the property must be set to the binary contents of a PFX file (i.e., PKCS#12 certificate store).

Data Type

Binary String

SSLCertStorePassword Property (IPWorks_RSS Class)

If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.

Object Oriented Interface

public function getSSLCertStorePassword();
public function setSSLCertStorePassword($value);

Procedural Interface

ipworks_rss_get($res, 123 );
ipworks_rss_set($res, 123, $value );

Default Value

''

Remarks

If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.

Data Type

String

SSLCertStoreType Property (IPWorks_RSS Class)

The type of certificate store for this certificate.

Object Oriented Interface

public function getSSLCertStoreType();
public function setSSLCertStoreType($value);

Procedural Interface

ipworks_rss_get($res, 124 );
ipworks_rss_set($res, 124, $value );

Default Value

0

Remarks

The type of certificate store for this certificate.

The class supports both public and private keys in a variety of formats. When the cstAuto value is used, the class will automatically determine the type. This property can take one of the following values:

Data Type

Integer

SSLCertSubjectAltNames Property (IPWorks_RSS Class)

Comma-separated lists of alternative subject names for the certificate.

Object Oriented Interface

public function getSSLCertSubjectAltNames();

Procedural Interface

ipworks_rss_get($res, 125 );

Default Value

''

Remarks

Comma-separated lists of alternative subject names for the certificate.

This property is read-only.

Data Type

String

SSLCertThumbprintMD5 Property (IPWorks_RSS Class)

The MD5 hash of the certificate.

Object Oriented Interface

public function getSSLCertThumbprintMD5();

Procedural Interface

ipworks_rss_get($res, 126 );

Default Value

''

Remarks

The MD5 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.

This property is read-only.

Data Type

String

SSLCertThumbprintSHA1 Property (IPWorks_RSS Class)

The SHA-1 hash of the certificate.

Object Oriented Interface

public function getSSLCertThumbprintSHA1();

Procedural Interface

ipworks_rss_get($res, 127 );

Default Value

''

Remarks

The SHA-1 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.

This property is read-only.

Data Type

String

SSLCertThumbprintSHA256 Property (IPWorks_RSS Class)

The SHA-256 hash of the certificate.

Object Oriented Interface

public function getSSLCertThumbprintSHA256();

Procedural Interface

ipworks_rss_get($res, 128 );

Default Value

''

Remarks

The SHA-256 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.

This property is read-only.

Data Type

String

SSLCertUsage Property (IPWorks_RSS Class)

The text description of UsageFlags .

Object Oriented Interface

public function getSSLCertUsage();

Procedural Interface

ipworks_rss_get($res, 129 );

Default Value

''

Remarks

The text description of SSLCertUsageFlags.

This value will be one or more of the following strings and will be separated by commas:

• Digital Signature
• Non-Repudiation
• Key Encipherment
• Data Encipherment
• Key Agreement
• Certificate Signing
• CRL Signing
• Encipher Only

If the provider is OpenSSL, the value is a comma-separated list of X.509 certificate extension names.

This property is read-only.

Data Type

String

SSLCertUsageFlags Property (IPWorks_RSS Class)

The flags that show intended use for the certificate.

Object Oriented Interface

public function getSSLCertUsageFlags();

Procedural Interface

ipworks_rss_get($res, 130 );

Default Value

0

Remarks

The flags that show intended use for the certificate. The value of SSLCertUsageFlags is a combination of the following flags:

Please see the SSLCertUsage property for a text representation of SSLCertUsageFlags.

This functionality currently is not available when the provider is OpenSSL.

This property is read-only.

Data Type

Integer

SSLCertVersion Property (IPWorks_RSS Class)

The certificate's version number.

Object Oriented Interface

public function getSSLCertVersion();

Procedural Interface

ipworks_rss_get($res, 131 );

Default Value

''

Remarks

The certificate's version number. The possible values are the strings "V1", "V2", and "V3".

This property is read-only.

Data Type

String

SSLCertSubject Property (IPWorks_RSS Class)

The subject of the certificate used for client authentication.

Object Oriented Interface

public function getSSLCertSubject();
public function setSSLCertSubject($value);

Procedural Interface

ipworks_rss_get($res, 132 );
ipworks_rss_set($res, 132, $value );

Default Value

''

Remarks

The subject of the certificate used for client authentication.

This property must be set after all other certificate properties are set. When this property is set, a search is performed in the current certificate store to locate a certificate with a matching subject.

If a matching certificate is found, the property is set to the full subject of the matching certificate.

If an exact match is not found, the store is searched for subjects containing the value of the property.

If a match is still not found, the property is set to an empty string, and no certificate is selected.

The special value "*" picks a random certificate in the certificate store.

The certificate subject is a comma-separated list of distinguished name fields and values. For instance, "CN=www.server.com, OU=test, C=US, E=support@nsoftware.com". Common fields and their meanings are as follows:

If a field value contains a comma, it must be quoted.

Data Type

String

SSLCertEncoded Property (IPWorks_RSS Class)

The certificate (PEM/Base64 encoded).

Object Oriented Interface

public function getSSLCertEncoded();
public function setSSLCertEncoded($value);

Procedural Interface

ipworks_rss_get($res, 133 );
ipworks_rss_set($res, 133, $value );

Default Value

''

Remarks

The certificate (PEM/Base64 encoded). This property is used to assign a specific certificate. The SSLCertStore and SSLCertSubject properties also may be used to specify a certificate.

When SSLCertEncoded is set, a search is initiated in the current SSLCertStore for the private key of the certificate. If the key is found, SSLCertSubject is updated to reflect the full subject of the selected certificate; otherwise, SSLCertSubject is set to an empty string.

This property is not available at design time.

Data Type

Binary String

SSLProvider Property (IPWorks_RSS Class)

The Secure Sockets Layer/Transport Layer Security (SSL/TLS) implementation to use.

Object Oriented Interface

public function getSSLProvider();
public function setSSLProvider($value);

Procedural Interface

ipworks_rss_get($res, 134 );
ipworks_rss_set($res, 134, $value );

Default Value

0

Remarks

This property specifies the SSL/TLS implementation to use. In most cases the default value of 0 (Automatic) is recommended and should not be changed. When set to 0 (Automatic), the class will select whether to use the platform implementation or the internal implementation depending on the operating system as well as the TLS version being used.

Possible values are as follows:

In most cases using the default value (Automatic) is recommended. The class will select a provider depending on the current platform.

When Automatic is selected, on Windows, the class will use the platform implementation. On Linux/macOS, the class will use the internal implementation. When TLS 1.3 is enabled via SSLEnabledProtocols, the internal implementation is used on all platforms.

Data Type

Integer

SSLServerCertEffectiveDate Property (IPWorks_RSS Class)

The date on which this certificate becomes valid.

Object Oriented Interface

public function getSSLServerCertEffectiveDate();

Procedural Interface

ipworks_rss_get($res, 135 );

Default Value

''

Remarks

The date on which this certificate becomes valid. Before this date, it is not valid. The date is localized to the system's time zone. The following example illustrates the format of an encoded date:

23-Jan-2000 15:00:00.

This property is read-only.

Data Type

String

SSLServerCertExpirationDate Property (IPWorks_RSS Class)

The date on which the certificate expires.

Object Oriented Interface

public function getSSLServerCertExpirationDate();

Procedural Interface

ipworks_rss_get($res, 136 );

Default Value

''

Remarks

The date on which the certificate expires. After this date, the certificate will no longer be valid. The date is localized to the system's time zone. The following example illustrates the format of an encoded date:

23-Jan-2001 15:00:00.

This property is read-only.

Data Type

String

SSLServerCertExtendedKeyUsage Property (IPWorks_RSS Class)

A comma-delimited list of extended key usage identifiers.

Object Oriented Interface

public function getSSLServerCertExtendedKeyUsage();

Procedural Interface

ipworks_rss_get($res, 137 );

Default Value

''

Remarks

A comma-delimited list of extended key usage identifiers. These are the same as ASN.1 object identifiers (OIDs).

This property is read-only.

Data Type

String

SSLServerCertFingerprint Property (IPWorks_RSS Class)

The hex-encoded, 16-byte MD5 fingerprint of the certificate.

Object Oriented Interface

public function getSSLServerCertFingerprint();

Procedural Interface

ipworks_rss_get($res, 138 );

Default Value

''

Remarks

The hex-encoded, 16-byte MD5 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.

The following example illustrates the format: bc:2a:72:af:fe:58:17:43:7a:5f:ba:5a:7c:90:f7:02

This property is read-only.

Data Type

String

SSLServerCertFingerprintSHA1 Property (IPWorks_RSS Class)

The hex-encoded, 20-byte SHA-1 fingerprint of the certificate.

Object Oriented Interface

public function getSSLServerCertFingerprintSHA1();

Procedural Interface

ipworks_rss_get($res, 139 );

Default Value

''

Remarks

The hex-encoded, 20-byte SHA-1 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.

The following example illustrates the format: 30:7b:fa:38:65:83:ff:da:b4:4e:07:3f:17:b8:a4:ed:80:be:ff:84

This property is read-only.

Data Type

String

SSLServerCertFingerprintSHA256 Property (IPWorks_RSS Class)

The hex-encoded, 32-byte SHA-256 fingerprint of the certificate.

Object Oriented Interface

public function getSSLServerCertFingerprintSHA256();

Procedural Interface

ipworks_rss_get($res, 140 );

Default Value

''

Remarks

The hex-encoded, 32-byte SHA-256 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.

The following example illustrates the format: 6a:80:5c:33:a9:43:ea:b0:96:12:8a:64:96:30:ef:4a:8a:96:86:ce:f4:c7:be:10:24:8e:2b:60:9e:f3:59:53

This property is read-only.

Data Type

String

SSLServerCertIssuer Property (IPWorks_RSS Class)

The issuer of the certificate.

Object Oriented Interface

public function getSSLServerCertIssuer();

Procedural Interface

ipworks_rss_get($res, 141 );

Default Value

''

Remarks

The issuer of the certificate. This property contains a string representation of the name of the issuing authority for the certificate.

This property is read-only.

Data Type

String

SSLServerCertPrivateKey Property (IPWorks_RSS Class)

The private key of the certificate (if available).

Object Oriented Interface

public function getSSLServerCertPrivateKey();

Procedural Interface

ipworks_rss_get($res, 142 );

Default Value

''

Remarks

The private key of the certificate (if available). The key is provided as PEM/Base64-encoded data.

Note: The SSLServerCertPrivateKey may be available but not exportable. In this case, SSLServerCertPrivateKey returns an empty string.

This property is read-only.

Data Type

String

SSLServerCertPrivateKeyAvailable Property (IPWorks_RSS Class)

Whether a PrivateKey is available for the selected certificate.

Object Oriented Interface

public function getSSLServerCertPrivateKeyAvailable();

Procedural Interface

ipworks_rss_get($res, 143 );

Default Value

false

Remarks

Whether a SSLServerCertPrivateKey is available for the selected certificate. If SSLServerCertPrivateKeyAvailable is True, the certificate may be used for authentication purposes (e.g., server authentication).

This property is read-only.

Data Type

Boolean

SSLServerCertPrivateKeyContainer Property (IPWorks_RSS Class)

The name of the PrivateKey container for the certificate (if available).

Object Oriented Interface

public function getSSLServerCertPrivateKeyContainer();

Procedural Interface

ipworks_rss_get($res, 144 );

Default Value

''

Remarks

The name of the SSLServerCertPrivateKey container for the certificate (if available). This functionality is available only on Windows platforms.

This property is read-only.

Data Type

String

SSLServerCertPublicKey Property (IPWorks_RSS Class)

The public key of the certificate.

Object Oriented Interface

public function getSSLServerCertPublicKey();

Procedural Interface

ipworks_rss_get($res, 145 );

Default Value

''

Remarks

The public key of the certificate. The key is provided as PEM/Base64-encoded data.

This property is read-only.

Data Type

String

SSLServerCertPublicKeyAlgorithm Property (IPWorks_RSS Class)

The textual description of the certificate's public key algorithm.

Object Oriented Interface

public function getSSLServerCertPublicKeyAlgorithm();

Procedural Interface

ipworks_rss_get($res, 146 );

Default Value

''

Remarks

The textual description of the certificate's public key algorithm. The property contains either the name of the algorithm (e.g., "RSA" or "RSA_DH") or an object identifier (OID) string representing the algorithm.

This property is read-only.

Data Type

String

SSLServerCertPublicKeyLength Property (IPWorks_RSS Class)

The length of the certificate's public key (in bits).

Object Oriented Interface

public function getSSLServerCertPublicKeyLength();

Procedural Interface

ipworks_rss_get($res, 147 );

Default Value

0

Remarks

The length of the certificate's public key (in bits). Common values are 512, 1024, and 2048.

This property is read-only.

Data Type

Integer

SSLServerCertSerialNumber Property (IPWorks_RSS Class)

The serial number of the certificate encoded as a string.

Object Oriented Interface

public function getSSLServerCertSerialNumber();

Procedural Interface

ipworks_rss_get($res, 148 );

Default Value

''

Remarks

The serial number of the certificate encoded as a string. The number is encoded as a series of hexadecimal digits, with each pair representing a byte of the serial number.

This property is read-only.

Data Type

String

SSLServerCertSignatureAlgorithm Property (IPWorks_RSS Class)

The text description of the certificate's signature algorithm.

Object Oriented Interface

public function getSSLServerCertSignatureAlgorithm();

Procedural Interface

ipworks_rss_get($res, 149 );

Default Value

''

Remarks

The text description of the certificate's signature algorithm. The property contains either the name of the algorithm (e.g., "RSA" or "RSA_MD5RSA") or an object identifier (OID) string representing the algorithm.

This property is read-only.

Data Type

String

SSLServerCertStore Property (IPWorks_RSS Class)

The name of the certificate store for the client certificate.

Object Oriented Interface

public function getSSLServerCertStore();

Procedural Interface

ipworks_rss_get($res, 150 );

Default Value

'MY'

Remarks

The name of the certificate store for the client certificate.

The SSLServerCertStoreType property denotes the type of the certificate store specified by SSLServerCertStore. If the store is password-protected, specify the password in SSLServerCertStorePassword.

SSLServerCertStore is used in conjunction with the SSLServerCertSubject property to specify client certificates. If SSLServerCertStore has a value, and SSLServerCertSubject or SSLServerCertEncoded is set, a search for a certificate is initiated. Please see the SSLServerCertSubject property for details.

Designations of certificate stores are platform dependent.

The following designations are the most common User and Machine certificate stores in Windows:

When the certificate store type is cstPFXFile, this property must be set to the name of the file. When the type is cstPFXBlob, the property must be set to the binary contents of a PFX file (i.e., PKCS#12 certificate store).

This property is read-only.

Data Type

Binary String

SSLServerCertStorePassword Property (IPWorks_RSS Class)

If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.

Object Oriented Interface

public function getSSLServerCertStorePassword();

Procedural Interface

ipworks_rss_get($res, 151 );

Default Value

''

Remarks

If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.

This property is read-only.

Data Type

String

SSLServerCertStoreType Property (IPWorks_RSS Class)

The type of certificate store for this certificate.

Object Oriented Interface

public function getSSLServerCertStoreType();

Procedural Interface

ipworks_rss_get($res, 152 );

Default Value

0

Remarks

The type of certificate store for this certificate.

The class supports both public and private keys in a variety of formats. When the cstAuto value is used, the class will automatically determine the type. This property can take one of the following values:

This property is read-only.

Data Type

Integer

SSLServerCertSubjectAltNames Property (IPWorks_RSS Class)

Comma-separated lists of alternative subject names for the certificate.

Object Oriented Interface

public function getSSLServerCertSubjectAltNames();

Procedural Interface

ipworks_rss_get($res, 153 );

Default Value

''

Remarks

Comma-separated lists of alternative subject names for the certificate.

This property is read-only.

Data Type

String

SSLServerCertThumbprintMD5 Property (IPWorks_RSS Class)

The MD5 hash of the certificate.

Object Oriented Interface

public function getSSLServerCertThumbprintMD5();

Procedural Interface

ipworks_rss_get($res, 154 );

Default Value

''

Remarks

The MD5 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.

This property is read-only.

Data Type

String

SSLServerCertThumbprintSHA1 Property (IPWorks_RSS Class)

The SHA-1 hash of the certificate.

Object Oriented Interface

public function getSSLServerCertThumbprintSHA1();

Procedural Interface

ipworks_rss_get($res, 155 );

Default Value

''

Remarks

The SHA-1 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.

This property is read-only.

Data Type

String

SSLServerCertThumbprintSHA256 Property (IPWorks_RSS Class)

The SHA-256 hash of the certificate.

Object Oriented Interface

public function getSSLServerCertThumbprintSHA256();

Procedural Interface

ipworks_rss_get($res, 156 );

Default Value

''

Remarks

The SHA-256 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.

This property is read-only.

Data Type

String

SSLServerCertUsage Property (IPWorks_RSS Class)

The text description of UsageFlags .

Object Oriented Interface

public function getSSLServerCertUsage();

Procedural Interface

ipworks_rss_get($res, 157 );

Default Value

''

Remarks

The text description of SSLServerCertUsageFlags.

This value will be one or more of the following strings and will be separated by commas:

• Digital Signature
• Non-Repudiation
• Key Encipherment
• Data Encipherment
• Key Agreement
• Certificate Signing
• CRL Signing
• Encipher Only

If the provider is OpenSSL, the value is a comma-separated list of X.509 certificate extension names.

This property is read-only.

Data Type

String

SSLServerCertUsageFlags Property (IPWorks_RSS Class)

The flags that show intended use for the certificate.

Object Oriented Interface

public function getSSLServerCertUsageFlags();

Procedural Interface

ipworks_rss_get($res, 158 );

Default Value

0

Remarks

The flags that show intended use for the certificate. The value of SSLServerCertUsageFlags is a combination of the following flags:

Please see the SSLServerCertUsage property for a text representation of SSLServerCertUsageFlags.

This functionality currently is not available when the provider is OpenSSL.

This property is read-only.

Data Type

Integer

SSLServerCertVersion Property (IPWorks_RSS Class)

The certificate's version number.

Object Oriented Interface

public function getSSLServerCertVersion();

Procedural Interface

ipworks_rss_get($res, 159 );

Default Value

''

Remarks

The certificate's version number. The possible values are the strings "V1", "V2", and "V3".

This property is read-only.

Data Type

String

SSLServerCertSubject Property (IPWorks_RSS Class)

The subject of the certificate used for client authentication.

Object Oriented Interface

public function getSSLServerCertSubject();

Procedural Interface

ipworks_rss_get($res, 160 );

Default Value

''

Remarks

The subject of the certificate used for client authentication.

This property must be set after all other certificate properties are set. When this property is set, a search is performed in the current certificate store to locate a certificate with a matching subject.

If a matching certificate is found, the property is set to the full subject of the matching certificate.

If an exact match is not found, the store is searched for subjects containing the value of the property.

If a match is still not found, the property is set to an empty string, and no certificate is selected.

The special value "*" picks a random certificate in the certificate store.

The certificate subject is a comma-separated list of distinguished name fields and values. For instance, "CN=www.server.com, OU=test, C=US, E=support@nsoftware.com". Common fields and their meanings are as follows:

If a field value contains a comma, it must be quoted.

This property is read-only.

Data Type

String

SSLServerCertEncoded Property (IPWorks_RSS Class)

The certificate (PEM/Base64 encoded).

Object Oriented Interface

public function getSSLServerCertEncoded();

Procedural Interface

ipworks_rss_get($res, 161 );

Default Value

''

Remarks

The certificate (PEM/Base64 encoded). This property is used to assign a specific certificate. The SSLServerCertStore and SSLServerCertSubject properties also may be used to specify a certificate.

When SSLServerCertEncoded is set, a search is initiated in the current SSLServerCertStore for the private key of the certificate. If the key is found, SSLServerCertSubject is updated to reflect the full subject of the selected certificate; otherwise, SSLServerCertSubject is set to an empty string.

This property is read-only and not available at design time.

Data Type

Binary String

Timeout Property (IPWorks_RSS Class)

The timeout for the class.

Object Oriented Interface

public function getTimeout();
public function setTimeout($value);

Procedural Interface

ipworks_rss_get($res, 162 );
ipworks_rss_set($res, 162, $value );

Default Value

60

Remarks

If the Timeout property is set to 0, all operations will run uninterrupted until successful completion or an error condition is encountered.

If Timeout is set to a positive value, the class will wait for the operation to complete before returning control.

The class will use DoEvents to enter an efficient wait loop during any potential waiting period, making sure that all system events are processed immediately as they arrive. This ensures that the host application does not freeze and remains responsive.

If Timeout expires, and the operation is not yet complete, the class fails with an error.

Note: By default, all timeouts are inactivity timeouts, that is, the timeout period is extended by Timeout seconds when any amount of data is successfully sent or received.

The default value for the Timeout property is 60 seconds.

Data Type

Integer

TransferredData Property (IPWorks_RSS Class)

This property includes the contents of the last response from the server.

Object Oriented Interface

public function getTransferredData();

Procedural Interface

ipworks_rss_get($res, 163 );

Default Value

''

Remarks

This property contains the contents of the last response from the server. If the LocalFile is empty, the data are accumulated in TransferredData and also can be received in the Transfer event. Otherwise, this property returns an empty string.

TransferredDataLimit controls the maximum amount of data accumulated in TransferredData (by default there is no limit).

This property is read-only and not available at design time.

Data Type

Binary String

TransferredDataLimit Property (IPWorks_RSS Class)

This property includes the maximum number of bytes of data to be transferred.

Object Oriented Interface

public function getTransferredDataLimit();
public function setTransferredDataLimit($value);

Procedural Interface

ipworks_rss_get($res, 164 );
ipworks_rss_set($res, 164, $value );

Default Value

0

Remarks

This property defines the maximum number of bytes of data to be transferred. The default value is zero, which means there is no limit to the amount of data the class will accumulate and parse. If this value is set to a number n that is greater than zero, the class will receive only the first n bytes of data from the server.

Data Type

Long64

TransferredHeaders Property (IPWorks_RSS Class)

The full set of headers as received from the server.

Object Oriented Interface

public function getTransferredHeaders();

Procedural Interface

ipworks_rss_get($res, 165 );

Default Value

''

Remarks

This property returns the complete set of raw headers as received from the server.

The Header event shows the individual headers as parsed by the class.

This property is read-only and not available at design time.

Data Type

String

User Property (IPWorks_RSS Class)

This property includes a user name if authentication is to be used.

Object Oriented Interface

public function getUser();
public function setUser($value);

Procedural Interface

ipworks_rss_get($res, 166 );
ipworks_rss_set($res, 166, $value );

Default Value

''

Remarks

This property contains a user name if authentication is to be used. If AuthScheme is set to HTTP Basic Authentication, The User and Password are Base64 encoded, and the result is put in the Authorization property in the form "Basic [encoded-user-password]".

If AuthScheme is set to HTTP Digest Authentication, the User and Password properties are used to respond to the HTTP Digest Authentication challenge from the server.

If AuthScheme is set to NTLM, NTLM authentication will be attempted. If AuthScheme is set to NTLM, and User and Password are empty, the class will attempt to authenticate using the current user's credentials.

Data Type

String

AddCookie Method (IPWorks_RSS Class)

Adds a cookie and the corresponding value to the outgoing request headers.

Object Oriented Interface

public function doAddCookie($cookiename, $cookievalue);

Procedural Interface

ipworks_rss_do_addcookie($res, $cookiename, $cookievalue);

Remarks

This method adds a cookie and the corresponding value to the outgoing request headers. Please refer to the Cookies property for more information on cookies and how they are managed.

AddItem Method (IPWorks_RSS Class)

This method inserts a new item into the beginning of an RSS feed.

Object Oriented Interface

public function doAddItem($title, $description, $link);

Procedural Interface

ipworks_rss_do_additem($res, $title, $description, $link);

Remarks

This method assumes that the items are new and more important than existing items and thus adds the item to the beginning of the current item list. This method requires the three standard fields Title, Description, and Link to be specified.

Example 1. Add a New Item: RSSControl.AddItem("New Item Title", "Item Description", "http://www.itemsource.com") RSSControl.WriteFile(filename) Example 2. Add a New Item Using the Item Arrays: RSSControl.ItemCount = 1 RSSControl.ItemTitle(0) = "New Item Title" RSSControl.ItemDescription(0) = "Item Description" RSSControl.ItemLink(0) = "http://www.itemsource.com" RSSControl.WriteFile(filename)

AddNamespace Method (IPWorks_RSS Class)

This method adds a namespace to the Namespaces properties.

Object Oriented Interface

public function doAddNamespace($prefix, $namespaceuri);

Procedural Interface

ipworks_rss_do_addnamespace($res, $prefix, $namespaceuri);

Remarks

This method adds a namespace to the Namespaces properties. Prefix specifies the namespace prefix, and NamespaceURI specifies the namespace.

Config Method (IPWorks_RSS Class)

Sets or retrieves a configuration setting.

Object Oriented Interface

public function doConfig($configurationstring);

Procedural Interface

ipworks_rss_do_config($res, $configurationstring);

Remarks

Config is a generic method available in every class. It is used to set and retrieve configuration settings for the class.

These settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the class, access to these internal properties is provided through the Config method.

To set a configuration setting named PROPERTY, you must call Config("PROPERTY=VALUE"), where VALUE is the value of the setting expressed as a string. For boolean values, use the strings "True", "False", "0", "1", "Yes", or "No" (case does not matter).

To read (query) the value of a configuration setting, you must call Config("PROPERTY"). The value will be returned as a string.

DoEvents Method (IPWorks_RSS Class)

This method processes events from the internal message queue.

Object Oriented Interface

public function doEvents();

Procedural Interface

ipworks_rss_do_doevents($res);

Remarks

When DoEvents is called, the class processes any available events. If no events are available, it waits for a preset period of time, and then returns.

GetFeed Method (IPWorks_RSS Class)

This method retrieves an RSS feed.

Object Oriented Interface

public function doGetFeed($url);

Procedural Interface

ipworks_rss_do_getfeed($res, $url);

Remarks

This method retrieves documents using the HTTP GET method. The document contents are delivered in the RSSData property, as well as through the Transfer event, and the HTTP response headers through the Header event. If the LocalFile property has been set, the class will write the transferred data there.

The class will then attempt to parse the RSS feed, filling in the channel and item properties as it goes. The feed properties can be accessed either directly through the named properties, or through the GetProperty and SetProperty methods.

GetProperty Method (IPWorks_RSS Class)

This method gets the value of a specific RSS feed item element or attribute.

Object Oriented Interface

public function doGetProperty($propertyname);

Procedural Interface

ipworks_rss_do_getproperty($res, $propertyname);

Remarks

This method is intended to extend the functionality of the RSS class. It will get the value for a specific item element or attribute of this RSS feed. Property is the XPath of the element or attribute according to the following convention: root/element@attribute. The @attribute part is optional, and the root field can be any of the four following values:

The element field can be any property of the root field, and attribute can be any property of that field. If an attribute is not supplied, this method will return the text portion of element.

Example. GetProperty:

RSSControl.GetProperty("item[5]/guid@isPermaLink") RSSControl.GetProperty("item[5]/link") RSSControl.GetProperty("/channel/title")

Note: To add nonstandard fields (i.e., fields that are not defined in the RSS specification), element must be prefixed with a namespace that defines that field. The same applies for the attribute field. Use the Namespaces properties to define and list namespaces.

GetURL Method (IPWorks_RSS Class)

This method retrieves an RSS feed.

Object Oriented Interface

public function doGetURL($url);

Procedural Interface

ipworks_rss_do_geturl($res, $url);

Remarks

This method retrieves the document using the HTTP GET method. The document contents are delivered in the RSSData property, as well as through the Transfer event, and the HTTP response headers are delivered through the Header event. If the LocalFile property has been set, the class will write the transferred data there.

The class will not parse the data returned by the server. For more control over the retrieval of the item link, please use the HTTP class.

Interrupt Method (IPWorks_RSS Class)

This method interrupts the current method.

Object Oriented Interface

public function doInterrupt();

Procedural Interface

ipworks_rss_do_interrupt($res);

Remarks

If there is no method in progress, Interrupt simply returns, doing nothing.

If there is no method in progress, Interrupt simply returns, doing nothing.

OPMLAttr Method (IPWorks_RSS Class)

This method returns the value of the attribute specified in the parameter.

Object Oriented Interface

public function doOPMLAttr($attrname);

Procedural Interface

ipworks_rss_do_opmlattr($res, $attrname);

Remarks

This method may be used to get the value of an attribute for an outline entry of an OPML document. The desired attribute must be specified in the parameter of this method. This method also must be invoked inside the OPMLOutline event.

Put Method (IPWorks_RSS Class)

This method sends data to the HTTP server using the HTTP PUT method.

Object Oriented Interface

public function doPut($url);

Procedural Interface

ipworks_rss_do_put($res, $url);

Remarks

This method sends data to the HTTP server. The data are taken from the PostData or AttachedFile properties. The server response text is received through the Transfer event, and the HTTP response headers are received through the Header event. If LocalFile is not empty, the data (not the headers) are written there as well. The user normally should have assigned the correct values to User and Password or Authorization.

ReadFile Method (IPWorks_RSS Class)

This method loads an RSS file into the class.

Object Oriented Interface

public function doReadFile($filename);

Procedural Interface

ipworks_rss_do_readfile($res, $filename);

Remarks

This method loads an RSS file and attempts to parse it, filling in the properties as it goes. The feed properties can be accessed either directly through the named properties or through the GetProperty and SetProperty methods.

ReadOPML Method (IPWorks_RSS Class)

This method reads and parses an OPML file.

Object Oriented Interface

public function doReadOPML($opmlfile);

Procedural Interface

ipworks_rss_do_readopml($res, $opmlfile);

Remarks

This method reads in the OPML file specified by OPMLFile. The class then parses the file and returns the data to the user in the OPMLHeader and OPMLOutline events.

Reset Method (IPWorks_RSS Class)

This method resets all properties of the class.

Object Oriented Interface

public function doReset();

Procedural Interface

ipworks_rss_do_reset($res);

Remarks

This method resets all properties to the class's default settings. This is an easy way to clear all of the property values before repopulating the RSS feed.

SetProperty Method (IPWorks_RSS Class)

This method sets the value of a specific RSS feed property.

Object Oriented Interface

public function doSetProperty($propertyname, $propertyvalue);

Procedural Interface

ipworks_rss_do_setproperty($res, $propertyname, $propertyvalue);

Remarks

This method is intended to extend the functionality of the RSS class. It will set the value for a specific field of this RSS feed. Property is the name of the property according to the following convention: root/element@attribute. The root field can be any of the four following values:

The element field can be any property of the root field, and attribute can be any property of that field. If an attribute is not supplied, Value will be placed in the text portion of element. Example. SetProperty:

RSSControl.SetProperty("item[5]/guid@isPermaLink", "true")

Note: To add nonstandard fields (i.e., fields that are not defined in the RSS specification), element must be prefixed with a namespace that defines that field. The same applies for the attribute field. Use the Namespaces properties to define and list namespaces.

WriteFile Method (IPWorks_RSS Class)

This method writes an RSS feed from the class.

Object Oriented Interface

public function doWriteFile($filename);

Procedural Interface

ipworks_rss_do_writefile($res, $filename);

Remarks

This method will write an RSS feed from the existing property values to FileName. The RSS feed will be preverified, and if there are any missing required fields, the class fails with an error.

Example 1. Add a New Item: RSSControl.AddItem("New Item Title", "Item Description", "http://www.itemsource.com") RSSControl.WriteFile(filename) Example 3. Add a New Item Using the Item Arrays: RSSControl.ItemCount = 1 RSSControl.ItemTitle(0) = "New Item Title" RSSControl.ItemDescription(0) = "Item Description" RSSControl.ItemLink(0) = "http://www.itemsource.com" RSSControl.WriteFile(filename)

Connected Event (IPWorks_RSS Class)

Fired immediately after a connection completes (or fails).

Object Oriented Interface

public function fireConnected($param);

Procedural Interface

ipworks_rss_register_callback($res, 1, array($this, 'fireConnected'));

Parameter List

 'statuscode'
 'description'

Remarks

If the connection is made normally, StatusCode is 0 and Description is "OK".

If the connection fails, StatusCode has the error code returned by the Transmission Control Protocol (TCP)/IP stack. Description contains a description of this code. The value of StatusCode is equal to the value of the error.

Please refer to the Error Codes section for more information.

ConnectionStatus Event (IPWorks_RSS Class)

Fired to indicate changes in the connection state.

Object Oriented Interface

public function fireConnectionStatus($param);

Procedural Interface

ipworks_rss_register_callback($res, 2, array($this, 'fireConnectionStatus'));

Parameter List

 'connectionevent'
 'statuscode'
 'description'

Remarks

This event is fired when the connection state changes: for example, completion of a firewall or proxy connection or completion of a security handshake.

The ConnectionEvent parameter indicates the type of connection event. Values may include the following:

Disconnected Event (IPWorks_RSS Class)

Fired when a connection is closed.

Object Oriented Interface

public function fireDisconnected($param);

Procedural Interface

ipworks_rss_register_callback($res, 3, array($this, 'fireDisconnected'));

Parameter List

 'statuscode'
 'description'

Remarks

If the connection is broken normally, StatusCode is 0 and Description is "OK".

If the connection is broken for any other reason, StatusCode has the error code returned by the Transmission Control Protocol (TCP/IP) subsystem. Description contains a description of this code. The value of StatusCode is equal to the value of the TCP/IP error.

Please refer to the Error Codes section for more information.

EndTransfer Event (IPWorks_RSS Class)

This event is fired when a document finishes transferring.

Object Oriented Interface

public function fireEndTransfer($param);

Procedural Interface

ipworks_rss_register_callback($res, 4, array($this, 'fireEndTransfer'));

Parameter List

 'direction'

Remarks

The EndTransfer event is fired when the document text finishes transferring from the server to the local host.

The Direction parameter shows whether the client (0) or the server (1) is sending the data.

Error Event (IPWorks_RSS Class)

Fired when information is available about errors during data delivery.

Object Oriented Interface

public function fireError($param);

Procedural Interface

ipworks_rss_register_callback($res, 5, array($this, 'fireError'));

Parameter List

 'errorcode'
 'description'

Remarks

The Error event is fired in case of exceptional conditions during message processing. Normally the class fails with an error.

The ErrorCode parameter contains an error code, and the Description parameter contains a textual description of the error. For a list of valid error codes and their descriptions, please refer to the Error Codes section.

Header Event (IPWorks_RSS Class)

Fired every time a header line comes in.

Object Oriented Interface

public function fireHeader($param);

Procedural Interface

ipworks_rss_register_callback($res, 6, array($this, 'fireHeader'));

Parameter List

 'field'
 'value'

Remarks

The Field parameter contains the name of the HTTP header (which is the same as it is delivered). The Value parameter contains the header contents.

If the header line being retrieved is a continuation header line, then the Field parameter contains "" (empty string).

Log Event (IPWorks_RSS Class)

Fired once for each log message.

Object Oriented Interface

public function fireLog($param);

Procedural Interface

ipworks_rss_register_callback($res, 7, array($this, 'fireLog'));

Parameter List

 'loglevel'
 'message'
 'logtype'

Remarks

This event is fired once for each log message generated by the class. The verbosity is controlled by the LogLevel setting.

LogLevel indicates the level of message. Possible values are as follows:

The value 1 (Info) logs basic information, including the URL, HTTP version, and status details.

The value 2 (Verbose) logs additional information about the request and response.

The value 3 (Debug) logs the headers and body for both the request and response, as well as additional debug information (if any).

Message is the log entry.

LogType identifies the type of log entry. Possible values are as follows:

• "Info"
• "RequestHeaders"
• "ResponseHeaders"
• "RequestBody"
• "ResponseBody"
• "ProxyRequest"
• "ProxyResponse"
• "FirewallRequest"
• "FirewallResponse"

OPMLHeader Event (IPWorks_RSS Class)

This event is fired for each value in the header section of the current OPML document.

Object Oriented Interface

public function fireOPMLHeader($param);

Procedural Interface

ipworks_rss_register_callback($res, 8, array($this, 'fireOPMLHeader'));

Parameter List

 'field'
 'value'

Remarks

This event is fired when the class is parsing an OPML document after a call to ReadOPML is made. The class parses each header field and value from the OPML document and fires OPMLHeader once for each header present.

OPMLOutline Event (IPWorks_RSS Class)

This event is fired for each outline in the current OPML document.

Object Oriented Interface

public function fireOPMLOutline($param);

Procedural Interface

ipworks_rss_register_callback($res, 9, array($this, 'fireOPMLOutline'));

Parameter List

 'level'
 'text'
 'typename'
 'title'
 'url'
 'xmlurl'
 'htmlurl'
 'created'
 'description'
 'otherattrs'

Remarks

This event is fired for each outline in the OPML document.

The Level parameter contains the depth of the current outline in the OPML document.

Each outline contains a Text attribute, which is parsed out, and returned in the Text parameter.

The Type attribute is a string that describes how the other attributes of the outline are interpreted and is returned in the TypeName parameter.

The Title parameter refers to the title of the outline.

The URL parameter indicates the external location of the outline.

The XMLURL parameter is usually set to an RSS, Atom, or OPML file.

The HTMLURL parameter specifies an HTMLURL attribute, which may be used instead of the URL attribute.

The Created parameter contains the date the outline node was created.

The OtherAttrs parameter contains a list of other attributes for the current outline. In this case, you must use the OPMLAttr method to get the attribute's corresponding values from the parser.

Redirect Event (IPWorks_RSS Class)

Fired when a redirection is received from the server.

Object Oriented Interface

public function fireRedirect($param);

Procedural Interface

ipworks_rss_register_callback($res, 10, array($this, 'fireRedirect'));

Parameter List

 'location'
 'accept'

Remarks

This event is fired in cases in which the client can decide whether or not to continue with the redirection process. The Accept parameter is always True by default, but if you do not want to follow the redirection, Accept may be set to False, in which case the class fails with an error. Location is the location to which the client is being redirected. Further control over redirection is provided in the FollowRedirects property.

SetCookie Event (IPWorks_RSS Class)

Fired for every cookie set by the server.

Object Oriented Interface

public function fireSetCookie($param);

Procedural Interface

ipworks_rss_register_callback($res, 11, array($this, 'fireSetCookie'));

Parameter List

 'name'
 'value'
 'expires'
 'domain'
 'path'
 'secure'

Remarks

This event is fired for every Set-Cookie: header received from the HTTP server.

The Name parameter contains the name of the cookie, with the corresponding value supplied in the Value parameter.

The Expires parameter contains an expiration time for the cookie (if provided by the server). The time format used is "Weekday, DD-Mon-YY HH:MM:SS GMT". If the server does not provide an expiration time, the Expires parameter will be an empty string. In this case, the convention is to drop the cookie at the end of the session.

The Domain parameter contains a domain name to limit the cookie to (if provided by the server). If the server does not provide a domain name, the Domain parameter will be an empty string. The convention in this case is to use the server specified in the URL (URLServer) as the cookie domain.

The Path parameter contains a path name to limit the cookie to (if provided by the server). If the server does not provide a cookie path, the Path parameter will be an empty string. The convention in this case is to use the path specified in the URL (URLPath) as the cookie path.

The Secure parameter specifies whether the cookie is secure. If the value of this parameter is True, the cookie value must be submitted only through a secure (HTTPS) connection.

SSLServerAuthentication Event (IPWorks_RSS Class)

Fired after the server presents its certificate to the client.

Object Oriented Interface

public function fireSSLServerAuthentication($param);

Procedural Interface

ipworks_rss_register_callback($res, 12, array($this, 'fireSSLServerAuthentication'));

Parameter List

 'certencoded'
 'certsubject'
 'certissuer'
 'status'
 'accept'

Remarks

During this event, the client can decide whether or not to continue with the connection process. The Accept parameter is a recommendation on whether to continue or close the connection. This is just a suggestion: application software must use its own logic to determine whether or not to continue.

When Accept is False, Status shows why the verification failed (otherwise, Status contains the string OK). If it is decided to continue, you can override and accept the certificate by setting the Accept parameter to True.

SSLStatus Event (IPWorks_RSS Class)

Fired when secure connection progress messages are available.

Object Oriented Interface

public function fireSSLStatus($param);

Procedural Interface

ipworks_rss_register_callback($res, 13, array($this, 'fireSSLStatus'));

Parameter List

 'message'

Remarks

The event is fired for informational and logging purposes only. This event tracks the progress of the connection.

StartTransfer Event (IPWorks_RSS Class)

This event is fired when a document starts transferring (after the headers).

Object Oriented Interface

public function fireStartTransfer($param);

Procedural Interface

ipworks_rss_register_callback($res, 14, array($this, 'fireStartTransfer'));

Parameter List

 'direction'

Remarks

The StartTransfer event is fired when the document text starts transferring from the server to the local host.

The Direction parameter shows whether the client (0) or the server (1) is sending the data.

Status Event (IPWorks_RSS Class)

Fired when the HTTP status line is received from the server.

Object Oriented Interface

public function fireStatus($param);

Procedural Interface

ipworks_rss_register_callback($res, 15, array($this, 'fireStatus'));

Parameter List

 'httpversion'
 'statuscode'
 'description'

Remarks

HTTPVersion is a string containing the HTTP version string as returned from the server (e.g., "1.1").

StatusCode contains the HTTP status code (e.g., 200), and Description the associated message returned by the server (e.g., "OK").

Transfer Event (IPWorks_RSS Class)

Fired while a document transfers (delivers document).

Object Oriented Interface

public function fireTransfer($param);

Procedural Interface

ipworks_rss_register_callback($res, 16, array($this, 'fireTransfer'));

Parameter List

 'direction'
 'bytestransferred'
 'percentdone'
 'text'

Remarks

The Text parameter contains the portion of the document text being received. It is empty if data are being posted to the server.

The BytesTransferred parameter contains the number of bytes transferred in this Direction since the beginning of the document text (excluding HTTP response headers).

The Direction parameter shows whether the client (0) or the server (1) is sending the data.

The PercentDone parameter shows the progress of the transfer in the corresponding direction. If PercentDone can not be calculated the value will be -1.

Note: Events are not re-entrant. Performing time-consuming operations within this event will prevent it from firing again in a timely manner and may affect overall performance.

Config Settings (RSS Class)

RSS Config Settings

HTTP Config Settings

TCPClient Config Settings

SSL Config Settings

-----BEGIN CERTIFICATE-----
MIIEKzCCAxOgAwIBAgIRANTET4LIkxdH6P+CFIiHvTowDQYJKoZIhvcNAQELBQAw
... Intermediate Cert ...
eWHV5OW1K53o/atv59sOiW5K3crjFhsBOd5Q+cJJnU+SWinPKtANXMht+EDvYY2w
F0I1XhM+pKj7FjDr+XNj
-----END CERTIFICATE-----
\r \n
-----BEGIN CERTIFICATE-----
MIIEFjCCAv6gAwIBAgIQetu1SMxpnENAnnOz1P+PtTANBgkqhkiG9w0BAQUFADBp
... Root Cert ...
d8q23djXZbVYiIfE9ebr4g3152BlVCHZ2GyPdjhIuLeH21VbT/dyEHHA
-----END CERTIFICATE-----

-----BEGIN CERTIFICATE-----
MIIEKzCCAxOgAwIBAgIRANTET4LIkxdH6P+CFIiHvTowDQYJKoZIhvcNAQELBQAw
... Intermediate Cert ...
eWHV5OW1K53o/atv59sOiW5K3crjFhsBOd5Q+cJJnU+SWinPKtANXMht+EDvYY2w
F0I1XhM+pKj7FjDr+XNj
-----END CERTIFICATE-----
\r \n
-----BEGIN CERTIFICATE-----
MIIEFjCCAv6gAwIBAgIQetu1SMxpnENAnnOz1P+PtTANBgkqhkiG9w0BAQUFADBp
... Root Cert ...
d8q23djXZbVYiIfE9ebr4g3152BlVCHZ2GyPdjhIuLeH21VbT/dyEHHA
-----END CERTIFICATE-----

-----BEGIN CERTIFICATE-----
MIIEKzCCAxOgAwIBAgIRANTET4LIkxdH6P+CFIiHvTowDQYJKoZIhvcNAQELBQAw
... Intermediate Cert...
eWHV5OW1K53o/atv59sOiW5K3crjFhsBOd5Q+cJJnU+SWinPKtANXMht+EDvYY2w
F0I1XhM+pKj7FjDr+XNj
-----END CERTIFICATE-----
\r \n
-----BEGIN CERTIFICATE-----
MIIEFjCCAv6gAwIBAgIQetu1SMxpnENAnnOz1P+PtTANBgkqhkiG9w0BAQUFADBp
... Root Cert...
d8q23djXZbVYiIfE9ebr4g3152BlVCHZ2GyPdjhIuLeH21VbT/dyEHHA
-----END CERTIFICATE-----

Socket Config Settings

Base Config Settings