DocumentGeneration::__construct() - Code Metrics - alxarafe/alixar - Measure and Improve Code Quality continuously with Scrutinizer

DocumentGeneration::__construct() A
last analyzed 2024-11-03 11:50 UTC

↳ Parent: DocumentGeneration

Complexity

Conditions	1
Paths	1

Size

Total Lines	53
Code Lines	30

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
cc	1
eloc	30
nc	1
nop	1
dl	0
loc	53
rs	9.44
c	0
b	0
f	0

How to fix Long Method

<?php

/* Copyright (C) 2007      Rodolphe Quiedeville <[email protected]>
 * Copyright (C) 2005-2009 Regis Houssin        <[email protected]>
 * Copyright (C) 2024       Rafael San José             <[email protected]>
 *
 * 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\Modules;

/**
 *  \defgroup       document     Module mass mailings
 *  \brief          Module pour gerer des generations de documents
 *  \file           htdocs/core/modules/modDocumentGeneration.class.php
 *  \ingroup        document
 *  \brief          Description and activation file for the module Generation document
 */

use Dolibarr\Core\Base\DolibarrModules;

/**
 *  Class to describe and enable module Document
 */
class DocumentGeneration extends DolibarrModules
{
    /**
     *   Constructor. Define names, constants, directories, boxes, permissions
     *
     * @param DoliDB $db Database handler

     */
    public function __construct($db)
    {
        $this->db = $db;
        $this->numero = 1520;

        $this->family = "technic";
        $this->module_position = '78';
        // Module label (no space allowed), used if translation string 'ModuleXXXName' not found (where XXX is value of numeric property 'numero' of module)
        $this->name = preg_replace('/^mod/i', '', get_only_class($this));
        $this->description = "Direct mail document generation";
        // Possible values for version are: 'development', 'experimental', 'dolibarr' or version
        $this->version = 'development';

        $this->const_name = 'MAIN_MODULE_' . static::getNameOf($this->name); // strtoupper($this->name);
        $this->picto = 'email';

        // Data directories to create when module is enabled
        $this->dirs = array("/documentgeneration/temp");

        // Config pages
        //$this->config_page_url = array("document.php");

        // Dependencies
        $this->depends = array();
        $this->requiredby = array();
        $this->conflictwith = array();
        $this->langfiles = array("orders", "bills", "companies", "mails");

        // Constants

        $this->const = array();

        // Boxes
        $this->boxes = array();

        // Permissions
        $this->rights = array();
        $this->rights_class = 'document';

        $r = 0;

        $this->rights[$r][0] = 1521;
        $this->rights[$r][1] = 'Lire les documents';
        $this->rights[$r][2] = 'r';
        $this->rights[$r][3] = 0;
        $this->rights[$r][4] = 'lire';

        $r++;
        $this->rights[$r][0] = 1522;
        $this->rights[$r][1] = 'Supprimer les documents clients';
        $this->rights[$r][2] = 'd';
        $this->rights[$r][3] = 0;
        $this->rights[$r][4] = 'supprimer';
    }


    /**
     *  Function called when module is enabled.
     *  The init function add constants, boxes, permissions and menus (defined in constructor) into Dolibarr database.
     *  It also creates data directories
     *
     * @param string $options Options when enabling module ('', 'noboxes')
     * @return     int                 1 if OK, 0 if KO
     */
    public function init($options = '')
    {
        global $conf;

        // Permissions
        $this->remove($options);

        $sql = array();

        return $this->_init($sql, $options);
    }
}


