PhpMethod::__construct() - Code Metrics - Inspection of "road to v0.4" - gossi/php-code-generator - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 55b21a...aec22b )

by Thomas

created 2016-11-15 12:20 UTC

PhpMethod::__construct() A

↳ Parent: PhpMethod

Complexity

Conditions	1
Paths	1

Size

Total Lines	4
Code Lines	3

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	4
CRAP Score	1

Importance

Changes

Metric	Value
c	0
b	0
f	0
dl	0
loc	4
ccs	4
cts	4
cp	1
rs	10
cc	1
eloc	3
nc	1
nop	1
crap	1

<?php
/*
 * Copyright 2011 Johannes M. Schmitt <[email protected]>
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 * http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
namespace gossi\codegen\model;

use gossi\codegen\model\parts\AbstractPart;
use gossi\codegen\model\parts\BodyPart;
use gossi\codegen\model\parts\FinalPart;
use gossi\codegen\model\parts\ParametersPart;
use gossi\codegen\model\parts\ReferenceReturnPart;
use gossi\codegen\model\parts\TypeDocblockGeneratorPart;
use gossi\docblock\Docblock;
use gossi\docblock\tags\ReturnTag;

/**
 * Represents a PHP method.
 *
 * @author Johannes M. Schmitt <[email protected]>
 * @author Thomas Gossmann
 */
class PhpMethod extends AbstractPhpMember implements RoutineInterface {

	use AbstractPart;
	use BodyPart;
	use FinalPart;
	use ParametersPart;
	use ReferenceReturnPart;
	use TypeDocblockGeneratorPart;

	/**
	 * Creates a new PHP method.
	 *
	 * @param string $name the method name
	 */
	public static function create($name) {
		return new static($name);
	}
	
	public function __construct($name) {
		parent::__construct($name);
		$this->initParameters();
class User
{
    private $email;

    public function getEmail()
    {
        return $this->email;
    }

    public function setEmail($email)
    {
        $this->email = $email;
    }
}
	}

	/**
	 * Generates docblock based on provided information
	 */
	public function generateDocblock() {
		$docblock = $this->getDocblock();
		$docblock->setShortDescription($this->getDescription());
		$docblock->setLongDescription($this->getLongDescription());

		// return tag
		$this->generateTypeTag(new ReturnTag());

		// param tags
		$this->generateParamDocblock();
	}
}


1		<?php
2		/*
3		* Copyright 2011 Johannes M. Schmitt <[email protected]>
4		*
5		* Licensed under the Apache License, Version 2.0 (the "License");
6		* you may not use this file except in compliance with the License.
7		* You may obtain a copy of the License at
8		*
9		* http://www.apache.org/licenses/LICENSE-2.0
10		*
11		* Unless required by applicable law or agreed to in writing, software
12		* distributed under the License is distributed on an "AS IS" BASIS,
13		* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14		* See the License for the specific language governing permissions and
15		* limitations under the License.
16		*/
17		namespace gossi\codegen\model;
18
19		use gossi\codegen\model\parts\AbstractPart;
20		use gossi\codegen\model\parts\BodyPart;
21		use gossi\codegen\model\parts\FinalPart;
22		use gossi\codegen\model\parts\ParametersPart;
23		use gossi\codegen\model\parts\ReferenceReturnPart;
24		use gossi\codegen\model\parts\TypeDocblockGeneratorPart;
25		use gossi\docblock\Docblock;
26		use gossi\docblock\tags\ReturnTag;
27
28		/**
29		* Represents a PHP method.
30		*
31		* @author Johannes M. Schmitt <[email protected]>
32		* @author Thomas Gossmann
33		*/
34		class PhpMethod extends AbstractPhpMember implements RoutineInterface {
35
36		use AbstractPart;
37		use BodyPart;
38		use FinalPart;
39		use ParametersPart;
40		use ReferenceReturnPart;
41		use TypeDocblockGeneratorPart;
42
43		/**
44		* Creates a new PHP method.
45		*
46		* @param string $name the method name
47		*/
48	22	public static function create($name) {
49	22	return new static($name);
50		}
51
52	37	public function __construct($name) {
53	37	parent::__construct($name);
54	37	$this->initParameters();
		1 ignored issue – show Unused Code introduced 2016-11-15 12:27 UTC by Report Bug Copy Issue Report The call to the method `gossi\codegen\model\PhpMethod::initParameters()` seems un-needed as the method has no side-effects. PHP Analyzer performs a side-effects analysis of your code. A side-effect is basically anything that might be visible after the scope of the method is left. Let’s take a look at an example: class User { private $email; public function getEmail() { return $this->email; } public function setEmail($email) { $this->email = $email; } } If we look at the `getEmail()` method, we can see that it has no side-effect. Whether you call this method or not, no future calls to other methods are affected by this. As such code as the following is useless: $user = new User(); $user->getEmail(); // This line could safely be removed as it has no effect. On the hand, if we look at the `setEmail()`, this method _has_ side-effects. In the following case, we could not remove the method call: $user = new User(); $user->setEmail('email@domain'); // This line has a side-effect (it changes an // instance variable). Loading history...
55	37	}
56
57		/**
58		* Generates docblock based on provided information
59		*/
60	11	public function generateDocblock() {
61	11	$docblock = $this->getDocblock();
62	11	$docblock->setShortDescription($this->getDescription());
63	11	$docblock->setLongDescription($this->getLongDescription());
64
65		// return tag
66	11	$this->generateTypeTag(new ReturnTag());
67
68		// param tags
69	11	$this->generateParamDocblock();
70	11	}
71		}
72

gossi / php-code-generator

Push — master ( 55b21a...aec22b )

PhpMethod::__construct() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like