bianchins / JarvisPHP

Core/JarvisBehaviourLanguage.php

Doc Comments +3 added lines

@@ -17,6 +17,9 @@
 		}
 	}
 
+	/**
+	 * @param string $sentence
+	 */
 	public function answer($sentence) {
 		foreach(JarvisBehaviourLanguage::$jbl_set->rules as $rule) {
 			foreach($rule->matches as $match) {

Spacing +4 added lines, -4 removed lines

@@ -12,15 +12,15 @@
 	public static $jbl_set = array();
 
 	public function loadBehaviourLanguage() {
-		if(file_exists('language/jbl_'._LANGUAGE.'.jbl')) {
+		if (file_exists('language/jbl_'._LANGUAGE.'.jbl')) {
 			JarvisBehaviourLanguage::$jbl_set = json_decode(file_get_contents('language/jbl_'._LANGUAGE.'.jbl'));
 		}
 	}
 
 	public function answer($sentence) {
-		foreach(JarvisBehaviourLanguage::$jbl_set->rules as $rule) {
-			foreach($rule->matches as $match) {
-				if(preg_match($match, $sentence)) {
+		foreach (JarvisBehaviourLanguage::$jbl_set->rules as $rule) {
+			foreach ($rule->matches as $match) {
+				if (preg_match($match, $sentence)) {
 					return $rule->responses[array_rand($rule->responses)];
 				}
 			}

Plugins/Gcalendar_plugin/Gcalendar_plugin.php

Doc Comments +2 added lines, -2 removed lines

@@ -83,7 +83,7 @@ 
     /**
      * Is it the right plugin for the command?
      * @param string $command
-     * @return boolean
+     * @return integer
      */
     function isLikely($command) {
         return preg_match(JarvisLanguage::translate('preg_match_activate_plugin',get_called_class()), $command);
@@ -99,7 +99,7 @@ 
 
     /**
      * Returns an authorized API client.
-     * @return Google_Client the authorized client object
+     * @return null|\Google_Client the authorized client object
      */
     function getClient() {
       $client = new \Google_Client();

Spacing +5 added lines, -5 removed lines

@@ -20,7 +20,7 @@ 
  * @author Stefano Bianchini
  * @website http://www.stefanobianchini.net
  */
-class Gcalendar_plugin implements \JarvisPHP\Core\JarvisPluginInterface{
+class Gcalendar_plugin implements \JarvisPHP\Core\JarvisPluginInterface {
     /**
      * Priority of plugin
      * @var int  
@@ -39,7 +39,7 @@ 
         // Get the API client and construct the service object.
         $client = Gcalendar_plugin::getClient();
         
-        if($client==null) return null;
+        if ($client == null) return null;
 
         $service = new \Google_Service_Calendar($client);
 
@@ -54,7 +54,7 @@ 
         $results = $service->events->listEvents($calendarId, $optParams);
 
         if (count($results->getItems()) == 0) {
-          $answer = JarvisLanguage::translate('no_appointments',get_called_class());
+          $answer = JarvisLanguage::translate('no_appointments', get_called_class());
         } else {
           
           foreach ($results->getItems() as $event) {
@@ -64,7 +64,7 @@ 
             }
 
             $date = new \DateTime($start);
-            $answer.= sprintf(JarvisLanguage::translate('list_events',get_called_class()), $date->format('j'), JarvisLanguage::translate('month_'.$date->format('n'),get_called_class()), $date->format('H'), $date->format('i'), $event->getSummary())."\n";
+            $answer .= sprintf(JarvisLanguage::translate('list_events', get_called_class()), $date->format('j'), JarvisLanguage::translate('month_'.$date->format('n'), get_called_class()), $date->format('H'), $date->format('i'), $event->getSummary())."\n";
           }
         }
 
@@ -86,7 +86,7 @@ 
      * @return boolean
      */
     function isLikely($command) {
-        return preg_match(JarvisLanguage::translate('preg_match_activate_plugin',get_called_class()), $command);
+        return preg_match(JarvisLanguage::translate('preg_match_activate_plugin', get_called_class()), $command);
     }
     
     /**

Plugins/Wemo_plugin/Wemo_plugin.php

Doc Comments +1 added lines, -1 removed lines

@@ -86,7 +86,7 @@
     /**
      * Is it the right plugin for the command?
      * @param string $command
-     * @return boolean
+     * @return integer
      */
     function isLikely($command) {
         return preg_match(JarvisLanguage::translate('preg_match_activate_plugin',get_called_class()), $command);

Spacing +6 added lines, -6 removed lines

@@ -12,7 +12,7 @@ 
  * @author Stefano Bianchini
  * @website http://www.stefanobianchini.net
  */
-class Wemo_plugin implements \JarvisPHP\Core\JarvisPluginInterface{
+class Wemo_plugin implements \JarvisPHP\Core\JarvisPluginInterface {
     /**
      * Priority of plugin
      * @var int  
@@ -31,7 +31,7 @@ 
         $_IFTTT_MAKER_EVENT = '';
 
         //Load API key from json config
-        if(file_exists('Plugins/Wemo_plugin/api-key.json')) {
+        if (file_exists('Plugins/Wemo_plugin/api-key.json')) {
             //Create your own api key and put it in api-key.json
             $json_config = json_decode(file_get_contents('Plugins/Wemo_plugin/api-key.json'));
             $_IFTTT_MAKER_KEY = $json_config->ifttt_key;
@@ -60,12 +60,12 @@ 
         curl_setopt($ch, CURLOPT_SSL_VERIFYHOST, false); 
         $result = curl_exec($ch);
         
-        if(!$result) {
+        if (!$result) {
             JarvisPHP::getLogger()->error('Curl error: '.curl_error($ch));
-            $answer = JarvisLanguage::translate('command_not_sent',get_called_class());  
+            $answer = JarvisLanguage::translate('command_not_sent', get_called_class());  
         }
         else {
-            $answer = JarvisLanguage::translate('command_sent_to_light_switch',get_called_class());    
+            $answer = JarvisLanguage::translate('command_sent_to_light_switch', get_called_class());    
         }
         
         curl_close($ch);
@@ -89,7 +89,7 @@ 
      * @return boolean
      */
     function isLikely($command) {
-        return preg_match(JarvisLanguage::translate('preg_match_activate_plugin',get_called_class()), $command);
+        return preg_match(JarvisLanguage::translate('preg_match_activate_plugin', get_called_class()), $command);
     }
     
     /**

TelegramBot/GenericCurl.php

Doc Comments +3 added lines

@@ -8,6 +8,9 @@
  */
 class GenericCurl {
 
+	/**
+	 * @param string $url
+	 */
 	static function exec($url, $fields) {
 
 

Spacing +7 added lines, -7 removed lines

@@ -13,8 +13,8 @@ 
 
 		$fields_string = "";
 		//url-ify the data for the POST
-		if(count($fields)>0) {
-			foreach($fields as $key=>$value) { $fields_string .= $key.'='.$value.'&'; }
+		if (count($fields) > 0) {
+			foreach ($fields as $key=>$value) { $fields_string .= $key.'='.$value.'&'; }
 			rtrim($fields_string, '&');
 		} 
 		
@@ -23,11 +23,11 @@ 
 		$ch = curl_init();
 
 		//set the url, number of POST vars, POST data
-		curl_setopt($ch,CURLOPT_URL, $url);
-		curl_setopt($ch,CURLOPT_POST, count($fields));
-		curl_setopt($ch,CURLOPT_POSTFIELDS, $fields_string);
+		curl_setopt($ch, CURLOPT_URL, $url);
+		curl_setopt($ch, CURLOPT_POST, count($fields));
+		curl_setopt($ch, CURLOPT_POSTFIELDS, $fields_string);
 		curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
-		curl_setopt ($ch, CURLOPT_COOKIEFILE, "TelegramBot/JarvisPHPSession.cookie");
+		curl_setopt($ch, CURLOPT_COOKIEFILE, "TelegramBot/JarvisPHPSession.cookie");
 		curl_setopt($ch, CURLOPT_COOKIEJAR, "TelegramBot/JarvisPHPSession.cookie"); 
 
 		//execute post
@@ -40,6 +40,6 @@ 
 
 
 
-		return ($http_response_code==200) ? json_decode($result) : false;
+		return ($http_response_code == 200) ? json_decode($result) : false;
 	}
 }
\ No newline at end of file

TelegramBot/TelegramBot.php

Doc Comments +6 added lines

@@ -9,6 +9,9 @@ 
  */
 class TelegramBotApiWrapper {
 
+	/**
+	 * @param resource $handle
+	 */
 	function exec_curl_request($handle) {
 	  $response = curl_exec($handle);
 
@@ -45,6 +48,9 @@ 
 	  return $response;
 	}
 
+	/**
+	 * @param string $method
+	 */
 	function apiRequestJson($method, $parameters) {
 	  if (!is_string($method)) {
 	    echo("Method name must be a string\n");

Spacing +1 added lines, -1 removed lines

@@ -62,7 +62,7 @@
 
 	  $_BOT_TOKEN = '';
 	  //Load API key from json config
-      if(file_exists('TelegramBot/api-key.json')) {
+      if (file_exists('TelegramBot/api-key.json')) {
           //Create your own bot token and put it in api-key.json
           // like {"bot_token": "<your-bot-token>"}
           $json_config = json_decode(file_get_contents('TelegramBot/api-key.json'));

TelegramBot/JarvisPHPTelegramBot.php

Spacing +19 added lines, -19 removed lines

@@ -5,7 +5,7 @@ 
 use JarvisPHP\TelegramBot\GenericCurl;
 
 //Very important!
-define('_JARVISPHP_URL','http://localhost:8000');
+define('_JARVISPHP_URL', 'http://localhost:8000');
 
 /**
  * A TelegramBot for JarvisPHP
@@ -23,14 +23,14 @@ 
 		echo "JarvisPHP Telegram Bot started at ".date('Y-m-d H:i:s')."\n";
 		echo "-----------------------------------------------------\n";
 
-		while(true) {
+		while (true) {
 
 			$updates = $bot->apiRequestJson("getUpdates", array('offset'=>$offset));
 			
-			if($updates) {
-				foreach($updates as $update) {
+			if ($updates) {
+				foreach ($updates as $update) {
 
-					if(isset($update->message->text)) {
+					if (isset($update->message->text)) {
 
 						//TODO check if $update->message->chat->id is in enabled list
 
@@ -40,28 +40,28 @@ 
 
 						$message = $update->message->text;
 
-						$offset = $update->update_id + 1;
+						$offset = $update->update_id+1;
 
 						$response = '';
 
 						//Understand if the message is a telegram command (begins with "/")
-						if(preg_match('$^/(.+)$', $message)) {
+						if (preg_match('$^/(.+)$', $message)) {
 							
 							//Telegram command
-							switch($message) {
-								case '/start': $response='I am JarvisPHP, a private bot. \u1F510'; break;
-								case '/info': $response='I am JarvisPHP, a private bot. \u1F510'; break;
+							switch ($message) {
+								case '/start': $response = 'I am JarvisPHP, a private bot. \u1F510'; break;
+								case '/info': $response = 'I am JarvisPHP, a private bot. \u1F510'; break;
 								case '/register': 
-												$response='Ok, i registered your ID in registerIdLog.log'; 
-												file_put_contents('TelegramBot/registerIdLog.log', '['.date('Y-m-d H:i:s').'] ID:'.$update->message->from->id . '; FIRSTNAME:'. $update->message->from->first_name . '; LASTNAME:'. $update->message->from->last_name. '; USERNAME:'. $update->message->from->username.PHP_EOL , FILE_APPEND | LOCK_EX);
+												$response = 'Ok, i registered your ID in registerIdLog.log'; 
+												file_put_contents('TelegramBot/registerIdLog.log', '['.date('Y-m-d H:i:s').'] ID:'.$update->message->from->id.'; FIRSTNAME:'.$update->message->from->first_name.'; LASTNAME:'.$update->message->from->last_name.'; USERNAME:'.$update->message->from->username.PHP_EOL, FILE_APPEND | LOCK_EX);
 												break;	
-								case '/say': $response='Use /say "sentence" (without quotes) to make JarvisPHP speak a sentence.'; break;	
+								case '/say': $response = 'Use /say "sentence" (without quotes) to make JarvisPHP speak a sentence.'; break;	
 							}
 
 							//"Say" Telegram command
-							if(preg_match('$^/say (.+)$', $message, $matches)) {
-								if($matches) {
-									if(in_array($update->message->chat->id, $allowedClientIdList)) {
+							if (preg_match('$^/say (.+)$', $message, $matches)) {
+								if ($matches) {
+									if (in_array($update->message->chat->id, $allowedClientIdList)) {
 										//Redirect message to JarvisPhp
 										$JarvisResponse = GenericCurl::exec(_JARVISPHP_URL.'/answer', array('sentence'=>$matches[0]));
 
@@ -73,12 +73,12 @@ 
 							}
 
 							//Encode emoji
-							$response = preg_replace_callback('/\\\\u([0-9a-fA-F]+)/', function ($match) {
+							$response = preg_replace_callback('/\\\\u([0-9a-fA-F]+)/', function($match) {
 							    return iconv('UCS-4LE', 'UTF-8', pack('V', hexdec($match[1])));
 							}, $response);
 
 						} else {
-							if(in_array($update->message->chat->id, $allowedClientIdList)) {
+							if (in_array($update->message->chat->id, $allowedClientIdList)) {
 								//Redirect message to JarvisPhp
 								$JarvisResponse = GenericCurl::exec(_JARVISPHP_URL.'/answer', array('command'=>$message, 'tts' => 'None_tts'));
 
@@ -88,7 +88,7 @@ 
 							}
 
 						}
-						if($response) {
+						if ($response) {
 							$bot->apiRequestJson("sendMessage", array('chat_id' => $update->message->chat->id, "text" => $response));
 						}
 					}

config/Espeak_config.php

Spacing +2 added lines, -2 removed lines

@@ -5,10 +5,10 @@
  * m1, m2, ... m8 male voices
  * f1, f2, f3, f4 female voices
  */
-define('_ESPEAK_VOICE','m2');
+define('_ESPEAK_VOICE', 'm2');
 
 //Language of text-to-speech
 define('_ESPEAK_LANGUAGE', _LANGUAGE);
 
 //Amplitude (espeak -a <amplitude>)
-define('_ESPEAK_AMPLITUDE','100');
\ No newline at end of file
+define('_ESPEAK_AMPLITUDE', '100');
\ No newline at end of file

config/Jarvis.php

Spacing +2 added lines, -2 removed lines

@@ -4,7 +4,7 @@ 
  */
 
 //Set locale
-define('_LANGUAGE','en');
+define('_LANGUAGE', 'en');
 
 //Command session timeout, in seconds
 define('_COMMAND_SESSION_TIMEOUT', 30);
@@ -13,4 +13,4 @@ 
 define('_JARVIS_TTS', 'None_tts');
 
 //Define system's name
-define('_SYSTEM_NAME','JarvisPhp');
\ No newline at end of file
+define('_SYSTEM_NAME', 'JarvisPhp');
\ No newline at end of file

Plugins/Info_plugin/Info_plugin.php

Spacing +5 added lines, -5 removed lines

@@ -12,7 +12,7 @@ 
  * @author Stefano Bianchini
  * @website http://www.stefanobianchini.net
  */
-class Info_plugin implements \JarvisPHP\Core\JarvisPluginInterface{
+class Info_plugin implements \JarvisPHP\Core\JarvisPluginInterface {
     /**
      * Priority of plugin
      * @var int  
@@ -25,15 +25,15 @@ 
      */
     function answer($command) {
         $answer = '';
-        if(preg_match(JarvisLanguage::translate('preg_match_tell_more',get_called_class()), $command)) {
+        if (preg_match(JarvisLanguage::translate('preg_match_tell_more', get_called_class()), $command)) {
             //Testing session
             JarvisPHP::getLogger()->debug('User says: '.$command);
-            $answer = 'Ok, i am on '. php_uname();
+            $answer = 'Ok, i am on '.php_uname();
             JarvisSession::terminate();
         }
         else {
             JarvisPHP::getLogger()->debug('Answering to command: "'.$command.'"');
-            $answer = sprintf(JarvisLanguage::translate('my_name_is',get_called_class()),_SYSTEM_NAME, $_SERVER['SERVER_NAME'],$_SERVER['SERVER_ADDR']);
+            $answer = sprintf(JarvisLanguage::translate('my_name_is', get_called_class()), _SYSTEM_NAME, $_SERVER['SERVER_NAME'], $_SERVER['SERVER_ADDR']);
             
         }
         JarvisTTS::speak($answer);
@@ -54,7 +54,7 @@ 
      * @return boolean
      */
     function isLikely($command) {
-        return preg_match(JarvisLanguage::translate('preg_match_activate_plugin',get_called_class()), $command);
+        return preg_match(JarvisLanguage::translate('preg_match_activate_plugin', get_called_class()), $command);
     }
     
     /**

Doc Comments +1 added lines, -1 removed lines

@@ -86,7 +86,7 @@
     /**
      * Is it the right plugin for the command?
      * @param string $command
-     * @return boolean
+     * @return integer
      */
     function isLikely($command) {
         return preg_match(JarvisLanguage::translate('preg_match_activate_plugin',get_called_class()), $command);