UserSingle::render() - 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

UserSingle::render() A

↳ Parent: UserSingle

Complexity

Conditions	1
Paths	1

Size

Total Lines	19
Code Lines	16

Duplication

Lines	19
Ratio	100 %

Metric	Value
dl	19
loc	19
rs	9.4285
cc	1
eloc	16
nc	1
nop	0

<?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: UserSingle.php 12258 2014-01-02 09:33:29Z timgno $
 */
defined('XOOPS_ROOT_PATH') || die('Restricted access');

/**
 * Class UserSingle.
 */
class UserSingle 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 UserSingle
     */
    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 getUserSingleHeader
     *
     * @param $moduleDirname
     *
     * @return string
     */
    private function getUserSingleHeader($moduleDirname, $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');
        $ret .= $this->usercode->getUserTplMain($moduleDirname);
        $ret .= $this->phpcode->getPhpCodeIncludeDir('XOOPS_ROOT_PATH', 'header', true);
        $ret .= $this->getCommentLine('Define Stylesheet');
        $ret .= $this->xoopscode->getXoopsCodeAddStylesheet();

        return $ret;
    }

    /*
    *  @public function getAdminPagesList
    *  @param string $tableName
    *  @param string $language
    */
    /**
     * @param $module
     * @param $tableName
     * @param $language
     *
     * @return string
     */
    public function getUserSingle($moduleDirname, $tableName, $language)

    {
        $ret = <<<EOT

EOT;
        $ret .= $this->getSimpleString('$keywords = array();');

        return $ret;
    }

    /**
     * @private function getUserSingleFooter
     *
     * @param $moduleDirname
     * @param $tableName
     * @param $language
     *
     * @return string
     */
    private function getUserSingleFooter($moduleDirname, $tableName, $language)
    {
        $stuModuleDirname = strtoupper($moduleDirname);
        $stuTableName = strtoupper($tableName);
        $ret = $this->getCommentLine('Breadcrumbs');
        $ret .= $this->usercode->getUserBreadcrumbs("{$stuTableName}", $language);
        $ret .= $this->getCommentLine('Keywords');
        $ret .= $this->usercode->getUserMetaKeywords($moduleDirname);
        $ret .= $this->phpcode->getPhpCodeUnset('keywords');
        $ret .= $this->getCommentLine('Description');
        $ret .= $this->usercode->getUserMetaDesc($moduleDirname, 'DESC', $language);
        $ret .= $this->xoopscode->getXoopsCodeTplAssign('xoops_mpageurl', "{$stuModuleDirname}_URL.'/index.php'");
        $ret .= $this->xoopscode->getXoopsCodeTplAssign('xoops_icons32_url', 'XOOPS_ICONS32_URL');
        $ret .= $this->xoopscode->getXoopsCodeTplAssign("{$moduleDirname}_upload_url", "{$stuModuleDirname}_UPLOAD_URL");
        $ret .= $this->getInclude('footer');

        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');
        $fields = $this->getTableFields($tableMid, $tableId);
        $language = $this->getLanguage($moduleDirname, 'MA');
        $content = $this->getHeaderFilesComments($module, $filename);
        $content .= $this->getUserSingleHeader($moduleDirname, $table, $fields);
        $content .= $this->getUserSingle($module, $tableName, $language);
        $content .= $this->getUserSingleFooter($moduleDirname, $tableName, $language);
        $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: UserSingle.php 12258 2014-01-02 09:33:29Z timgno $
23		*/
24		defined('XOOPS_ROOT_PATH') \|\| die('Restricted access');
25
26		/**
27		* Class UserSingle.
28		*/
29	View Code Duplication	class UserSingle extends TDMCreateFile
		0 ignored issues – show Duplication introduced 2015-12-23 22:08 UTC by Report Bug Copy Issue Report This class seems to be duplicated in your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history... 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 UserSingle
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 getUserSingleHeader
83		*
84		* @param $moduleDirname
85		*
86		* @return string
87		*/
88		private function getUserSingleHeader($moduleDirname, $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		$ret .= $this->usercode->getUserTplMain($moduleDirname);
107		$ret .= $this->phpcode->getPhpCodeIncludeDir('XOOPS_ROOT_PATH', 'header', true);
108		$ret .= $this->getCommentLine('Define Stylesheet');
109		$ret .= $this->xoopscode->getXoopsCodeAddStylesheet();
110
111		return $ret;
112		}
113
114		/*
115		* @public function getAdminPagesList
116		* @param string $tableName
117		* @param string $language
118		*/
119		/**
120		* @param $module
121		* @param $tableName
122		* @param $language
123		*
124		* @return string
125		*/
126		public function getUserSingle($moduleDirname, $tableName, $language)
		0 ignored issues – show Unused Code introduced 2016-01-28 16:29 UTC by Report Bug Copy Issue Report The parameter `$moduleDirname` is not used and could be removed. This check looks from parameters that have been defined for a function or method, but which are not used in the method body. Loading history... Unused Code introduced 2016-01-28 16:29 UTC by Report Bug Copy Issue Report The parameter `$tableName` is not used and could be removed. This check looks from parameters that have been defined for a function or method, but which are not used in the method body. Loading history... Unused Code introduced 2016-01-28 16:29 UTC by Report Bug Copy Issue Report The parameter `$language` is not used and could be removed. This check looks from parameters that have been defined for a function or method, but which are not used in the method body. Loading history...
127		{
128		$ret = <<<EOT
129
130		EOT;
131		$ret .= $this->getSimpleString('$keywords = array();');
132
133		return $ret;
134		}
135
136		/**
137		* @private function getUserSingleFooter
138		*
139		* @param $moduleDirname
140		* @param $tableName
141		* @param $language
142		*
143		* @return string
144		*/
145		private function getUserSingleFooter($moduleDirname, $tableName, $language)
146		{
147		$stuModuleDirname = strtoupper($moduleDirname);
148		$stuTableName = strtoupper($tableName);
149		$ret = $this->getCommentLine('Breadcrumbs');
150		$ret .= $this->usercode->getUserBreadcrumbs("{$stuTableName}", $language);
151		$ret .= $this->getCommentLine('Keywords');
152		$ret .= $this->usercode->getUserMetaKeywords($moduleDirname);
153		$ret .= $this->phpcode->getPhpCodeUnset('keywords');
154		$ret .= $this->getCommentLine('Description');
155		$ret .= $this->usercode->getUserMetaDesc($moduleDirname, 'DESC', $language);
156		$ret .= $this->xoopscode->getXoopsCodeTplAssign('xoops_mpageurl', "{$stuModuleDirname}_URL.'/index.php'");
157		$ret .= $this->xoopscode->getXoopsCodeTplAssign('xoops_icons32_url', 'XOOPS_ICONS32_URL');
158		$ret .= $this->xoopscode->getXoopsCodeTplAssign("{$moduleDirname}_upload_url", "{$stuModuleDirname}_UPLOAD_URL");
159		$ret .= $this->getInclude('footer');
160
161		return $ret;
162		}
163
164		/*
165		* @public function render
166		* @param null
167		*/
168		/**
169		* @return bool\|string
170		*/
171		public function render()
172		{
173		$module = $this->getModule();
174		$table = $this->getTable();
175		$filename = $this->getFileName();
176		$moduleDirname = $module->getVar('mod_dirname');
177		$tableId = $table->getVar('table_id');
178		$tableMid = $table->getVar('table_mid');
179		$tableName = $table->getVar('table_name');
180		$fields = $this->getTableFields($tableMid, $tableId);
181		$language = $this->getLanguage($moduleDirname, 'MA');
182		$content = $this->getHeaderFilesComments($module, $filename);
183		$content .= $this->getUserSingleHeader($moduleDirname, $table, $fields);
184		$content .= $this->getUserSingle($module, $tableName, $language);
185		$content .= $this->getUserSingleFooter($moduleDirname, $tableName, $language);
186		$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...
187
188		return $this->renderFile();
189		}
190		}
191

txmodxoops / tdmcreate

Pull Request — master (#51)

UserSingle::render() A

Complexity

Size

Duplication

Available Fixes

Available Fixes

Duplication Side-by-Side

Filter issues like