ListViewPackages::setup()   A
last analyzed

Complexity

Conditions 1
Paths 1

Size

Total Lines 4
Code Lines 3

Duplication

Lines 0
Ratio 0 %

Code Coverage

Tests 0
CRAP Score 2
Metric Value
cc 1
eloc 3
nc 1
nop 8
dl 0
loc 4
ccs 0
cts 4
cp 0
crap 2
rs 10

How to fix   Many Parameters   

Many Parameters

Methods with many parameters are not only hard to understand, but their parameters also often become inconsistent when you need more, or different data.

There are several approaches to avoid long parameter lists:

1
<?php
2
/*********************************************************************************
3
 * SugarCRM Community Edition is a customer relationship management program developed by
4
 * SugarCRM, Inc. Copyright (C) 2004-2013 SugarCRM Inc.
5
6
 * SuiteCRM is an extension to SugarCRM Community Edition developed by Salesagility Ltd.
7
 * Copyright (C) 2011 - 2014 Salesagility Ltd.
8
 *
9
 * This program is free software; you can redistribute it and/or modify it under
10
 * the terms of the GNU Affero General Public License version 3 as published by the
11
 * Free Software Foundation with the addition of the following permission added
12
 * to Section 15 as permitted in Section 7(a): FOR ANY PART OF THE COVERED WORK
13
 * IN WHICH THE COPYRIGHT IS OWNED BY SUGARCRM, SUGARCRM DISCLAIMS THE WARRANTY
14
 * OF NON INFRINGEMENT OF THIRD PARTY RIGHTS.
15
 *
16
 * This program is distributed in the hope that it will be useful, but WITHOUT
17
 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
18
 * FOR A PARTICULAR PURPOSE.  See the GNU Affero General Public License for more
19
 * details.
20
 *
21
 * You should have received a copy of the GNU Affero General Public License along with
22
 * this program; if not, see http://www.gnu.org/licenses or write to the Free
23
 * Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
24
 * 02110-1301 USA.
25
 *
26
 * You can contact SugarCRM, Inc. headquarters at 10050 North Wolfe Road,
27
 * SW2-130, Cupertino, CA 95014, USA. or at email address [email protected].
28
 *
29
 * The interactive user interfaces in modified source and object code versions
30
 * of this program must display Appropriate Legal Notices, as required under
31
 * Section 5 of the GNU Affero General Public License version 3.
32
 *
33
 * In accordance with Section 7(b) of the GNU Affero General Public License version 3,
34
 * these Appropriate Legal Notices must retain the display of the "Powered by
35
 * SugarCRM" logo and "Supercharged by SuiteCRM" logo. If the display of the logos is not
36
 * reasonably feasible for  technical reasons, the Appropriate Legal Notices must
37
 * display the words  "Powered by SugarCRM" and "Supercharged by SuiteCRM".
38
 ********************************************************************************/
39
40
 require_once('include/ListView/ListViewSmarty.php');
41
42
class ListViewPackages extends ListViewSmarty{
43
    var $secondaryDisplayColumns;
44
    /**
45
     * Constructor  Call ListViewSmarty
46
     */
47
    function __construct(){
48
        parent::__construct();
49
    }
50
51
    /**
52
     * @deprecated deprecated since version 7.6, PHP4 Style Constructors are deprecated and will be remove in 7.8, please update your code, use __construct instead
53
     */
54
    function ListViewPackages(){
55
        $deprecatedMessage = 'PHP4 Style Constructors are deprecated and will be remove in 7.8, please update your code';
56
        if(isset($GLOBALS['log'])) {
57
            $GLOBALS['log']->deprecated($deprecatedMessage);
58
        }
59
        else {
60
            trigger_error($deprecatedMessage, E_USER_DEPRECATED);
61
        }
62
        self::__construct();
63
    }
64
65
66
    /**
67
     * Override the setup method in ListViewSmarty since we are not passing in a bean
68
     *
69
     * @param data  the data to display on the page
70
     * @param file  the template file to parse
71
     */
72
    function setup($data, $file, $where, $params = Array(), $offset = 0, $limit = -1, $filter_fields = Array(), $id_field = 'id'){
73
        $this->data = $data;
74
        $this->tpl = $file;
75
    }
76
77
    /**
78
     * Override the display method
79
     */
80
    function display($end = true){
81
        global $odd_bg, $even_bg, $app_strings;
82
        $this->ss->assign('rowColor', array('oddListRow', 'evenListRow'));
83
        $this->ss->assign('bgColor', array($odd_bg, $even_bg));
84
        $this->ss->assign('displayColumns', $this->displayColumns);
85
        $this->ss->assign('secondaryDisplayColumns', $this->secondaryDisplayColumns);
86
        $this->ss->assign('data', $this->data);
87
        return $this->ss->fetch($this->tpl);
0 ignored issues
show
Bug introduced by
It seems like $this->tpl can also be of type object<File>; however, Smarty::fetch() does only seem to accept string, maybe add an additional type check?

If a method or function can return multiple different values and unless you are sure that you only can receive a single value in this context, we recommend to add an additional type check:

/**
 * @return array|string
 */
function returnsDifferentValues($x) {
    if ($x) {
        return 'foo';
    }

    return array();
}

$x = returnsDifferentValues($y);
if (is_array($x)) {
    // $x is an array.
}

If this a common case that PHP Analyzer should handle natively, please let us know by opening an issue.

Loading history...
88
    }
89
}
90
?>
91