Introduce a document aware interface (#40662)

* Introduce a document aware interface

* cs

---------

Author: laoneo

administrator/components/com_associations/src/View/Association/HtmlView.php

@@ -318,7 +318,7 @@ public function display($tpl = null): void
              * Let's put the target src into a variable to use in the javascript code
              * to avoid race conditions when the reference iframe loads.
              */
-            $this->document->addScriptOptions('targetSrc', Route::_($this->editUri . '&task=' . $task . '&id=' . (int) $this->targetId));
+            $this->getDocument()->addScriptOptions('targetSrc', Route::_($this->editUri . '&task=' . $task . '&id=' . (int) $this->targetId));
             $this->form->setValue('itemlanguage', '', $this->targetLanguage . ':' . $this->targetId . ':' . $this->targetAction);
         }
 

administrator/components/com_banners/src/View/Tracks/RawView.php

@@ -53,7 +53,7 @@ public function display($tpl = null): void
             throw new GenericDataException(implode("\n", $errors), 500);
         }
 
-        $this->document->setMimeEncoding($mimeType);
+        $this->getDocument()->setMimeEncoding($mimeType);
 
         /** @var CMSApplication $app */
         $app = Factory::getApplication();

administrator/components/com_categories/src/View/Categories/HtmlView.php

@@ -188,7 +188,7 @@ protected function addToolbar()
 
         // Load specific css component
         /** @var \Joomla\CMS\WebAsset\WebAssetManager $wa */
-        $wa = $this->document->getWebAssetManager();
+        $wa = $this->getDocument()->getWebAssetManager();
         $wa->getRegistry()->addExtensionRegistryFile($component);
 
         if ($wa->assetExists('style', $component . '.admin-categories')) {

administrator/components/com_categories/src/View/Category/HtmlView.php

@@ -173,7 +173,7 @@ protected function addToolbar()
 
         // Load specific css component
         /** @var \Joomla\CMS\WebAsset\WebAssetManager $wa */
-        $wa = $this->document->getWebAssetManager();
+        $wa = $this->getDocument()->getWebAssetManager();
         $wa->getRegistry()->addExtensionRegistryFile($component);
 
         if ($wa->assetExists('style', $component . '.admin-categories')) {

administrator/components/com_privacy/src/View/Export/XmlView.php

@@ -53,8 +53,8 @@ public function display($tpl = null)
         $requestId = $model->getState($model->getName() . '.request_id');
 
         // This document should always be downloaded
-        $this->document->setDownload(true);
-        $this->document->setName('export-request-' . $requestId);
+        $this->getDocument()->setDownload(true);
+        $this->getDocument()->setName('export-request-' . $requestId);
 
         echo PrivacyHelper::renderDataAsXml($exportData);
     }

api/components/com_config/src/View/Application/JsonapiView.php

@@ -60,7 +60,7 @@ public function displayList(array $items = null)
 
         $items = array_splice($items, $offset, $limit);
 
-        $this->document->addMeta('total-pages', $totalPagesAvailable)
+        $this->getDocument()->addMeta('total-pages', $totalPagesAvailable)
             ->addLink('self', (string) $currentUrl);
 
         // Check for first and previous pages
@@ -76,7 +76,7 @@ public function displayList(array $items = null)
             $previousPageQuery['offset'] = $previousOffset >= 0 ? $previousOffset : 0;
             $previousPage->setVar('page', $previousPageQuery);
 
-            $this->document->addLink('first', $this->queryEncode((string) $firstPage))
+            $this->getDocument()->addLink('first', $this->queryEncode((string) $firstPage))
                 ->addLink('previous', $this->queryEncode((string) $previousPage));
         }
 
@@ -93,16 +93,16 @@ public function displayList(array $items = null)
             $lastPageQuery['offset'] = ($totalPagesAvailable - 1) * $limit;
             $lastPage->setVar('page', $lastPageQuery);
 
