<?php
/*
 * This file is part of Part-DB (https://github.com/Part-DB/Part-DB-symfony).
 *
 *  Copyright (C) 2019 - 2023 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);


namespace App\Entity\Parts;

/**
 * The values of this enums are used to describe how two parts are associated with each other.
 */
enum AssociationType: int
{
    /** A user definable association type, which can be described in the comment field */
    case OTHER = 0;
    /** The owning part is compatible with the other part  */
    case COMPATIBLE = 1;
    /** The owning part supersedes the other part (owner is newer version) */
    case SUPERSEDES = 2;

    /**
     * Returns the translation key for this association type.
     * @return string
     */
    public function getTranslationKey(): string
    {
        return 'part_association.type.' . strtolower($this->name);
    }
}
