Part-DB.Part-DB-server/src/Entity/LogSystem/ElementEditedLogEntry.php

<?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/>.
 */

declare(strict_types=1);

/**
 * 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 General Public License
 * as published by the Free Software Foundation; either version 2
 * 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 General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA
 */

namespace App\Entity\LogSystem;

use App\Entity\Base\AbstractDBElement;
use App\Entity\Contracts\LogWithCommentInterface;
use App\Entity\Contracts\TimeTravelInterface;
use Doctrine\ORM\Mapping as ORM;

/**
 * @ORM\Entity()
 */
class ElementEditedLogEntry extends AbstractLogEntry implements TimeTravelInterface, LogWithCommentInterface
{
    protected $typeString = 'element_edited';

    public function __construct(AbstractDBElement $changed_element)
    {
        parent::__construct();
        $this->level = self::LEVEL_INFO;

        $this->setTargetElement($changed_element);
    }

    /**
     * Checks if this log contains infos about which fields has changed.
     * @return bool
     */
    public function hasChangedFieldsInfo(): bool
    {
        return isset($this->extra['f']) || $this->hasOldDataInformations();
    }

    /**
     * Return the names of all fields that were changed during the change.
     * @return string[]
     */
    public function getChangedFields(): array
    {
        if ($this->hasOldDataInformations()) {
            return array_keys($this->getOldData());
        }

        if (isset($this->extra['f'])) {
            return $this->extra['f'];
        }

        return [];
    }

    /**
     * Set the fields that were changed during this element change.
     * @param  string[]  $changed_fields The names of the fields that were changed during the elements
     * @return $this
     */
    public function setChangedFields(array $changed_fields): self
    {
        $this->extra['f'] = $changed_fields;
        return $this;
    }

    /**
     * Sets the old data for this entry.
     * @param array $old_data
     * @return $this
     */
    public function setOldData(array $old_data): self
    {
        $this->extra['d'] = $old_data;
        return $this;
    }

    /**
     * @inheritDoc
     */
    public function hasOldDataInformations(): bool
    {
        return !empty($this->extra['d']);
    }

    /**
     * @inheritDoc
     */
    public function getOldData(): array
    {
        return $this->extra['d'] ?? [];
    }

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

    /**
     * @inheritDoc
     */
    public function getComment(): ?string
    {
        return $this->extra['m'] ?? null;
    }

    /**
     * @inheritDoc
     */
    public function setComment(?string $new_comment): LogWithCommentInterface
    {
        $this->extra['m'] = $new_comment;
        return $this;
    }
}