Issues in common.inc.php - New Issues - Inspection of "Automatically build navbar" - smtech/canvas-management - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 64dc55...56ac70 )

by Seth

created 2017-05-24 16:44 UTC

common.inc.php (1 issue)

Labels

Bug 1

Severity

Minor 1

Upgrade to new PHP Analysis Engine

These results are based on our legacy PHP analysis, consider migrating to our new PHP analysis engine instead. Learn more

<?php

$requestApiDomain = (empty($_REQUEST['custom_canvas_api_domain']) ? false : $_REQUEST['custom_canvas_api_domain']);

require_once __DIR__ . '/vendor/autoload.php';
require_once __DIR__ . '/constants.inc.php';

use smtech\CanvasManagement\Toolbox;
use smtech\ReflexiveCanvasLTI\LTI\ToolProvider;
use Battis\DataUtilities;

@session_start(); // TODO suppressing warnings is wrong

/* prepare the toolbox */
if (empty($_SESSION[Toolbox::class])) {
    $_SESSION[Toolbox::class] = Toolbox::fromConfiguration(CONFIG_FILE);
}
$toolbox =& $_SESSION[Toolbox::class];

/* set the Tool Consumer's instance URL, if present */
if (empty($_SESSION[CANVAS_INSTANCE_URL])) {
    if (!empty($requestApiDomain)) {
        $_SESSION[CANVAS_INSTANCE_URL] = "https://{$requestApiDomain}";
    } elseif (!empty($_SESSION[ToolProvider::class]['canvas']['api_domain'])) {
        $_SESSION[CANVAS_INSTANCE_URL] = 'https://' . $_SESSION[ToolProvider::class]['canvas']['api_domain'];
    } else {
        $toolbox->log('Could not detect CANVAS_INSTANCE_URL');
        $_SESSION[CANVAS_INSTANCE_URL] = 'https://example.com';
    }
}

/* cache per-instance */
$toolbox->cache_pushKey(parse_url($_SESSION[CANVAS_INSTANCE_URL], PHP_URL_HOST));

/* Configure smarty templating */
/* FIXME this is sometimes superfluous overhead (e.g. action=config) */
$toolbox->smarty_prependTemplateDir(__DIR__ . '/templates', basename(__DIR__));
$toolbox->getSmarty()->addStylesheet(
    DataUtilities::URLfromPath(__DIR__ . '/css/canvas-management.css'),
    basename(__DIR__)
);

$toolbox->smarty_assign([
    'title' => $toolbox->config('TOOL_NAME'),
    'category' => DataUtilities::titleCase(preg_replace('/[\-_]+/', ' ', basename(__DIR__))),
    'APP_URL' => $toolbox->config('APP_URL'),
    'CANVAS_INSTANCE_URL' => $_SESSION[CANVAS_INSTANCE_URL],
    'navbarActive' => basename(dirname($_SERVER['REQUEST_URI'])),
    'menuItems' => $toolbox->buildMenu(__DIR__, [
abstract class User
{
    /** @return string */
    abstract public function getPassword();
}

class MyUser extends User
{
    public function getPassword()
    {
        // return something
    }

    public function getDisplayName()
    {
        // return some name.
    }
}

class AuthSystem
{
    public function authenticate(User $user)
    {
        $this->logger->info(sprintf('Authenticating %s.', $user->getDisplayName()));
        // do something.
    }
}
        '.git',
        'build',
        'css',
        'docs',
        'examples',
        'images',
        'js',
        'logs',
        'node_modules',
        'src',
        'templates',
        'tests',
        'vendor'
    ])
]);


Push — master ( 64dc55...56ac70 )

common.inc.php (1 issue)

Labels

Severity

Introduced By

Upgrade to new PHP Analysis Engine

Available Fixes

