modulebuilder.lib.php ➔ rebuildObjectClass() - Code Metrics - Inspection of "Daily Inspection: Merge pull request #7200 from hg..." - Dolibarr/dolibarr - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Branch — develop (420c52)

unknown

created 2017-07-25 16:34 UTC

modulebuilder.lib.php ➔ rebuildObjectClass() F

↳ Parent: Project

Complexity

Conditions	16
Paths	282

Size

Total Lines	89
Code Lines	49

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
cc	16
eloc	49
nc	282
nop	4
dl	0
loc	89
rs	3.7109
c	0
b	0
f	0

How to fix Long Method Complexity

<?php
/* Copyright (C) 2009-2010 Laurent Destailleur  <[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 <http://www.gnu.org/licenses/>.
 * or see http://www.gnu.org/
 */

/**
 *  \file		htdocs/core/lib/memory.lib.php
 *  \brief		Set of function for memory/cache management
 */




/**
 * 	Save data into a memory area shared by all users, all sessions on server
 *
 *  @param	string      $destdir		Directory
 * 	@param	string		$module			Module name
 *  @param	string      $objectname		Name of object
 * 	@param	string		$newmask		New mask
 * 	@return	int							<0 if KO, >0 if OK
 */
function rebuildObjectClass($destdir, $module, $objectname, $newmask)
{
    global $db, $langs;

    if (empty($objectname)) return -1;

    $pathoffiletoeditsrc=$destdir.'/class/'.strtolower($objectname).'.class.php';
    $pathoffiletoedittarget=$destdir.'/class/'.strtolower($objectname).'.class.php';
    if (! dol_is_file($pathoffiletoeditsrc))
    {
        //$pathoffiletoeditsrc=DOL_DOCUMENT_ROOT.'/modulebuilder/template/class/myobject.class.php';
        setEventMessages($langs->trans("ErrorFileNotFound", $pathoffiletoeditsrc), null, 'errors');
        return -1;
    }

    //$pathoffiletoedittmp=$destdir.'/class/'.strtolower($objectname).'.class.php.tmp';
    //dol_delete_file($pathoffiletoedittmp, 0, 1, 1);

    try
    {
        include_once $pathoffiletoeditsrc;
        if (class_exists($objectname)) $object=new $objectname($db);
        else return -1;

        // Backup old file
        dol_copy($pathoffiletoeditsrc, $pathoffiletoeditsrc.'.back', $newmask, 1);

        // Edit class files
        $contentclass = file_get_contents(dol_osencode($pathoffiletoeditsrc), 'r');

        $i=0;
        $texttoinsert = '// BEGIN MODULEBUILDER PROPERTIES'."\n";
        $texttoinsert.= "\t".'/**'."\n";
        $texttoinsert.= "\t".' * @var array  Array with all fields and their property'."\n";
        $texttoinsert.= "\t".' */'."\n";
        $texttoinsert.= "\t".'public $fields=array('."\n";

        if (count($object->fields))
        {
            foreach($object->fields as $key => $val)
            {
                $i++;
                $typephp='';
                $texttoinsert.= "\t\t'".$key."' => array('type'=>'".$val['type']."', 'label'=>'".$val['label']."',";
                $texttoinsert.= " 'visible'=>".($val['visible']?$val['visible']:0).",";
                $texttoinsert.= " 'enabled'=>".($val['enabled']?$val['enabled']:0).",";
                if ($val['position']) $texttoinsert.= " 'position'=>".$val['position'].",";
                if ($val['notnull']) $texttoinsert.= " 'notnull'=>".$val['notnull'].",";
                if ($val['index']) $texttoinsert.= " 'index'=>".$val['index'].",";
                if ($val['searchall']) $texttoinsert.= " 'searchall'=>".$val['searchall'].",";
                if ($val['comment']) $texttoinsert.= " 'comment'=>'".$val['comment']."',";
                $texttoinsert.= "),\n";
            }
        }
        $texttoinsert.= "\t".');'."\n";

        $texttoinsert.= "\n";

        if (count($object->fields))
        {
            foreach($object->fields as $key => $val)
            {
                $i++;
                $typephp='';
                $texttoinsert.= "\t".'public $'.$key.$typephp.";";
                //if ($key == 'rowid')  $texttoinsert.= ' AUTO_INCREMENT PRIMARY KEY';
                //if ($key == 'entity') $texttoinsert.= ' DEFAULT 1';
                //$texttoinsert.= ($val['notnull']?' NOT NULL':'');
                //if ($i < count($object->fields)) $texttoinsert.=";";
                $texttoinsert.= "\n";
            }
        }

        $texttoinsert.= "\t".'// END MODULEBUILDER PROPERTIES';

        $contentclass = preg_replace('/\/\/ BEGIN MODULEBUILDER PROPERTIES.*END MODULEBUILDER PROPERTIES/ims', $texttoinsert, $contentclass);

        //file_put_contents($pathoffiletoedittmp, $contentclass);
        file_put_contents(dol_osencode($pathoffiletoedittarget), $contentclass);
        @chmod($pathoffiletoedittarget, octdec($newmask));

        return 1;
    }
    catch(Exception $e)
    {
        print $e->getMessage();
        return -1;
    }
}

