views.php ➔ editRandomquoteBlockViews() - Code Metrics - Inspection of "namespaces, category" - mambax7/randomquote - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 171474...8d265e )

by Michael

created 2018-01-01 13:50 UTC

views.php ➔ editRandomquoteBlockViews() A

↳ Parent: Project

Complexity

Conditions	1
Paths	1

Size

Total Lines	23
Code Lines	16

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
cc	1
eloc	16
nc	1
nop	1
dl	0
loc	23
rs	9.0856
c	0
b	0
f	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.
 */

/**
 * Module: RandomQuote
 *
 * @category        Module
 * @package         randomquote
 * @author          XOOPS Module Development Team
 * @author          Mamba
 * @copyright       {@link https://xoops.org 2001-2016 XOOPS Project}
 * @license         {@link http://www.fsf.org/copyleft/gpl.html GNU public license}
 * @link            https://xoops.org XOOPS
 * @since           2.00
 */

use Xoopsmodules\randomquote;
.
|-- OtherDir
|   |-- Bar.php
|   `-- Foo.php
`-- SomeDir
    `-- Foo.php

$moduleDirName = basename(dirname(__DIR__));
require_once $GLOBALS['xoops']->path("/modules/{$moduleDirName}/class/Constants.php");
//require_once XOOPS_ROOT_PATH . '/modules/' . $moduleDirName . '/class/Utility.php';

/**
 *
 * Show a random quote in a block
 *
 * @param array    {
 * @param string   [0] block type
 * @param int      [1] number of quotes to display
 *                 }
 *
 * @return array {
 *                 array {
 * @param string   [quote]
 * @param string   [author]
 */

function showRandomquoteBlockViews($options)
// Bad
class Router
{
    public function generate($path)
    {
        return $_SERVER['HOST'].$path;
    }
}

// Better
class Router
{
    private $host;

    public function __construct($host)
    {
        $this->host = $host;
    }

    public function generate($path)
    {
        return $this->host.$path;
    }
}

class Controller
{
    public function myAction(Request $request)
    {
        // Instead of
        $page = isset($_GET['page']) ? intval($_GET['page']) : 1;

        // Better (assuming you use the Symfony2 request)
        $page = $request->query->get('page', 1);
    }
}
{
    $moduleDirName = basename(dirname(__DIR__));
$myVar = 'Value';
$higher = false;

if (rand(1, 6) > 3) {
    $higher = true;
} else {
    $higher = false;
}
    //    require_once XOOPS_ROOT_PATH . '/modules/randomquote/class/quotes.php';
    $utility = new randomquote\Utility();

    $quotes       = [];
    $type_block   = $options[0];
    $nb_quotes    = $options[1];
    $length_title = (int)$options[2];

    $quotesHandler = new randomquote\QuotesHandler($GLOBALS['xoopsDB']);
    $criteria      = new CriteriaCompo();
    array_shift($options);
    array_shift($options);
    array_shift($options);

    switch ($type_block) {
        // for block: quotes recent
        case 'recent':
            $criteria->add(new Criteria('online', 1));
            //            $criteria->setSort("quotes_date_created");

            $criteria->setSort('id');
            $criteria->setOrder('DESC');
            break;
        // for block: quotes today's
        case 'day':
            $criteria->add(new Criteria('online', 1));
            //            $criteria->add(new Criteria("quotes_date_created", strtotime(date("Y/m/d")), ">="));

            //            $criteria->add(new Criteria("quotes_date_created", strtotime(date("Y/m/d")) + 86400, "<="));

            //            $criteria->setSort("quotes_date_created");

            $criteria->setOrder('ASC');
            $criteria->setSort('RAND()');
            break;
        // for block: quotes random
        case 'random':
            $criteria->add(new Criteria('online', 1));
            $criteria->setSort('RAND()');
            break;
    }

    $criteria->setLimit($nb_quotes);
    $quoteObjsArray = $quotesHandler->getAll($criteria);
    foreach ($quoteObjsArray as $thisQuote) {
        if ($length_title > 0) {
            //            $short_quote = xoops_substr($thisQuote->getVar('quote'), 0, $length_title, $trimmarker = '...');

            $short_quote = $utility::truncateHtml($thisQuote->getVar('quote'), $length_title, $ending = '...', $exact = false, $considerHtml = true);
        } else {
            $short_quote = $thisQuote->getVar('quote');
        }
        $quotes[] = [
            'quote'  => $short_quote,
            'author' => $thisQuote->getVar('author')
        ];
    }

    return $quotes;
}

/**
 * @param array $options Preferences config array
 *
 * @return string HTML form to edit module options
 */
function editRandomquoteBlockViews($options)
{
    $quotes_arr = [];
$myVar = 'Value';
$higher = false;

if (rand(1, 6) > 3) {
    $higher = true;
} else {
    $higher = false;
}
    $form       = ''
                  . _MB_RANDOMQUOTE_QUOTES_DISPLAY
                  . "\n"
                  . "<input type='hidden' name='options[0]' value='{$options[0]}'>\n"
                  . "<input type='text' name='options[1]' value='{$options[1]}' size='3' maxlength='4'>&nbsp;<br>\n"
                  . ''
                  . _MB_RANDOMQUOTE_QUOTES_SHORTEN
                  . " <input type='text' name='options[2]' value='{$options[2]}' size='3' maxlength='5'' min='0'>"
                  . _MB_RANDOMQUOTE_QUOTES_CHARACTERS
                  . '<br><br>';

    //    $form .= '' . _MB_XNEWSLETTER_LETTER_TITLELENGTH
    //             . " : <input name=\"options[2]\" size=\"5\" maxlength=\"255\" value=\"" . $options[2] . "\" type=\"text\"><br><br>";


    array_shift($options);
    array_shift($options);
    array_shift($options);

    return $form;
}


1			<?php
			0 ignored issues – show Coding Style Compatibility introduced 2016-05-30 19:13 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 47 and the first side effect is on line 28. 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			You may not change or alter any portion of this comment or credits of
4			supporting developers from this source code or any supporting source code
5			which is considered copyrighted (c) material of the original comment or credit
6			authors.
7
8			This program is distributed in the hope that it will be useful, but
9			WITHOUT ANY WARRANTY; without even the implied warranty of
10			MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
11			*/
12
13			/**
14			* Module: RandomQuote
15			*
16			* @category Module
17			* @package randomquote
18			* @author XOOPS Module Development Team
19			* @author Mamba
20			* @copyright {@link https://xoops.org 2001-2016 XOOPS Project}
21			* @license {@link http://www.fsf.org/copyleft/gpl.html GNU public license}
22			* @link https://xoops.org XOOPS
23			* @since 2.00
24			*/
25
26			use Xoopsmodules\randomquote;
			0 ignored issues – show Bug introduced 2018-01-01 13:52 UTC by Report Bug Copy Issue Report This use statement conflicts with another class in this namespace, `randomquote`. Let’s assume that you have a directory layout like this: . \|-- OtherDir \| \|-- Bar.php \| `-- Foo.php `-- SomeDir `-- Foo.php and let’s assume the following content of `Bar.php`: // Bar.php namespace OtherDir; use SomeDir\Foo; // This now conflicts the class OtherDir\Foo If both files `OtherDir/Foo.php` and `SomeDir/Foo.php` are loaded in the same runtime, you will see a PHP error such as the following: PHP Fatal error: Cannot use SomeDir\Foo as Foo because the name is already in use in OtherDir/Foo.php However, as `OtherDir/Foo.php` does not necessarily have to be loaded and the error is only triggered if it is loaded before `OtherDir/Bar.php`, this problem might go unnoticed for a while. In order to prevent this error from surfacing, you must import the namespace with a different alias: // Bar.php namespace OtherDir; use SomeDir\Foo as SomeDirFoo; // There is no conflict anymore. Loading history...
