Wemo_plugin::answer() - Code Metrics - bianchins/JarvisPHP - Measure and Improve Code Quality continuously with Scrutinizer

Wemo_plugin::answer() A
last analyzed 2015-12-19 07:35 UTC

↳ Parent: Wemo_plugin

Complexity

Conditions	3
Paths	4

Size

Total Lines	51
Code Lines	38

Duplication

Lines	0
Ratio	0 %

Importance

Changes	2
Bugs	0	Features	0

Metric	Value
c	2
b	0
f	0
dl	0
loc	51
rs	9.411
cc	3
eloc	38
nc	4
nop	1

How to fix Long Method

<?php

namespace JarvisPHP\Plugins\Wemo_plugin;

use JarvisPHP\Core\JarvisSession;
use JarvisPHP\Core\JarvisPHP;
use JarvisPHP\Core\JarvisLanguage;
use JarvisPHP\Core\JarvisTTS;

/**
 * A IFTTT Plugin for my Wemo Insight Switch
 * @author Stefano Bianchini
 * @website http://www.stefanobianchini.net
 */
class Wemo_plugin implements \JarvisPHP\Core\JarvisPluginInterface{
    /**
     * Priority of plugin
     * @var int  
     */
    var $priority = 2;
class A {
    var $property;
}
    
    /**
     * the behaviour of plugin
     * @param string $command
     */
    function answer($command) {

        $answer = '';
$myVar = 'Value';
$higher = false;

if (rand(1, 6) > 3) {
    $higher = true;
} else {
    $higher = false;
}
        JarvisPHP::getLogger()->debug('Answering to command: "'.$command.'"');

        $_IFTTT_MAKER_KEY = '';
        $_IFTTT_MAKER_EVENT = '';

        //Load API key from json config
        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;
            $_IFTTT_MAKER_EVENT = $json_config->ifttt_event;
        }

        //Toggle switch via curl
        $ch = curl_init();
        curl_setopt($ch, CURLOPT_URL, 'https://maker.ifttt.com/trigger/'.$_IFTTT_MAKER_EVENT.'/with/key/'.$_IFTTT_MAKER_KEY);
        curl_setopt($ch, CURLOPT_USERAGENT, 'Mozilla/5.0 (Windows NT 6.1; WOW64; rv:42.0) Gecko/20100101 Firefox/42.0');
        curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
        curl_setopt($ch, CURLOPT_FOLLOWLOCATION, true);
        curl_setopt($ch, CURLOPT_FAILONERROR, true);
        curl_setopt($ch, CURLOPT_VERBOSE, TRUE);
        curl_setopt($ch, CURLOPT_PROTOCOLS, CURLPROTO_HTTPS);
        curl_setopt($ch, CURLOPT_POST, 1);
        $headers = array();
        $headers[] = 'Accept: text/html,application/xhtml+xml,application/xml;q=0.9,*/*;q=0.8';
        $headers[] = 'Accept-Encoding: gzip, deflate';
        $headers[] = 'Accept-Language: it-IT,it;q=0.8,en-US;q=0.5,en;q=0.3';
        $headers[] = 'Cache-Control: no-cache';
        $headers[] = 'Host: maker.ifttt.com';
        curl_setopt($ch, CURLOPT_HTTPHEADER, $headers);
        curl_setopt($ch, CURLOPT_POSTFIELDS, array());
        curl_setopt($ch, CURLOPT_SSL_VERIFYPEER, 0);
        curl_setopt($ch, CURLOPT_SSL_VERIFYHOST, false); 
        $result = curl_exec($ch);
        
        if(!$result) {
            JarvisPHP::getLogger()->error('Curl error: '.curl_error($ch));
            $answer = JarvisLanguage::translate('command_not_sent',get_called_class());  
        }
        else {
            $answer = JarvisLanguage::translate('command_sent_to_light_switch',get_called_class());    
        }
        
        curl_close($ch);
        
