kitodo / kitodo-publication

Classes/Services/Document/EditingLockService.php

<?php
namespace EWW\Dpf\Services\Document;

/*
 * This file is part of the TYPO3 CMS project.
 *
 * It is free software; you can redistribute it and/or modify it under
 * the terms of the GNU General Public License, either version 2
 * of the License, or any later version.
 *
 * For the full copyright and license information, please read the
 * LICENSE.txt file that was distributed with this source code.
 *
 * The TYPO3 project - inspiring people to share!
 */

use EWW\Dpf\Domain\Model\EditingLock;

class EditingLockService
{
    /**
     * editingLockRepository
     *
     * @var \EWW\Dpf\Domain\Repository\EditingLockRepository
     * @TYPO3\CMS\Extbase\Annotation\Inject
     */
    protected $editingLockRepository = null;

    /**
     * persistence manager
     *
     * @var \TYPO3\CMS\Extbase\Persistence\PersistenceManagerInterface
     * @TYPO3\CMS\Extbase\Annotation\Inject
     */
    protected $persistenceManager;

    /**
     * Locks editing for the given document identifier and all users except the given user.
     *
     * @param string $documentIdentifier
     * @param int $userUid
     * @return bool
     */
    public function lock($documentIdentifier, $userUid)
    {
        if ($this->editingLockRepository->findOneByDocumentIdentifier($documentIdentifier)) {

The method findOneByDocumentIdentifier() does not exist on EWW\Dpf\Domain\Repository\EditingLockRepository. Since you implemented __call, consider adding a @method annotation.

            return FALSE;
        }

        /** @var \EWW\Dpf\Domain\Model\EditingLock $editingLock */
        $editingLock = new EditingLock();
        $editingLock->setEditorUid($userUid);
        $editingLock->setDocumentIdentifier($documentIdentifier);

$documentIdentifier of type string is incompatible with the type integer expected by parameter $documentIdentifier of EWW\Dpf\Domain\Model\EditingLock::setDocumentIdentifier().

        $this->editingLockRepository->add($editingLock);
        $this->persistenceManager->persistAll();

        return TRUE;
    }

    /**
     * Unlocks editing for the given document identifier
     *
     * @param string $documentIdentifier
     * @throws \TYPO3\CMS\Extbase\Persistence\Exception\IllegalObjectTypeException
     */
    public function unlock($documentIdentifier)
    {
        /** @var \EWW\Dpf\Domain\Model\EditingLock $editingLock */
        $editingLock = $this->editingLockRepository->findOneByDocumentIdentifyer($documentIdentifier);

The method findOneByDocumentIdentifyer() does not exist on EWW\Dpf\Domain\Repository\EditingLockRepository. Since you implemented __call, consider adding a @method annotation.

        $this->editingLockRepository->remove($editingLock);
        $this->persistenceManager->persistAll();
    }

    /**
     * Checks if editing of the specified document (by its document identifier) is locked for the given user uid.
     *
     * @param string $documentIdentifier
     * @param int $userUid
     * @return bool
     */
    public function isLocked($documentIdentifier, $userUid)
    {
        $locks = $this->editingLockRepository->findByDocumentIdentifier($documentIdentifier);

The method findByDocumentIdentifier() does not exist on EWW\Dpf\Domain\Repository\EditingLockRepository. Since you implemented __call, consider adding a @method annotation.

        /** @var  \EWW\Dpf\Domain\Model\EditingLock $lock */
        foreach ($locks as $lock) {
            if ($lock->getEditorUid() != $userUid) {
                return TRUE;
            }
        }
        return FALSE;
    }

    /**
     * Unlocks all outdated editing locks.
     *
     * @param int $timeout : Time interval (in seconds) in which locks are not outdated, default is 1 hour.
     */
    public function unlockOutdatedLocks($timeout = 3600)
    {
        // Unlock outdated editing locks.
        $outdatedLocks = $this->editingLockRepository->findOutdatedLocks($timeout);
        foreach ($outdatedLocks as $outdatedLock) {
            $this->editingLockRepository->remove($outdatedLock);
        }
        $this->persistenceManager->persistAll();
    }

    /**
     * Unlocks all editing locks of the given user (editor uid).
     *
     * @param int $editorUid
     */
    public function unlockAllByEditor($editorUid)
    {
        $locks = $this->editingLockRepository->findByEditorUid($editorUid);

The method findByEditorUid() does not exist on EWW\Dpf\Domain\Repository\EditingLockRepository. Since you implemented __call, consider adding a @method annotation.

        foreach ($locks as $lock) {
            $this->editingLockRepository->remove($lock);
        }

        $this->persistenceManager->persistAll();
    }

    public function getLockedDocumentIdentifiersByUserUid($userUid)
    {
        $identifiers = array();

        $locks = $this->editingLockRepository->findByEditorUid($userUid);
        /** @var  \EWW\Dpf\Domain\Model\EditingLock $lock */
        foreach ($locks as $lock) {
            $identifiers[] = $lock->getDocumentIdentifier();
        }

        return $identifiers;
    }

}