DakuTree / manga-tracker

application/models/Auth_Model.php

Doc Comments +1 added lines, -1 removed lines

@@ -72,7 +72,7 @@
 
 	/**
 	 * @param string $verificationCode
-	 * @return mixed
+	 * @return string
 	 */
 	public function verification_check(string $verificationCode) {
 		//user is trying to validate their email for signup, check if verification code is still valid/exists

Indentation +3 added lines, -3 removed lines

@@ -77,9 +77,9 @@
 	public function verification_check(string $verificationCode) {
 		//user is trying to validate their email for signup, check if verification code is still valid/exists
 		$query = $this->db->select('email, verification_code_time')
-		                  ->from('auth_signup_verification')
-		                  ->where(array('verification_code' => $verificationCode))
-		                  ->get();
+						  ->from('auth_signup_verification')
+						  ->where(array('verification_code' => $verificationCode))
+						  ->get();
 
 		$return = FALSE;
 		if($query->num_rows() > 0) {

application/models/Tracker_Model.php

Doc Comments +3 added lines

@@ -88,6 +88,9 @@
 		return $arr;
 	}
 
+	/**
+	 * @return string
+	 */
 	public function getSiteDataFromURL(string $site_url) {
 		$query = $this->db->select('id, site_class')
 		                  ->from('tracker_sites')

Indentation +48 added lines, -48 removed lines

@@ -91,9 +91,9 @@ 
 
 	public function getSiteDataFromURL(string $site_url) {
 		$query = $this->db->select('id, site_class')
-		                  ->from('tracker_sites')
-		                  ->where('site', $site_url)
-		                  ->get();
+						  ->from('tracker_sites')
+						  ->where('site', $site_url)
+						  ->get();
 
 		if($query->num_rows() > 0) {
 			$siteData = $query->row();
@@ -104,10 +104,10 @@ 
 
 	public function getTitleID(string $titleURL, int $siteID) {
 		$query = $this->db->select('id')
-		                  ->from('tracker_titles')
-		                  ->where('title_url', $titleURL)
-		                  ->where('site_id', $siteID)
-		                  ->get();
+						  ->from('tracker_titles')
+						  ->where('title_url', $titleURL)
+						  ->where('site_id', $siteID)
+						  ->get();
 
 		if($query->num_rows() > 0) {
 			$titleID = $query->row('id');
@@ -141,14 +141,14 @@ 
 			}
 
 			$idQuery = $this->db->select('id')
-			                    ->where('user_id', $userID)
-			                    ->where('title_id', $titleID)
-			                    ->get('tracker_chapters');
+								->where('user_id', $userID)
+								->where('title_id', $titleID)
+								->get('tracker_chapters');
 			if($idQuery->num_rows() > 0) {
 				$success = (bool) $this->db->set(['current_chapter' => $chapter, 'active' => 'Y', 'last_updated' => NULL])
-				                    ->where('user_id', $userID)
-				                    ->where('title_id', $titleID)
-				                    ->update('tracker_chapters');
+									->where('user_id', $userID)
+									->where('title_id', $titleID)
+									->update('tracker_chapters');
 
 				if($success) {
 					$idQueryRow = $idQuery->row();
@@ -173,9 +173,9 @@ 
 
 	public function updateTrackerByID(int $userID, int $chapterID, string $chapter) : bool {
 		$success = (bool) $this->db->set(['current_chapter' => $chapter, 'active' => 'Y', 'last_updated' => NULL])
-		                    ->where('user_id', $userID)
-		                    ->where('id', $chapterID)
-		                    ->update('tracker_chapters');
+							->where('user_id', $userID)
+							->where('id', $chapterID)
+							->update('tracker_chapters');
 
 		if($success) {
 			$this->History->userUpdateTitle($chapterID, $chapter);
@@ -188,23 +188,23 @@ 
 		//This is to allow user history to function properly.
 
 		$success = $this->db->set(['active' => 'N', 'last_updated' => NULL])
-		                    ->where('user_id', $userID)
-		                    ->where('id', $chapterID)
-		                    ->update('tracker_chapters');
+							->where('user_id', $userID)
+							->where('id', $chapterID)
+							->update('tracker_chapters');
 
 		return (bool) $success;
 	}
 	private function updateTitleById(int $id, string $latestChapter) {
 		//FIXME: Really not too happy with how we're doing history stuff here, it just feels messy.
 		$query = $this->db->select('latest_chapter AS current_chapter')
-		                  ->from('tracker_titles')
-		                  ->where('id', $id)
-		                  ->get();
+						  ->from('tracker_titles')
+						  ->where('id', $id)
+						  ->get();
 		$row = $query->row();
 
 		$success = $this->db->set(['latest_chapter' => $latestChapter]) //last_updated gets updated via a trigger if something changes
-		                    ->where('id', $id)
-		                    ->update('tracker_titles');
+							->where('id', $id)
+							->update('tracker_titles');
 
 		//Update History
 		//NOTE: To avoid doing another query to grab the last_updated time, we just use time() which <should> get the same thing.
@@ -215,16 +215,16 @@ 
 	}
 	private function updateTitleDataById(int $id, array $titleData) {
 		$success = $this->db->set($titleData)
-		                    ->where('id', $id)
-		                    ->update('tracker_titles');
+							->where('id', $id)
+							->update('tracker_titles');
 
 		return (bool) $success;
 	}
 	private function addTitle(string $titleURL, int $siteID) {
 		$query = $this->db->select('site, site_class')
-		                  ->from('tracker_sites')
-		                  ->where('id', $siteID)
-		                  ->get();
+						  ->from('tracker_sites')
+						  ->where('id', $siteID)
+						  ->get();
 
 		$titleData = $this->sites->{$query->row()->site_class}->getTitleData($titleURL);
 		$this->db->insert('tracker_titles', array_merge($titleData, ['title_url' => $titleURL, 'site_id' => $siteID]));
@@ -275,8 +275,8 @@ 
 						//Make sure last_checked is always updated on successful run.
 						//CHECK: Is there a reason we aren't just doing this in updateTitleById?
 						$this->db->set('last_checked', 'CURRENT_TIMESTAMP', FALSE)
-						         ->where('id', $row->id)
-						         ->update('tracker_titles');
+								 ->where('id', $row->id)
+								 ->update('tracker_titles');
 
 						print " - ({$titleData['latest_chapter']})\n";
 					}
@@ -393,9 +393,9 @@ 
 	}
 	public function setCategoryTrackerByID(int $userID, int $chapterID, string $category) : bool {
 		$success = $this->db->set(['category' => $category, 'active' => 'Y', 'last_updated' => NULL])
-		                    ->where('user_id', $userID)
-		                    ->where('id', $chapterID)
-		                    ->update('tracker_chapters');
+							->where('user_id', $userID)
+							->where('id', $chapterID)
+							->update('tracker_chapters');
 
 		return (bool) $success;
 	}
@@ -405,9 +405,9 @@ 
 		$success = FALSE;
 		if(preg_match("/^[a-z0-9-_,]{0,255}$/", $tag_string)) {
 			$success = (bool) $this->db->set(['tags' => $tag_string, 'active' => 'Y', 'last_updated' => NULL])
-			                           ->where('user_id', $userID)
-			                           ->where('id', $chapterID)
-			                           ->update('tracker_chapters');
+									   ->where('user_id', $userID)
+									   ->where('id', $chapterID)
+									   ->update('tracker_chapters');
 		}
 
 		if($success) {
@@ -445,23 +445,23 @@ 
 
 			//We need the series to be tracked
 			$idCQuery = $this->db->select('id')
-			                    ->where('user_id', $userID)
-			                    ->where('title_id', $titleID)
-			                    ->get('tracker_chapters');
+								->where('user_id', $userID)
+								->where('title_id', $titleID)
+								->get('tracker_chapters');
 			if($idCQuery->num_rows() > 0) {
 				$idCQueryRow = $idCQuery->row();
 
 				//Check if it is already favourited
 				$idFQuery = $this->db->select('id')
-				                    ->where('chapter_id', $idCQueryRow->id)
-				                    ->where('chapter', $chapter)
-				                    ->get('tracker_favourites');
+									->where('chapter_id', $idCQueryRow->id)
+									->where('chapter', $chapter)
+									->get('tracker_favourites');
 				if($idFQuery->num_rows() > 0) {
 					//Chapter is already favourited, so remove it from DB
 					$idFQueryRow = $idFQuery->row();
 
 					$isSuccess = (bool) $this->db->where('id', $idFQueryRow->id)
-					                           ->delete('tracker_favourites');
+											   ->delete('tracker_favourites');
 
 					if($isSuccess) {
 						$success = array(
@@ -534,10 +534,10 @@ 
 		$usedCategories = [];
 
 		$query = $this->db->distinct()
-		                  ->select('category')
-		                  ->from('tracker_chapters')
-		                  ->where('tracker_chapters.active', 'Y')
-		                  ->get();
+						  ->select('category')
+						  ->from('tracker_chapters')
+						  ->where('tracker_chapters.active', 'Y')
+						  ->get();
 
 		return array_column($query->result_array(), 'category');
 	}

application/tests/libraries/MY_Form_validation_test.php

Doc Comments +4 added lines

@@ -144,6 +144,10 @@
 	}
 
 	//utility functions
+
+	/**
+	 * @param string $field
+	 */
 	function get_error_message(/*str*/$field, /*obj*/ $customObj = FALSE) {
 		$obj = $customObj ?: $this->form_validation;
 		$error_messages = ReflectionHelper::getPrivateProperty(

public/index.php

Indentation +4 added lines, -4 removed lines

@@ -210,10 +210,10 @@
 {
 	// Ensure there's a trailing slash
 	$system_path = strtr(
-		               rtrim($system_path, '/\\'),
-		               '/\\',
-		               DIRECTORY_SEPARATOR.DIRECTORY_SEPARATOR
-	               ).DIRECTORY_SEPARATOR;
+					   rtrim($system_path, '/\\'),
+					   '/\\',
+					   DIRECTORY_SEPARATOR.DIRECTORY_SEPARATOR
+				   ).DIRECTORY_SEPARATOR;
 }
 
 // Is the system path correct?

application/tests/TestCase.php

Indentation +13 added lines, -13 removed lines

@@ -29,27 +29,27 @@ 
 
 	public function getMock_ion_auth_logged_in() {
 		$ion_auth = $this->getMockBuilder('Ion_auth')
-		                 ->disableOriginalConstructor()
-		                 ->getMock();
+						 ->disableOriginalConstructor()
+						 ->getMock();
 
 		$ion_auth->expects($this->at(0))
-		         ->method('logged_in')
-		         ->willReturn(TRUE);
+				 ->method('logged_in')
+				 ->willReturn(TRUE);
 		$ion_auth->expects($this->at(1))
-		         ->method('logged_in')
-		         ->willReturn(TRUE);
+				 ->method('logged_in')
+				 ->willReturn(TRUE);
 
 		$ion_auth->expects($this->any())
-		         ->method($this->anything())
-		         ->will($this->returnSelf());
+				 ->method($this->anything())
+				 ->will($this->returnSelf());
 		
 		return $ion_auth;
 	}
 
 	public function getMock_CI_DB_result(array $methods) {
 		$db_result = $this->getMockBuilder('CI_DB_result')
-		                  ->disableOriginalConstructor()
-		                  ->getMock();
+						  ->disableOriginalConstructor()
+						  ->getMock();
 
 		foreach ($methods as $method => $return) {
 			$db_result->method($method)->willReturn($return);
@@ -59,9 +59,9 @@ 
 
 	public function getMock_CI_DB($return) {
 		$db = $this->getMockBuilder('CI_DB')
-		           ->disableOriginalConstructor()
-		           ->setMethods(array('select', 'from', 'where', 'get'))
-		           ->getMock();
+				   ->disableOriginalConstructor()
+				   ->setMethods(array('select', 'from', 'where', 'get'))
+				   ->getMock();
 
 		$db->expects($this->at(3))
 		   ->method('get')

application/tests/models/User_Model_test.php

Indentation +2 added lines, -2 removed lines

@@ -30,8 +30,8 @@
 		$User_Model = $this->User_Model;
 
 		$ion_auth = $this->getMockBuilder('ion_auth')
-		                 ->disableOriginalConstructor()
-		                 ->getMock();
+						 ->disableOriginalConstructor()
+						 ->getMock();
 		$ion_auth->method('logged_in')->willReturn(FALSE);
 
 		$User_Model->ion_auth = $ion_auth;

application/models/User_Options_Model.php

Indentation +4 added lines, -4 removed lines

@@ -138,10 +138,10 @@
 	private function get_db(string $option, int $userID) {
 		//This function assumes we've already done some basic validation.
 		$query = $this->db->select('value_str, value_int')
-		                  ->from('user_options')
-		                  ->where('user_id', $userID)
-		                  ->where('name',    $option)
-		                  ->limit(1);
+						  ->from('user_options')
+						  ->where('user_id', $userID)
+						  ->where('name',    $option)
+						  ->limit(1);
 		return $query->get()->row_array();
 	}
 	private function set_db(string $option, $value) : bool {}

Doc Comments +8 added lines, -1 removed lines

@@ -73,11 +73,15 @@ 
 	/**
 	 * Get user option, or default option if it does not exist.
 	 * @param string $option
-	 * @return mixed Returns option value as STRING, or FALSE if option does not exist.
+	 * @return string Returns option value as STRING, or FALSE if option does not exist.
 	 */
 	public function get(string $option) {
 		return $this->get_by_userid($option, (int) $this->User->id);
 	}
+
+	/**
+	 * @return string
+	 */
 	public function get_by_userid(string $option, int $userID) {
 		//Check if option is valid
 		if(array_key_exists($option, $this->options)) {
@@ -135,6 +139,9 @@ 
 		return $success;
 	}
 
+	/**
+	 * @return string
+	 */
 	private function get_db(string $option, int $userID) {
 		//This function assumes we've already done some basic validation.
 		$query = $this->db->select('value_str, value_int')

application/models/Site_Model.php

Indentation +2 added lines, -2 removed lines

@@ -228,8 +228,8 @@
 		//Bato.to is annoying and locks stuff behind auth. See: https://github.com/DakuTree/manga-tracker/issues/14#issuecomment-233830855
 		$cookies = [
 			"lang_option={$title_lang}",
-		    "member_id=" . $this->config->item('batoto_cookie_member_id'),
-		    "pass_hash=" . $this->config->item('batoto_cookie_pass_hash')
+			"member_id=" . $this->config->item('batoto_cookie_member_id'),
+			"pass_hash=" . $this->config->item('batoto_cookie_pass_hash')
 		];
 		$data = $this->get_content($title_url, implode("; ", $cookies));
 		if(!$data) {

application/models/User_Model.php

Indentation +12 added lines, -12 removed lines

@@ -40,9 +40,9 @@ 
 		$this->load->database();
 
 		$query = $this->db->select('*')
-		                  ->from('auth_users')
-		                  ->where('username', $username)
-		                  ->get();
+						  ->from('auth_users')
+						  ->where('username', $username)
+						  ->get();
 
 		return (bool) $query->num_rows();
 	}
@@ -64,9 +64,9 @@ 
 			$this->load->database();
 
 			$query = $this->db->select('email')
-			                  ->from('auth_users')
-			                  ->where('username', $identity)
-			                  ->get();
+							  ->from('auth_users')
+							  ->where('username', $identity)
+							  ->get();
 
 			if($query->num_rows() > 0) {
 				//username exists, grab email
@@ -84,9 +84,9 @@ 
 		$user = NULL;
 
 		$query = $this->db->select('*')
-		                  ->from('auth_users')
-		                  ->where('username', $username)
-		                  ->get();
+						  ->from('auth_users')
+						  ->where('username', $username)
+						  ->get();
 
 		if($query->num_rows() > 0) {
 			$user = $query->row();
@@ -114,9 +114,9 @@ 
 	
 	public function get_id_from_api_key(string $api_key) {
 		$query = $this->db->select('id')
-		                  ->from('auth_users')
-		                  ->where('api_key', $api_key)
-		                  ->get();
+						  ->from('auth_users')
+						  ->where('api_key', $api_key)
+						  ->get();
 
 		if($query->num_rows() > 0) {
 			$userID = $query->row('id');