PhpProperty::export() - Code Metrics - Inspection of "Add parent class support from reflection, remove p..." - gossi/php-code-generator - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#30)

unknown

created 2016-06-30 07:39 UTC

PhpProperty::export() B

↳ Parent: PhpProperty

Complexity

Conditions	7
Paths	7

Size

Total Lines	19
Code Lines	16

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	0
CRAP Score	56

Importance

Changes	1
Bugs	0	Features	1

Metric	Value
c	1
b	0
f	1
dl	0
loc	19
ccs	0
cts	15
cp	0
rs	8.2222
cc	7
eloc	16
nc	7
nop	2
crap	56

<?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\TypeDocblockGeneratorPart;
use gossi\codegen\model\parts\ValuePart;
use gossi\docblock\Docblock;
use gossi\docblock\tags\VarTag;

/**
 * Represents a PHP property.
 *
 * @author Johannes M. Schmitt <[email protected]>
 * @author Thomas Gossmann
 */
class PhpProperty extends AbstractPhpMember {

	use TypeDocblockGeneratorPart;
	use ValuePart;

	/**
	 * Creates a new PHP property
	 *
	 * @param string $name the properties name
	 * @return static
	 */
	public static function create($name) {
		return new static($name);
	}


	/**
	 * Export array as php 5.4
	 *
	 * @param $var
	 * @param string $indent
	 * @return string
	 */
	static public function export($var, $indent="") {
<?php

$singleQuoted = 'Value';
$doubleQuoted = "\tSingle is $singleQuoted";

print $doubleQuoted;
		switch (gettype($var)) {
			case "string":
<?php

$singleQuoted = 'Value';
$doubleQuoted = "\tSingle is $singleQuoted";

print $doubleQuoted;
				return '"' . addcslashes($var, "\\\$\"\r\n\t\v\f") . '"';
			case "array":
<?php

$singleQuoted = 'Value';
$doubleQuoted = "\tSingle is $singleQuoted";

print $doubleQuoted;
				$indexed = array_keys($var) === range(0, count($var) - 1);
				$r = [];
				foreach ($var as $key => $value) {
					$r[] = "$indent    "
// Instead of
$x = "foo $bar $baz";

// Better use either
$x = "foo " . $bar . " " . $baz;
$x = sprintf("foo %s %s", $bar, $baz);
						. ($indexed ? "" : static::export($key) . " => ")
<?php

$singleQuoted = 'Value';
$doubleQuoted = "\tSingle is $singleQuoted";

print $doubleQuoted;
						. static::export($value, "$indent    ");
// Instead of
$x = "foo $bar $baz";

// Better use either
$x = "foo " . $bar . " " . $baz;
$x = sprintf("foo %s %s", $bar, $baz);
				}
				return "[\n" . implode(",\n", $r) . "\n" . $indent . "]";
<?php

$singleQuoted = 'Value';
$doubleQuoted = "\tSingle is $singleQuoted";

print $doubleQuoted;
			case "boolean":
<?php

$singleQuoted = 'Value';
$doubleQuoted = "\tSingle is $singleQuoted";

print $doubleQuoted;
				return $var ? "TRUE" : "FALSE";
<?php

$singleQuoted = 'Value';
$doubleQuoted = "\tSingle is $singleQuoted";

print $doubleQuoted;
			default:
				return var_export($var, TRUE);
		}
	}

	/**
	 * Creates a new PHP property from reflection
	 *
	 * @param \ReflectionProperty $ref
	 * @return static
	 */
	public static function fromReflection(\ReflectionProperty $ref) {
		$property = new static($ref->name);
		$property->setStatic($ref->isStatic())
			->setVisibility($ref->isPublic() ? self::VISIBILITY_PUBLIC : ($ref->isProtected() ? self::VISIBILITY_PROTECTED : self::VISIBILITY_PRIVATE));

		$docblock = new Docblock($ref);
		$property->setDocblock($docblock);
		$property->setDescription($docblock->getShortDescription());
		$property->setLongDescription($docblock->getLongDescription());

		$vars = $docblock->getTags('var');
		if ($vars->size() > 0) {
			$var = $vars->get(0);
			$property->setType($var->getType(), $var->getDescription());
		}

		$defaultProperties = $ref->getDeclaringClass()->getDefaultProperties();

		if (isset($defaultProperties[$ref->name])) {
			$default = $defaultProperties[$ref->name];
			if (is_string($default)) {
				$property->setValue($default);
			} elseif(is_array($default)) {
				$property->setValue(static::export($default));
			} elseif(is_object($default)) {

			} else {
				$property->setExpression($default);
			}
		}

		return $property;
	}

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

