[ Index ]

PHP Cross Reference of Joomla 4.2.2 documentation

title

Body

[close]

/libraries/src/Document/ -> OpensearchDocument.php (summary)

Joomla! Content Management System

Copyright: (C) 2011 Open Source Matters, Inc.
License: GNU General Public License version 2 or later; see LICENSE.txt
File Size: 226 lines (6 kb)
Included or required:0 times
Referenced: 2 times
Includes or requires: 0 files

Defines 1 class

OpensearchDocument:: (5 methods):
  __construct()
  render()
  setShortName()
  addUrl()
  addImage()


Class: OpensearchDocument  - X-Ref

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

__construct($options = array()   X-Ref
Class constructor

param: array  $options  Associative array of options

render($cache = false, $params = array()   X-Ref
Render the document

param: boolean  $cache   If true, cache the output
param: array    $params  Associative array of attributes
return: string  The rendered data

setShortName($name)   X-Ref
Sets the short name

param: string  $name  The name.
return: OpensearchDocument instance of $this to allow chaining

addUrl(OpensearchUrl $url)   X-Ref
Adds a URL to the Opensearch description.

param: OpensearchUrl  $url  The url to add to the description.
return: OpensearchDocument instance of $this to allow chaining

addImage(OpensearchImage $image)   X-Ref
Adds an image to the Opensearch description.

param: OpensearchImage  $image  The image to add to the description.
return: OpensearchDocument instance of $this to allow chaining



Generated: Wed Sep 7 05:41:13 2022 Chilli.vc Blog - For Webmaster,Blog-Writer,System Admin and Domainer