Home » Docs » FeedConstruct » “commonName” Values

“commonName” Values

A “commonName” value is used by Php FeedWriter to map a single component of a feed output format such as Atom 1.0 to the corresponding information in the feed. This is required as the various feed output formats use different XML tags/elements for similar information. When validating and outputting a feed, the “commonName” value is used to identify a construct in the FeedConstruct class, and also to map this construct to the equivalent data in the feed.

The table below provides a full list of the “commonName” values that are currently used in the Php FeedWriter solution across all feed formats.  The “Feed Construct” representation for each feed format is made up of a selection of elements from the tables below.  A description of the type of data that should be included in each element / construct is also provided below.

For additional information, including the components of a feed schema that a “commonName” value maps to for each of the supported feed formats, see Predefined Feed Constructs.

 

Feed Data Elements

docs commonName Description of Feed Data Constant
feed The main element containing all feed data and items ROOT_CONSTRUCT
__construct() feedChannel An element containing the channel data for the feed. CHANNEL_DATA_CONSTRUCT
__construct() feedTitle The title of the feed
__construct() feedLink The web URL for the feed. This is usually the homepage of the website or blog.
__construct() feedDescription A description of the feed.
set_selfLink() feedSelfLink The link to the current feed.
set_id() feedId Sets the ID of the feed.  This value is set to the feed link by default.
set_language() feedLanguage A string representation of the language that the feed is in.
set_copyright() feedCopyright A copyright notice for the feed content.
set_author() feedAuthor Details about the author of the feed. This element is outputted in various ways depending on the feed format.
set_webmaster() feedWebmaster The webmaster, or technical contact for the feed.
set_rating() feedRating The PICS rating for the feed. For RSS only.
set_date() feedPubDate The date that the feed was published, or created.
set_date() feedDateUpdated The date that the feed was last updated. This date is required for some output formats.
feedDocs A URL to a page on the internet that provides information about the schema that was adhered to when designing the XML document for output of a feed. This value is predefined in Php FeedWriter for each of the supported formats, and points to the relevant schemas used when designing Php FeedWriter.
set_skipDays() feedSkipDays A parent element to contain child elements indicating days of that feed readers can skip checking for updates.
set_skipDays() skipDay The child element indicating a specific day of the week to not check for updates.
set_skipHours() feedSkipHours A parent element to contain a set of elements indicating hours of the day to skip checking for updates.
set_skipHours() skipHour The element that indicates a specific hour of the day to skip checking for updates to the feed.
add_category() feedCategory En element that stores details of a catory for the feed. More than one
categories can be assicated with a feed.
set_refreshInterval() feedRefreshInterval The number of minutes to wait before checking for updates to the feed.
set_icon() feedIcon A URL to an icon image associated with the feed.
set_image() feedImage An element to store information about an image associated with the feed.
set_image() imageUrl The URL to the image on the internet.
set_image() imageTitle The title of the image.
set_image() imageLink A URL for the image link, where a user is taken if they click on the image.
set_image() imageWidth An integer value representing the width of the image.
set_image() imageHeight An integer value representing the height of the image.
set_input() feedInput An element that stores information about an input field that can be associated with a feed in some output formats.
set_input() inputTitle The title of the input field
set_input() inputDescription The description of the input field, suggesting it’s purpose.
set_input() inputName The name of the input field, to be used to retrieve the data from the input field after the form has been submitted to the specified page on the internet.
set_input() inputLink A URL to the page on the internet that should process the input from the field in the feed. This may be a search results page if the input field is used as a search box for the feed.
set_cloud() feedCloud Include details the feed’s cloud. (domain, port, path, registerProcedure,
protocol)
feedGenerator A element containing details of the generator of the feed (Php FeedWriter).
add_contributor() feedContributor An element containing details of a contributor of the feed.  There can be
more than one contributors associated with a feed.
add_contributor() feedContributorName The name of the contrubutor.
add_contributor() feedContributorUri A URL to the contribtor’s website or profile page.
add_contributor() feedContributorEmail The email address of the contributor

 

Item Data Elements

docs commonName Description of Item Data Constant
add_item() item The main element containing an item from the feed ITEM_CONSTRUCT
add_item() itemTitle The title of the feed item
set_id() itemId The ID of the feed Item. This is automatically set to the same value as the feed item link when adding an item to the feed, but can be overridden with a custom ID if required.
set_date() itemUpdated The date that the feed item was last updated.
add_item() itemLink The link for the feed item. This should point ot the online version of the content within the item.
itemCopyright A copyright notice for a specific feed item.
add_item() itemContent The content for the feed item.
itemSummary A summary of the content included in the feed item.
set_source() itemSource A parent element containing a range of child elements with information about the source feed. This can be used when the item has been included with items from other feeds, allowing information from the source feed to be retained. Php FeedWriter currently allows the Title URL and the date that a source feed was last updated to be included.
set_source() sourceTitle The title of the source feed.
set_source() sourceUrl The URL of the source feed.
set_source() sourceUpdated The date that the source feed was last updated.
add_media() itemMedia Associate a media file with a feed item. This can be a range of types, but is commonly an image (jpeg, png, etc.), video, or compressed (zip) file. Many other MIME types can be included also.
itemLinks Associate links to additional resources relating to an item in the feed.
set_date() itemPubDate The date tat the item was first published.
set_author() itemAuthor Details about the author of the feed item.
set_author() itemAuthorName The name of the item author.
set_author() itemAuthorUri A URL pointing to the author’s website or profile page.
set_author() itemAuthorEmail The emails address of the feed item author.
add_contributor() itemContributor An element containing details of contributor(s) of the feed item. More than one contributor can be associated with a single feed item.
add_contributor() itemContributorName The Name of a contributor of the feed item.
add_contributor() itemContributorUri The URL to the contributor’s website or profile page on the internet.
add_contributor() itemContributorEmail The email address of a contributor of the feed.
add_category() itemCategory An element that places the current feed item in a particular category. More than one category can be added to each feed item.
set_comments() itemComments A URL pointing the a page on the internet where people can comment on content in
the feed item.

Comments (0)

No comments yet

Leave a Reply

You must be logged in to post a comment.
  • Php FeedWriter (c) Copyright 2011 Daniel Soutter. Php FeedWriter and the information on this site has been designed to benefit website developers, owners and users, but may contain errors and is provided as is, with no warranty. Terms.