[ Index ]
 

Code source de Mantis 1.1.0rc3

Accédez au Source d'autres logiciels libres

Classes | Fonctions | Variables | Constantes | Tables

title

Body

[fermer]

/core/ -> class.RSSBuilder.inc.php (sommaire)

(pas de description)

Poids: 1740 lignes (43 kb)
Inclus ou requis:0 fois
Référencé: 0 fois
Nécessite: 0 fichiers

Définit 3 classes

RSSBase:: (1 méthode):
  RSSBase()

RSSBuilder:: (50 méthodes):
  RSSBuilder()
  addDCdata()
  addSYdata()
  setEncoding()
  setAbout()
  setTitle()
  setDescription()
  setPublisher()
  setCreator()
  setDate()
  setLanguage()
  setRights()
  setCoverage()
  setContributor()
  setImageLink()
  setPeriod()
  setFrequency()
  setBase()
  setCategory()
  setCache()
  isValidLanguageCode()
  getEncoding()
  getAbout()
  getTitle()
  getDescription()
  getPublisher()
  getCreator()
  getDate()
  getLanguage()
  getRights()
  getCoverage()
  getContributor()
  getImageLink()
  getPeriod()
  getFrequency()
  getBase()
  getCategory()
  getCache()
  addItem()
  deleteItem()
  getItemList()
  getItems()
  getItem()
  createOutputV090()
  createOutputV091()
  createOutputV100()
  createOutputV200()
  createOutput()
  outputRSS()
  getRSSOutput()

RSSItem:: (19 méthodes):
  RSSItem()
  setAbout()
  setTitle()
  setLink()
  setDescription()
  setSubject()
  setDate()
  setAuthor()
  setComments()
  setImage()
  getAbout()
  getTitle()
  getLink()
  getDescription()
  getSubject()
  getDate()
  getAuthor()
  getComments()
  getImage()


Classe: RSSBase  - X-Ref

Abstract class for getting ini preferences

Tested with WAMP (XP-SP1/1.3.27/4.0.12/4.3.2)
Last change: 2003-06-26

RSSBase()   X-Ref
Constructor

return: void

Classe: RSSBuilder  - X-Ref

Class for creating a RSS file

Tested with WAMP (XP-SP1/1.3.27/4.0.12/4.3.2)
Last change: 2003-06-26

RSSBuilder($encoding = '',$about = '',$title = '',$description = '',$image_link = '',$category = '',$cache = '')   X-Ref
Constructor

param: string $encoding encoding of the xml file
param: string $about URL where the RSS document will be made available
param: string $title
param: string $description
param: string $image_link  URL

addDCdata($publisher = '',$creator = '',$date = '',$language = '',$rights = '',$coverage = '',$contributor = '')   X-Ref
add additional DC data

param: string $publisher person, an organization, or a service
param: string $creator person, an organization, or a service
param: string $date  format: 2003-05-29T00:03:07+0200
param: string $language  iso-format
param: string $rights  copyright information
param: string $coverage  spatial location (a place name or geographic coordinates), temporal period (a period label, date, or date range) or jurisdiction (such as a named administrative entity)
param: string $contributor  person, an organization, or a service

addSYdata($period = '', $frequency = '', $base = '')   X-Ref
add additional SY data

param: string $period  'hourly' | 'daily' | 'weekly' | 'monthly' | 'yearly'
param: int $frequency  every x hours/days/weeks/...
param: string $base  format: 2003-05-29T00:03:07+0200

setEncoding($encoding = '')   X-Ref
Sets $encoding variable

param: string $encoding  encoding of the xml file

setAbout($about = '')   X-Ref
Sets $about variable

param: string $about

setTitle($title = '')   X-Ref
Sets $title variable

param: string $title

setDescription($description = '')   X-Ref
Sets $description variable

param: string $description

setPublisher($publisher = '')   X-Ref
Sets $publisher variable

param: string $publisher

setCreator($creator = '')   X-Ref
Sets $creator variable

param: string $creator

setDate($date = '')   X-Ref
Sets $date variable

param: string $date  format: 2003-05-29T00:03:07+0200

setLanguage($language = '')   X-Ref
Sets $language variable

param: string $language

setRights($rights = '')   X-Ref
Sets $rights variable

param: string $rights

setCoverage($coverage = '')   X-Ref
Sets $coverage variable

param: string $coverage

setContributor($contributor = '')   X-Ref
Sets $contributor variable

param: string $contributor

setImageLink($image_link = '')   X-Ref
Sets $image_link variable

param: string $image_link

setPeriod($period = '')   X-Ref
Sets $period variable

param: string $period  'hourly' | 'daily' | 'weekly' | 'monthly' | 'yearly'

setFrequency($frequency = '')   X-Ref
Sets $frequency variable

param: int $frequency

setBase($base = '')   X-Ref
Sets $base variable

param: string $base

setCategory($category = '')   X-Ref
Sets $category variable

param: string $category

setCache($cache = '')   X-Ref
Sets $cache variable

param: int $cache

isValidLanguageCode($code = '')   X-Ref
Checks if a given string is a valid iso-language-code

