Search

Projects

Classes

Methods

⇦ Back to Joomla project (class list)

Class XmlDocument - list of methods

XmlDocument class, provides an easy interface to parse and display XML output

Extends

Document
Package: Joomla\CMS\Document
Copyright: (C) 2008 Open Source Matters, Inc.
License: GNU General Public License version 2 or later; see LICENSE.txt
Located at: Joomla/Document/XmlDocument.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 string
()

Returns the document name
Returns
  • string
Since
  • 1.7.0
Show source code of this method: getName Source Code

public \Joomla\CMS\Document\XmlDocument
(mixed $name = 'joomla')

Sets the document name
Parameters
  • string $name Document name
Returns
  • \Joomla\CMS\Document\XmlDocument instance of $this to allow chaining
Since
  • 1.7.0
Show source code of this method: setName Source Code

public string
()

Check if this document is intended for download
Returns
  • string
Since
  • 3.9.0
Show source code of this method: isDownload Source Code

public \Joomla\CMS\Document\XmlDocument
(mixed $download = false)

Sets the document's download state
Parameters
  • bool $download If true, this document will be downloaded; if false, this document will be displayed inline
Returns
  • \Joomla\CMS\Document\XmlDocument instance of $this to allow chaining
Since
  • 3.9.0
Show source code of this method: setDownload Source Code

Properties Summary

protected string
$name
Document name
Since
  • 3.0.0
protected bool
$isDownload
Flag indicating the document should be downloaded (Content-Disposition = attachment) versus displayed inline
Since
  • 3.9.0

Tags Summary

Since
1.7.0