create-courses.php ➔ generateSisId() - Code Metrics - smtech/canvas-management - Measure and Improve Code Quality continuously with Scrutinizer

create-courses.php ➔ generateSisId() A
last analyzed 2017-06-08 12:57 UTC

↳ Parent: Project

Complexity

Conditions	2
Paths	1

Size

Total Lines	6
Code Lines	4

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
cc	2
eloc	4
nc	1
nop	1
dl	0
loc	6
rs	9.4285
c	0
b	0
f	0

<?php

require_once __DIR__ . '/common.inc.php';

use Battis\DataUtilities;
use Battis\BootstrapSmarty\NotificationMessage;

$MANUALLY_CREATED_COURSES_ACCOUNT = 96;
$DEFAULT_TERM = 195;

/**
 * Generate a unique SIS ID
 *
 * @param string $name
 *
 * @return string
 **/
function generateSisId($name)
// 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);
    }
}
{
    return strtolower(preg_replace('/[^a-z0-9\-]+/i', '-', $_REQUEST['prefix'] .
        $name . $_REQUEST['suffix']) . (empty($_REQUEST['unique']) ? '' : '.' .
        md5(time())));
}

define('STEP_INSTRUCTIONS', 1);
define('STEP_RESULT', 2);

$step = (empty($_REQUEST['step']) ? STEP_INSTRUCTIONS : $_REQUEST['step']);

switch ($step) {
    case STEP_RESULT:
        // TODO use $toolbox->explodeNewLines()

        $courses = array();
        $courseNames = explode("\n", $_REQUEST['courses']);
        foreach ($courseNames as $name) {
            if (!empty(trim($name))) {
                $courses[]['long_name'] = trim($name);
            }
        }

        if (empty($_REQUEST['account'])) {
            $toolbox->smarty_addMessage(
                'Account',
                'was not selected, defaulting to the <a target=\"_parent\" href="' . $_SESSION[CANVAS_INSTANCE_URL] . '/accounts/' . $MANUALLY_CREATED_COURSES_ACCOUNT . '">Manually-Created Courses</a> account.',
                NotificationMessage::WARNING
            );
            $account = $MANUALLY_CREATED_COURSES_ACCOUNT;
        } else {
            $account = $_REQUEST['account'];
        }

        if (empty($_REQUEST['term'])) {
            $toolbox->smarty_addMessage(
                'Term',
                'was not selected, defaulting to the Default Term.',
                NotificationMessage::WARNING
            );
            $term = $DEFAULT_TERM;
        } else {
            $term = $_REQUEST['term'];
        }

        $templated = false;
        if (empty($_REQUEST['template'])) {

            $toolbox->smarty_addMessage(
                'Template',
                'was not entered, courses are in default configuration.'
            );
        } else {
            $templated = true;
            $template = (is_int($_REQUEST['template']) ? $_REQUEST['template'] : "sis_course_id:{$_REQUEST['template']}");

            /* pull course settings as completely as possible */
            try {
                $source = $toolbox->api_get("courses/$template/settings");
                $source = array_merge(
                    $source->getArrayCopy(),
                    $toolbox->api_get("courses/$template")->getArrayCopy()
                );

                /* save ID and name to create a nice link later */
                $sourceId = $source['id'];
                $sourceName = $source['name'];

                /* clear settings that are provided form entry */
                unset($source['id']);
                unset($source['sis_course_id']);
                unset($source['integration_id']);
                unset($source['name']);
                unset($source['course_code']);
                unset($source['account_id']);
                unset($source['enrollment_term_id']);
                unset($source['start_at']);
                unset($source['end_at']);
                unset($source['enrollments']);

                /* why nest this, I mean... really? */
                $source = array('course' => $source);

                /* pull course navigation */
                $tabs = $toolbox->api_get("courses/$template/tabs", [
                    'include[]' => 'external'
                ]);
                $navigation = [];
                foreach ($tabs as $tab) {
                    if ($tab['id'] != 'home' && $tab['id'] != 'settings') {
                        $navigation[$tab['id']] = $tab;
                    }
                }
                uasort($navigation, function ($left, $right) {
                    return $left['position'] - $right['position'];
                });
            } catch (Exception $e) {
                $toolbox->exceptionErrorMessage($e);
            }
        }

        $csv = DataUtilities::loadCsvToArray('csv');
        if ($csv) {
            $courses = array_merge($courses, $csv);
        }

        if (!empty($courses)) {
            foreach ($courses as $course) {
                /* build parameter list */
                $params = array();

                if (!empty($course['course_id'])) {
                    $params['sis_course_id'] = $course['course_id'];
                } else {
                    $params['sis_course_id'] = generateSisId((empty($course['course_id']) ? $course['long_name'] : $course['course_id']));
                }

                if (!empty($course['long_name'])) {
                    $params['name'] = $course['long_name'];
                }

                if (!empty($course['short_name'])) {

                    $params['course_code'] = $course['short_name'];
                } elseif (!empty($params['name'])) {
                    $params['course_code'] = $params['name'];
                }

                if (!empty($course['account_id'])) {
                    $_account = "sis_account_id:{$course['account_id']}";
                } else {
                    $_account = $account;
                }

                if (!empty($course['term_id'])) {

                    $params['term_id'] = "sis_term_id:{$course['term_id']}";
                } elseif (!empty($term)) {
                    $params['term_id'] = $term;
                }

                if (!empty($course['start_at'])) {
                    $params['start_at'] = $course['start_at'];
                }

                if (!empty($course['end_at'])) {
                    $params['end_at'] = $course['end_at'];
                }

                /* create course */
                try {
                    $course = $toolbox->api_post(
                        "accounts/$_account/courses",
                        array(
                            'course' => $params
                        )
                    );

                    if ($templated) {
                        /* duplicate course settings */
                        $toolbox->api_put("/courses/{$course['id']}", $source);

                        /* duplicate course navigation */
                        foreach ($navigation as $id => $tab) {

                            $toolbox->api_put(
                                "courses/{$course['id']}/tabs/$id",
                                [
                                    'position' => $tab['position'],
                                    'visibility' => $tab['visibility']
                                ]
                            );
                        }

                        /* duplicate course content */
                        $migration = $toolbox->api_post(
                            "courses/{$course['id']}/content_migrations",
                            array(
                                'migration_type' => 'course_copy_importer',
                                'settings[source_course_id]' => $template
                            )
                        );

                        $toolbox->smarty_addMessage(
                            "<a target=\"_parent\" href=\"{$_SESSION[CANVAS_INSTANCE_URL]}/courses/{$course['id']}\">{$course['name']}</a>",
                            "has been created as a clone of <a target=\"_parent\" href=\"{$_SESSION[CANVAS_INSTANCE_URL]}/courses/$sourceId\">$sourceName</a>. Course content is being <a target=\"_parent\" href=\"{$_SESSION[CANVAS_INSTANCE_URL]}/courses/{$course['id']}/content_migrations\">migrated</a> right now.",
                            NotificationMessage::GOOD

                        );
                    } else {

                        $toolbox->smarty_addMessage(
                            "<a target=\"_parent\" href=\"{$_SESSION[CANVAS_INSTANCE_URL]}/courses/{$course['id']}\">{$course['name']}</a>",
                            "has been created.",
                            NotificationMessage::GOOD

                        );
                    }
                } catch (Exception $e) {
                    $toolbox->exceptionErrorMessage($e);
                }
            }
        } else {
            $toolbox->smarty_addMessage(
                'Courses',
                'No course names were entered',
                NotificationMessage::ERROR

            );
        }

        /* flow into STEP_INSTRUCTIONS */

    case STEP_INSTRUCTIONS:
    default:
        $toolbox->smarty_assign('accounts', $toolbox->getAccountList());
        $toolbox->smarty_assign('terms', $toolbox->getTermList());

        $toolbox->smarty_assign('formHidden', array('step' => STEP_RESULT));
        $toolbox->smarty_display(basename(__FILE__, '.php') . '/instructions.tpl');
}