27
28			$moduleDirName = basename(dirname(__DIR__));
29			require_once $GLOBALS['xoops']->path("/modules/{$moduleDirName}/class/Constants.php");
30			//require_once XOOPS_ROOT_PATH . '/modules/' . $moduleDirName . '/class/Utility.php';
31
32			/**
33			*
34			* Show a random quote in a block
35			*
36			* @param array {
37			* @param string [0] block type
38			* @param int [1] number of quotes to display
39			* }
40			*
41			* @return array {
42			* array {
43			* @param string [quote]
44			* @param string [author]
45			*/
46
47			function showRandomquoteBlockViews($options)
			0 ignored issues – show Coding Style introduced 2018-01-01 13:52 UTC by Report Bug Copy Issue Report `showRandomquoteBlockViews` uses the super-global variable `$GLOBALS` which is generally not recommended. Instead of super-globals, we recommend to explicitly inject the dependencies of your class. This makes your code less dependent on global state and it becomes generally more testable: // Bad class Router { public function generate($path) { return $_SERVER['HOST'].$path; } } // Better class Router { private $host; public function __construct($host) { $this->host = $host; } public function generate($path) { return $this->host.$path; } } class Controller { public function myAction(Request $request) { // Instead of $page = isset($_GET['page']) ? intval($_GET['page']) : 1; // Better (assuming you use the Symfony2 request) $page = $request->query->get('page', 1); } } Loading history...