/**
 * 	Save data into a memory area shared by all users, all sessions on server
 *
 *  @param	string      $destdir		Directory
 * 	@param	string		$module			Module name
 *  @param	string      $objectname		Name of object
 * 	@param	string		$newmask		New mask
 * 	@return	int							<0 if KO, >0 if OK
 */
function rebuildObjectSql($destdir, $module, $objectname, $newmask)
{
    global $db, $langs;

    if (empty($objectname)) return -1;

    try
    {
        dol_include_once(strtolower($module).'/class/'.strtolower($objectname).'.class.php');
        if (class_exists($objectname)) $object=new $objectname($db);
        else return -1;
    }
    catch(Exception $e)
    {
        print $e->getMessage();
    }

    // Edit .sql file
    $pathoffiletoeditsrc=dol_osencode($destdir.'/sql/llx_'.strtolower($objectname).'.sql');
    $pathoffiletoedittarget=dol_osencode($destdir.'/sql/llx_'.strtolower($objectname).'.sql');

    $contentsql = file_get_contents($pathoffiletoeditsrc, 'r');

    $i=0;
    $texttoinsert = '-- BEGIN MODULEBUILDER FIELDS'."\n";
    if (count($object->fields))
    {
        foreach($object->fields as $key => $val)
        {
            $i++;
            $texttoinsert.= "\t".$key." ".$val['type'];
            if ($key == 'rowid')  $texttoinsert.= ' AUTO_INCREMENT PRIMARY KEY';
            if ($key == 'entity') $texttoinsert.= ' DEFAULT 1';
            $texttoinsert.= ($val['notnull']?' NOT NULL':'');
            if ($i < count($object->fields)) $texttoinsert.=", ";
function myFunction($a) {
    switch ($a) {
        case 'foo':
            $x = 1;
            break;

        case 'bar':
            $x = 2;
            break;
    }

    // $x is potentially undefined here.
    echo $x;
}
            $texttoinsert.= "\n";
        }
    }
    $texttoinsert.= "\t".'-- END MODULEBUILDER FIELDS';

    $contentsql = preg_replace('/-- BEGIN MODULEBUILDER FIELDS.*END MODULEBUILDER FIELDS/ims', $texttoinsert, $contentsql);

    file_put_contents($pathoffiletoedittarget, $contentsql);
    @chmod($pathoffiletoedittarget, octdec($newmask));


    // Edit .key.sql file
    $pathoffiletoeditsrc=dol_osencode($destdir.'/sql/llx_'.strtolower($objectname).'.key.sql');
    $pathoffiletoedittarget=dol_osencode($destdir.'/sql/llx_'.strtolower($objectname).'.key.sql');

    $contentsql = file_get_contents($pathoffiletoeditsrc, 'r');

    $i=0;
    $texttoinsert = '-- BEGIN MODULEBUILDER INDEXES'."\n";
    if (count($object->fields))
    {
        foreach($object->fields as $key => $val)
        {
            $i++;
            if ($val['index'])
            {
                $texttoinsert.= "ALTER TABLE llx_".strtolower($objectname)." ADD INDEX idx_".strtolower($objectname)."_".$key." (".$key.");";
                $texttoinsert.= "\n";
            }
        }
    }
    $texttoinsert.= '-- END MODULEBUILDER INDEXES';

    $contentsql = preg_replace('/-- BEGIN MODULEBUILDER INDEXES.*END MODULEBUILDER INDEXES/ims', $texttoinsert, $contentsql);

    file_put_contents($pathoffiletoedittarget, $contentsql);
    @chmod($pathoffiletoedittarget, octdec($newmask));

    return 1;
}