param: string $code  String that should validated
return: boolean $isvalid  If string is valid or not

getEncoding()   X-Ref
Returns $encoding variable

return: string $encoding

getAbout()   X-Ref
Returns $about variable

return: string $about

getTitle()   X-Ref
Returns $title variable

return: string $title

getDescription()   X-Ref
Returns $description variable

return: string $description

getPublisher()   X-Ref
Returns $publisher variable

return: string $publisher

getCreator()   X-Ref
Returns $creator variable

return: string $creator

getDate()   X-Ref
Returns $date variable

return: string $date

getLanguage()   X-Ref
Returns $language variable

return: string $language

getRights()   X-Ref
Returns $rights variable

return: string $rights

getCoverage()   X-Ref
Returns $coverage variable

return: string $coverage

getContributor()   X-Ref
Returns $contributor variable

return: string $contributor

getImageLink()   X-Ref
Returns $image_link variable

return: string $image_link

getPeriod()   X-Ref
Returns $period variable

return: string $period

getFrequency()   X-Ref
Returns $frequency variable

return: string $frequency

getBase()   X-Ref
Returns $base variable

return: string $base

getCategory()   X-Ref
Returns $category variable

return: string $category

getCache()   X-Ref
Returns $cache variable

return: int $cache

addItem($about = '',$title = '',$link = '',$description = '',$subject = '',$date = '',$author = '',$comments = '',$image = '')   X-Ref
Adds another rss item to the object

param: string $about  URL
param: string $title
param: string $link  URL
param: string $description (optional)
param: string $subject  some sort of category (optional dc value - only shows up if DC data has been set before)
param: string $date  format: 2003-05-29T00:03:07+0200 (optional dc value - only shows up if DC data has been set before)
param: string $author  some sort of category author of item
param: string $comments  url to comment page rss 2.0 value
param: string $image  optional mod_im value for dispaying a different pic for every item
return: void

deleteItem($id = -1)   X-Ref
Deletes a rss item from the array

param: int $id  id of the element in the $items array
return: boolean true if item was deleted

getItemList()   X-Ref
Returns an array with all the keys of the $items array

return: array array with all the keys of the $items array

getItems()   X-Ref
Returns the $items array

return: array $items

getItem($id = -1)   X-Ref
Returns a single rss item by ID

param: int $id  id of the element in the $items array
return: mixed RSSItem or FALSE

createOutputV090()   X-Ref
creates the output based on the 0.91 rss version


createOutputV091()   X-Ref
creates the output based on the 0.91 rss version


createOutputV100()   X-Ref
creates the output based on the 1.0 rss version


createOutputV200()   X-Ref
creates the output based on the 2.0 rss draft


createOutput($version = '')   X-Ref
creates the output


outputRSS($version = '')   X-Ref
echos the output

use this function if you want to directly output the rss stream

return: void

getRSSOutput($version = '')   X-Ref
returns the output

use this function if you want to have the output stream as a string (for example to write it in a cache file)


Classe: RSSItem  - X-Ref

single rss item object

Tested with WAMP (XP-SP1/1.3.27/4.0.12/4.3.2)
Last change: 2003-06-26

RSSItem($about = '',$title = '',$link = '',$description = '',$subject = '',$date = '',$author = '',$comments = '',$image = '')   X-Ref
Constructor

param: string $about  URL
param: string $title
param: string $link  URL
param: string $description (optional)
param: string $subject  some sort of category (optional)
param: string $date  format: 2003-05-29T00:03:07+0200 (optional)
param: string $author  some sort of category author of item
param: string $comments  url to comment page rss 2.0 value
param: string $image  optional mod_im value for dispaying a different pic for every item

setAbout($about = '')   X-Ref
Sets $about variable

param: string $about

setTitle($title = '')   X-Ref
Sets $title variable

param: string $title

setLink($link = '')   X-Ref
Sets $link variable

param: string $link

setDescription($description = '')   X-Ref
Sets $description variable

param: string $description

setSubject($subject = '')   X-Ref
Sets $subject variable

param: string $subject

setDate($date = '')   X-Ref
Sets $date variable

param: string $date

setAuthor($author = '')   X-Ref
Sets $author variable

param: string $author

setComments($comments = '')   X-Ref
Sets $comments variable

param: string $comments

setImage($image = '')   X-Ref
Sets $image variable

param: string $image

getAbout()   X-Ref
Returns $about variable

return: string $about

getTitle()   X-Ref
Returns $title variable

return: string $title

getLink()   X-Ref
Returns $link variable

return: string $link

getDescription()   X-Ref
Returns $description variable

return: string $description

getSubject()   X-Ref
Returns $subject variable

return: string $subject

getDate()   X-Ref
Returns $date variable

return: string $date

getAuthor()   X-Ref
Returns $author variable

return: string $author

getComments()   X-Ref
Returns $comments variable

return: string $comments

getImage()   X-Ref
Returns $image variable

return: string $image



Généré le : Thu Nov 29 09:42:17 2007 par Balluche grâce à PHPXref 0.7
  Clicky Web Analytics