UserVisit::getUserVisitHeader() - Code Metrics - Inspection of "Timgno" - txmodxoops/tdmcreate - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#51)

by Gino

created 2016-01-28 16:23 UTC

UserVisit::getUserVisitHeader() B

↳ Parent: UserVisit

Complexity

Conditions	5
Paths	10

Size

Total Lines	21
Code Lines	14

Duplication

Lines	0
Ratio	0 %

Metric	Value
dl	0
loc	21
rs	8.7624
cc	5
eloc	14
nc	10
nop	2

<?php


/*
 You may not change or alter any portion of this comment or credits
 of supporting developers from this source code or any supporting source code
 which is considered copyrighted (c) material of the original comment or credit authors.

 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.
 */
/**
 * tdmcreate module.
 *
 * @copyright       The XOOPS Project http://sourceforge.net/projects/xoops/
 * @license         GNU GPL 2 (http://www.gnu.org/licenses/old-licenses/gpl-2.0.html)
 *
 * @since           2.5.0
 *
 * @author          Txmod Xoops http://www.txmodxoops.org
 *
 * @version         $Id: UserVisit.php 12258 2014-01-02 09:33:29Z timgno \$
 */
defined('XOOPS_ROOT_PATH') || die('Restricted access');

/**
 * Class UserVisit.
 */
class UserVisit extends TDMCreateFile
namespace YourVendor;

class YourClass { }
{
    /*
    *  @public function constructor
    *  @param null
    */
    /**
     *
     */
    public function __construct()
    {
        parent::__construct();
        $this->xoopscode = TDMCreateXoopsCode::getInstance();
class MyClass { }

$x = new MyClass();
$x->foo = true;
        $this->phpcode = TDMCreatePhpCode::getInstance();
class MyClass { }

$x = new MyClass();
$x->foo = true;
        $this->usercode = UserXoopsCode::getInstance();
class MyClass { }

$x = new MyClass();
$x->foo = true;
    }

    /*
    *  @static function &getInstance
    *  @param null
    */
    /**
     * @return UserVisit
     */
    public static function &getInstance()
    {
        static $instance = false;
        if (!$instance) {
            $instance = new self();
        }

        return $instance;
    }

    /*
    *  @public function write
    *  @param string $module
    *  @param mixed $table
    *  @param string $filename
    */
    /**
     * @param $module
     * @param $table
     * @param $filename
     */
    public function write($module, $table, $filename)
    {
        $this->setModule($module);
        $this->setTable($table);
        $this->setFileName($filename);
    }

