BusinessForm::_initForm() - Code Metrics - Inspection of "Widgets asModal" - phpMv/phpMv-UI - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 138cdf...e53430 )

by Jean-Christophe

created 2017-02-26 13:37 UTC

BusinessForm::_initForm() A

↳ Parent: BusinessForm

Complexity

Conditions	1
Paths	1

Size

Total Lines	7
Code Lines	6

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
c	0
b	0
f	0
dl	0
loc	7
rs	9.4285
cc	1
eloc	6
nc	1
nop	5

<?php

namespace Ajax\semantic\widgets\business;

use Ajax\semantic\widgets\dataform\DataForm;
use Ajax\JsUtils;

/**
 * @author jc
 */
abstract class BusinessForm extends DataForm {
	protected $_fieldsOrder;
	/**
	 *
	 * {@inheritdoc}
	 *
	 * @see \Ajax\semantic\widgets\dataform\DataForm::__construct()
	 */
	public function __construct($identifier,$modelInstance=null,$fieldsOrder,$fieldsDefinition,$fields=[],$captions=[],$separators=[]) {
		if(!isset($modelInstance)){
			$modelInstance=$this->getDefaultModelInstance();
		}
		parent::__construct($identifier,$modelInstance);
		$this->_initForm($fieldsOrder, $fieldsDefinition,$fields,$captions,$separators);
	}

	abstract protected function getDefaultModelInstance();

	protected function _initForm($fieldsOrder,$fieldsDefinition,$fields=[],$captions=[],$separators=[]){
		$this->_fieldsOrder=$fieldsOrder;
		$this->setFields($fields);
		$this->setSeparators($separators);
		$this->fieldsAs($fieldsDefinition);
		$this->setCaptions($captions);
	}

	protected function _getIndex($fieldName){
		$index=$fieldName;
		if(\is_string($fieldName)){
			$index=\array_search($fieldName, $this->_fieldsOrder);
		}
		return $index;
	}
	protected function _fieldAs($elementCallback,&$index,$attributes=NULL,$prefix=null){
		$index=$this->_getIndex($index);
		return parent::_fieldAs($elementCallback, $index,$attributes,$prefix);
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());
}
	}


	public function removeField($fieldName){
		parent::removeField($fieldName);
		\array_splice($this->_fieldsOrder,$this->_getIndex($fieldName),1);
		return $this;
	}

	public function compile(JsUtils $js=NULL,&$view=NULL){
		return parent::compile($js,$view);
	}
}

1			<?php
2
3			namespace Ajax\semantic\widgets\business;
4
5			use Ajax\semantic\widgets\dataform\DataForm;
6			use Ajax\JsUtils;
7
8			/**
9			* @author jc
10			*/
11			abstract class BusinessForm extends DataForm {
12			protected $_fieldsOrder;
13			/**
14			*
15			* {@inheritdoc}
16			*
17			* @see \Ajax\semantic\widgets\dataform\DataForm::__construct()
18			*/
19			public function __construct($identifier,$modelInstance=null,$fieldsOrder,$fieldsDefinition,$fields=[],$captions=[],$separators=[]) {
20			if(!isset($modelInstance)){
21			$modelInstance=$this->getDefaultModelInstance();
22			}
23			parent::__construct($identifier,$modelInstance);
24			$this->_initForm($fieldsOrder, $fieldsDefinition,$fields,$captions,$separators);
25			}
26
27			abstract protected function getDefaultModelInstance();
28
29			protected function _initForm($fieldsOrder,$fieldsDefinition,$fields=[],$captions=[],$separators=[]){
30			$this->_fieldsOrder=$fieldsOrder;
31			$this->setFields($fields);
32			$this->setSeparators($separators);
33			$this->fieldsAs($fieldsDefinition);
34			$this->setCaptions($captions);
35			}
36
37			protected function _getIndex($fieldName){
38			$index=$fieldName;
39			if(\is_string($fieldName)){
40			$index=\array_search($fieldName, $this->_fieldsOrder);
41			}
42			return $index;
43			}
44			protected function _fieldAs($elementCallback,&$index,$attributes=NULL,$prefix=null){
45			$index=$this->_getIndex($index);
46			return parent::_fieldAs($elementCallback, $index,$attributes,$prefix);
			0 ignored issues – show Bug Best Practice introduced 2017-02-25 02:37 UTC by Report Bug Copy Issue Report The return type of `return parent::_fieldAs(... $attributes, $prefix);` (`Ajax\semantic\widgets\business\BusinessForm`) is incompatible with the return type of the parent method `Ajax\common\Widget::_fieldAs` of type `Ajax\semantic\widgets\base\FieldAsTrait`. 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...
47			}
48
49
50			public function removeField($fieldName){
51			parent::removeField($fieldName);
52			\array_splice($this->_fieldsOrder,$this->_getIndex($fieldName),1);
53			return $this;
54			}
55
56			public function compile(JsUtils $js=NULL,&$view=NULL){
57			return parent::compile($js,$view);
58			}
59			}

phpMv / phpMv-UI

Push — master ( 138cdf...e53430 )

BusinessForm::_initForm() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like