Toolbox::isAcademic() - Code Metrics - Inspection of "PSR-2 compliance improvements" - smtech/advisor-dashboard - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — develop ( 79e117...34fa42 )

by Seth

created 2017-05-31 13:31 UTC

Toolbox::isAcademic() B

↳ Parent: Toolbox

Complexity

Conditions	5
Paths	4

Size

Total Lines	13
Code Lines	9

Duplication

Lines	0
Ratio	0 %

Importance

Changes	1
Bugs	0	Features	0

Metric	Value
cc	5
eloc	9
c	1
b	0
f	0
nc	4
nop	1
dl	0
loc	13
rs	8.8571

<?php

namespace smtech\AdvisorDashboard;

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

/**
 * Advisor Dashboard toolbox
 *
 * Adds some common, useful methods to the St. Mark's-styled
 * ReflexiveCanvasLTI Toolbox
 *
 * @author  Seth Battis <[email protected]>
 * @version v1.2
 */
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',
            'admins'
        );
        $this->generator->setOptionProperty(
            Option::ACCOUNT_NAVIGATION(),
            'visibility',
            'admins'
        );

        return $this->generator;
    }

    /**
     * Get a listing of all accounts organized for presentation in a select picker
     *
     * @return array
     **/
    public function getAccountList()
    {
        $cache = new HierarchicalSimpleCache($this->getMySQL(), __CLASS__);

        $accounts = $cache->getCache('accounts');
        if ($accounts === false) {
            $accountsResponse = $this->api_get(
                'accounts/1/sub_accounts',
                [
                    'recursive' => 'true'
                ]
            );
            $accounts = [];
            foreach ($accountsResponse as $account) {
$collection = json_decode($data, true);
if ( ! is_array($collection)) {
    throw new \RuntimeException('$collection must be an array.');
}

foreach ($collection as $item) { /** ... */ }
                $accounts[$account['id']] = $account;
            }
            $cache->setCache('accounts', $accounts);
        }

        return $accounts;
    }

    /**
     * Get a listing of all terms organized for presentation in a select picker
     *
     * @return array
     **/
    public function getTermList()
    {
        $cache = new HierarchicalSimpleCache($this->getMySQL(), __CLASS__);

        $terms = $cache->getCache('terms');
        if ($terms === false) {
            $_terms = $this->api_get(
                'accounts/1/terms',
                [
                    'workflow_state' => 'active'
                ]
            );
            $termsResponse = $_terms['enrollment_terms'];
            $terms = [];
            foreach ($termsResponse as $term) {
                $terms[$term['id']] = $term;
            }
            $cache->setCache('terms', $terms);
        }

        return $terms;
    }

    /**
     * @param array $arr
     * @param string|integer $key
     * @return string `$arr[$key]` if present, `''` otherwise
     */
    public function blank($arr, $key)
    {
        if (empty($arr[$key])) {
            return '';
        } else {
            return $arr[$key];
        }
    }

    /**
     * @param integer $account Canvas account ID
     * @return boolean `TRUE` if the account is a child of the Academics
     *                        account, `FALSE` otherwise
     */
    public function isAcademic($account)
    {
        if ($account == 132) { // FIXME really, hard-coded values? Really?
            return true;
        } elseif ($account == 1 || !is_integer($account)) {
            return false;
        } else {
            if (empty($this->accounts)) {
                $this->accounts = $this->getAccountList();
class MyClass { }

$x = new MyClass();
$x->foo = true;
            }
            return isAcademic($this->accounts[$account]['parent_account_id']);
        }
    }
}


