Action::isLoadingRequired() - Code Metrics - Inspection of "Release/v0.4.3" - larriereguichet/AdminBundle - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#71)

by Arnaud

created 2016-11-05 21:52 UTC

Action::isLoadingRequired() A

↳ Parent: Action

Complexity

Conditions	1
Paths	1

Size

Total Lines	6
Code Lines	4

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	0
CRAP Score	2

Importance

Changes

Metric	Value
dl	0
loc	6
ccs	0
cts	0
cp	0
rs	9.4285
c	0
b	0
f	0
cc	1
eloc	4
nc	1
nop	0
crap	2

<?php

namespace LAG\AdminBundle\Action;

use LAG\AdminBundle\Action\Configuration\ActionConfiguration;
use LAG\AdminBundle\Admin\AdminInterface;
use LAG\AdminBundle\Admin\Filter;
use LAG\AdminBundle\Field\Field;

class Action implements ActionInterface
{
    /**
     * Action name.
     *
     * @var string
     */
    protected $name;

    /**
     * Action title.
     *
     * @var string
     */
    protected $title;

    /**
     * Fields displayed for this action.
     *
     * @var Field[]
     */
    protected $fields = [];

    /**
     * Action permissions.
     *
     * @var string[]
     */
    protected $permissions = [];

    /**
     * @var ActionConfiguration
     */
    protected $configuration;

    /**
     * @var array
     */
    protected $filters = [];

    /**
     * Action constructor.
     *
     * @param string $actionName
     * @param ActionConfiguration $configuration
     */
    public function __construct($actionName, ActionConfiguration $configuration)
    {
        $this->configuration = $configuration;
        $this->name = $actionName;
        $this->title = $configuration->getParameter('title');
        $this->permissions = $configuration->getParameter('permissions');
    }

    /**
     * @return string
     */
    public function getName()
    {
        return $this->name;
    }

    /**
     * @return string
     */
    public function getTitle()
    {
        return $this->title;
    }

    /**
     * @return Field[]
     */
    public function getFields()
    {
        return $this->fields;
    }

    /**
     * Return true if action has a field named $fieldName.
     *
     * @param string $fieldName
     *
     * @return bool
     */
    public function hasField($fieldName)
    {
        return array_key_exists($fieldName, $this->fields);
    }

    /**
     * @param Field[] $fields
     */
    public function setFields($fields)
    {
        $this->fields = $fields;
    }

    /**
     * @param Field $field
     */
    public function addField(Field $field)
    {
        $this->fields[$field->getName()] = $field;
    }

    /**
     * @return string[]
     */
    public function getPermissions()
    {
        return $this->permissions;
    }

    /**
     * @return array
     */
    public function getFilters()
    {
        return $this->filters;
    }

    /**
     * @param array $filters
     */
    public function setFilters($filters)
    {
        $this->filters = $filters;
    }

    /**
     * @param Filter $filter
     */
    public function addFilter(Filter $filter)
    {
        $this->filters[] = $filter;
    }
    
    /**
     * @return ActionConfiguration
     */
    public function getConfiguration()
    {
        return $this->configuration;
    }

    /**
     * Return true if the pagination is required for this action. Only action with a "multiple" load strategy require
     * pagination.
     *
     * @return bool
     */
    public function isPaginationRequired()
    {
        return $this
            ->configuration
            ->getParameter('load_strategy') === AdminInterface::LOAD_STRATEGY_MULTIPLE;
    }

    /**
     * Return true if one or more entities should be loaded ini this action.
     *
     * @return bool
     */
    public function isLoadingRequired()
    {
        return $this
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());
}
            ->configuration
            ->getParameter('load_strategy') !== AdminInterface::LOAD_STRATEGY_NONE;
    }
}


