InformationOn_plugin - Code Metrics - bianchins/JarvisPHP - Measure and Improve Code Quality continuously with Scrutinizer

InformationOn_plugin A
last analyzed 2015-12-19 07:35 UTC

↳ Parent: Project

Complexity

Total Complexity

Size/Duplication

Total Lines	58
Duplicated Lines	0 %

Coupling/Cohesion

Components	0
Dependencies	4

Importance

Changes	1
Bugs	0	Features	0

Metric	Value
wmc	7
c	1
b	0
f	0
lcom	0
cbo	4
dl	0
loc	58
rs	10

4 Methods

Rating	Name	Size	Complexity
A	answer()	21	4
A	getPriority()	3	1
A	isLikely()	3	1
A	hasSession()	3	1

<?php

namespace JarvisPHP\Plugins\InformationOn_plugin;

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

/**
 * A simple InformationOn plugin that uses Wikipedia Opensearch API
 * @author Stefano Bianchini
 * @website http://www.stefanobianchini.net
 * Based on Wiki_plugin of UgoRaffaele https://github.com/UgoRaffaele/
 */
class InformationOn_plugin implements \JarvisPHP\Core\JarvisPluginInterface{
    /**
     * Priority of plugin
     * @var int  
     */
    var $priority = 10;
class A {
    var $property;
}
    
    /**
     * the behaviour of plugin
     * @param string $command
     */
    function answer($command) {

        //Extract search term
        preg_match(JarvisLanguage::translate('preg_match_activate_plugin',get_called_class()), $command, $matches);
        $search_term = $matches[2];
		$wiki_query_url = _WIKI_URL . "?action=opensearch&search=" . urlencode($search_term) . "&format=xml&limit=5";
		$xml = simplexml_load_string(file_get_contents($wiki_query_url));
        $item_array = $xml->Section->Item;
        $answer = JarvisLanguage::translate('nothing_found',get_called_class());
        //Have i got results?
        if(count($item_array)>0) {
            foreach ($item_array as $item) {
                if (strlen($item->Description) > 0) {
                    $answer = sprintf(JarvisLanguage::translate('search_result_is',get_called_class()), $item->Description);
                    break;
                }
            }
        }
        //Making response
        $response = new \JarvisPHP\Core\JarvisResponse($answer, JarvisTTS::speak($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\InformationOn_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 simple InformationOn plugin that uses Wikipedia Opensearch API
12			* @author Stefano Bianchini
13			* @website http://www.stefanobianchini.net
14			* Based on Wiki_plugin of UgoRaffaele https://github.com/UgoRaffaele/
15			*/
16			class InformationOn_plugin implements \JarvisPHP\Core\JarvisPluginInterface{
17			/**
18			* Priority of plugin
19			* @var int
20			*/
21			var $priority = 10;
			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...
22
23			/**
24			* the behaviour of plugin
25			* @param string $command
26			*/
27			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...
28			//Extract search term
29			preg_match(JarvisLanguage::translate('preg_match_activate_plugin',get_called_class()), $command, $matches);
30			$search_term = $matches[2];
31			$wiki_query_url = _WIKI_URL . "?action=opensearch&search=" . urlencode($search_term) . "&format=xml&limit=5";
32			$xml = simplexml_load_string(file_get_contents($wiki_query_url));
33			$item_array = $xml->Section->Item;
34			$answer = JarvisLanguage::translate('nothing_found',get_called_class());
35			//Have i got results?
36			if(count($item_array)>0) {
37			foreach ($item_array as $item) {
38			if (strlen($item->Description) > 0) {
39			$answer = sprintf(JarvisLanguage::translate('search_result_is',get_called_class()), $item->Description);
40			break;
41			}
42			}
43			}
44			//Making response
45			$response = new \JarvisPHP\Core\JarvisResponse($answer, JarvisTTS::speak($answer), JarvisPHP::getRealClassName(get_called_class()), true);
			0 ignored issues – show Unused Code introduced 2015-12-17 08:53 UTC by Report Bug Copy Issue Report The call to `JarvisResponse::__construct()` has too many arguments starting with `true`. This check compares calls to functions or methods with their respective definitions. If the call has more arguments than are defined, it raises an issue. If a function is defined several times with a different number of parameters, the check may pick up the wrong definition and report false positives. One codebase where this has been known to happen is Wordpress. In this case you can add the `@ignore` PhpDoc annotation to the duplicate definition and it will be ignored. Loading history...
46			$response->send();
47			}
48
49			/**
50			* Get plugin's priority
51			* @return int
52			*/
53			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...
54			return $this->priority;
55			}
56
57			/**
58			* Is it the right plugin for the command?
59			* @param string $command
60			* @return boolean
61			*/
62			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...
63			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...
64			}
65
66			/**
67			* Does the plugin need a session?
68			* @return boolean
69			*/
70			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...
71			return false;
72			}
73			}
74

bianchins / JarvisPHP

InformationOn_plugin A last analyzed 2015-12-19 07:35 UTC

Complexity

Size/Duplication

Coupling/Cohesion

Importance

4 Methods

Duplication Side-by-Side

Filter issues like

InformationOn_plugin A
last analyzed 2015-12-19 07:35 UTC