Search

Projects

Classes

Methods

⇦ Back to Joomla project (class list)

Class OpensearchDocument - list of methods

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

Extends

Document
Package: Joomla\CMS\Document
Copyright: (C) 2011 Open Source Matters, Inc.
License: GNU General Public License version 2 or later; see LICENSE.txt
Located at: Joomla/Document/OpensearchDocument.php
Project: Joomla

Method Summary

public
__construct
(mixed $options = array())

Class constructor
Parameters
  • array $options Associative array of options
Since
  • 1.7.0
Show source code of this method: __construct Source Code

public string
(mixed $cache = false, mixed $params = array())

Render the document
Parameters
  • bool $cache If true, cache the output
  • array $params Associative array of attributes
Returns
  • string The rendered data
Since
  • 1.7.0
Show source code of this method: render Source Code

public \Joomla\CMS\Document\OpensearchDocument
(mixed $name)

Sets the short name
Parameters
  • string $name The name.
Returns
  • \Joomla\CMS\Document\OpensearchDocument instance of $this to allow chaining
Since
  • 1.7.0
Show source code of this method: setShortName Source Code

public \Joomla\CMS\Document\OpensearchDocument
(\Joomla\CMS\Document\Opensearch\OpensearchUrl $url)

Adds a URL to the Opensearch description.
Parameters
  • \Joomla\CMS\Document\Opensearch\OpensearchUrl $url The url to add to the description.
Returns
  • \Joomla\CMS\Document\OpensearchDocument instance of $this to allow chaining
Since
  • 1.7.0
Show source code of this method: addUrl Source Code

public \Joomla\CMS\Document\OpensearchDocument
(\Joomla\CMS\Document\Opensearch\OpensearchImage $image)

Adds an image to the Opensearch description.
Parameters
  • \Joomla\CMS\Document\Opensearch\OpensearchImage $image The image to add to the description.
Returns
  • \Joomla\CMS\Document\OpensearchDocument instance of $this to allow chaining
Since
  • 1.7.0
Show source code of this method: addImage Source Code

Properties Summary

private string
$_shortName
ShortName element
Since
  • 1.7.0
private object
$_images
Images collection
Since
  • 1.7.0
private array
$_urls
The url collection
Since
  • 1.7.0

Tags Summary

Since
1.7.0