Toolbox::getGenerator() - Code Metrics - smtech/advisor-dashboard - Measure and Improve Code Quality continuously with Scrutinizer

Toolbox::getGenerator() A
last analyzed 2017-06-05 15:34 UTC

↳ Parent: Toolbox

Complexity

Conditions	1
Paths	1

Size

Total Lines	17
Code Lines	11

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
cc	1
eloc	11
nc	1
nop	0
dl	0
loc	17
rs	9.4285
c	0
b	0
f	0

<?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
{
    /**
     * Store a listing of Canvas accounts for quick access
     * @var \smtech\CanvasPest\CanvasObject[]
     */
    private $accounts;

    /**
     * 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 Id
{
    public $id;

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

}

class Account
{
    /** @var  Id $id */
    public $id;
}

$account_id = false;

if (starsAreRight()) {
    $account_id = new Id(42);
}

$account = new Account();
if ($account instanceof Id)
{
    $account->id = $account_id;
}
            }
            return $this->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			* Store a listing of Canvas accounts for quick access
21			* @var \smtech\CanvasPest\CanvasObject[]
22			*/
23			private $accounts;
24
25			/**
26			* Configure course and account navigation placements
27			*
28			* @return Generator
29			*/
30			public function getGenerator()
31			{
32			parent::getGenerator();
33
34			$this->generator->setOptionProperty(
35			Option::COURSE_NAVIGATION(),
36			'visibility',
37			'admins'
38			);
39			$this->generator->setOptionProperty(
40			Option::ACCOUNT_NAVIGATION(),
41			'visibility',
42			'admins'
43			);
44
45			return $this->generator;
46			}
47
48			/**
49			* Get a listing of all accounts organized for presentation in a select picker
50			*
51			* @return array
52			**/
53			public function getAccountList()
54			{
55			$cache = new HierarchicalSimpleCache($this->getMySQL(), __CLASS__);
56
57			$accounts = $cache->getCache('accounts');
58			if ($accounts === false) {
59			$accountsResponse = $this->api_get(
60			'accounts/1/sub_accounts',
61			[
62			'recursive' => 'true'
63			]
64			);
65			$accounts = [];
66			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...
67			$accounts[$account['id']] = $account;
68			}
69			$cache->setCache('accounts', $accounts);
70			}
71
72			return $accounts;
73			}
74
75			/**
76			* Get a listing of all terms organized for presentation in a select picker
77			*
78			* @return array
79			**/
80			public function getTermList()
81			{
82			$cache = new HierarchicalSimpleCache($this->getMySQL(), __CLASS__);
83
84			$terms = $cache->getCache('terms');
85			if ($terms === false) {
86			$_terms = $this->api_get(
87			'accounts/1/terms',
88			[
89			'workflow_state' => 'active'
90			]
91			);
92			$termsResponse = $_terms['enrollment_terms'];
93			$terms = [];
94			foreach ($termsResponse as $term) {
95			$terms[$term['id']] = $term;
96			}
97			$cache->setCache('terms', $terms);
98			}
99
100			return $terms;
101			}
102
103			/**
104			* @param array $arr
105			* @param string\|integer $key
106			* @return string `$arr[$key]` if present, `''` otherwise
107			*/
108			public function blank($arr, $key)
109			{
110			if (empty($arr[$key])) {
111			return '';
112			} else {
113			return $arr[$key];
114			}
115			}
116
117			/**
118			* @param integer $account Canvas account ID
119			* @return boolean `TRUE` if the account is a child of the Academics
120			* account, `FALSE` otherwise
121			*/
122			public function isAcademic($account)
123			{
124			if ($account == 132) { // FIXME really, hard-coded values? Really?
125			return true;
126			} elseif ($account == 1 \|\| !is_integer($account)) {
127			return false;
128			} else {
129			if (empty($this->accounts)) {
130			$this->accounts = $this->getAccountList();
			0 ignored issues – show Documentation Bug introduced 2017-05-31 19:19 UTC by Report Bug Copy Issue Report It seems like `$this->getAccountList()` can also be of type `boolean`. However, the property `$accounts` is declared as type `array<integer,object<smt...nvasPest\CanvasObject>>`. Maybe add an additional type check? Our type inference engine has found a suspicous assignment of a value to a property. This check raises an issue when a value that can be of a mixed type is assigned to a property that is type hinted more strictly. For example, imagine you have a variable `$accountId` that can either hold an Id object or false (if there is no account id yet). Your code now assigns that value to the `id` property of an instance of the `Account` class. This class holds a proper account, so the id value must no longer be false. Either this assignment is in error or a type check should be added for that assignment. class Id { public $id; public function __construct($id) { $this->id = $id; } } class Account { /** @var Id $id */ public $id; } $account_id = false; if (starsAreRight()) { $account_id = new Id(42); } $account = new Account(); if ($account instanceof Id) { $account->id = $account_id; } Loading history...
131			}
132			return $this->isAcademic($this->accounts[$account]['parent_account_id']);
133			}
134			}
135			}
136

smtech / advisor-dashboard

Toolbox::getGenerator() A last analyzed 2017-06-05 15:34 UTC

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like

Toolbox::getGenerator() A
last analyzed 2017-06-05 15:34 UTC