1			<?php
2			/* Copyright (C) 2009-2010 Laurent Destailleur <[email protected]>
3			*
4			* This program is free software; you can redistribute it and/or modify
5			* it under the terms of the GNU General Public License as published by
6			* the Free Software Foundation; either version 3 of the License, or
7			* (at your option) any later version.
8			*
9			* This program is distributed in the hope that it will be useful,
10			* but WITHOUT ANY WARRANTY; without even the implied warranty of
11			* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12			* GNU General Public License for more details.
13			*
14			* You should have received a copy of the GNU General Public License
15			* along with this program. If not, see <http://www.gnu.org/licenses/>.
16			* or see http://www.gnu.org/
17			*/
18
19			/**
20			* \file htdocs/core/lib/memory.lib.php
21			* \brief Set of function for memory/cache management
22			*/
23
24
25
26
27			/**
28			* Save data into a memory area shared by all users, all sessions on server
29			*
30			* @param string $destdir Directory
31			* @param string $module Module name
32			* @param string $objectname Name of object
33			* @param string $newmask New mask
34			* @return int <0 if KO, >0 if OK
35			*/
36			function rebuildObjectClass($destdir, $module, $objectname, $newmask)
37			{
38			global $db, $langs;
39
40			if (empty($objectname)) return -1;
41
42			$pathoffiletoeditsrc=$destdir.'/class/'.strtolower($objectname).'.class.php';
43			$pathoffiletoedittarget=$destdir.'/class/'.strtolower($objectname).'.class.php';
44			if (! dol_is_file($pathoffiletoeditsrc))
45			{
46			//$pathoffiletoeditsrc=DOL_DOCUMENT_ROOT.'/modulebuilder/template/class/myobject.class.php';
47			setEventMessages($langs->trans("ErrorFileNotFound", $pathoffiletoeditsrc), null, 'errors');
48			return -1;
49			}
50
51			//$pathoffiletoedittmp=$destdir.'/class/'.strtolower($objectname).'.class.php.tmp';
52			//dol_delete_file($pathoffiletoedittmp, 0, 1, 1);
53
54			try
55			{
56			include_once $pathoffiletoeditsrc;
57			if (class_exists($objectname)) $object=new $objectname($db);
58			else return -1;
59
60			// Backup old file
61			dol_copy($pathoffiletoeditsrc, $pathoffiletoeditsrc.'.back', $newmask, 1);
62
63			// Edit class files
64			$contentclass = file_get_contents(dol_osencode($pathoffiletoeditsrc), 'r');
65
66			$i=0;
67			$texttoinsert = '// BEGIN MODULEBUILDER PROPERTIES'."\n";
68			$texttoinsert.= "\t".'/**'."\n";
69			$texttoinsert.= "\t".' * @var array Array with all fields and their property'."\n";
70			$texttoinsert.= "\t".' */'."\n";
71			$texttoinsert.= "\t".'public $fields=array('."\n";
72
73			if (count($object->fields))
74			{
75			foreach($object->fields as $key => $val)
76			{
77			$i++;
78			$typephp='';
79			$texttoinsert.= "\t\t'".$key."' => array('type'=>'".$val['type']."', 'label'=>'".$val['label']."',";
80			$texttoinsert.= " 'visible'=>".($val['visible']?$val['visible']:0).",";
81			$texttoinsert.= " 'enabled'=>".($val['enabled']?$val['enabled']:0).",";
82			if ($val['position']) $texttoinsert.= " 'position'=>".$val['position'].",";
83			if ($val['notnull']) $texttoinsert.= " 'notnull'=>".$val['notnull'].",";
84			if ($val['index']) $texttoinsert.= " 'index'=>".$val['index'].",";
85			if ($val['searchall']) $texttoinsert.= " 'searchall'=>".$val['searchall'].",";
86			if ($val['comment']) $texttoinsert.= " 'comment'=>'".$val['comment']."',";
87			$texttoinsert.= "),\n";
88			}
89			}
90			$texttoinsert.= "\t".');'."\n";
91
92			$texttoinsert.= "\n";
93
94			if (count($object->fields))
95			{
96			foreach($object->fields as $key => $val)
97			{
98			$i++;
99			$typephp='';
100			$texttoinsert.= "\t".'public $'.$key.$typephp.";";
101			//if ($key == 'rowid') $texttoinsert.= ' AUTO_INCREMENT PRIMARY KEY';
102			//if ($key == 'entity') $texttoinsert.= ' DEFAULT 1';
103			//$texttoinsert.= ($val['notnull']?' NOT NULL':'');
104			//if ($i < count($object->fields)) $texttoinsert.=";";
105			$texttoinsert.= "\n";
106			}
107			}
108
109			$texttoinsert.= "\t".'// END MODULEBUILDER PROPERTIES';
110
111			$contentclass = preg_replace('/\/\/ BEGIN MODULEBUILDER PROPERTIES.*END MODULEBUILDER PROPERTIES/ims', $texttoinsert, $contentclass);
112
113			//file_put_contents($pathoffiletoedittmp, $contentclass);
114			file_put_contents(dol_osencode($pathoffiletoedittarget), $contentclass);
115			@chmod($pathoffiletoedittarget, octdec($newmask));
116
117			return 1;
118			}
119			catch(Exception $e)
120			{
121			print $e->getMessage();
122			return -1;
123			}
124			}
125
126			/**
127			* Save data into a memory area shared by all users, all sessions on server
128			*
129			* @param string $destdir Directory
130			* @param string $module Module name
131			* @param string $objectname Name of object
132			* @param string $newmask New mask
133			* @return int <0 if KO, >0 if OK
134			*/
135			function rebuildObjectSql($destdir, $module, $objectname, $newmask)
136			{
137			global $db, $langs;
138
139			if (empty($objectname)) return -1;
140
141			try
142			{
143			dol_include_once(strtolower($module).'/class/'.strtolower($objectname).'.class.php');
144			if (class_exists($objectname)) $object=new $objectname($db);
145			else return -1;
146			}
147			catch(Exception $e)
148			{
149			print $e->getMessage();
150			}
151
152			// Edit .sql file
153			$pathoffiletoeditsrc=dol_osencode($destdir.'/sql/llx_'.strtolower($objectname).'.sql');
154			$pathoffiletoedittarget=dol_osencode($destdir.'/sql/llx_'.strtolower($objectname).'.sql');
155
156			$contentsql = file_get_contents($pathoffiletoeditsrc, 'r');
157
158			$i=0;
159			$texttoinsert = '-- BEGIN MODULEBUILDER FIELDS'."\n";
160			if (count($object->fields))
161			{
162			foreach($object->fields as $key => $val)
163			{
164			$i++;
165			$texttoinsert.= "\t".$key." ".$val['type'];
166			if ($key == 'rowid') $texttoinsert.= ' AUTO_INCREMENT PRIMARY KEY';
167			if ($key == 'entity') $texttoinsert.= ' DEFAULT 1';
168			$texttoinsert.= ($val['notnull']?' NOT NULL':'');
169			if ($i < count($object->fields)) $texttoinsert.=", ";
			0 ignored issues – show Bug introduced 2017-07-13 17:00 UTC by Report Bug Copy Issue Report The variable `$object` does not seem to be defined for all execution paths leading up to this point. If you define a variable conditionally, it can happen that it is not defined for all execution paths. Let’s take a look at an example: function myFunction($a) { switch ($a) { case 'foo': $x = 1; break; case 'bar': $x = 2; break; } // $x is potentially undefined here. echo $x; } In the above example, the variable `$x` is defined if you pass “foo” or “bar” as argument for `$a`. However, since the `switch` statement has no default case statement, if you pass any other value, the variable `$x` would be undefined. Available Fixes Check for existence of the variable explicitly: function myFunction($a) { switch ($a) { case 'foo': $x = 1; break; case 'bar': $x = 2; break; } if (isset($x)) { // Make sure it's always set. echo $x; } } Define a default value for the variable: function myFunction($a) { $x = ''; // Set a default which gets overridden for certain paths. switch ($a) { case 'foo': $x = 1; break; case 'bar': $x = 2; break; } echo $x; } Add a value for the missing path: function myFunction($a) { switch ($a) { case 'foo': $x = 1; break; case 'bar': $x = 2; break; // We add support for the missing case. default: $x = ''; break; } echo $x; } Loading history...
170			$texttoinsert.= "\n";
171			}
172			}
173			$texttoinsert.= "\t".'-- END MODULEBUILDER FIELDS';
174
175			$contentsql = preg_replace('/-- BEGIN MODULEBUILDER FIELDS.*END MODULEBUILDER FIELDS/ims', $texttoinsert, $contentsql);
176
177			file_put_contents($pathoffiletoedittarget, $contentsql);
178			@chmod($pathoffiletoedittarget, octdec($newmask));
179
180
181			// Edit .key.sql file
182			$pathoffiletoeditsrc=dol_osencode($destdir.'/sql/llx_'.strtolower($objectname).'.key.sql');
183			$pathoffiletoedittarget=dol_osencode($destdir.'/sql/llx_'.strtolower($objectname).'.key.sql');
184
185			$contentsql = file_get_contents($pathoffiletoeditsrc, 'r');
186
187			$i=0;
188			$texttoinsert = '-- BEGIN MODULEBUILDER INDEXES'."\n";
189			if (count($object->fields))
190			{
191			foreach($object->fields as $key => $val)
192			{
193			$i++;
194			if ($val['index'])
195			{
196			$texttoinsert.= "ALTER TABLE llx_".strtolower($objectname)." ADD INDEX idx_".strtolower($objectname)."_".$key." (".$key.");";
197			$texttoinsert.= "\n";
198			}
199			}
200			}
201			$texttoinsert.= '-- END MODULEBUILDER INDEXES';
202
203			$contentsql = preg_replace('/-- BEGIN MODULEBUILDER INDEXES.*END MODULEBUILDER INDEXES/ims', $texttoinsert, $contentsql);
204
205			file_put_contents($pathoffiletoedittarget, $contentsql);
206			@chmod($pathoffiletoedittarget, octdec($newmask));
207
208			return 1;
209			}
210
211
212

Dolibarr / dolibarr

Branch — develop (420c52)

modulebuilder.lib.php ➔ rebuildObjectClass() F

Complexity

Size

Duplication

Importance

How to fix Long Method Complexity

Long Method

Available Fixes

Duplication Side-by-Side

Filter issues like