48			{
49			$moduleDirName = basename(dirname(__DIR__));
			0 ignored issues – show Unused Code introduced 2018-01-01 13:52 UTC by Report Bug Copy Issue Report `$moduleDirName` 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...
50			// require_once XOOPS_ROOT_PATH . '/modules/randomquote/class/quotes.php';
51			$utility = new randomquote\Utility();
52
53			$quotes = [];
54			$type_block = $options[0];
55			$nb_quotes = $options[1];
56			$length_title = (int)$options[2];
57
58			$quotesHandler = new randomquote\QuotesHandler($GLOBALS['xoopsDB']);
59			$criteria = new CriteriaCompo();
60			array_shift($options);
61			array_shift($options);
62			array_shift($options);
63
64			switch ($type_block) {
65			// for block: quotes recent
66			case 'recent':
67			$criteria->add(new Criteria('online', 1));
68			// $criteria->setSort("quotes_date_created");
			0 ignored issues – show Unused Code Comprehensibility introduced 2016-04-17 06:14 UTC by Report Bug Copy Issue Report `75%` of this comment could be valid code. Did you maybe forget this after debugging? Sometimes obsolete code just ends up commented out instead of removed. In this case it is better to remove the code once you have checked you do not need it. The code might also have been commented out for debugging purposes. In this case it is vital that someone uncomments it again or your project may behave in very unexpected ways in production. This check looks for comments that seem to be mostly valid code and reports them. Loading history...
69			$criteria->setSort('id');
70			$criteria->setOrder('DESC');
71			break;
72			// for block: quotes today's
73			case 'day':
74			$criteria->add(new Criteria('online', 1));
75			// $criteria->add(new Criteria("quotes_date_created", strtotime(date("Y/m/d")), ">="));
			0 ignored issues – show Unused Code Comprehensibility introduced 2016-04-17 06:14 UTC by Report Bug Copy Issue Report `68%` of this comment could be valid code. Did you maybe forget this after debugging? Sometimes obsolete code just ends up commented out instead of removed. In this case it is better to remove the code once you have checked you do not need it. The code might also have been commented out for debugging purposes. In this case it is vital that someone uncomments it again or your project may behave in very unexpected ways in production. This check looks for comments that seem to be mostly valid code and reports them. Loading history...
76			// $criteria->add(new Criteria("quotes_date_created", strtotime(date("Y/m/d")) + 86400, "<="));
			0 ignored issues – show Unused Code Comprehensibility introduced 2016-04-17 06:14 UTC by Report Bug Copy Issue Report `63%` of this comment could be valid code. Did you maybe forget this after debugging? Sometimes obsolete code just ends up commented out instead of removed. In this case it is better to remove the code once you have checked you do not need it. The code might also have been commented out for debugging purposes. In this case it is vital that someone uncomments it again or your project may behave in very unexpected ways in production. This check looks for comments that seem to be mostly valid code and reports them. Loading history...
77			// $criteria->setSort("quotes_date_created");
			0 ignored issues – show Unused Code Comprehensibility introduced 2016-04-17 06:14 UTC by Report Bug Copy Issue Report `75%` of this comment could be valid code. Did you maybe forget this after debugging? Sometimes obsolete code just ends up commented out instead of removed. In this case it is better to remove the code once you have checked you do not need it. The code might also have been commented out for debugging purposes. In this case it is vital that someone uncomments it again or your project may behave in very unexpected ways in production. This check looks for comments that seem to be mostly valid code and reports them. Loading history...
78			$criteria->setOrder('ASC');
79			$criteria->setSort('RAND()');
80			break;
81			// for block: quotes random
82			case 'random':
83			$criteria->add(new Criteria('online', 1));
84			$criteria->setSort('RAND()');
85			break;
86			}
87
88			$criteria->setLimit($nb_quotes);
89			$quoteObjsArray = $quotesHandler->getAll($criteria);
90			foreach ($quoteObjsArray as $thisQuote) {
91			if ($length_title > 0) {
92			// $short_quote = xoops_substr($thisQuote->getVar('quote'), 0, $length_title, $trimmarker = '...');
			0 ignored issues – show Unused Code Comprehensibility introduced 2018-01-01 13:52 UTC by Report Bug Copy Issue Report `58%` of this comment could be valid code. Did you maybe forget this after debugging? Sometimes obsolete code just ends up commented out instead of removed. In this case it is better to remove the code once you have checked you do not need it. The code might also have been commented out for debugging purposes. In this case it is vital that someone uncomments it again or your project may behave in very unexpected ways in production. This check looks for comments that seem to be mostly valid code and reports them. Loading history...
93			$short_quote = $utility::truncateHtml($thisQuote->getVar('quote'), $length_title, $ending = '...', $exact = false, $considerHtml = true);
94			} else {
95			$short_quote = $thisQuote->getVar('quote');
96			}
97			$quotes[] = [
98			'quote' => $short_quote,
99			'author' => $thisQuote->getVar('author')
100			];
101			}
102
103			return $quotes;
104			}
105
106			/**
107			* @param array $options Preferences config array
108			*
109			* @return string HTML form to edit module options
110			*/
111			function editRandomquoteBlockViews($options)
112			{
113			$quotes_arr = [];
			0 ignored issues – show Unused Code introduced 2016-05-30 19:13 UTC by Report Bug Copy Issue Report `$quotes_arr` 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...
114			$form = ''
115			. _MB_RANDOMQUOTE_QUOTES_DISPLAY
116			. "\n"
117			. "<input type='hidden' name='options[0]' value='{$options[0]}'>\n"
118			. "<input type='text' name='options[1]' value='{$options[1]}' size='3' maxlength='4'> <br>\n"
119			. ''
120			. _MB_RANDOMQUOTE_QUOTES_SHORTEN
121			. " <input type='text' name='options[2]' value='{$options[2]}' size='3' maxlength='5'' min='0'>"
122			. _MB_RANDOMQUOTE_QUOTES_CHARACTERS
123			. '<br><br>';
124
125			// $form .= '' . _MB_XNEWSLETTER_LETTER_TITLELENGTH
126			// . " : <input name=\"options[2]\" size=\"5\" maxlength=\"255\" value=\"" . $options[2] . "\" type=\"text\"><br><br>";
			0 ignored issues – show Unused Code Comprehensibility introduced 2018-01-01 13:52 UTC by Report Bug Copy Issue Report `60%` of this comment could be valid code. Did you maybe forget this after debugging? Sometimes obsolete code just ends up commented out instead of removed. In this case it is better to remove the code once you have checked you do not need it. The code might also have been commented out for debugging purposes. In this case it is vital that someone uncomments it again or your project may behave in very unexpected ways in production. This check looks for comments that seem to be mostly valid code and reports them. Loading history...
127
128			array_shift($options);
129			array_shift($options);
130			array_shift($options);
131
132			return $form;
133			}
134

mambax7 / randomquote

Push — master ( 171474...8d265e )

views.php ➔ editRandomquoteBlockViews() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like