1			<?php
2
3			$requestApiDomain = (empty($_REQUEST['custom_canvas_api_domain']) ? false : $_REQUEST['custom_canvas_api_domain']);
4
5			require_once __DIR__ . '/vendor/autoload.php';
6			require_once __DIR__ . '/constants.inc.php';
7
8			use smtech\CanvasManagement\Toolbox;
9			use smtech\ReflexiveCanvasLTI\LTI\ToolProvider;
10			use Battis\DataUtilities;
11
12			@session_start(); // TODO suppressing warnings is wrong
13
14			/* prepare the toolbox */
15			if (empty($_SESSION[Toolbox::class])) {
16			$_SESSION[Toolbox::class] = Toolbox::fromConfiguration(CONFIG_FILE);
17			}
18			$toolbox =& $_SESSION[Toolbox::class];
19
20			/* set the Tool Consumer's instance URL, if present */
21			if (empty($_SESSION[CANVAS_INSTANCE_URL])) {
22			if (!empty($requestApiDomain)) {
23			$_SESSION[CANVAS_INSTANCE_URL] = "https://{$requestApiDomain}";
24			} elseif (!empty($_SESSION[ToolProvider::class]['canvas']['api_domain'])) {
25			$_SESSION[CANVAS_INSTANCE_URL] = 'https://' . $_SESSION[ToolProvider::class]['canvas']['api_domain'];
26			} else {
27			$toolbox->log('Could not detect CANVAS_INSTANCE_URL');
28			$_SESSION[CANVAS_INSTANCE_URL] = 'https://example.com';
29			}
30			}
31
32			/* cache per-instance */
33			$toolbox->cache_pushKey(parse_url($_SESSION[CANVAS_INSTANCE_URL], PHP_URL_HOST));
34
35			/* Configure smarty templating */
36			/* FIXME this is sometimes superfluous overhead (e.g. action=config) */
37			$toolbox->smarty_prependTemplateDir(__DIR__ . '/templates', basename(__DIR__));
38			$toolbox->getSmarty()->addStylesheet(
39			DataUtilities::URLfromPath(__DIR__ . '/css/canvas-management.css'),
40			basename(__DIR__)
41			);
42
43			$toolbox->smarty_assign([
44			'title' => $toolbox->config('TOOL_NAME'),
45			'category' => DataUtilities::titleCase(preg_replace('/[\-_]+/', ' ', basename(__DIR__))),
46			'APP_URL' => $toolbox->config('APP_URL'),
47			'CANVAS_INSTANCE_URL' => $_SESSION[CANVAS_INSTANCE_URL],
48			'navbarActive' => basename(dirname($_SERVER['REQUEST_URI'])),
49			'menuItems' => $toolbox->buildMenu(__DIR__, [
			0 ignored issues – show Bug introduced 2017-05-24 16:47 UTC by Report Bug Copy Issue Report Show Similar Issues like this It seems like you code against a specific sub-type and not the parent class `smtech\ReflexiveCanvasLTI\Toolbox` as the method `buildMenu()` does only exist in the following sub-classes of `smtech\ReflexiveCanvasLTI\Toolbox`: `smtech\CanvasManagement\Toolbox`. Maybe you want to `instanceof` check for one of these explicitly? Let’s take a look at an example: abstract class User { /** @return string / abstract public function getPassword(); } class MyUser extends User { public function getPassword() { // return something } public function getDisplayName() { // return some name. } } class AuthSystem { public function authenticate(User $user) { $this->logger->info(sprintf('Authenticating %s.', $user->getDisplayName())); // do something. } } In the above example, the authenticate() method works fine as long as you just pass instances of MyUser. However, if you now also want to pass a different sub-classes of User which does not have a getDisplayName() method, the code will break. Available Fixes Change the type-hint for the parameter: class AuthSystem { public function authenticate(MyUser $user) { / ... / } } Add an additional type-check: class AuthSystem { public function authenticate(User $user) { if ($user instanceof MyUser) { $this->logger->info(/* ... /); } // or alternatively if ( ! $user instanceof MyUser) { throw new \LogicException( '$user must be an instance of MyUser, ' .'other instances are not supported.' ); } } } Note:* PHP Analyzer uses reverse abstract interpretation to narrow down the types inside the if block in such a case. Add the method to the parent class: abstract class User { /** @return string / abstract public function getPassword(); /* @return string */ abstract public function getDisplayName(); } Loading history...
50			'.git',
51			'build',
52			'css',
53			'docs',
54			'examples',
55			'images',
56			'js',
57			'logs',
58			'node_modules',
59			'src',
60			'templates',
61			'tests',
62			'vendor'
63			])
64			]);
65

smtech / canvas-management

Push — master ( 64dc55...56ac70 )

common.inc.php (1 issue)

Labels

Severity

Introduced By

Upgrade to new PHP Analysis Engine

Available Fixes

Duplication Side-by-Side

Filter issues like