Joomla CMS  3.10.11 (avec JPlatform 13.1 inclus)
Documentation des API du CMS Joomla en version 3.10.11 et du framework Joomla Platform intégré
Tout Structures de données Espaces de nommage Fichiers Fonctions Variables Pages
Référence de la classe OpensearchDocument
+ Graphe d'héritage de OpensearchDocument:

Fonctions membres publiques

 __construct ($options=array())
 
 render ($cache=false, $params=array())
 
 setShortName ($name)
 
 addUrl (OpensearchUrl $url)
 
 addImage (OpensearchImage $image)
 
- Fonctions membres publiques hérités de Document
 __construct ($options=array())
 
 setType ($type)
 
 getType ()
 
 getBuffer ()
 
 setBuffer ($content, $options=array())
 
 getMetaData ($name, $attribute='name')
 
 setMetaData ($name, $content, $attribute='name')
 
 addScript ($url, $options=array(), $attribs=array())
 
 addScriptVersion ($url, $options=array(), $attribs=array())
 
 addScriptDeclaration ($content, $type='text/javascript')
 
 addScriptOptions ($key, $options, $merge=true)
 
 getScriptOptions ($key=null)
 
 addStyleSheet ($url, $options=array(), $attribs=array())
 
 addStyleSheetVersion ($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 ()
 
 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())
 

Attributs privés

 $_shortName = ''
 
 $_images = array()
 
 $_urls = array()
 

Membres hérités additionnels

- Fonctions membres publiques statiques hérités de Document
static getInstance ($type='html', $attributes=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
 
- Attributs publics statiques hérités de Document
static $_buffer = null
 
- Attributs protégés hérités de Document
 $scriptOptions = array()
 
 $mediaVersion = null
 
- Attributs protégés statiques hérités de Document
static $instances = array()
 

Description détaillée

Opensearch class, provides an easy interface to display an Opensearch document

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 $app, $options, $path, Uri\base(), Uri\getInstance(), JPATH_BASE, et JPATH_THEMES.

Documentation des fonctions membres

◆ addImage()

addImage ( OpensearchImage  $image)

Adds an image to the Opensearch description.

Paramètres
OpensearchImage$imageThe image to add to the description.
Renvoie
OpensearchDocument instance of $this to allow chaining
Depuis
1.7.0

Références $image.

◆ addUrl()

addUrl ( OpensearchUrl  $url)

Adds a URL to the Opensearch description.

Paramètres
OpensearchUrl$urlThe url to add to the description.
Renvoie
OpensearchDocument instance of $this to allow chaining
Depuis
1.7.0

Références $url.

◆ 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

Références $image, $params, $url, description, htmlspecialchars, et JDEBUG.

◆ setShortName()

setShortName (   $name)

Sets the short name

Paramètres
string$nameThe name.
Renvoie
OpensearchDocument instance of $this to allow chaining
Depuis
1.7.0

Références $name.

Documentation des champs

◆ $_images

$_images = array()
private

◆ $_shortName

$_shortName = ''
private

◆ $_urls

$_urls = array()
private

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