Dolibarr\Code\KnowledgeManagement\Classes\ModeleNumRefKnowledgeRecord

Complexity

Total Complexity

6

Size/Duplication

Total Lines	73
Duplicated Lines	0 %

Importance

Changes

0

6 Methods

Rating	Name	Duplication	Size	Complexity
A	getNextValue()	0	4	1
A	isEnabled()	0	3	1
A	info()	0	5	1
A	canBeActivated()	0	3	1
A	getVersion()	0	3	1
A	getExample()	0	5	1

<?php

/* Copyright (C) 2003-2004  Rodolphe Quiedeville        <rodolphe@quiedeville.org>
 * Copyright (C) 2004-2011  Laurent Destailleur         <eldy@users.sourceforge.net>
 * Copyright (C) 2004       Eric Seigne                 <eric.seigne@ryxeo.com>
 * Copyright (C) 2005-2012  Regis Houssin               <regis.houssin@inodbox.com>
 * Copyright (C) 2006       Andre Cianfarani            <acianfa@free.fr>
 * Copyright (C) 2012       Juanjo Menent	            <jmenent@2byte.es>
 * Copyright (C) 2014       Marcos García               <marcosgdf@gmail.com>
 * Copyright (C) 2024       Rafael San José             <rsanjose@alxarafe.com>
 *
 * 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 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 General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program. If not, see <https://www.gnu.org/licenses/>.
 * or see https://www.gnu.org/
 */

namespace Dolibarr\Code\KnowledgeManagement\Classes;

/**
 *  \file           htdocs/knowledgemanagement/core/modules/knowledgemanagement/modules_knowledgerecord.php
 *  \ingroup        knowledgemanagement
 *  \brief          File that contains parent class for knowledgerecords document models and parent class for knowledgerecords numbering models
 */

/**
 *  Parent class to manage numbering of KnowledgeRecord
 */
abstract class ModeleNumRefKnowledgeRecord
{
    /**
     * @var string Error code (or message)
     */
    public $error = '';

    /**
     *  Return if a module can be used or not
     *
     * @return     boolean     true if module can be used
     */
    public function isEnabled()
    {
        return true;
    }

    /**
     *  Returns the default description of the numbering template
     *
     * @return     string      Descriptive text
     */
    public function info()
    {
        global $langs;
        $langs->load("knowledgemanagement");
        return $langs->trans("NoDescription");
    }

    /**
     *  Returns an example of numbering
     *
     * @return     string      Example
     */
    public function getExample()
    {
        global $langs;
        $langs->load("knowledgemanagement");
        return $langs->trans("NoExample");
    }

    /**
     *  Checks if the numbers already in the database do not
     *  cause conflicts that would prevent this numbering working.
     *
     * @param Object $object Object we need next value for
     * @return boolean                 false if conflict, true if ok
     */
    public function canBeActivated($object)
    {
        return true;
    }

    /**
     *  Returns next assigned value
     *
     * @param Object $object Object we need next value for
     * @return string      Valeur
     */
    public function getNextValue($object)
    {
        global $langs;
        return $langs->trans("NotAvailable");
    }

    /**
     *  Returns version of numbering module
     *
     * @return     string      Valeur
     */
    public function getVersion()
    {
        return DOL_VERSION;
    }
}