1			<?php
2
3			namespace smtech\AdvisorDashboard;
4
5			use smtech\LTI\Configuration\Option;
6			use Battis\HierarchicalSimpleCache;
7
8			/**
9			* Advisor Dashboard 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			* @version v1.2
16			*/
17			class Toolbox extends \smtech\StMarksReflexiveCanvasLTI\Toolbox
18			{
19
20			/**
21			* Configure course and account navigation placements
22			*
23			* @return Generator
24			*/
25			public function getGenerator()
26			{
27			parent::getGenerator();
28
29			$this->generator->setOptionProperty(
30			Option::COURSE_NAVIGATION(),
31			'visibility',
32			'admins'
33			);
34			$this->generator->setOptionProperty(
35			Option::ACCOUNT_NAVIGATION(),
36			'visibility',
37			'admins'
38			);
39
40			return $this->generator;
41			}
42
43			/**
44			* Get a listing of all accounts organized for presentation in a select picker
45			*
46			* @return array
47			**/
48			public function getAccountList()
49			{
50			$cache = new HierarchicalSimpleCache($this->getMySQL(), __CLASS__);
51
52			$accounts = $cache->getCache('accounts');
53			if ($accounts === false) {
54			$accountsResponse = $this->api_get(
55			'accounts/1/sub_accounts',
56			[
57			'recursive' => 'true'
58			]
59			);
60			$accounts = [];
61			foreach ($accountsResponse as $account) {
			0 ignored issues – show Bug introduced 2016-08-18 13:17 UTC by Report Bug Copy Issue Report The expression `$accountsResponse` of type `object<smtech\CanvasPest...CanvasPest\CanvasArray>` is not guaranteed to be traversable. How about adding an additional type check? There are different options of fixing this problem. If you want to be on the safe side, you can add an additional type-check: $collection = json_decode($data, true); if ( ! is_array($collection)) { throw new \RuntimeException('$collection must be an array.'); } foreach ($collection as $item) { /** ... / } If you are sure that the expression is traversable, you might want to add a doc comment cast* to improve IDE auto-completion and static analysis: /** @var array $collection / $collection = json_decode($data, true); foreach ($collection as $item) { /* .. / } Mark the issue as a false-positive*: Just hover the remove button, in the top-right corner of this issue for more options. Loading history...
62			$accounts[$account['id']] = $account;
63			}
64			$cache->setCache('accounts', $accounts);
65			}
66
67			return $accounts;
68			}
69
70			/**
71			* Get a listing of all terms organized for presentation in a select picker
72			*
73			* @return array
74			**/
75			public function getTermList()
76			{
77			$cache = new HierarchicalSimpleCache($this->getMySQL(), __CLASS__);
78
79			$terms = $cache->getCache('terms');
80			if ($terms === false) {
81			$_terms = $this->api_get(
82			'accounts/1/terms',
83			[
84			'workflow_state' => 'active'
85			]
86			);
87			$termsResponse = $_terms['enrollment_terms'];
88			$terms = [];
89			foreach ($termsResponse as $term) {
90			$terms[$term['id']] = $term;
91			}
92			$cache->setCache('terms', $terms);
93			}
94
95			return $terms;
96			}
97
98			/**
99			* @param array $arr
100			* @param string\|integer $key
101			* @return string `$arr[$key]` if present, `''` otherwise
102			*/
103			public function blank($arr, $key)
104			{
105			if (empty($arr[$key])) {
106			return '';
107			} else {
108			return $arr[$key];
109			}
110			}
111
112			/**
113			* @param integer $account Canvas account ID
114			* @return boolean `TRUE` if the account is a child of the Academics
115			* account, `FALSE` otherwise
116			*/
117			public function isAcademic($account)
118			{
119			if ($account == 132) { // FIXME really, hard-coded values? Really?
120			return true;
121			} elseif ($account == 1 \|\| !is_integer($account)) {
122			return false;
123			} else {
124			if (empty($this->accounts)) {
125			$this->accounts = $this->getAccountList();
			0 ignored issues – show Bug introduced 2017-05-31 13:33 UTC by Report Bug Copy Issue Report The property `accounts` 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...
126			}
127			return isAcademic($this->accounts[$account]['parent_account_id']);
128			}
129			}
130			}
131

smtech / advisor-dashboard

Push — develop ( 79e117...34fa42 )

Toolbox::isAcademic() B

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like