smtech / canvashack

classes/CanvasAPIviaLTI_Installer.php

Doc Comments +2 added lines, -2 removed lines

@@ -20,7 +20,7 @@ 
 	/**
 	 * Generate a SECRETS_FILE from user input.
 	 *
-	 * @param scalar $step optional Where are we in the SECRETS_FILE creation workflow? (defaults to SECRETS_NEEDED_STEP -- the beginning)
+	 * @param integer $step optional Where are we in the SECRETS_FILE creation workflow? (defaults to SECRETS_NEEDED_STEP -- the beginning)
 	 *
 	 * @throws CanvasAPIviaLTI_Installer_Exception If form submission does not contain all required MySQL credentals (host, username, password and database)
 	 * @throws CanvasAPIviaLTI_Installer_Exception If SECRETS_FILE cannot be created
@@ -261,7 +261,7 @@ 
 	/**
 	 * Obtain a Canvas API token, if needed.
 	 *
-	 * @param scalar $step optional Where are we in the API token negotiation workflow? (defaults to API_DECISION_NEEDED_STEP -- the beginning)
+	 * @param integer $step optional Where are we in the API token negotiation workflow? (defaults to API_DECISION_NEEDED_STEP -- the beginning)
 	 * @param boolean $skip optional Skip this step (defaults to FALSE)
 	 *
 	 * @throws CanvasAPIviaLTI_Installer_Exception If $step is not a pre-defined *_STEP constant

Spacing +2 added lines, -2 removed lines

@@ -96,7 +96,7 @@ 
 						}
 						
 						$htaccessFile = __DIR__ . '/.htaccess';
-						if(!file_put_contents($htaccessFile, "AuthType Basic\nAuthName \"{$secrets->app->name} Admin\"\nAuthUserFile $htpasswdFile\nRequire valid-user\n")) {
+						if (!file_put_contents($htaccessFile, "AuthType Basic\nAuthName \"{$secrets->app->name} Admin\"\nAuthUserFile $htpasswdFile\nRequire valid-user\n")) {
 							throw new CanvasAPIviaLTI_Installer_Exception(
 								"Failed to create $htaccessFile",
 								CanvasAPIviaLTI_Installer_Exception::HTACCESS_FILE
@@ -154,7 +154,7 @@ 
 		} elseif (file_exists($ltiSchema)) {
 			$queries = explode(";", file_get_contents($ltiSchema));
 			$created = true;
-			foreach($queries as $query) {
+			foreach ($queries as $query) {
 				if (!empty(trim($query))) {
 					if (!$sql->query($query)) {
 						throw new CanvasAPIviaLTI_Installer_Exception(

classes/CanvasHack.php

Doc Comments +18 added lines

@@ -26,6 +26,9 @@ 
 	private $abstract = null;
 	private $description = null;
 	
+	/**
+	 * @param \mysqli $sql
+	 */
 	public function __construct($sql, $path) {
 
 		if ($sql instanceof \mysqli) {
@@ -98,6 +101,9 @@ 
 		}
 	}
 	
