Joomla! Platform 12.1

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

• see: http://www.opensearch.org/
• since: 11.1

Located in /libraries/joomla/document/opensearch/opensearch.php (line 22)

 JObject   (Subpackage Object)

 JDocument
   
    JDocumentOpensearch   (Subpackage Document)

Inherited Variables

Inherited from JDocument

JDocument::$base
JDocument::$description
JDocument::$direction
JDocument::$instances
JDocument::$language
JDocument::$link
JDocument::$title
JDocument::$_buffer
JDocument::$_charset
JDocument::$_engine
JDocument::$_generator
JDocument::$_lineEnd
JDocument::$_mdate
JDocument::$_metaTags
JDocument::$_mime
JDocument::$_namespace
JDocument::$_profile
JDocument::$_script
JDocument::$_scripts
JDocument::$_style
JDocument::$_styleSheets
JDocument::$_tab
JDocument::$_type

Inherited from JObject

JObject::$_errors

Constructor __construct (line 59)

Class constructor

• since: 11.1
• access: public

JDocumentOpensearch __construct ([array $options = array()])

• array $options: Associative array of options

---

Redefinition of:

JDocument::__construct()

Class constructor.

addImage (line 206)

Adds an image to the OpenSearch description.

• return: instance of $this to allow chaining
• since: 11.1
• access: public

JDocumentOpensearch addImage (JOpenSearchImage $image)

• JOpenSearchImage $image: The image to add to the description.

addUrl (line 190)

Adds an URL to the OpenSearch description.

• return: instance of $this to allow chaining
• since: 11.1
• access: public

JDocumentOpensearch addUrl (JOpenSearchUrl $url)

• JOpenSearchUrl $url: The url to add to the description.

render (line 112)

Render the document

• return: rendered data
• since: 11.1
• access: public

The render ([boolean $cache = false], [array $params = array()])

• boolean $cache: If true, cache the output
• array $params: Associative array of attributes

---

Redefinition of:

JDocument::render()

Outputs the document

setShortName (line 174)

Sets the short name

• return: instance of $this to allow chaining
• since: 11.1
• access: public

JDocumentOpensearch setShortName (string $name)

• string $name: The name.

Inherited Methods

Inherited From JDocument

JDocument::__construct()
JDocument::addScript()
JDocument::addScriptDeclaration()
JDocument::addStyleDeclaration()
JDocument::addStyleSheet()
JDocument::getBase()
JDocument::getBuffer()
JDocument::getCharset()
JDocument::getDescription()
JDocument::getDirection()
JDocument::getGenerator()
JDocument::getInstance()
JDocument::getLanguage()
JDocument::getLink()
JDocument::getMetaData()
JDocument::getMimeEncoding()
JDocument::getModifiedDate()
JDocument::getTitle()
JDocument::getType()
JDocument::loadRenderer()
JDocument::parse()
JDocument::render()
JDocument::setBase()
JDocument::setBuffer()
JDocument::setCharset()
JDocument::setDescription()
JDocument::setDirection()
JDocument::setGenerator()
JDocument::setLanguage()
JDocument::setLineEnd()
JDocument::setLink()
JDocument::setMetaData()
JDocument::setMimeEncoding()
JDocument::setModifiedDate()
JDocument::setTab()
JDocument::setTitle()
JDocument::setType()
JDocument::_getLineEnd()
JDocument::_getTab()

Inherited From JObject

JObject::__construct()
JObject::def()
JObject::get()
JObject::getError()
JObject::getErrors()
JObject::getProperties()
JObject::set()
JObject::setError()
JObject::setProperties()
JObject::__toString()