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

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`

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) {