TemporaryInlineFormAction - Code Metrics - Inspection of "WIP: Upgrade for SS4" - silverstripe/silverstripe-translatable - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#264)

by Robbie

created 2017-08-11 00:13 UTC

TemporaryInlineFormAction A

↳ Parent: Project

Complexity

Total Complexity

Size/Duplication

Total Lines	42
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	3

Importance

Changes

Metric	Value
wmc	4
lcom	1
cbo	3
dl	0
loc	42
rs	10
c	0
b	0
f	0

4 Methods

Rating	Name	Size	Complexity
A	__construct()	5	1
A	performReadonlyTransformation()	4	1
A	Field()	13	1
A	Title()	4	1

<?php

namespace SilverStripe\Translatable\Forms;

use SilverStripe\ORM\FieldType\DBField;
use SilverStripe\Forms\FormField;
use SilverStripe\View\HTML;

/**
 * TEMPORARY
 *
 * Removed from 4.0 - added temporarily to restore functionality while upgrading to SS4
 */
class TemporaryInlineFormAction extends FormField
{
    /**
     * Create a new action button.
     * @param action The method to call when the button is clicked
     * @param title The label on the button
     * @param extraClass A CSS class to apply to the button in addition to 'action'
     */
    public function __construct($action, $title = '', $extraClass = '')
    {
        $this->extraClass = ' '.$extraClass;
        parent::__construct($action, $title);
    }

    public function performReadonlyTransformation()
    {
        return $this->castedCopy('InlineFormAction_ReadOnly');
    }

    /**
     * @param array $properties
     * @return HTMLText
     */
    public function Field($properties = [])
    {
        return DBField::create_field(
            'HTMLText',
            HTML::createTag('input', [
                'type' => 'submit',
                'name' => sprintf('action_%s', $this->getName()),
                'value' => $this->title,
                'id' => $this->ID(),
                'class' => sprintf('action%s', $this->extraClass),
            ])
        );
    }

    public function Title()
    {
        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());
}
    }
}


1			<?php
2
3			namespace SilverStripe\Translatable\Forms;
4
5			use SilverStripe\ORM\FieldType\DBField;
6			use SilverStripe\Forms\FormField;
7			use SilverStripe\View\HTML;
8
9			/**
10			* TEMPORARY
11			*
12			* Removed from 4.0 - added temporarily to restore functionality while upgrading to SS4
13			*/
14			class TemporaryInlineFormAction extends FormField
15			{
16			/**
17			* Create a new action button.
18			* @param action The method to call when the button is clicked
19			* @param title The label on the button
20			* @param extraClass A CSS class to apply to the button in addition to 'action'
21			*/
22			public function __construct($action, $title = '', $extraClass = '')
23			{
24			$this->extraClass = ' '.$extraClass;
25			parent::__construct($action, $title);
26			}
27
28			public function performReadonlyTransformation()
29			{
30			return $this->castedCopy('InlineFormAction_ReadOnly');
31			}
32
33			/**
34			* @param array $properties
35			* @return HTMLText
36			*/
37			public function Field($properties = [])
38			{
39			return DBField::create_field(
40			'HTMLText',
41			HTML::createTag('input', [
42			'type' => 'submit',
43			'name' => sprintf('action_%s', $this->getName()),
44			'value' => $this->title,
45			'id' => $this->ID(),
46			'class' => sprintf('action%s', $this->extraClass),
47			])
48			);
49			}
50
51			public function Title()
52			{
53			return false;
			0 ignored issues – show Bug Best Practice introduced 2017-08-11 00:26 UTC by Report Bug Copy Issue Report The return type of `return false;` (`false`) is incompatible with the return type of the parent method `SilverStripe\Forms\FormField::Title` of type `null\|string`. 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...
54			}
55			}
56

silverstripe / silverstripe-translatable

Pull Request — master (#264)

TemporaryInlineFormAction A

Complexity

Size/Duplication

Coupling/Cohesion

Importance

4 Methods

Duplication Side-by-Side

Filter issues like