Skip to content

[FEATURE] 5.0.6 subhh documentservice #14

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
chrizzor merged 6 commits into from
Dec 18, 2025
Merged

[FEATURE] 5.0.6 subhh documentservice #14

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
dc18b92
Introduce Document Service to load current Document only once for all…
marco-lengua Dec 8, 2025
6a83b9e
Extend comment for loadDocument method
marco-lengua Dec 8, 2025
c40b9bd
Merge branch '5.0.6_subhh' into 5.0.6_subhh_documentservice
marco-lengua Dec 11, 2025
b95fb47
test
marco-lengua Dec 12, 2025
df7bd99
working DocumentService
marco-lengua Dec 12, 2025
424b0fe
minor spacing issues and comments fixed
marco-lengua Dec 16, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
164 changes: 29 additions & 135 deletions Classes/Controller/AbstractController.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,10 +11,10 @@

namespace Kitodo\Dlf\Controller;

use Kitodo\Dlf\Common\AbstractDocument;
use Kitodo\Dlf\Common\Helper;
use Kitodo\Dlf\Domain\Model\Document;
use Kitodo\Dlf\Domain\Repository\DocumentRepository;
use Kitodo\Dlf\Service\DocumentService;
use Psr\Log\LoggerAwareInterface;
use Psr\Log\LoggerAwareTrait;
use TYPO3\CMS\Core\Configuration\ExtensionConfiguration;
Expand All @@ -26,6 +26,7 @@
use TYPO3\CMS\Core\Pagination\PaginatorInterface;
use TYPO3\CMS\Extbase\Mvc\Controller\ActionController;


/**
* Abstract controller class for most of the plugin controller.
*
Expand All @@ -40,24 +41,6 @@ abstract class AbstractController extends ActionController implements LoggerAwar
{
use LoggerAwareTrait;

/**
* @access protected
* @var DocumentRepository
*/
protected DocumentRepository $documentRepository;

/**
* @access public
*
* @param DocumentRepository $documentRepository
*
* @return void
*/
public function injectDocumentRepository(DocumentRepository $documentRepository): void
{
$this->documentRepository = $documentRepository;
}

/**
* @access protected
* @var Document|null This holds the current document
Expand Down Expand Up @@ -87,7 +70,30 @@ public function injectDocumentRepository(DocumentRepository $documentRepository)
* @var int
*/
protected int $pageUid;
/**
* @access protected
* @var DocumentRepository
*/
protected DocumentRepository $documentRepository;
/**
* @access protected
* @var DocumentService
*/
protected DocumentService $documentService;

public function __construct()
{
$this->initialize();
}

public function injectDocumentService(DocumentService $documentService)
{
$this->documentService = $documentService;
}
public function injectDocumentRepository(DocumentRepository $repo): void
{
$this->documentRepository = $repo;
}
/**
* Initialize the plugin controller
*
Expand All @@ -114,56 +120,16 @@ protected function initialize(): void
'requestData' => $this->requestData
];
}

/**
* Loads the current document into $this->document
* Load the current Document into Memory just once with Document Service - it will then be available for all controllers.
*
* @access protected
*
* @param int $documentId The document's UID (fallback: $this->requestData[id])
*
* @return void
*/
protected function loadDocument(int $documentId = 0): void
protected function loadDocument(): void
{
// Sanitize FlexForm settings to avoid later casting.
$this->sanitizeSettings();

// Get document ID from request data if not passed as parameter.
if ($documentId === 0 && !empty($this->requestData['id'])) {
$documentId = $this->requestData['id'];
}

// Try to get document format from database
if (!empty($documentId)) {

$doc = null;

if (MathUtility::canBeInterpretedAsInteger($documentId)) {
$doc = $this->getDocumentByUid($documentId);
} elseif (GeneralUtility::isValidUrl($documentId)) {
$doc = $this->getDocumentByUrl($documentId);
}

if ($this->document !== null && $doc !== null) {
$this->document->setCurrentDocument($doc);
}

} elseif (!empty($this->requestData['recordId'])) {

$this->document = $this->documentRepository->findOneByRecordId($this->requestData['recordId']);

if ($this->document !== null) {
$doc = AbstractDocument::getInstance($this->document->getLocation(), $this->settings, true);
if ($doc !== null) {
$this->document->setCurrentDocument($doc);
} else {
$this->logger->error('Failed to load document with record ID "' . $this->requestData['recordId'] . '"');
}
}
} else {
$this->logger->error('Invalid ID "' . $documentId . '" or PID "' . $this->settings['storagePid'] . '" for document loading');
}
$this->document = $this->documentService->getDocument($this->requestData['id'], $this->settings);
}

/**
Expand Down Expand Up @@ -368,18 +334,7 @@ protected function setDefaultPage(): void
$this->viewData['requestData'] = $this->requestData;
}

/**
* This is the constructor
*
* @access public
*
* @return void
*/
public function __construct()
{
$this->initialize();
}


/**
* build simple pagination
*
Expand Down Expand Up @@ -500,65 +455,4 @@ protected function buildSimplePagination(PaginationInterface $pagination, Pagina
'pagesR' => $pagesSect
];
}

/**
* Get document from repository by uid.
*
* @access private
*
* @param int $documentId The document's UID
*
* @return AbstractDocument
*/
private function getDocumentByUid(int $documentId)
{
$doc = null;
$this->document = $this->documentRepository->findOneByIdAndSettings($documentId);

if ($this->document) {
$doc = AbstractDocument::getInstance($this->document->getLocation(), $this->settings, false);
} else {
$this->logger->error('Invalid UID "' . $documentId . '" or PID "' . $this->settings['storagePid'] . '" for document loading');
}

return $doc;
}

/**
* Get document by URL.
*
* @access private
*
* @param string $documentId The document's URL
*
* @return AbstractDocument
*/
private function getDocumentByUrl(string $documentId)
{
$doc = AbstractDocument::getInstance($documentId, $this->settings, true);

if ($doc !== null) {
if ($doc->recordId) {
// find document from repository by recordId
$docFromRepository = $this->documentRepository->findOneByRecordId($doc->recordId);
if ($docFromRepository !== null) {
$this->document = $docFromRepository;
} else {
// create new dummy Document object
$this->document = GeneralUtility::makeInstance(Document::class);
}
}

// Make sure configuration PID is set when applicable
if ($doc->cPid == 0) {
$doc->cPid = max($this->settings['storagePid'], 0);
}

$this->document->setLocation($documentId);
} else {
$this->logger->error('Invalid location given "' . $documentId . '" for document loading');
}

return $doc;
}
}
Loading