1		<?php
2
3		require_once __DIR__ . '/common.inc.php';
4
5		use Battis\DataUtilities;
6		use Battis\BootstrapSmarty\NotificationMessage;
7
8		$MANUALLY_CREATED_COURSES_ACCOUNT = 96;
9		$DEFAULT_TERM = 195;
10
11		/**
12		* Generate a unique SIS ID
13		*
14		* @param string $name
15		*
16		* @return string
17		**/
18		function generateSisId($name)
		0 ignored issues – show Coding Style introduced 2016-08-22 18:53 UTC by Report Bug Copy Issue Report `generateSisId` uses the super-global variable `$_REQUEST` 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...
19		{
20		return strtolower(preg_replace('/[^a-z0-9\-]+/i', '-', $_REQUEST['prefix'] .
21		$name . $_REQUEST['suffix']) . (empty($_REQUEST['unique']) ? '' : '.' .
22		md5(time())));
23		}
24
25		define('STEP_INSTRUCTIONS', 1);
26		define('STEP_RESULT', 2);
27
28		$step = (empty($_REQUEST['step']) ? STEP_INSTRUCTIONS : $_REQUEST['step']);
29
30		switch ($step) {
31		case STEP_RESULT:
32		// TODO use $toolbox->explodeNewLines()
		0 ignored issues – show Unused Code Comprehensibility introduced 2016-08-22 18:53 UTC by Report Bug Copy Issue Report `50%` 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...
33		$courses = array();
34		$courseNames = explode("\n", $_REQUEST['courses']);
35		foreach ($courseNames as $name) {
36		if (!empty(trim($name))) {
37		$courses[]['long_name'] = trim($name);
38		}
39		}
40
41		if (empty($_REQUEST['account'])) {
42		$toolbox->smarty_addMessage(
43		'Account',
44		'was not selected, defaulting to the <a target=\"_parent\" href="' . $_SESSION[CANVAS_INSTANCE_URL] . '/accounts/' . $MANUALLY_CREATED_COURSES_ACCOUNT . '">Manually-Created Courses</a> account.',
45		NotificationMessage::WARNING
46		);
47		$account = $MANUALLY_CREATED_COURSES_ACCOUNT;
48		} else {
49		$account = $_REQUEST['account'];
50		}
51
52		if (empty($_REQUEST['term'])) {
53		$toolbox->smarty_addMessage(
54		'Term',
55		'was not selected, defaulting to the Default Term.',
56		NotificationMessage::WARNING
57		);
58		$term = $DEFAULT_TERM;
59		} else {
60		$term = $_REQUEST['term'];
61		}
62
63		$templated = false;
64	View Code Duplication	if (empty($_REQUEST['template'])) {
		0 ignored issues – show Duplication introduced 2016-08-22 18:53 UTC by Report Bug Copy Issue Report This code seems to be duplicated across your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
65		$toolbox->smarty_addMessage(
66		'Template',
67		'was not entered, courses are in default configuration.'
68		);
69		} else {
70		$templated = true;
71		$template = (is_int($_REQUEST['template']) ? $_REQUEST['template'] : "sis_course_id:{$_REQUEST['template']}");
72
73		/* pull course settings as completely as possible */
74		try {
75		$source = $toolbox->api_get("courses/$template/settings");
76		$source = array_merge(
77		$source->getArrayCopy(),
78		$toolbox->api_get("courses/$template")->getArrayCopy()
79		);
80
81		/* save ID and name to create a nice link later */
82		$sourceId = $source['id'];
83		$sourceName = $source['name'];
84
85		/* clear settings that are provided form entry */
86		unset($source['id']);
87		unset($source['sis_course_id']);
88		unset($source['integration_id']);
89		unset($source['name']);
90		unset($source['course_code']);
91		unset($source['account_id']);
92		unset($source['enrollment_term_id']);
93		unset($source['start_at']);
94		unset($source['end_at']);
95		unset($source['enrollments']);
96
97		/* why nest this, I mean... really? */
98		$source = array('course' => $source);
99
100		/* pull course navigation */
101		$tabs = $toolbox->api_get("courses/$template/tabs", [
102		'include[]' => 'external'
103		]);
104		$navigation = [];
105		foreach ($tabs as $tab) {
106		if ($tab['id'] != 'home' && $tab['id'] != 'settings') {
107		$navigation[$tab['id']] = $tab;
108		}
109		}
110		uasort($navigation, function ($left, $right) {
111		return $left['position'] - $right['position'];
112		});
113		} catch (Exception $e) {
114		$toolbox->exceptionErrorMessage($e);
115		}
116		}
117
118		$csv = DataUtilities::loadCsvToArray('csv');
119		if ($csv) {
120		$courses = array_merge($courses, $csv);
121		}
122
123		if (!empty($courses)) {
124		foreach ($courses as $course) {
125		/* build parameter list */
126		$params = array();
127
128		if (!empty($course['course_id'])) {
129		$params['sis_course_id'] = $course['course_id'];
130		} else {
131		$params['sis_course_id'] = generateSisId((empty($course['course_id']) ? $course['long_name'] : $course['course_id']));
132		}
133
134		if (!empty($course['long_name'])) {
135		$params['name'] = $course['long_name'];
136		}
137
138	View Code Duplication	if (!empty($course['short_name'])) {
		0 ignored issues – show Duplication introduced 2016-08-22 18:53 UTC by Report Bug Copy Issue Report This code seems to be duplicated across your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
139		$params['course_code'] = $course['short_name'];
140		} elseif (!empty($params['name'])) {
141		$params['course_code'] = $params['name'];
142		}
143
144		if (!empty($course['account_id'])) {
145		$_account = "sis_account_id:{$course['account_id']}";
146		} else {
147		$_account = $account;
148		}
149
150	View Code Duplication	if (!empty($course['term_id'])) {
		0 ignored issues – show Duplication introduced 2016-08-22 18:53 UTC by Report Bug Copy Issue Report This code seems to be duplicated across your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
151		$params['term_id'] = "sis_term_id:{$course['term_id']}";
152		} elseif (!empty($term)) {
153		$params['term_id'] = $term;
154		}
155
156		if (!empty($course['start_at'])) {
157		$params['start_at'] = $course['start_at'];
158		}
159
160		if (!empty($course['end_at'])) {
161		$params['end_at'] = $course['end_at'];
162		}
163
164		/* create course */
165		try {
166		$course = $toolbox->api_post(
167		"accounts/$_account/courses",
168		array(
169		'course' => $params
170		)
171		);
172
173		if ($templated) {
174		/* duplicate course settings */
175		$toolbox->api_put("/courses/{$course['id']}", $source);
176
177		/* duplicate course navigation */
178	View Code Duplication	foreach ($navigation as $id => $tab) {
		0 ignored issues – show Duplication introduced 2017-06-08 12:57 UTC by Report Bug Copy Issue Report This code seems to be duplicated across your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
179		$toolbox->api_put(
180		"courses/{$course['id']}/tabs/$id",
181		[
182		'position' => $tab['position'],
183		'visibility' => $tab['visibility']
184		]
185		);
186		}
187
188		/* duplicate course content */
189		$migration = $toolbox->api_post(
190		"courses/{$course['id']}/content_migrations",
191		array(
192		'migration_type' => 'course_copy_importer',
193		'settings[source_course_id]' => $template
194		)
195		);
196
197		$toolbox->smarty_addMessage(
198		"<a target=\"_parent\" href=\"{$_SESSION[CANVAS_INSTANCE_URL]}/courses/{$course['id']}\">{$course['name']}</a>",
199		"has been created as a clone of <a target=\"_parent\" href=\"{$_SESSION[CANVAS_INSTANCE_URL]}/courses/$sourceId\">$sourceName</a>. Course content is being <a target=\"_parent\" href=\"{$_SESSION[CANVAS_INSTANCE_URL]}/courses/{$course['id']}/content_migrations\">migrated</a> right now.",
200		NotificationMessage::GOOD
		0 ignored issues – show Deprecated Code introduced 2016-08-22 18:53 UTC by Report Bug Copy Issue Report The constant `Battis\BootstrapSmarty\NotificationMessage::GOOD` has been deprecated with message: Use `SUCCESS` instead for consistency with Bootstrap This class constant has been deprecated. The supplier of the class has supplied an explanatory message. The explanatory message should give you some clue as to whether and when the constant will be removed from the class and what other constant to use instead. Loading history...
201		);
202	View Code Duplication	} else {
		0 ignored issues – show Duplication introduced 2016-08-22 18:53 UTC by Report Bug Copy Issue Report This code seems to be duplicated across your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
203		$toolbox->smarty_addMessage(
204		"<a target=\"_parent\" href=\"{$_SESSION[CANVAS_INSTANCE_URL]}/courses/{$course['id']}\">{$course['name']}</a>",
205		"has been created.",
206		NotificationMessage::GOOD
		0 ignored issues – show Deprecated Code introduced 2016-08-22 18:53 UTC by Report Bug Copy Issue Report The constant `Battis\BootstrapSmarty\NotificationMessage::GOOD` has been deprecated with message: Use `SUCCESS` instead for consistency with Bootstrap This class constant has been deprecated. The supplier of the class has supplied an explanatory message. The explanatory message should give you some clue as to whether and when the constant will be removed from the class and what other constant to use instead. Loading history...
207		);
208		}
209		} catch (Exception $e) {
210		$toolbox->exceptionErrorMessage($e);
211		}
212		}
213		} else {
214		$toolbox->smarty_addMessage(
215		'Courses',
216		'No course names were entered',
217		NotificationMessage::ERROR
		0 ignored issues – show Deprecated Code introduced 2016-08-22 18:53 UTC by Report Bug Copy Issue Report The constant `Battis\BootstrapSmarty\NotificationMessage::ERROR` has been deprecated with message: Use `DANGER` instead for consistency with Bootstrap This class constant has been deprecated. The supplier of the class has supplied an explanatory message. The explanatory message should give you some clue as to whether and when the constant will be removed from the class and what other constant to use instead. Loading history...
218		);
219		}
220
221		/* flow into STEP_INSTRUCTIONS */
222
223		case STEP_INSTRUCTIONS:
224		default:
225		$toolbox->smarty_assign('accounts', $toolbox->getAccountList());
226		$toolbox->smarty_assign('terms', $toolbox->getTermList());
227
228		$toolbox->smarty_assign('formHidden', array('step' => STEP_RESULT));
229		$toolbox->smarty_display(basename(__FILE__, '.php') . '/instructions.tpl');
230		}
231

smtech / canvas-management

create-courses.php ➔ generateSisId() A last analyzed 2017-06-08 12:57 UTC

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like

create-courses.php ➔ generateSisId() A
last analyzed 2017-06-08 12:57 UTC