Docs For Class TRssFeedImage

Description

TRssFeedImage class

Specifies a GIF, JPEG or PNG image that can be displayed with the channel.

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 680)

TComponent
   |
   --TXmlElement
      |
      --TFeedElement
         |
         --TRssFeedImage

Method Summary

TRssFeedImage __construct ()

string getDescription ()

int getHeight ()

string getLink ()

string getTitle ()

string getUrl ()

int getWidth ()

void setDescription (string $description)

void setHeight (int $height)

void setLink (string $link)

void setTitle (string $title)

void setUrl (string $url)

void setWidth (int $width)

Methods

Constructor __construct (line 682)

access: public

TRssFeedImage __construct ()

Redefinition of:

TXmlElement::__construct(): Constructor.

getDescription (line 784)

return: A plain text description of the image.
access: public

string getDescription ()

getHeight (line 764)

return: Height of the image in pixels.
access: public

int getHeight ()

getLink (line 720)

return: The URL that a user is expected to click on.
access: public

string getLink ()

getTitle (line 689)

return: Title of the image.
access: public

string getTitle ()

getUrl (line 706)

return: URL of a GIF, JPEG or PNG image that represents the channel.
access: public

string getUrl ()

getWidth (line 744)

return: Width of the image in pixels.
access: public

int getWidth ()

setDescription (line 791)

access: public

void setDescription (string $description)

string $description: A plain text description of the image.

setHeight (line 773)

The value must be between 1 and 400. If ommitted, the default value is 31.

access: public

void setHeight (int $height)

int $height: Height of the image in pixels.

setLink (line 733)

The URL that a user is expected to click on, as opposed to a TRssFeedImage::setUrl that is for loading a resource, such as an image.

The link must start with either "http://" or "ftp://". All other urls are considered invalid.

access: public

void setLink (string $link)

string $link: The URL that a user is expected to click on.

setTitle (line 699)

Title describes the image, it's used in the ALT attribute of the HTML <img> tag when the channel is rendered in HTML.

access: public

void setTitle (string $title)

string $title: Title of the image.

setUrl (line 713)

access: public

void setUrl (string $url)

string $url: URL of a GIF, JPEG or PNG image that represents the channel.

setWidth (line 753)

The value must be between 1 and 144. If ommitted, the default value is 88.

access: public

void setWidth (int $width)

int $width: Width of the image in pixels.

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()