TwigTemplateTask - Code Metrics - Inspection of "Add support for baking CRUD templates with Twig" - WyriHaximus/TwigView - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#32)

by Yves

created 2016-07-26 11:14 UTC

TwigTemplateTask A

↳ Parent: Project

Complexity

Total Complexity

Size/Duplication

Total Lines	33
Duplicated Lines	0 %

Coupling/Cohesion

Components	0
Dependencies	1

Test Coverage

Coverage

71.43%

Importance

Changes	2
Bugs	0	Features	0

Metric	Value
wmc	4
c	2
b	0
f	0
lcom	0
cbo	1
dl	0
loc	33
ccs	10
cts	14
cp	0.7143
rs	10

2 Methods

Rating	Name	Duplication	Size	Complexity
A	name()	0	4	1
A	bake()	0	17	3

<?php

/**
 * This file is part of TwigView.
 *
 ** (c) 2014 Cees-Jan Kiewiet
 *
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 */
namespace WyriHaximus\TwigView\Shell\Task;

use Bake\Shell\Task\TemplateTask;
use Cake\Console\Shell;
use Cake\Core\Configure;
use Cake\Utility\Inflector;

/**
 * Task class for creating and updating twig view template files.
 *
 */
class TwigTemplateTask extends TemplateTask
{

    public function name()
    {
        return 'twig_template';
    }

    /**
     * Assembles and writes bakes the twig view file.
     *
     * @param string $action Action to bake.
     * @param string $content Content to write.
     * @return string Generated file content.
     */
    public function bake($action, $content = '')
    {
        if ($content === true) {
            $content = $this->getContent($action);
        }
        if (empty($content)) {
            $this->err("<warning>No generated content for '{$action}.ctp', not generating template.</warning>");

            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());
}
        }
        $this->out("\n" . sprintf('Baking `%s` view twig template file...', $action), 1, Shell::QUIET);
        $path = $this->getPath();
        $filename = $path . Inflector::underscore($action) . '.twig';
        $this->createFile($filename, $content);

        return $content;
    }
}


1		<?php
2
3		/**
4		* This file is part of TwigView.
5		*
6		** (c) 2014 Cees-Jan Kiewiet
7		*
8		* For the full copyright and license information, please view the LICENSE
9		* file that was distributed with this source code.
10		*/
11		namespace WyriHaximus\TwigView\Shell\Task;
12
13		use Bake\Shell\Task\TemplateTask;
14		use Cake\Console\Shell;
15		use Cake\Core\Configure;
16		use Cake\Utility\Inflector;
17
18		/**
19		* Task class for creating and updating twig view template files.
20		*
21		*/
22		class TwigTemplateTask extends TemplateTask
23		{
24
25		public function name()
26		{
27		return 'twig_template';
28		}
29
30		/**
31		* Assembles and writes bakes the twig view file.
32		*
33		* @param string $action Action to bake.
34		* @param string $content Content to write.
35		* @return string Generated file content.
36		*/
37	4	public function bake($action, $content = '')
38		{
39	4	if ($content === true) {
40	4	$content = $this->getContent($action);
41	4	}
42	4	if (empty($content)) {
43		$this->err("<warning>No generated content for '{$action}.ctp', not generating template.</warning>");
44
45		return false;
		0 ignored issues – show Bug Best Practice introduced 2016-07-26 11:19 UTC by Report Bug Copy Issue Report The return type of `return false;` (`false`) is incompatible with the return type documented by `WyriHaximus\TwigView\She...\TwigTemplateTask::bake` of type `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...
46		}
47	4	$this->out("\n" . sprintf('Baking `%s` view twig template file...', $action), 1, Shell::QUIET);
48	4	$path = $this->getPath();
49	4	$filename = $path . Inflector::underscore($action) . '.twig';
50	4	$this->createFile($filename, $content);
51
52	4	return $content;
53		}
54		}
55

WyriHaximus / TwigView

Pull Request — master (#32)

TwigTemplateTask A

Complexity

Size/Duplication

Coupling/Cohesion

Test Coverage

Importance

2 Methods

Duplication Side-by-Side

Filter issues like