App\Entity\LogSystem\CollectionElementDeleted

Complexity

Total Complexity

13

Size/Duplication

Total Lines	100
Duplicated Lines	0 %

Importance

Changes	1
Bugs	0	Features	0

9 Methods

Rating	Name	Duplication	Size	Complexity
A	getDeletedElementID()	0	3	1
A	getUndoMode()	0	7	2
A	setUndoneEvent()	0	13	3
A	getUndoEventID()	0	3	1
A	getDeletedElementClass()	0	3	1
A	__construct()	0	11	2
A	isUndoEvent()	0	3	1
A	getOldName()	0	3	1
A	getCollectionName()	0	3	1

<?php
/**
 * This file is part of Part-DB (https://github.com/Part-DB/Part-DB-symfony).
 *
 * Copyright (C) 2019 - 2020 Jan Böhmer (https://github.com/jbtronics)
 *
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Affero General Public License as published
 * by the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU Affero General Public License for more details.
 *
 * You should have received a copy of the GNU Affero General Public License
 * along with this program.  If not, see <https://www.gnu.org/licenses/>.
 */

namespace App\Entity\LogSystem;


use App\Entity\Base\AbstractDBElement;
use App\Entity\Contracts\LogWithEventUndoInterface;
use App\Entity\Contracts\NamedElementInterface;
use Doctrine\ORM\Mapping as ORM;

/**
 * @ORM\Entity()
 * This log entry is created when an element is deleted, that is used in a collection of an other entity.
 * This is needed to signal time travel, that it has to undelete the deleted entity.
 */
class CollectionElementDeleted extends AbstractLogEntry implements LogWithEventUndoInterface
{
    protected $typeString = 'collection_element_deleted';
    protected $level = self::LEVEL_INFO;

    public function __construct(AbstractDBElement $changed_element, string $collection_name, AbstractDBElement $deletedElement)
    {
        parent::__construct();

        $this->level = self::LEVEL_INFO;
        $this->setTargetElement($changed_element);
        $this->extra['n'] = $collection_name;
        $this->extra['c'] = self::targetTypeClassToID(get_class($deletedElement));
        $this->extra['i'] = $deletedElement->getID();
        if ($deletedElement instanceof NamedElementInterface) {
            $this->extra['o'] = $deletedElement->getName();
        }
    }

    /**
     * Get the name of the collection (on target element) that was changed.
     * @return string
     */
    public function getCollectionName(): string
    {
        return $this->extra['n'];
    }

    /**
     * Gets the name of the element that was deleted.
     * Return null, if the element did not have a name.
     * @return string|null
     */
    public function getOldName(): ?string
    {
        return $this->extra['o'] ?? null;
    }

    /**
     * Returns the class of the deleted element.
     * @return string
     */
    public function getDeletedElementClass(): string
    {
        return self::targetTypeIdToClass($this->extra['c']);
    }

    /**
     * Returns the ID of the deleted element.
     * @return int
     */
    public function getDeletedElementID(): int
    {
        return $this->extra['i'];
    }

    /**
     * @inheritDoc
     */
    public function isUndoEvent(): bool
    {
        return isset($this->extra['u']);
    }

    /**
     * @inheritDoc
     */
    public function getUndoEventID(): ?int
    {
        return $this->extra['u'] ?? null;
    }

    /**
     * @inheritDoc
     */
    public function setUndoneEvent(AbstractLogEntry $event, string $mode = 'undo'): LogWithEventUndoInterface
    {
        $this->extra['u'] = $event->getID();

        if ($mode === 'undo') {
            $this->extra['um'] = 1;
        } elseif ($mode === 'revert') {
            $this->extra['um'] = 2;
        } else {
            throw new \InvalidArgumentException('Passed invalid $mode!');
        }

        return $this;
    }

    /**
     * @inheritDoc
     */
    public function getUndoMode(): string
    {
        $mode_int = $this->extra['um'] ?? 1;
        if ($mode_int === 1) {
            return 'undo';
        } else {
            return 'revert';
        }
    }
}