        JarvisTTS::speak($answer);
        $response = new \JarvisPHP\Core\JarvisResponse($answer, JarvisPHP::getRealClassName(get_called_class()), true);
        $response->send();
    }
    
    /**
     * Get plugin's priority
     * @return int
     */
    function getPriority() {

        return $this->priority;
    }
    
    /**
     * Is it the right plugin for the command?
     * @param string $command
     * @return boolean
     */
    function isLikely($command) {

        return preg_match(JarvisLanguage::translate('preg_match_activate_plugin',get_called_class()), $command);
class Author {
    private $name;

    public function __construct($name) {
        $this->name = $name;
    }

    public function getName() {
        return $this->name;
    }
}

abstract class Post {
    public function getAuthor() {
        return 'Johannes';
    }
}

class BlogPost extends Post {
    public function getAuthor() {
        return new Author('Johannes');
    }
}

class ForumPost extends Post { /* ... */ }

function my_function(Post $post) {
    echo strtoupper($post->getAuthor());
}
    }
    
    /**
     * Does the plugin need a session?
     * @return boolean
     */
    function hasSession() {

        return false;
    }
}


1			<?php
2
3			namespace JarvisPHP\Plugins\Wemo_plugin;
4
5			use JarvisPHP\Core\JarvisSession;
6			use JarvisPHP\Core\JarvisPHP;
7			use JarvisPHP\Core\JarvisLanguage;
8			use JarvisPHP\Core\JarvisTTS;
9
10			/**
11			* A IFTTT Plugin for my Wemo Insight Switch
12			* @author Stefano Bianchini
13			* @website http://www.stefanobianchini.net
14			*/
15			class Wemo_plugin implements \JarvisPHP\Core\JarvisPluginInterface{
16			/**
17			* Priority of plugin
18			* @var int
19			*/
20			var $priority = 2;
			0 ignored issues – show Coding Style introduced 2015-12-17 08:53 UTC by Report Bug Copy Issue Report The visibility should be declared for property `$priority`. The PSR-2 coding standard requires that all properties in a class have their visibility explicitly declared. If you declare a property using class A { var $property; } the property is implicitly global. To learn more about the PSR-2, please see the PHP-FIG site on the PSR-2. Loading history...
21
22			/**
23			* the behaviour of plugin
24			* @param string $command
25			*/
26			function answer($command) {
			0 ignored issues – show Best Practice introduced 2015-12-17 08:53 UTC by Report Bug Copy Issue Report It is generally recommended to explicitly declare the visibility for methods. Adding explicit visibility (`private`, `protected`, or `public`) is generally recommend to communicate to other developers how, and from where this method is intended to be used. Loading history...
27			$answer = '';
			0 ignored issues – show Unused Code introduced 2015-12-17 08:53 UTC by Report Bug Copy Issue Report `$answer` is not used, you could remove the assignment. This check looks for variable assignements that are either overwritten by other assignments or where the variable is not used subsequently. $myVar = 'Value'; $higher = false; if (rand(1, 6) > 3) { $higher = true; } else { $higher = false; } Both the `$myVar` assignment in line 1 and the `$higher` assignment in line 2 are dead. The first because `$myVar` is never used and the second because `$higher` is always overwritten for every possible time line. Loading history...
28			JarvisPHP::getLogger()->debug('Answering to command: "'.$command.'"');
29
30			$_IFTTT_MAKER_KEY = '';
31			$_IFTTT_MAKER_EVENT = '';
32
33			//Load API key from json config
34			if(file_exists('Plugins/Wemo_plugin/api-key.json')) {
35			//Create your own api key and put it in api-key.json
36			$json_config = json_decode(file_get_contents('Plugins/Wemo_plugin/api-key.json'));
37			$_IFTTT_MAKER_KEY = $json_config->ifttt_key;
38			$_IFTTT_MAKER_EVENT = $json_config->ifttt_event;
39			}
40
41			//Toggle switch via curl
42			$ch = curl_init();
43			curl_setopt($ch, CURLOPT_URL, 'https://maker.ifttt.com/trigger/'.$_IFTTT_MAKER_EVENT.'/with/key/'.$_IFTTT_MAKER_KEY);
44			curl_setopt($ch, CURLOPT_USERAGENT, 'Mozilla/5.0 (Windows NT 6.1; WOW64; rv:42.0) Gecko/20100101 Firefox/42.0');
45			curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
46			curl_setopt($ch, CURLOPT_FOLLOWLOCATION, true);
47			curl_setopt($ch, CURLOPT_FAILONERROR, true);
48			curl_setopt($ch, CURLOPT_VERBOSE, TRUE);
49			curl_setopt($ch, CURLOPT_PROTOCOLS, CURLPROTO_HTTPS);
50			curl_setopt($ch, CURLOPT_POST, 1);
51			$headers = array();
52			$headers[] = 'Accept: text/html,application/xhtml+xml,application/xml;q=0.9,/;q=0.8';
53			$headers[] = 'Accept-Encoding: gzip, deflate';
54			$headers[] = 'Accept-Language: it-IT,it;q=0.8,en-US;q=0.5,en;q=0.3';
55			$headers[] = 'Cache-Control: no-cache';
56			$headers[] = 'Host: maker.ifttt.com';
57			curl_setopt($ch, CURLOPT_HTTPHEADER, $headers);
58			curl_setopt($ch, CURLOPT_POSTFIELDS, array());
59			curl_setopt($ch, CURLOPT_SSL_VERIFYPEER, 0);
60			curl_setopt($ch, CURLOPT_SSL_VERIFYHOST, false);
61			$result = curl_exec($ch);
62
63			if(!$result) {
64			JarvisPHP::getLogger()->error('Curl error: '.curl_error($ch));
65			$answer = JarvisLanguage::translate('command_not_sent',get_called_class());
66			}
67			else {
68			$answer = JarvisLanguage::translate('command_sent_to_light_switch',get_called_class());
69			}
70
71			curl_close($ch);
72
73			JarvisTTS::speak($answer);
74			$response = new \JarvisPHP\Core\JarvisResponse($answer, JarvisPHP::getRealClassName(get_called_class()), true);
75			$response->send();
76			}
77
78			/**
79			* Get plugin's priority
80			* @return int
81			*/
82			function getPriority() {
			0 ignored issues – show Best Practice introduced 2015-12-17 08:53 UTC by Report Bug Copy Issue Report It is generally recommended to explicitly declare the visibility for methods. Adding explicit visibility (`private`, `protected`, or `public`) is generally recommend to communicate to other developers how, and from where this method is intended to be used. Loading history...
83			return $this->priority;
84			}
85
86			/**
87			* Is it the right plugin for the command?
88			* @param string $command
89			* @return boolean
90			*/
91			function isLikely($command) {
			0 ignored issues – show Best Practice introduced 2015-12-17 08:53 UTC by Report Bug Copy Issue Report It is generally recommended to explicitly declare the visibility for methods. Adding explicit visibility (`private`, `protected`, or `public`) is generally recommend to communicate to other developers how, and from where this method is intended to be used. Loading history...
92			return preg_match(JarvisLanguage::translate('preg_match_activate_plugin',get_called_class()), $command);
			0 ignored issues – show Bug Best Practice introduced 2015-12-17 08:53 UTC by Report Bug Copy Issue Report The return type of `return preg_match(\Jarvi...ed_class()), $command);` (`integer`) is incompatible with the return type declared by the interface `JarvisPHP\Core\JarvisPluginInterface::isLikely` of type `boolean`. If you return a value from a function or method, it should be a sub-type of the type that is given by the parent type f.e. an interface, or abstract method. This is more formally defined by the Lizkov substitution principle, and guarantees that classes that depend on the parent type can use any instance of a child type interchangably. This principle also belongs to the SOLID principles for object oriented design. Let’s take a look at an example: class Author { private $name; public function __construct($name) { $this->name = $name; } public function getName() { return $this->name; } } abstract class Post { public function getAuthor() { return 'Johannes'; } } class BlogPost extends Post { public function getAuthor() { return new Author('Johannes'); } } class ForumPost extends Post { /* ... */ } function my_function(Post $post) { echo strtoupper($post->getAuthor()); } Our function `my_function` expects a `Post` object, and outputs the author of the post. The base class `Post` returns a simple string and outputting a simple string will work just fine. However, the child class `BlogPost` which is a sub-type of `Post` instead decided to return an `object`, and is therefore violating the SOLID principles. If a `BlogPost` were passed to `my_function`, PHP would not complain, but ultimately fail when executing the `strtoupper` call in its body. Loading history...
93			}
94
95			/**
96			* Does the plugin need a session?
97			* @return boolean
98			*/
99			function hasSession() {
			0 ignored issues – show Best Practice introduced 2015-12-17 08:53 UTC by Report Bug Copy Issue Report It is generally recommended to explicitly declare the visibility for methods. Adding explicit visibility (`private`, `protected`, or `public`) is generally recommend to communicate to other developers how, and from where this method is intended to be used. Loading history...
100			return false;
101			}
102			}
103

bianchins / JarvisPHP

Wemo_plugin::answer() A last analyzed 2015-12-19 07:35 UTC

Complexity

Size

Duplication

Importance

How to fix Long Method

Long Method

Duplication Side-by-Side

Filter issues like

Wemo_plugin::answer() A
last analyzed 2015-12-19 07:35 UTC