Joomla! API

Download
Launch

DocumentAwareTrait

Defines the trait for a document aware class.

since

4.4.0
package

Joomla CMS

Methods

getDocument

Get the Document.

getDocument() : \Joomla\CMS\Document\Document
since

4.4.0
throws

UnexpectedValueExceptionMay be thrown if the document has not been set.

Response

Document

setDocument

Set the document to use.

setDocument(\Joomla\CMS\Document\Document document) :
since

4.4.0

Arguments

document

DocumentThe document to use

Response

void

Properties

document

Document

since

4.4.0

Type(s)

Document
  • \ Joomla
  • \ CMS
  • \ Document
  • \ DocumentAwareTrait