    /**
     * @private function getUserVisitHeader
     *
     * @param $table
     *
     * @return string
     */
    private function getUserVisitHeader($table, $fields)
    {
        $ret = $this->getInclude();
        foreach (array_keys($fields) as $f) {
            $fieldName = $fields[$f]->getVar('field_name');
            if (0 == $f) {
                $fieldId = $fieldName;
            }
            if (1 == $fields[$f]->getVar('field_parent')) {
                $fieldPid = $fieldName;
            }
        }
        if ($table->getVar('table_category') == 1) {
            $ccFieldPid = $this->getCamelCase($fieldPid, false, true);
function myFunction($a) {
    switch ($a) {
        case 'foo':
            $x = 1;
            break;

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

    // $x is potentially undefined here.
    echo $x;
}
            $ret .= $this->xoopscode->getXoopsCodeXoopsRequest("{$ccFieldPid}", "{$fieldPid}", '0', 'Int');
        }
        $ccFieldId = $this->getCamelCase($fieldId, false, true);
function myFunction($a) {
    switch ($a) {
        case 'foo':
            $x = 1;
            break;

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

    // $x is potentially undefined here.
    echo $x;
}
        $ret .= $this->xoopscode->getXoopsCodeXoopsRequest("{$ccFieldId}", "{$fieldId}", '0', 'Int');

        return $ret;
    }

    /**
     * @private function getUserVisitCheckPermissions
     *
     * @param null
     *
     * @return string
     */
    private function getUserVisitCheckPermissions()
    {
        $ret = '';

        return $ret;
    }

    /**
     * @private function getUserVisitCheckLimit
     *
     * @param null
     *
     * @return string
     */
    private function getUserVisitCheckLimit()
    {
        $ret = '';

        return $ret;
    }

    /**
     * @private function getUserVisitCheckHost
     *
     * @param null
     *
     * @return string
     */
    private function getUserVisitCheckHost()
    {
        $ret = '';

        return $ret;
    }

    /*
    *  @public function render
    *  @param null
    */
    /**
     * @return bool|string
     */
    public function render()
    {
        $module = $this->getModule();
        $table = $this->getTable();
        $filename = $this->getFileName();
        $moduleDirname = $module->getVar('mod_dirname');
        $tableId = $table->getVar('table_id');
        $tableMid = $table->getVar('table_mid');
        $tableName = $table->getVar('table_name');
$myVar = 'Value';
$higher = false;

if (rand(1, 6) > 3) {
    $higher = true;
} else {
    $higher = false;
}
        $tableSoleName = $table->getVar('table_solename');
$myVar = 'Value';
$higher = false;

if (rand(1, 6) > 3) {
    $higher = true;
} else {
    $higher = false;
}
        $fields = $this->getTableFields($tableMid, $tableId);
        $language = $this->getLanguage($moduleDirname, 'MA');
$myVar = 'Value';
$higher = false;

if (rand(1, 6) > 3) {
    $higher = true;
} else {
    $higher = false;
}
        $content = $this->getHeaderFilesComments($module, $filename);
        $content .= $this->getUserVisitHeader($table, $fields);
        $content .= $this->getUserVisitCheckPermissions();
        $content .= $this->getUserVisitCheckLimit();
        $content .= $this->getUserVisitCheckHost();

        $this->create($moduleDirname, '/', $filename, $content, _AM_TDMCREATE_FILE_CREATED, _AM_TDMCREATE_FILE_NOTCREATED);
function acceptsInteger($int) { }

$x = '123'; // string "123"

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);

        return $this->renderFile();
    }
}


1			<?php
			0 ignored issues – show Coding Style Compatibility introduced 2015-12-23 22:08 UTC by Report Bug Copy Issue Report For compatibility and reusability of your code, PSR1 recommends that a file should introduce either new symbols (like classes, functions, etc.) or have side-effects (like outputting something, or including other files), but not both at the same time. The first symbol is defined on line 29 and the first side effect is on line 24. The PSR-1: Basic Coding Standard recommends that a file should either introduce new symbols, that is classes, functions, constants or similar, or have side effects. Side effects are anything that executes logic, like for example printing output, changing ini settings or writing to a file. The idea behind this recommendation is that merely auto-loading a class should not change the state of an application. It also promotes a cleaner style of programming and makes your code less prone to errors, because the logic is not spread out all over the place. To learn more about the PSR-1, please see the PHP-FIG site on the PSR-1. Loading history...
2
3			/*
4			You may not change or alter any portion of this comment or credits
5			of supporting developers from this source code or any supporting source code
6			which is considered copyrighted (c) material of the original comment or credit authors.
7
8			This program is distributed in the hope that it will be useful,
9			but WITHOUT ANY WARRANTY; without even the implied warranty of
10			MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
11			*/
12			/**
13			* tdmcreate module.
14			*
15			* @copyright The XOOPS Project http://sourceforge.net/projects/xoops/
16			* @license GNU GPL 2 (http://www.gnu.org/licenses/old-licenses/gpl-2.0.html)
17			*
18			* @since 2.5.0
19			*
20			* @author Txmod Xoops http://www.txmodxoops.org
21			*
22			* @version $Id: UserVisit.php 12258 2014-01-02 09:33:29Z timgno \$
23			*/
24			defined('XOOPS_ROOT_PATH') \|\| die('Restricted access');
25
26			/**
27			* Class UserVisit.
28			*/
29			class UserVisit extends TDMCreateFile
			0 ignored issues – show Coding Style Compatibility introduced 2015-12-23 22:08 UTC by Report Bug Copy Issue Report PSR1 recommends that each class must be in a namespace of at least one level to avoid collisions. You can fix this by adding a namespace to your class: namespace YourVendor; class YourClass { } When choosing a vendor namespace, try to pick something that is not too generic to avoid conflicts with other libraries. Loading history...
30			{
31			/*
32			* @public function constructor
33			* @param null
34			*/
35			/**
36			*
37			*/
38			public function __construct()
39			{
40			parent::__construct();
41			$this->xoopscode = TDMCreateXoopsCode::getInstance();
			0 ignored issues – show Bug introduced 2016-01-28 16:29 UTC by Report Bug Copy Issue Report The property `xoopscode` does not exist. Did you maybe forget to declare it? In PHP it is possible to write to properties without declaring them. For example, the following is perfectly valid PHP code: class MyClass { } $x = new MyClass(); $x->foo = true; Generally, it is a good practice to explictly declare properties to avoid accidental typos and provide IDE auto-completion: class MyClass { public $foo; } $x = new MyClass(); $x->foo = true; Loading history...
42			$this->phpcode = TDMCreatePhpCode::getInstance();
			0 ignored issues – show Bug introduced 2016-01-28 16:29 UTC by Report Bug Copy Issue Report The property `phpcode` does not exist. Did you maybe forget to declare it? In PHP it is possible to write to properties without declaring them. For example, the following is perfectly valid PHP code: class MyClass { } $x = new MyClass(); $x->foo = true; Generally, it is a good practice to explictly declare properties to avoid accidental typos and provide IDE auto-completion: class MyClass { public $foo; } $x = new MyClass(); $x->foo = true; Loading history...
43			$this->usercode = UserXoopsCode::getInstance();
			0 ignored issues – show Bug introduced 2016-01-28 16:29 UTC by Report Bug Copy Issue Report The property `usercode` does not exist. Did you maybe forget to declare it? In PHP it is possible to write to properties without declaring them. For example, the following is perfectly valid PHP code: class MyClass { } $x = new MyClass(); $x->foo = true; Generally, it is a good practice to explictly declare properties to avoid accidental typos and provide IDE auto-completion: class MyClass { public $foo; } $x = new MyClass(); $x->foo = true; Loading history...
44			}
45
46			/*
47			* @static function &getInstance
48			* @param null
49			*/
50			/**
51			* @return UserVisit
52			*/
53			public static function &getInstance()
54			{
55			static $instance = false;
56			if (!$instance) {
57			$instance = new self();
58			}
59
60			return $instance;
61			}
62
63			/*
64			* @public function write
65			* @param string $module
66			* @param mixed $table
67			* @param string $filename
68			*/
69			/**
70			* @param $module
71			* @param $table
72			* @param $filename
73			*/
74			public function write($module, $table, $filename)
75			{
76			$this->setModule($module);
77			$this->setTable($table);
78			$this->setFileName($filename);
79			}
80
81			/**
82			* @private function getUserVisitHeader
83			*
84			* @param $table
85			*
86			* @return string
87			*/
88			private function getUserVisitHeader($table, $fields)
89			{
90			$ret = $this->getInclude();
91			foreach (array_keys($fields) as $f) {
92			$fieldName = $fields[$f]->getVar('field_name');
93			if (0 == $f) {
94			$fieldId = $fieldName;
95			}
96			if (1 == $fields[$f]->getVar('field_parent')) {
97			$fieldPid = $fieldName;
98			}
99			}
100			if ($table->getVar('table_category') == 1) {
101			$ccFieldPid = $this->getCamelCase($fieldPid, false, true);
			0 ignored issues – show Bug introduced 2016-01-28 16:29 UTC by Report Bug Copy Issue Report The variable `$fieldPid` 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...
102			$ret .= $this->xoopscode->getXoopsCodeXoopsRequest("{$ccFieldPid}", "{$fieldPid}", '0', 'Int');
103			}
104			$ccFieldId = $this->getCamelCase($fieldId, false, true);
			0 ignored issues – show Bug introduced 2016-01-28 16:29 UTC by Report Bug Copy Issue Report The variable `$fieldId` 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...
105			$ret .= $this->xoopscode->getXoopsCodeXoopsRequest("{$ccFieldId}", "{$fieldId}", '0', 'Int');
106
107			return $ret;
108			}
109
110			/**
111			* @private function getUserVisitCheckPermissions
112			*
113			* @param null
114			*
115			* @return string
116			*/
117			private function getUserVisitCheckPermissions()
118			{
119			$ret = '';
120
121			return $ret;
122			}
123
124			/**
125			* @private function getUserVisitCheckLimit
126			*
127			* @param null
128			*
129			* @return string
130			*/
131			private function getUserVisitCheckLimit()
132			{
133			$ret = '';
134
135			return $ret;
136			}
137
138			/**
139			* @private function getUserVisitCheckHost
140			*
141			* @param null
142			*
143			* @return string
144			*/
145			private function getUserVisitCheckHost()
146			{
147			$ret = '';
148
149			return $ret;
150			}
151
152			/*
153			* @public function render
154			* @param null
155			*/
156			/**
157			* @return bool\|string
158			*/
159			public function render()
160			{
161			$module = $this->getModule();
162			$table = $this->getTable();
163			$filename = $this->getFileName();
164			$moduleDirname = $module->getVar('mod_dirname');
165			$tableId = $table->getVar('table_id');
166			$tableMid = $table->getVar('table_mid');
167			$tableName = $table->getVar('table_name');
			0 ignored issues – show Unused Code introduced 2016-01-28 16:29 UTC by Report Bug Copy Issue Report `$tableName` is not used, you could remove the assignment. This check looks for variable assignements that are either overwritten by other assignments or where the variable is not used subsequently. $myVar = 'Value'; $higher = false; if (rand(1, 6) > 3) { $higher = true; } else { $higher = false; } Both the `$myVar` assignment in line 1 and the `$higher` assignment in line 2 are dead. The first because `$myVar` is never used and the second because `$higher` is always overwritten for every possible time line. Loading history...
168			$tableSoleName = $table->getVar('table_solename');
			0 ignored issues – show Unused Code introduced 2016-01-28 16:29 UTC by Report Bug Copy Issue Report `$tableSoleName` is not used, you could remove the assignment. This check looks for variable assignements that are either overwritten by other assignments or where the variable is not used subsequently. $myVar = 'Value'; $higher = false; if (rand(1, 6) > 3) { $higher = true; } else { $higher = false; } Both the `$myVar` assignment in line 1 and the `$higher` assignment in line 2 are dead. The first because `$myVar` is never used and the second because `$higher` is always overwritten for every possible time line. Loading history...
169			$fields = $this->getTableFields($tableMid, $tableId);
170			$language = $this->getLanguage($moduleDirname, 'MA');
			0 ignored issues – show Unused Code introduced 2016-01-28 16:29 UTC by Report Bug Copy Issue Report `$language` is not used, you could remove the assignment. This check looks for variable assignements that are either overwritten by other assignments or where the variable is not used subsequently. $myVar = 'Value'; $higher = false; if (rand(1, 6) > 3) { $higher = true; } else { $higher = false; } Both the `$myVar` assignment in line 1 and the `$higher` assignment in line 2 are dead. The first because `$myVar` is never used and the second because `$higher` is always overwritten for every possible time line. Loading history...
171			$content = $this->getHeaderFilesComments($module, $filename);
172			$content .= $this->getUserVisitHeader($table, $fields);
173			$content .= $this->getUserVisitCheckPermissions();
174			$content .= $this->getUserVisitCheckLimit();
175			$content .= $this->getUserVisitCheckHost();
176
177			$this->create($moduleDirname, '/', $filename, $content, _AM_TDMCREATE_FILE_CREATED, _AM_TDMCREATE_FILE_NOTCREATED);
			0 ignored issues – show Documentation introduced 2016-01-28 16:29 UTC by Report Bug Copy Issue Report `_AM_TDMCREATE_FILE_CREATED` is of type `string`, but the function expects a `boolean`. It seems like the type of the argument is not accepted by the function/method which you are calling. In some cases, in particular if PHP’s automatic type-juggling kicks in this might be fine. In other cases, however this might be a bug. We suggest to add an explicit type cast like in the following example: function acceptsInteger($int) { } $x = '123'; // string "123" // Instead of acceptsInteger($x); // we recommend to use acceptsInteger((integer) $x); Loading history... Documentation introduced 2016-01-28 16:29 UTC by Report Bug Copy Issue Report `_AM_TDMCREATE_FILE_NOTCREATED` is of type `string`, but the function expects a `boolean`. It seems like the type of the argument is not accepted by the function/method which you are calling. In some cases, in particular if PHP’s automatic type-juggling kicks in this might be fine. In other cases, however this might be a bug. We suggest to add an explicit type cast like in the following example: function acceptsInteger($int) { } $x = '123'; // string "123" // Instead of acceptsInteger($x); // we recommend to use acceptsInteger((integer) $x); Loading history...
178
179			return $this->renderFile();
180			}
181			}
182

txmodxoops / tdmcreate

Pull Request — master (#51)

UserVisit::getUserVisitHeader() B

Complexity

Size

Duplication

Available Fixes

Available Fixes

Duplication Side-by-Side

Filter issues like