Issues in Toolbox.php - New Issues - Inspection of "PSR-2 tidying" - smtech/see-all-submissions - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 91af7f...6afa24 )

by Seth

created 2017-03-27 12:50 UTC

src/Toolbox.php (1 issue)

Labels

Coding Style 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

namespace smtech\SeeAllSubmissions;

use smtech\LTI\Configuration\Option;
use Battis\HierarchicalSimpleCache;

/**
 * See All Submissions toolbox
 *
 * Adds some common, useful methods to the St. Mark's-styled
 * ReflexiveCanvasLTI Toolbox
 *
 * @author  Seth Battis <[email protected]>
 */
class Toolbox extends \smtech\StMarksReflexiveCanvasLTI\Toolbox
{

    /**
     * Configure course and account navigation placements
     *
     * @return Generator
     */
    public function getGenerator()
    {
        parent::getGenerator();

        $this->generator->setOptionProperty(
            Option::COURSE_NAVIGATION(),
            'visibility',
            'members'
        );

        return $this->generator;
    }

    /**
     * This is a quasi temporary "unborking" while a few support tickets are
     * working through the queue. See the fix-me notations below.
     *
     * @param string $previewUrl
     * @return string
     */
    public function unborkPreviewUrl($previewUrl)
// 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);
    }
}
    {
        if (!preg_match('%^https?://.*%', $previewUrl)) {
            /*
             * FIXME: per [case 01584858 ](https://cases.canvaslms.com/CommunityConsole?id=500A000000UPwauIAD)
             * attachments are not well-documented and the Crocodoc attachments
             * include an incomplete preview URL that works… but not in an IFRAME
             */
            return $_SESSION[CANVAS_INSTANCE_URL] . $previewUrl;
        } elseif (preg_match('%^(.*version=)(\d+)(.*)$%', $previewUrl, $match)) {
            /*
             * FIXME: per [case 01584819](https://cases.canvaslms.com/CommunityConsole?id=500A000000UPwSlIAL)
             * preview URLs are generated "off by one" and are really zero-indexed.
             */
            return $match[1] . ($match[2] - 1) . $match[3];
        } else {
            /* whatevs, it is what it is… */
            return $previewUrl;
        }
    }
}


1			<?php
2
3			namespace smtech\SeeAllSubmissions;
4
5			use smtech\LTI\Configuration\Option;
6			use Battis\HierarchicalSimpleCache;
7
8			/**
9			* See All Submissions toolbox
10			*
11			* Adds some common, useful methods to the St. Mark's-styled
12			* ReflexiveCanvasLTI Toolbox
13			*
14			* @author Seth Battis <[email protected]>
15			*/
16			class Toolbox extends \smtech\StMarksReflexiveCanvasLTI\Toolbox
17			{
18
19			/**
20			* Configure course and account navigation placements
21			*
22			* @return Generator
23			*/
24			public function getGenerator()
25			{
26			parent::getGenerator();
27
28			$this->generator->setOptionProperty(
29			Option::COURSE_NAVIGATION(),
30			'visibility',
31			'members'
32			);
33
34			return $this->generator;
35			}
36
37			/**
38			* This is a quasi temporary "unborking" while a few support tickets are
39			* working through the queue. See the fix-me notations below.
40			*
41			* @param string $previewUrl
42			* @return string
43			*/
44			public function unborkPreviewUrl($previewUrl)
			0 ignored issues – show Coding Style introduced 2017-03-27 12:54 UTC by Report Bug Copy Issue Report Show Similar Issues like this `unborkPreviewUrl` uses the super-global variable `$_SESSION` 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...
45			{
46			if (!preg_match('%^https?://.*%', $previewUrl)) {
47			/*
48			* FIXME: per [case 01584858 ](https://cases.canvaslms.com/CommunityConsole?id=500A000000UPwauIAD)
49			* attachments are not well-documented and the Crocodoc attachments
50			* include an incomplete preview URL that works… but not in an IFRAME
51			*/
52			return $_SESSION[CANVAS_INSTANCE_URL] . $previewUrl;
53			} elseif (preg_match('%^(.version=)(\d+)(.)$%', $previewUrl, $match)) {
54			/*
55			* FIXME: per [case 01584819](https://cases.canvaslms.com/CommunityConsole?id=500A000000UPwSlIAL)
56			* preview URLs are generated "off by one" and are really zero-indexed.
57			*/
58			return $match[1] . ($match[2] - 1) . $match[3];
59			} else {
60			/* whatevs, it is what it is… */
61			return $previewUrl;
62			}
63			}
64			}
65

smtech / see-all-submissions

Push — master ( 91af7f...6afa24 )

src/Toolbox.php (1 issue)

Labels

Severity

Introduced By

Upgrade to new PHP Analysis Engine

Duplication Side-by-Side

Filter issues like