		// var tag
		$this->generateTypeTag(new VarTag());
	}
}


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\TypeDocblockGeneratorPart;
20		use gossi\codegen\model\parts\ValuePart;
21		use gossi\docblock\Docblock;
22		use gossi\docblock\tags\VarTag;
23
24		/**
25		* Represents a PHP property.
26		*
27		* @author Johannes M. Schmitt <[email protected]>
28		* @author Thomas Gossmann
29		*/
30		class PhpProperty extends AbstractPhpMember {
31
32		use TypeDocblockGeneratorPart;
33		use ValuePart;
34
35		/**
36		* Creates a new PHP property
37		*
38		* @param string $name the properties name
39		* @return static
40		*/
41	11	public static function create($name) {
42	11	return new static($name);
43		}
44
45
46		/**
47		* Export array as php 5.4
48		*
49		* @param $var
50		* @param string $indent
51		* @return string
52		*/
53		static public function export($var, $indent="") {
		0 ignored issues – show Coding Style introduced 2016-06-30 07:42 UTC by Report Bug Copy Issue Report As per PSR2, the `static` declaration should come after the visibility declaration. Loading history... Coding Style Comprehensibility introduced 2016-06-30 07:42 UTC by Report Bug Copy Issue Report The string literal does not require double quotes, as per coding-style, please use single quotes. PHP provides two ways to mark string literals. Either with single quotes `'literal'` or with double quotes `"literal"`. The difference between these is that string literals in double quotes may contain variables with are evaluated at run-time as well as escape sequences. String literals in single quotes on the other hand are evaluated very literally and the only two characters that needs escaping in the literal are the single quote itself (`\'`) and the backslash (`\\`). Every other character is displayed as is. Double quoted string literals may contain other variables or more complex escape sequences. <?php $singleQuoted = 'Value'; $doubleQuoted = "\tSingle is $singleQuoted"; print $doubleQuoted; will print an indented: `Single is Value` If your string literal does not contain variables or escape sequences, it should be defined using single quotes to make that fact clear. For more information on PHP string literals and available escape sequences see the PHP core documentation. Loading history...
54		switch (gettype($var)) {
55		case "string":
		0 ignored issues – show Coding Style Comprehensibility introduced 2016-06-30 07:42 UTC by Report Bug Copy Issue Report The string literal `string` does not require double quotes, as per coding-style, please use single quotes. PHP provides two ways to mark string literals. Either with single quotes `'literal'` or with double quotes `"literal"`. The difference between these is that string literals in double quotes may contain variables with are evaluated at run-time as well as escape sequences. String literals in single quotes on the other hand are evaluated very literally and the only two characters that needs escaping in the literal are the single quote itself (`\'`) and the backslash (`\\`). Every other character is displayed as is. Double quoted string literals may contain other variables or more complex escape sequences. <?php $singleQuoted = 'Value'; $doubleQuoted = "\tSingle is $singleQuoted"; print $doubleQuoted; will print an indented: `Single is Value` If your string literal does not contain variables or escape sequences, it should be defined using single quotes to make that fact clear. For more information on PHP string literals and available escape sequences see the PHP core documentation. Loading history...
56		return '"' . addcslashes($var, "\\\$\"\r\n\t\v\f") . '"';
57		case "array":
		0 ignored issues – show Coding Style Comprehensibility introduced 2016-06-30 07:42 UTC by Report Bug Copy Issue Report The string literal `array` does not require double quotes, as per coding-style, please use single quotes. PHP provides two ways to mark string literals. Either with single quotes `'literal'` or with double quotes `"literal"`. The difference between these is that string literals in double quotes may contain variables with are evaluated at run-time as well as escape sequences. String literals in single quotes on the other hand are evaluated very literally and the only two characters that needs escaping in the literal are the single quote itself (`\'`) and the backslash (`\\`). Every other character is displayed as is. Double quoted string literals may contain other variables or more complex escape sequences. <?php $singleQuoted = 'Value'; $doubleQuoted = "\tSingle is $singleQuoted"; print $doubleQuoted; will print an indented: `Single is Value` If your string literal does not contain variables or escape sequences, it should be defined using single quotes to make that fact clear. For more information on PHP string literals and available escape sequences see the PHP core documentation. Loading history...
58		$indexed = array_keys($var) === range(0, count($var) - 1);
59		$r = [];
60		foreach ($var as $key => $value) {
61		$r[] = "$indent "
		0 ignored issues – show Coding Style Best Practice introduced 2016-06-30 07:42 UTC by Report Bug Copy Issue Report As per coding-style, please use concatenation or `sprintf` for the variable `$indent` instead of interpolation. It is generally a best practice as it is often more readable to use concatenation instead of interpolation for variables inside strings. // Instead of $x = "foo $bar $baz"; // Better use either $x = "foo " . $bar . " " . $baz; $x = sprintf("foo %s %s", $bar, $baz); Loading history...
62		. ($indexed ? "" : static::export($key) . " => ")
		0 ignored issues – show Coding Style Comprehensibility introduced 2016-06-30 07:42 UTC by Report Bug Copy Issue Report The string literal does not require double quotes, as per coding-style, please use single quotes. PHP provides two ways to mark string literals. Either with single quotes `'literal'` or with double quotes `"literal"`. The difference between these is that string literals in double quotes may contain variables with are evaluated at run-time as well as escape sequences. String literals in single quotes on the other hand are evaluated very literally and the only two characters that needs escaping in the literal are the single quote itself (`\'`) and the backslash (`\\`). Every other character is displayed as is. Double quoted string literals may contain other variables or more complex escape sequences. <?php $singleQuoted = 'Value'; $doubleQuoted = "\tSingle is $singleQuoted"; print $doubleQuoted; will print an indented: `Single is Value` If your string literal does not contain variables or escape sequences, it should be defined using single quotes to make that fact clear. For more information on PHP string literals and available escape sequences see the PHP core documentation. Loading history... Coding Style Comprehensibility introduced 2016-06-30 07:42 UTC by Report Bug Copy Issue Report The string literal `=>` does not require double quotes, as per coding-style, please use single quotes. PHP provides two ways to mark string literals. Either with single quotes `'literal'` or with double quotes `"literal"`. The difference between these is that string literals in double quotes may contain variables with are evaluated at run-time as well as escape sequences. String literals in single quotes on the other hand are evaluated very literally and the only two characters that needs escaping in the literal are the single quote itself (`\'`) and the backslash (`\\`). Every other character is displayed as is. Double quoted string literals may contain other variables or more complex escape sequences. <?php $singleQuoted = 'Value'; $doubleQuoted = "\tSingle is $singleQuoted"; print $doubleQuoted; will print an indented: `Single is Value` If your string literal does not contain variables or escape sequences, it should be defined using single quotes to make that fact clear. For more information on PHP string literals and available escape sequences see the PHP core documentation. Loading history...
63		. static::export($value, "$indent ");
		0 ignored issues – show Coding Style Best Practice introduced 2016-06-30 07:42 UTC by Report Bug Copy Issue Report As per coding-style, please use concatenation or `sprintf` for the variable `$indent` instead of interpolation. It is generally a best practice as it is often more readable to use concatenation instead of interpolation for variables inside strings. // Instead of $x = "foo $bar $baz"; // Better use either $x = "foo " . $bar . " " . $baz; $x = sprintf("foo %s %s", $bar, $baz); Loading history...
64		}
65		return "[\n" . implode(",\n", $r) . "\n" . $indent . "]";
		0 ignored issues – show Coding Style Comprehensibility introduced 2016-06-30 07:42 UTC by Report Bug Copy Issue Report The string literal `]` does not require double quotes, as per coding-style, please use single quotes. PHP provides two ways to mark string literals. Either with single quotes `'literal'` or with double quotes `"literal"`. The difference between these is that string literals in double quotes may contain variables with are evaluated at run-time as well as escape sequences. String literals in single quotes on the other hand are evaluated very literally and the only two characters that needs escaping in the literal are the single quote itself (`\'`) and the backslash (`\\`). Every other character is displayed as is. Double quoted string literals may contain other variables or more complex escape sequences. <?php $singleQuoted = 'Value'; $doubleQuoted = "\tSingle is $singleQuoted"; print $doubleQuoted; will print an indented: `Single is Value` If your string literal does not contain variables or escape sequences, it should be defined using single quotes to make that fact clear. For more information on PHP string literals and available escape sequences see the PHP core documentation. Loading history...
66		case "boolean":
		0 ignored issues – show Coding Style Comprehensibility introduced 2016-06-30 07:42 UTC by Report Bug Copy Issue Report The string literal `boolean` does not require double quotes, as per coding-style, please use single quotes. PHP provides two ways to mark string literals. Either with single quotes `'literal'` or with double quotes `"literal"`. The difference between these is that string literals in double quotes may contain variables with are evaluated at run-time as well as escape sequences. String literals in single quotes on the other hand are evaluated very literally and the only two characters that needs escaping in the literal are the single quote itself (`\'`) and the backslash (`\\`). Every other character is displayed as is. Double quoted string literals may contain other variables or more complex escape sequences. <?php $singleQuoted = 'Value'; $doubleQuoted = "\tSingle is $singleQuoted"; print $doubleQuoted; will print an indented: `Single is Value` If your string literal does not contain variables or escape sequences, it should be defined using single quotes to make that fact clear. For more information on PHP string literals and available escape sequences see the PHP core documentation. Loading history...
67		return $var ? "TRUE" : "FALSE";
		0 ignored issues – show Coding Style Comprehensibility introduced 2016-06-30 07:42 UTC by Report Bug Copy Issue Report The string literal `TRUE` does not require double quotes, as per coding-style, please use single quotes. PHP provides two ways to mark string literals. Either with single quotes `'literal'` or with double quotes `"literal"`. The difference between these is that string literals in double quotes may contain variables with are evaluated at run-time as well as escape sequences. String literals in single quotes on the other hand are evaluated very literally and the only two characters that needs escaping in the literal are the single quote itself (`\'`) and the backslash (`\\`). Every other character is displayed as is. Double quoted string literals may contain other variables or more complex escape sequences. <?php $singleQuoted = 'Value'; $doubleQuoted = "\tSingle is $singleQuoted"; print $doubleQuoted; will print an indented: `Single is Value` If your string literal does not contain variables or escape sequences, it should be defined using single quotes to make that fact clear. For more information on PHP string literals and available escape sequences see the PHP core documentation. Loading history... Coding Style Comprehensibility introduced 2016-06-30 07:42 UTC by Report Bug Copy Issue Report The string literal `FALSE` does not require double quotes, as per coding-style, please use single quotes. PHP provides two ways to mark string literals. Either with single quotes `'literal'` or with double quotes `"literal"`. The difference between these is that string literals in double quotes may contain variables with are evaluated at run-time as well as escape sequences. String literals in single quotes on the other hand are evaluated very literally and the only two characters that needs escaping in the literal are the single quote itself (`\'`) and the backslash (`\\`). Every other character is displayed as is. Double quoted string literals may contain other variables or more complex escape sequences. <?php $singleQuoted = 'Value'; $doubleQuoted = "\tSingle is $singleQuoted"; print $doubleQuoted; will print an indented: `Single is Value` If your string literal does not contain variables or escape sequences, it should be defined using single quotes to make that fact clear. For more information on PHP string literals and available escape sequences see the PHP core documentation. Loading history...
68		default:
69		return var_export($var, TRUE);
70		}
71		}
72
73		/**
74		* Creates a new PHP property from reflection
75		*
76		* @param \ReflectionProperty $ref
77		* @return static
78		*/
79	1	public static function fromReflection(\ReflectionProperty $ref) {
80	1	$property = new static($ref->name);
81	1	$property->setStatic($ref->isStatic())
82	1	->setVisibility($ref->isPublic() ? self::VISIBILITY_PUBLIC : ($ref->isProtected() ? self::VISIBILITY_PROTECTED : self::VISIBILITY_PRIVATE));
83
84	1	$docblock = new Docblock($ref);
85	1	$property->setDocblock($docblock);
86	1	$property->setDescription($docblock->getShortDescription());
87	1	$property->setLongDescription($docblock->getLongDescription());
88
89	1	$vars = $docblock->getTags('var');
90	1	if ($vars->size() > 0) {
91		$var = $vars->get(0);
92		$property->setType($var->getType(), $var->getDescription());
93		}
94
95	1	$defaultProperties = $ref->getDeclaringClass()->getDefaultProperties();
96
97	1	if (isset($defaultProperties[$ref->name])) {
98		$default = $defaultProperties[$ref->name];
99		if (is_string($default)) {
100		$property->setValue($default);
101		} elseif(is_array($default)) {
102		$property->setValue(static::export($default));
103		} elseif(is_object($default)) {
		0 ignored issues – show Unused Code introduced 2016-06-30 07:42 UTC by Report Bug Copy Issue Report This `elseif` statement is empty, and could be removed. This check looks for the bodies of `elseif` statements that have no statements or where all statements have been commented out. This may be the result of changes for debugging or the code may simply be obsolete. These `elseif` bodies can be removed. If you have an empty elseif but statements in the `else` branch, consider inverting the condition. Loading history...
104		} else {
105		$property->setExpression($default);
106		}
107		}
108
109	1	return $property;
110		}
111
112		/**
113		* Generates docblock based on provided information
114		*/
115	8	public function generateDocblock() {
116	8	$docblock = $this->getDocblock();
117	8	$docblock->setShortDescription($this->getDescription());
118	8	$docblock->setLongDescription($this->getLongDescription());
119
120		// var tag
121	8	$this->generateTypeTag(new VarTag());
122	8	}
123		}
124

gossi / php-code-generator

Pull Request — master (#30)

PhpProperty::export() B

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like