C# Class Argentini.Halide.H3Xml

The H3Xml class contains methods and properties for manipulating and using XML and RSS Feeds.
Datei anzeigen Open project: argentini/Halide

Public Methods

Method Description
BuildRss ( String sql, String rssDate, String title, String link, String description, String copyright, String redirect, String feedUrl ) : String

Create a string object with an RSS 2.0 (XML) feed, generated by using the passed params. Uses the default "Halide" Connection string name.

SQL must return fields in the following order:

1. Unique ID for the record, which is appended to the "redirect" param below to create a link to the content.

2. Title for the article.

3. Short description of the article (up to 500 characters, or will be cropped to 500).

4. Date of the article.

BuildRss ( String sql, String connectionStringName, String rssDate, String title, String link, String description, String copyright, String redirect, String feedUrl ) : String

Create a string object with an RSS 2.0 (XML) feed, generated by using the passed params.

SQL must return fields in the following order:

1. Unique ID for the record, which is appended to the "redirect" param below to create a link to the content.

2. Title for the article.

3. Short description of the article (up to 500 characters, or will be cropped to 500).

4. Date of the article.

Clean ( string input ) : String

Sanitizes the string for XML use by converting special characters.

RssFilter ( string strVar ) : String

Filters text for use in RSS feeds.

Private Methods

Method Description
H3Xml ( ) : System

Method Details

BuildRss() public static method

Create a string object with an RSS 2.0 (XML) feed, generated by using the passed params. Uses the default "Halide" Connection string name.

SQL must return fields in the following order:

1. Unique ID for the record, which is appended to the "redirect" param below to create a link to the content.

2. Title for the article.

3. Short description of the article (up to 500 characters, or will be cropped to 500).

4. Date of the article.

public static BuildRss ( String sql, String rssDate, String title, String link, String description, String copyright, String redirect, String feedUrl ) : String
sql String SQL SELECT statement for pulling data
rssDate String Date of the feed itself
title String Title of the feed
link String Link to the source web site (e.g. http://nonsequiturs.com).
description String Description of the feed (up to 500 characters)
copyright String Copyright text
redirect String Path to use for redirection (e.g. "http://nonsequiturs.com/rss/redirect.aspx?ID="). The first column returned will be appended to the end of this string for you. /// Passed param is pulled from SQL and appended. This is also used as a unique GUID for the item.
feedUrl String Fully qualified URL to the generated feed. This is only used to generate an ATOM self-referral tag within the feed itself.
return String

BuildRss() public static method

Create a string object with an RSS 2.0 (XML) feed, generated by using the passed params.

SQL must return fields in the following order:

1. Unique ID for the record, which is appended to the "redirect" param below to create a link to the content.

2. Title for the article.

3. Short description of the article (up to 500 characters, or will be cropped to 500).

4. Date of the article.

public static BuildRss ( String sql, String connectionStringName, String rssDate, String title, String link, String description, String copyright, String redirect, String feedUrl ) : String
sql String SQL SELECT statement for pulling data
connectionStringName String Connection string name to use for SQL access.
rssDate String Date of the feed itself
title String Title of the feed
link String Link to the source web site (e.g. http://nonsequiturs.com).
description String Description of the feed (up to 500 characters)
copyright String Copyright text
redirect String Path to use for redirection (e.g. "http://nonsequiturs.com/rss/redirect.aspx?ID="). The first column returned will be appended to the end of this string for you. /// Passed param is pulled from SQL and appended. This is also used as a unique GUID for the item.
feedUrl String Fully qualified URL to the generated feed. This is only used to generate an ATOM self-referral tag within the feed itself.
return String

Clean() public static method

Sanitizes the string for XML use by converting special characters.
public static Clean ( string input ) : String
input string String to process.
return String

RssFilter() public static method

Filters text for use in RSS feeds.
public static RssFilter ( string strVar ) : String
strVar string String to process.
return String