Back to OpensearchDocument class

Method addImage

public \Joomla\CMS\Document\OpensearchDocument
addImage
(\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

Method addImage - Source code

/**
 * 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
 *
 * @since   1.7.0
 */
public function addImage(OpensearchImage $image)
{
    $this->_images[] = $image;
    return $this;
}