Class TRssFeedItem

Description
Description | Methods (details)

TRssFeedItem class

An item may represent a "story" -- much like a story in a newspaper or magazine; if so its description is a synopsis of the story, and the link points to the full story. An item may also be complete in itself, if so, the description contains the text (entity-encoded HTML is allowed), and the link and title may be omitted. All elements of an item are optional, however at least one of title or description must be present.

  • version: $Id: TXmlDocument.php 1398 2006-09-08 19:31:03Z xue $
  • since: 3.1
  • author: Knut Urdalen <knut.urdalen@gmail.com>

Located in /Xml/TRssFeedDocument.php (line 497) 

TComponent
   |
   --TXmlElement
      |
      --TFeedElement
         |
         --TFeedItem
            |
            --TRssFeedItem
Method Summary
Description | Methods (details)
TRssFeedItem __construct ()
string getDescription ()
string getLink ()
string getTitle ()
void setAuthor (string $author)
void setCategory (string $category, string $domain)
void setComments (string $comments)
void setDescription (string $description)
void setEnclosure (string $url, int $length, string $type)
void setGuid (string $guid, [bool $isPermaLink = true])
void setLink (string $link)
void setPublicationDate (string $pubDate)
void setSource (string $source, string $url)
void setTitle (string $title)
Methods
Description | Methods (details)
Constructor __construct (line 500)
  • access: public
TRssFeedItem __construct ()
Redefinition of:
TXmlElement::__construct()
Constructor.
getDescription (line 535)
  • return: The item synopsis.
  • access: public
string getDescription ()
getLink (line 521)
  • return: The URL of the item.
  • access: public
string getLink ()
getTitle (line 507)
  • return: The title of the item.
  • access: public
string getTitle ()
setAuthor (line 625)
  • access: public
  • since: RSS 2.0
void setAuthor (string $author)
  • string $author: Email address of the author of the item.
setCategory (line 600)

Includes the item in one or more categories.

  • access: public
  • since: RSS 0.92
void setCategory (string $category, string $domain)
  • string $category: A forward-slash-separated string that identifies a hierarchic location in the indicated taxonomy.
  • string $domain
setComments (line 617)
  • access: public
  • since: RSS 2.0
void setComments (string $comments)
  • string $comments: URL of a page for comments relating to the item.
setDescription (line 542)
  • access: public
void setDescription (string $description)
  • string $description: The item synopsis.
setEnclosure (line 578)

Describes a media object that is attached to the item.

  • access: public
  • since: RSS 0.92
void setEnclosure (string $url, int $length, string $type)
  • string $url: Where the enclosure is located.
  • int $length: Size in bytes.
  • string $type: MIME type
setGuid (line 646)

guid stands for globally unique identifier. It's a string that uniquely identifies the item. When present, an aggregator may choose to use this string to determine if an item is new.

  • access: public
  • since: RSS 2.0
void setGuid (string $guid, [bool $isPermaLink = true])
  • string $guid: A string that uniquely identifies the item.
  • bool $isPermaLink: If its value is false, the guid may not be assumed to be a url, or a url to anything in particular.
setLink (line 528)
  • access: public
void setLink (string $link)
  • string $link: The URL of the item.
setPublicationDate (line 633)
  • access: public
  • since: RSS 2.0
void setPublicationDate (string $pubDate)
  • string $pubDate: Indicates when the item was published.
setSource (line 557)

The RSS channel that the item came from. The purpose of this property is to propagate credit for links, to publicize the sources of news items. It can be used in the Post command of an aggregator. It should be generated automatically when forwarding an item from an aggregator to a weblog authoring tool.

  • access: public
  • since: RSS 0.92
void setSource (string $source, string $url)
  • string $source: Name of source
  • string $url: Link back to source
setTitle (line 514)
  • access: public
void setTitle (string $title)
  • string $title: The title of the item.

Inherited Methods

Inherited From TXmlElement

TXmlElement::__construct()
TXmlElement::getAttribute()
TXmlElement::getAttributes()
TXmlElement::getElementByTagName()
TXmlElement::getElements()
TXmlElement::getElementsByTagName()
TXmlElement::getHasAttribute()
TXmlElement::getHasElement()
TXmlElement::getParent()
TXmlElement::getTagName()
TXmlElement::getValue()
TXmlElement::setAttribute()
TXmlElement::setParent()
TXmlElement::setTagName()
TXmlElement::setValue()
TXmlElement::toString()

Inherited From TComponent

TComponent::addParsedObject()
TComponent::attachEventHandler()
TComponent::canGetProperty()
TComponent::canSetProperty()
TComponent::createdOnTemplate()
TComponent::detachEventHandler()
TComponent::evaluateExpression()
TComponent::evaluateStatements()
TComponent::getEventHandlers()
TComponent::getSubProperty()
TComponent::hasEvent()
TComponent::hasEventHandler()
TComponent::hasProperty()
TComponent::raiseEvent()
TComponent::setSubProperty()
TComponent::__get()
TComponent::__set()

Documentation generated on Sun, 14 Jan 2007 21:44:12 -0500 by phpDocumentor 1.3.0RC4