1			<?php
2
3			/* Copyright (C) 2007 Rodolphe Quiedeville <[email protected]>
4			* Copyright (C) 2005-2009 Regis Houssin <[email protected]>
5			* Copyright (C) 2024 Rafael San José <[email protected]>
6			*
7			* This program is free software; you can redistribute it and/or modify
8			* it under the terms of the GNU General Public License as published by
9			* the Free Software Foundation; either version 3 of the License, or
10			* (at your option) any later version.
11			*
12			* This program is distributed in the hope that it will be useful,
13			* but WITHOUT ANY WARRANTY; without even the implied warranty of
14			* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15			* GNU General Public License for more details.
16			*
17			* You should have received a copy of the GNU General Public License
18			* along with this program. If not, see <https://www.gnu.org/licenses/>.
19			* or see https://www.gnu.org/
20			*/
21
22			namespace Dolibarr\Modules;
23
24			/**
25			* \defgroup document Module mass mailings
26			* \brief Module pour gerer des generations de documents
27			* \file htdocs/core/modules/modDocumentGeneration.class.php
28			* \ingroup document
29			* \brief Description and activation file for the module Generation document
30			*/
31
32			use Dolibarr\Core\Base\DolibarrModules;
33
34			/**
35			* Class to describe and enable module Document
36			*/
37			class DocumentGeneration extends DolibarrModules
38			{
39			/**
40			* Constructor. Define names, constants, directories, boxes, permissions
41			*
42			* @param DoliDB $db Database handler
			0 ignored issues – show Bug introduced 2024-08-21 13:23 UTC by Report Bug Copy Issue Report The type `Dolibarr\Modules\DoliDB` was not found. Did you mean `DoliDB`? If so, make sure to prefix the type with `\`. Loading history...
43			*/
44			public function __construct($db)
45			{
46			$this->db = $db;
47			$this->numero = 1520;
48
49			$this->family = "technic";
50			$this->module_position = '78';
51			// Module label (no space allowed), used if translation string 'ModuleXXXName' not found (where XXX is value of numeric property 'numero' of module)
52			$this->name = preg_replace('/^mod/i', '', get_only_class($this));
53			$this->description = "Direct mail document generation";
54			// Possible values for version are: 'development', 'experimental', 'dolibarr' or version
55			$this->version = 'development';
56
57			$this->const_name = 'MAIN_MODULE_' . static::getNameOf($this->name); // strtoupper($this->name);
58			$this->picto = 'email';
59
60			// Data directories to create when module is enabled
61			$this->dirs = array("/documentgeneration/temp");
62
63			// Config pages
64			//$this->config_page_url = array("document.php");
65
66			// Dependencies
67			$this->depends = array();
68			$this->requiredby = array();
69			$this->conflictwith = array();
70			$this->langfiles = array("orders", "bills", "companies", "mails");
71
72			// Constants
73
74			$this->const = array();
75
76			// Boxes
77			$this->boxes = array();
78
79			// Permissions
80			$this->rights = array();
81			$this->rights_class = 'document';
82
83			$r = 0;
84
85			$this->rights[$r][0] = 1521;
86			$this->rights[$r][1] = 'Lire les documents';
87			$this->rights[$r][2] = 'r';
88			$this->rights[$r][3] = 0;
89			$this->rights[$r][4] = 'lire';
90
91			$r++;
92			$this->rights[$r][0] = 1522;
93			$this->rights[$r][1] = 'Supprimer les documents clients';
94			$this->rights[$r][2] = 'd';
95			$this->rights[$r][3] = 0;
96			$this->rights[$r][4] = 'supprimer';
97			}
98
99
100			/**
101			* Function called when module is enabled.
102			* The init function add constants, boxes, permissions and menus (defined in constructor) into Dolibarr database.
103			* It also creates data directories
104			*
105			* @param string $options Options when enabling module ('', 'noboxes')
106			* @return int 1 if OK, 0 if KO
107			*/
108			public function init($options = '')
109			{
110			global $conf;
111
112			// Permissions
113			$this->remove($options);
114
115			$sql = array();
116
117			return $this->_init($sql, $options);
118			}
119			}
120

alxarafe / alixar

DocumentGeneration::__construct() A last analyzed 2024-11-03 11:50 UTC

Complexity

Size

Duplication

Importance

How to fix Long Method

Long Method

Duplication Side-by-Side

Filter issues like

DocumentGeneration::__construct() A
last analyzed 2024-11-03 11:50 UTC