-            $this->document->addLink('next', $this->queryEncode((string) $nextPage))
+            $this->getDocument()->addLink('next', $this->queryEncode((string) $nextPage))
                 ->addLink('last', $this->queryEncode((string) $lastPage));
         }
 
         $collection = (new Collection($items, new JoomlaSerializer($this->type)));
 
         // Set the data into the document and render it
-        $this->document->setData($collection);
+        $this->getDocument()->setData($collection);
 
-        return $this->document->render();
+        return $this->getDocument()->render();
     }
 
     /**

api/components/com_config/src/View/Component/JsonapiView.php

@@ -72,7 +72,7 @@ public function displayList(array $items = null)
 
         $items = array_splice($items, $offset, $limit);
 
-        $this->document->addMeta('total-pages', $totalPagesAvailable)
+        $this->getDocument()->addMeta('total-pages', $totalPagesAvailable)
             ->addLink('self', (string) $currentUrl);
 
         // Check for first and previous pages
@@ -88,7 +88,7 @@ public function displayList(array $items = null)
             $previousPageQuery['offset'] = $previousOffset >= 0 ? $previousOffset : 0;
             $previousPage->setVar('page', $previousPageQuery);
 
-            $this->document->addLink('first', $this->queryEncode((string) $firstPage))
+            $this->getDocument()->addLink('first', $this->queryEncode((string) $firstPage))
                 ->addLink('previous', $this->queryEncode((string) $previousPage));
         }
 
@@ -105,16 +105,16 @@ public function displayList(array $items = null)
             $lastPageQuery['offset'] = ($totalPagesAvailable - 1) * $limit;
             $lastPage->setVar('page', $lastPageQuery);
 
-            $this->document->addLink('next', $this->queryEncode((string) $nextPage))
+            $this->getDocument()->addLink('next', $this->queryEncode((string) $nextPage))
                 ->addLink('last', $this->queryEncode((string) $lastPage));
         }
 
         $collection = (new Collection($items, new JoomlaSerializer($this->type)));
 
         // Set the data into the document and render it
-        $this->document->setData($collection);
+        $this->getDocument()->setData($collection);
 
-        return $this->document->render();
+        return $this->getDocument()->render();
     }
 
     /**

api/components/com_languages/src/View/Strings/JsonapiView.php

@@ -77,9 +77,9 @@ public function displayList(array $items = null)
             ->fields([$this->type => $this->fieldsToRenderList]);
 
         // Set the data into the document and render it
-        $this->document->setData($collection);
+        $this->getDocument()->setData($collection);
 
-        return $this->document->render();
+        return $this->getDocument()->render();
     }
 
     /**

api/components/com_menus/src/View/Items/JsonapiView.php

@@ -178,15 +178,15 @@ public function displayListTypes()
         $collection = (new Collection($items, new JoomlaSerializer('menutypes')));
 
         // Set the data into the document and render it
-        $this->document->addMeta('total-pages', $totalPagesAvailable)
+        $this->getDocument()->addMeta('total-pages', $totalPagesAvailable)
             ->setData($collection)
             ->addLink('self', (string) $currentUrl)
             ->addLink('first', (string) $firstPage)
             ->addLink('next', (string) $nextPage)
             ->addLink('previous', (string) $previousPage)
             ->addLink('last', (string) $lastPage);
 
-        return $this->document->render();
+        return $this->getDocument()->render();
     }
 
     /**

api/components/com_privacy/src/View/Consents/JsonapiView.php

@@ -112,9 +112,9 @@ public function displayItem($item = null)
         $element    = (new Resource($displayItem, $serializer))
             ->fields([$this->type => $this->fieldsToRenderItem]);
 
-        $this->document->setData($element);
-        $this->document->addLink('self', Uri::current());
+        $this->getDocument()->setData($element);
+        $this->getDocument()->addLink('self', Uri::current());
 
-        return $this->document->render();
+        return $this->getDocument()->render();
     }
 }