1		<?php
2
3		namespace LAG\AdminBundle\Action;
4
5		use LAG\AdminBundle\Action\Configuration\ActionConfiguration;
6		use LAG\AdminBundle\Admin\AdminInterface;
7		use LAG\AdminBundle\Admin\Filter;
8		use LAG\AdminBundle\Field\Field;
9
10		class Action implements ActionInterface
11		{
12		/**
13		* Action name.
14		*
15		* @var string
16		*/
17		protected $name;
18
19		/**
20		* Action title.
21		*
22		* @var string
23		*/
24		protected $title;
25
26		/**
27		* Fields displayed for this action.
28		*
29		* @var Field[]
30		*/
31		protected $fields = [];
32
33		/**
34		* Action permissions.
35		*
36		* @var string[]
37		*/
38		protected $permissions = [];
39
40		/**
41		* @var ActionConfiguration
42		*/
43		protected $configuration;
44
45		/**
46		* @var array
47		*/
48		protected $filters = [];
49
50		/**
51		* Action constructor.
52		*
53		* @param string $actionName
54		* @param ActionConfiguration $configuration
55		*/
56	15	public function __construct($actionName, ActionConfiguration $configuration)
57		{
58	15	$this->configuration = $configuration;
59	15	$this->name = $actionName;
60	15	$this->title = $configuration->getParameter('title');
61	15	$this->permissions = $configuration->getParameter('permissions');
62	15	}
63
64		/**
65		* @return string
66		*/
67	13	public function getName()
68		{
69	13	return $this->name;
70		}
71
72		/**
73		* @return string
74		*/
75	1	public function getTitle()
76		{
77	1	return $this->title;
78		}
79
80		/**
81		* @return Field[]
82		*/
83	1	public function getFields()
84		{
85	1	return $this->fields;
86		}
87
88		/**
89		* Return true if action has a field named $fieldName.
90		*
91		* @param string $fieldName
92		*
93		* @return bool
94		*/
95		public function hasField($fieldName)
96		{
97		return array_key_exists($fieldName, $this->fields);
98		}
99
100		/**
101		* @param Field[] $fields
102		*/
103		public function setFields($fields)
104		{
105		$this->fields = $fields;
106		}
107
108		/**
109		* @param Field $field
110		*/
111	2	public function addField(Field $field)
112		{
113	2	$this->fields[$field->getName()] = $field;
114	2	}
115
116		/**
117		* @return string[]
118		*/
119	3	public function getPermissions()
120		{
121	3	return $this->permissions;
122		}
123
124		/**
125		* @return array
126		*/
127		public function getFilters()
128		{
129		return $this->filters;
130		}
131
132		/**
133		* @param array $filters
134		*/
135		public function setFilters($filters)
136		{
137		$this->filters = $filters;
138		}
139
140		/**
141		* @param Filter $filter
142		*/
143		public function addFilter(Filter $filter)
144		{
145		$this->filters[] = $filter;
146		}
147
148		/**
149		* @return ActionConfiguration
150		*/
151	12	public function getConfiguration()
152		{
153	12	return $this->configuration;
154		}
155
156		/**
157		* Return true if the pagination is required for this action. Only action with a "multiple" load strategy require
158		* pagination.
159		*
160		* @return bool
161		*/
162	9	public function isPaginationRequired()
163		{
164	9	return $this
165		->configuration
166		->getParameter('load_strategy') === AdminInterface::LOAD_STRATEGY_MULTIPLE;
167		}
168
169		/**
170		* Return true if one or more entities should be loaded ini this action.
171		*
172		* @return bool
173		*/
174		public function isLoadingRequired()
175		{
176		return $this
		0 ignored issues – show Bug Best Practice introduced 2016-11-05 21:27 UTC by Report Bug Copy Issue Report The return type of `return $this->configurat...ce::LOAD_STRATEGY_NONE;` (`boolean`) is incompatible with the return type declared by the interface `LAG\AdminBundle\Action\A...face::isLoadingRequired` of type `LAG\AdminBundle\Action\true`. 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...
177		->configuration
178		->getParameter('load_strategy') !== AdminInterface::LOAD_STRATEGY_NONE;
179		}
180		}
181

larriereguichet / AdminBundle

Pull Request — master (#71)

Action::isLoadingRequired() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like