EE_Boolean_Field - Code Metrics - Inspection of "Daily Inspection: Merge branch 'FET-10330-add-sche..." - eventespresso/event-espresso-core - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Branch — FET-10304-welcome-to-vue (644299)

unknown

created 2017-01-11 21:07 UTC

EE_Boolean_Field A

↳ Parent: Project

Complexity

Total Complexity

Size/Duplication

Total Lines	49
Duplicated Lines	0 %

Coupling/Cohesion

Components	0
Dependencies	1

Importance

Changes

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

4 Methods

Rating	Name	Size	Complexity
A	__construct()	5	1
A	prepare_for_set()	8	2
A	prepare_for_set_from_db()	4	2
A	prepare_for_pretty_echoing()	8	2

<?php
defined( 'EVENT_ESPRESSO_VERSION') || exit;

class EE_Boolean_Field extends EE_Integer_Field
{
    /**
     * @param string $table_column
     * @param string $nicename
     * @param bool   $nullable
     * @param null   $default_value
     */
    public function __construct($table_column, $nicename, $nullable, $default_value = null)
    {
        parent::__construct($table_column, $nicename, $nullable, $default_value);
        $this->setSchemaType('boolean');
    }

    public function prepare_for_set($value_inputted_for_field_on_model_object)
    {
        if ($value_inputted_for_field_on_model_object) {
            return true;
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());
}
        } else {
            return false;
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());
}
        }
    }

    /**
     * Make sure we're returning booleans
     *
     * @param string $value_inputted_for_field_on_model_object
     * @return boolean
     */
    public function prepare_for_set_from_db($value_inputted_for_field_on_model_object)
    {
        return intval($value_inputted_for_field_on_model_object) ? true : false;
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());
}
    }

    /**
     * Gets a nice Yes/No value for this field
     *
     * @param boolean $value_on_field_to_be_outputted
     * @return string Yes or No
     */
    public function prepare_for_pretty_echoing($value_on_field_to_be_outputted)
    {
        return apply_filters(
            'FHEE__EE_Boolean_Field__prepare_for_pretty_echoing__return',
            $value_on_field_to_be_outputted ? __('Yes', 'event_espresso') : __('No', 'event_espresso'),
            $value_on_field_to_be_outputted
        );
    }
}


1			<?php
2			defined( 'EVENT_ESPRESSO_VERSION') \|\| exit;
3
4			class EE_Boolean_Field extends EE_Integer_Field
5			{
6			/**
7			* @param string $table_column
8			* @param string $nicename
9			* @param bool $nullable
10			* @param null $default_value
11			*/
12			public function __construct($table_column, $nicename, $nullable, $default_value = null)
13			{
14			parent::__construct($table_column, $nicename, $nullable, $default_value);
15			$this->setSchemaType('boolean');
16			}
17
18			public function prepare_for_set($value_inputted_for_field_on_model_object)
19			{
20			if ($value_inputted_for_field_on_model_object) {
21			return true;
			0 ignored issues – show Bug Best Practice introduced 2015-11-23 01:20 UTC by Report Bug Copy Issue Report The return type of `return true;` (`boolean`) is incompatible with the return type of the parent method `EE_Integer_Field::prepare_for_set` of type `integer`. 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...
22			} else {
23			return false;
			0 ignored issues – show Bug Best Practice introduced 2015-11-23 01:20 UTC by Report Bug Copy Issue Report The return type of `return false;` (`false`) is incompatible with the return type of the parent method `EE_Integer_Field::prepare_for_set` of type `integer`. 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...
24			}
25			}
26
27			/**
28			* Make sure we're returning booleans
29			*
30			* @param string $value_inputted_for_field_on_model_object
31			* @return boolean
32			*/
33			public function prepare_for_set_from_db($value_inputted_for_field_on_model_object)
34			{
35			return intval($value_inputted_for_field_on_model_object) ? true : false;
			0 ignored issues – show Bug Best Practice introduced 2015-11-23 01:20 UTC by Report Bug Copy Issue Report The return type of `return intval($value_inp...object) ? true : false;` (`boolean`) is incompatible with the return type of the parent method `EE_Integer_Field::prepare_for_set_from_db` of type `integer`. 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...
36			}
37
38			/**
39			* Gets a nice Yes/No value for this field
40			*
41			* @param boolean $value_on_field_to_be_outputted
42			* @return string Yes or No
43			*/
44			public function prepare_for_pretty_echoing($value_on_field_to_be_outputted)
45			{
46			return apply_filters(
47			'FHEE__EE_Boolean_Field__prepare_for_pretty_echoing__return',
48			$value_on_field_to_be_outputted ? __('Yes', 'event_espresso') : __('No', 'event_espresso'),
49			$value_on_field_to_be_outputted
50			);
51			}
52			}
53

eventespresso / event-espresso-core

Branch — FET-10304-welcome-to-vue (644299)

EE_Boolean_Field A

Complexity

Size/Duplication

Coupling/Cohesion

Importance

4 Methods

Duplication Side-by-Side

Filter issues like