Dolibarr\Code\Stock\Classes\ModelePDFStock

Complexity

Total Complexity

1

Size/Duplication

Total Lines	47
Duplicated Lines	0 %

Importance

Changes

0

1 Method

Rating	Name	Duplication	Size	Complexity
A	liste_modeles()	0	10	1

<?php

/* Copyright (C) 2018       Laurent Destailleur         <eldy@users.sourceforge.net>
 * 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\Stock\Classes;

use Dolibarr\Code\Core\Classes\CommonDocGenerator;

/**
 *  Parent class for stock models of doc generators
 */
abstract class ModelePDFStock extends CommonDocGenerator
{
    /**
     * @var DoliDB Database handler

The type Dolibarr\Code\Stock\Classes\DoliDB was not found. Did you mean DoliDB? If so, make sure to prefix the type with \.

     */
    public $db;

    /**
     * @var string model name
     */
    public $name;

    /**
     * @var string model description (short text)
     */
    public $description;

    /**
     * @var string document type
     */
    public $type;

    /**
     * @var string      Dolibarr version of the loaded document
     */
    public $version = 'dolibarr';


    // phpcs:disable PEAR.NamingConventions.ValidFunctionName.ScopeNotCamelCaps

    /**
     *  Return list of active generation modules
     *
     * @param DoliDB $db Database handler
     * @param integer $maxfilenamelength Max length of value to show
     * @return array                           List of templates
     */
    public static function liste_modeles($db, $maxfilenamelength = 0)
    {
        // phpcs:enable
        $type = 'stock';
        $list = array();

        include_once DOL_DOCUMENT_ROOT . '/core/lib/functions2.lib.php';
        $list = getListOfModels($db, $type, $maxfilenamelength);

        return $list;

The expression return $list also could return the type integer which is incompatible with the documented return type array.

    }
}