+	/**
+	 * @param string $manifest
+	 */
 	private function parseManifest($manifest) {
 		$xml = simplexml_load_string(file_get_contents($manifest));
 		if ($xml === false) {
@@ -111,6 +117,9 @@ 
 		$this->parseManifestComponents($xml->components);
 	}
 	
+	/**
+	 * @param \SimpleXMLElement $xml
+	 */
 	private function parseManifestMetadata($xml) {
 		$this->required('id', $this->sql->real_escape_string($xml->id));
 		$this->required('name', $xml->name);
@@ -247,6 +256,9 @@ 
 		$this->parseManifestCanvas($components->canvas);
 	}
 	
+	/**
+	 * @param string $field
+	 */
 	private function required($field, $value) {
 		if (!empty($value)) {
 			$this->$field = (string) $value;
@@ -258,6 +270,9 @@ 
 		}
 	}
 	
+	/**
+	 * @param string $field
+	 */
 	private function optional($field, $value) {
 		if (isset($value)) {
 			$this->$field = (string) $value;
@@ -360,6 +375,9 @@ 
 		}
 	}
 	
+	/**
+	 * @param string $table
+	 */
 	private function clearDb($table, $id, $idKey = 'canvashack') {
 		if (!$this->sql->query("
 			DELETE FROM `$table`

Spacing +6 added lines, -8 removed lines

@@ -128,13 +128,11 @@ 
 		$_name = $this->sql->real_escape_string($this->name);
 		$_abstract = (
 			isset($this->abstract) ?
-				$this->sql->real_escape_string($this->abstract) :
-				$this->sql->real_escape_string($this->description)
+				$this->sql->real_escape_string($this->abstract) : $this->sql->real_escape_string($this->description)
 		);
 		$_description = (
 			isset($this->description) ?
-				$this->sql->real_escape_string($this->description) :
-				$this->sql->real_escape_string($this->abstract)
+				$this->sql->real_escape_string($this->description) : $this->sql->real_escape_string($this->abstract)
 		);
 		$_path = $this->sql->real_escape_string($this->path);
 		
@@ -160,7 +158,7 @@ 
 	private function parseManifestCanvasPages($pages) {
 		$this->clearDb($this->pages, $this->id);
 		if (!empty($pages->include)) {
-			foreach($pages->include->children() as $page) {
+			foreach ($pages->include->children() as $page) {
 				if (!$this->sql->query("
 					INSERT INTO `{$this->pages}`
 					(
@@ -183,7 +181,7 @@ 
 			}
 		}
 		if (!empty($pages->exclude)) {
-			foreach($pages->exclude->children() as $page) {
+			foreach ($pages->exclude->children() as $page) {
 				if (!$this->sql->query("
 					INSERT INTO `{$this->pages}`
 					(
@@ -211,7 +209,7 @@ 
 	private function parseManifestCanvasDOM($dom) {
 		$this->clearDb($this->dom, $this->id);
 		if (!empty($dom)) {
-			foreach($dom->children() as $bundle) {
+			foreach ($dom->children() as $bundle) {
 				if (!$this->sql->query("
 					INSERT INTO `{$this->dom}`
 					(
@@ -327,7 +325,7 @@ 
 		");
 		
 		$params = array();
-		foreach($fields as $field => $value) {
+		foreach ($fields as $field => $value) {
 			$params[] = "`$field` = '$value'";
 		}
 		

classes/UserAPIToken.php

Doc Comments +2 added lines, -2 removed lines

@@ -91,7 +91,7 @@ 
 	}
 	
 	/**
-	 * @return string|boolean The API access token for this user, or FALSE if no token has been acquired
+	 * @return string|false The API access token for this user, or FALSE if no token has been acquired
 	 **/
 	public function getToken() {
 		if ($this->token) {
@@ -133,7 +133,7 @@ 
 	}
 	
 	/**
-	 * @return string|boolean The URL of the API for which the user's API token is valid, or FALSE if no token has been acquired
+	 * @return string|false The URL of the API for which the user's API token is valid, or FALSE if no token has been acquired
 	 **/
 	function getAPIUrl() {
 		if ($this->apiUrl) {

Spacing +1 added lines, -1 removed lines

@@ -116,7 +116,7 @@
 				UserAPIToken_Exception::TOKEN_REQUIRED
 			);
 		}
-		if($this->consumerKey && $this->id && $this->sql) {
+		if ($this->consumerKey && $this->id && $this->sql) {
 			$_token = $this->sql->real_escape_string($token);
 			if (!$this->sql->query("UPDATE `" . self::USER_TOKENS_TABLE . "` set `token` = '$_token' WHERE `consumer_key` = '{$this->consumerKey}' AND `id` = '{$this->id}'")) {
 				throw new UserAPIToken_Exception(

app.php

Spacing +3 added lines, -3 removed lines

@@ -8,7 +8,7 @@ 
 
 if (isset($_REQUEST['hack'])) {
 	while (list($id, $setting) = each($_REQUEST['hack'])) {
-		try{
+		try {
 
 			$hack = CanvasHack::getCanvasHackById($sql, $id);
 			if ($setting === 'enable') {
@@ -24,13 +24,13 @@ 
 
 $hacksContents = scandir(realpath(__DIR__ . '/hacks'), SCANDIR_SORT_ASCENDING);
 $hacks = array();
-foreach($hacksContents as $item) {
+foreach ($hacksContents as $item) {
 	if (is_dir($path = realpath(__DIR__ . "/hacks/$item")) && file_exists($manifest = "$path/manifest.xml")) {
 		try {
 			$hacks[$item] = new CanvasHack($sql, $path);
 		} catch (CanvasHack_Exception $e) {
 			$smarty->addMessage(
-				'CanvasHack Manifest Error ['. $e->getCode() . ']',
+				'CanvasHack Manifest Error [' . $e->getCode() . ']',
 				$e->getMessage(),
 				NotificationMessage::ERROR
 			);

admin/install.php

Spacing +1 added lines, -1 removed lines

@@ -15,7 +15,7 @@
 	
 /* ...otherwise, let's start with the SECRETS_FILE */
 } else {
-	if(!file_exists(SECRETS_FILE)) {
+	if (!file_exists(SECRETS_FILE)) {
 		if (isset($_REQUEST['step']) && $_REQUEST['step'] == CanvasAPIviaLTI_Installer::SECRETS_ENTERED_STEP) {
 			CanvasAPIviaLTI_Installer::createSecretsFile(CanvasAPIviaLTI_Installer::SECRETS_ENTERED_STEP);
 		} else {

admin/consumers.php

Braces +3 added lines, -2 removed lines

@@ -47,10 +47,11 @@
 /* look up consumer to edit, if requested */
 } elseif (isset($_REQUEST['consumer_key'])) {
 	$consumer = new LTI_Tool_Consumer($_REQUEST['consumer_key'], LTI_Data_Connector::getDataConnector($sql));
-	if (isset($_REQUEST['action']))
-		switch ($_REQUEST['action']) {
+	if (isset($_REQUEST['action'])) {
+			switch ($_REQUEST['action']) {
 			case 'delete': {
 				$consumer->delete();
+	}
 				break;
 			}
 			case 'select': {

canvashack-loader.js.php

Indentation +1 added lines, -1 removed lines

@@ -5,7 +5,7 @@
 header('Content-Type: application/javascript');
 
 if (!empty($_REQUEST['download'])) {
-    header("Content-Disposition: attachment; filename=canvashack-loader.js");
+	header("Content-Disposition: attachment; filename=canvashack-loader.js");
 }
 
 ?>

hacks/common.inc.php

Spacing +1 added lines, -1 removed lines

@@ -1,6 +1,6 @@
 <?php
 
-define ('IGNORE_LTI', true);
+define('IGNORE_LTI', true);
 
 require_once(__DIR__ . '/../common.inc.php');
 

classes/CanvasAPIviaLTI.php

Indentation +10 added lines, -10 removed lines

@@ -18,12 +18,12 @@ 
 		if ($this->user->isAdmin()) {
 			
 			/* set up any needed session variables */
-	        $_SESSION['consumer_key'] = $this->consumer->getKey();
-	        $_SESSION['resource_id'] = $this->resource_link->getId();
-	        $_SESSION['user_consumer_key'] = $this->user->getResourceLink()->getConsumer()->getKey();
-	        $_SESSION['user_id'] = $this->user->getId();
-	        $_SESSION['isStudent'] = $this->user->isLearner();
-	        $_SESSION['isContentItem'] = FALSE;	   
+			$_SESSION['consumer_key'] = $this->consumer->getKey();
+			$_SESSION['resource_id'] = $this->resource_link->getId();
+			$_SESSION['user_consumer_key'] = $this->user->getResourceLink()->getConsumer()->getKey();
+			$_SESSION['user_id'] = $this->user->getId();
+			$_SESSION['isStudent'] = $this->user->isLearner();
+			$_SESSION['isContentItem'] = FALSE;	   
 			
 			/* do we have an admin API access token? */
 			$haveToken = true;
@@ -52,10 +52,10 @@ 
 			}
 			$_SESSION['apiUrl'] = 'https://' . $this->user->getResourceLink()->settings['custom_canvas_api_domain'] . '/api/v1';
 			
-	        /* pass control off to the app */
-	        if ($haveToken) {
-		        $this->redirectURL = "{$metadata['APP_URL']}/app.php?lti-request=launch";
-	        }
+			/* pass control off to the app */
+			if ($haveToken) {
+				$this->redirectURL = "{$metadata['APP_URL']}/app.php?lti-request=launch";
+			}
 
 		/* ...otherwise set an appropriate error message and fail */
 		} else {