Joomla CMS  4.2.2
Documentation des API du CMS Joomla en version 4.2.2
Référence de la classe FeedDocument
+ Graphe d'héritage de FeedDocument:

Fonctions membres publiques

 __construct ($options=array())
 
 render ($cache=false, $params=array())
 
 addItem (FeedItem $item)
 
- Fonctions membres publiques hérités de Document
 __construct ($options=array())
 
 setFactory (FactoryInterface $factory)
 
 setType ($type)
 
 getType ()
 
 getBuffer ()
 
 setBuffer ($content, $options=array())
 
 getMetaData ($name, $attribute='name')
 
 setMetaData ($name, $content, $attribute='name')
 
 addScript ($url, $options=array(), $attribs=array())
 
 addScriptDeclaration ($content, $type='text/javascript')
 
 addScriptOptions ($key, $options, $merge=true)
 
 getScriptOptions ($key=null)
 
 addStyleSheet ($url, $options=array(), $attribs=array())
 
 addStyleDeclaration ($content, $type='text/css')
 
 setCharset ($type='utf-8')
 
 getCharset ()
 
 setLanguage ($lang='en-gb')
 
 getLanguage ()
 
 setDirection ($dir='ltr')
 
 getDirection ()
 
 setTitle ($title)
 
 getTitle ()
 
 setMediaVersion ($mediaVersion)
 
 getMediaVersion ()
 
 setPreloadManager (PreloadManagerInterface $preloadManager)
 
 getPreloadManager ()
 
 setWebAssetManager (WebAssetManager $webAsset)
 
 getWebAssetManager ()
 
 setBase ($base)
 
 getBase ()
 
 setDescription ($description)
 
 getDescription ()
 
 setLink ($url)
 
 getLink ()
 
 setGenerator ($generator)
 
 getGenerator ()
 
 setModifiedDate ($date)
 
 getModifiedDate ()
 
 setMimeEncoding ($type='text/html', $sync=true)
 
 getMimeEncoding ()
 
 setLineEnd ($style)
 
 _getLineEnd ()
 
 setTab ($string)
 
 _getTab ()
 
 loadRenderer ($type)
 
 parse ($params=array())
 
 render ($cache=false, $params=array())
 

Champs de données

 $syndicationURL = ''
 
 $image = null
 
 $copyright = ''
 
 $pubDate = ''
 
 $lastBuildDate
 
 $editor = ''
 
 $docs = ''
 
 $editorEmail = ''
 
 $webmaster = ''
 
 $category = ''
 
 $ttl = ''
 
 $rating = ''
 
 $skipHours = ''
 
 $skipDays = ''
 
 $items = array()
 
- Champs de données hérités de Document
 $title = ''
 
 $description = ''
 
 $link = ''
 
 $base = ''
 
 $language = 'en-gb'
 
 $direction = 'ltr'
 
 $_generator = 'Joomla! - Open Source Content Management'
 
 $_mdate = ''
 
 $_tab = "\11"
 
 $_lineEnd = "\12"
 
 $_charset = 'utf-8'
 
 $_mime = ''
 
 $_namespace = ''
 
 $_profile = ''
 
 $_scripts = array()
 
 $_script = array()
 
 $_styleSheets = array()
 
 $_style = array()
 
 $_metaTags = array()
 
 $_engine = null
 
 $_type = null
 

Membres hérités additionnels

- Fonctions membres publiques statiques hérités de Document
static getInstance ($type='html', $attributes=array())
 
- Attributs publics statiques hérités de Document
static $_buffer = null
 
- Fonctions membres protégées hérités de Document
 preloadAssets ()
 
- Attributs protégés hérités de Document
 $scriptOptions = array()
 
 $mediaVersion = null
 
 $factory
 
 $preloadManager = null
 
 $preloadTypes = ['preload', 'dns-prefetch', 'preconnect', 'prefetch', 'prerender']
 
 $webAssetManager = null
 
- Attributs protégés statiques hérités de Document
static $instances = array()
 

Description détaillée

FeedDocument class, provides an easy interface to parse and display any feed document

Depuis
1.7.0

Documentation des constructeurs et destructeur

◆ __construct()

__construct (   $options = array())

Class constructor

Paramètres
array$optionsAssociative array of options
Depuis
1.7.0

Références $options, et Symfony\Contracts\Service\__construct().

Documentation des fonctions membres

◆ addItem()

addItem ( FeedItem  $item)

Adds a FeedItem to the feed.

Paramètres
FeedItem$itemThe feeditem to add to the feed.
Renvoie
FeedDocument instance of $this to allow chaining
Depuis
1.7.0

Références $item, Document\$link, $this, et items.

◆ render()

render (   $cache = false,
  $params = array() 
)

Render the document

Paramètres
boolean$cacheIf true, cache the output
array$paramsAssociative array of attributes
Renvoie
string The rendered data
Depuis
1.7.0
Exceptions

Références $attr, $data, $params, $renderer, $type, Text\_(), Document\getGenerator(), Document\loadRenderer(), et Document\setMimeEncoding().

Documentation des champs

◆ $category

$category = ''

◆ $copyright

$copyright = ''

◆ $docs

$docs = ''

◆ $editor

$editor = ''

◆ $editorEmail

$editorEmail = ''

◆ $image

$image = null

◆ $items

$items = array()

◆ $lastBuildDate

$lastBuildDate

◆ $pubDate

$pubDate = ''

◆ $rating

$rating = ''

◆ $skipDays

$skipDays = ''

◆ $skipHours

$skipHours = ''

◆ $syndicationURL

$syndicationURL = ''

◆ $ttl

$ttl = ''

◆ $webmaster

$webmaster = ''

La documentation de cette classe a été générée à partir du fichier suivant :