ImportConnector - Code Metrics - owncloud/contacts - Measure and Improve Code Quality continuously with Scrutinizer

ImportConnector B
last analyzed 2016-02-29 12:21 UTC

↳ Parent: Project

Complexity

Total Complexity

Size/Duplication

Total Lines	155
Duplicated Lines	3.87 %

Coupling/Cohesion

Components	0
Dependencies	1

Test Coverage

Coverage

Importance

Changes	2
Bugs	1	Features	0

Metric	Value
wmc	38
c	2
b	1
f	0
lcom	0
cbo	1
dl	6
loc	155
ccs	0
cts	110
cp	0
rs	8.3999

8 Methods

Rating	Name	Duplication	Size	Complexity
	getElementsFromInput()	0	1	?
	convertElementToVCard()	0	1	?
	getFormatMatch()	0	1	?
A	setConfig()	0	3	1
A	__construct()	0	5	2
A	updateImageProperty()	6	13	2
D	updateProperty()	0	41	14
C	getOrCreateVCardProperty()	0	55	19

How to fix Duplicated Code

<?php
/**
 * ownCloud - CSV Import connector
 *
 * @author Nicolas Mora
 * @copyright 2013-2014 Nicolas Mora [email protected]
 *
 * This library is free software; you can redistribute it and/or
 * modify it under the terms of the GNU AFFERO GENERAL PUBLIC LICENSE
 * License as published by the Free Software Foundation
 * version 3 of the License
 *
 * This library is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.	See the
 * GNU AFFERO GENERAL PUBLIC LICENSE for more details.
 *
 * You should have received a copy of the GNU Affero General Public
 * License along with this library.	If not, see <http://www.gnu.org/licenses/>.
 *
 */
 

namespace OCA\Contacts\Connector;

use Sabre\VObject\StringUtil;

/**
 * Abstract class used to implement import classes
 */
abstract class ImportConnector {

	// XML Configuration, class SimpleXml format
	protected $configContent;
	
	/**
	 * @param \SimpleXMLElement $xml_config
	 */
	public function __construct($xml_config = null) {

		if ($xml_config != null) {
			$this->setConfig($xml_config);
		}
	}
	
	// returns a table containing converted elements from the input file
	abstract function getElementsFromInput($input, $limit=-1);

	
	// returns a single converted element
	abstract function convertElementToVCard($element);

	
	// returns the probability that the file matchs the current format
	abstract function getFormatMatch($file);

	
	public function setConfig($xml_config) {

		$this->configContent = $xml_config;
	}
	
	/**
	 * @brief updates a property given in parameter with the value and using the importEntry to set the different parameters
	 * @param $property the property to update
	 * @param $importEntry the entry configuration to update in SimpleXml format
	 * @value the value to update
	 */
	protected function updateProperty(&$property, $importEntry, $value) {
		if (isset($property) && isset($importEntry) && isset($value)) {
			if (isset($importEntry->vcard_entry)) {
				if (isset($importEntry->vcard_entry['type'])) {
					$property->add('TYPE', StringUtil::convertToUTF8($importEntry->vcard_entry['type']));
				}
				if (isset($importEntry->vcard_entry->additional_property)) {
					foreach ($importEntry->vcard_entry->additional_property as $additionalProperty) {
						$property->add($additionalProperty['name'], $additionalProperty['value']);
					}
				}
				if (isset($importEntry->vcard_entry['prefix'])) {
					$value = $importEntry->vcard_entry['prefix'].$value;
				}
				if (isset($importEntry->vcard_entry['group'])) {
					$property->group = $importEntry->vcard_entry['group'];
				}
				if (isset($importEntry->vcard_entry['position'])) {
					$separator=";";
$myVar = 'Value';
$higher = false;

if (rand(1, 6) > 3) {
    $higher = true;
} else {
    $higher = false;
}
					if (isset($importEntry->vcard_entry['separator'])) {
						$separator=$importEntry->vcard_entry['separator'];
$myVar = 'Value';
$higher = false;

if (rand(1, 6) > 3) {
    $higher = true;
} else {
    $higher = false;
}
					}
					$position = $importEntry->vcard_entry['position'];
					$vArray = $property->getParts();
					$vArray[intval($position)] = StringUtil::convertToUTF8($value);
					$property->setParts($vArray);
				} else {
					if (isset($importEntry->vcard_entry['value'])) {
						$property->add('TYPE', StringUtil::convertToUTF8($value));
					} else {
						$curVal = $property->getParts();
						$curVal[] = StringUtil::convertToUTF8($value);
						$property->setValue($curVal);
					}
				}
			}
			if (isset($importEntry->vcard_parameter)) {
				$property->add($importEntry->vcard_parameter['parameter'], StringUtil::convertToUTF8($value));
			}
		}
	}
		
	/**
	 * @brief modifies a vcard property array with the image
	 */
	public function updateImageProperty(&$property, $entry, $version=null) {
		$image = new \OC_Image();
		$image->loadFromData($entry);
		if (strcmp($version, '4.0') == 0) {

			$type = $image->mimeType();
		} else {
			$arrayType = explode('/', $image->mimeType());
			$type = strtoupper(array_pop($arrayType));
		}
		$property->add('ENCODING', 'b');
		$property->add('TYPE', $type);
		$property->setValue($image->__toString());
	}

	/**
	 * @brief returns the vcard property corresponding to the parameter
	 * creates the property if it doesn't exists yet
	 * @param $vcard the vcard to get or create the properties with
	 * @param $importEntry the parameter to find
	 * @return the property|false
	 */
	protected function getOrCreateVCardProperty(&$vcard, $importEntry) {

		
		if (isset($vcard) && isset($importEntry)) {
			// looking for a property with the same name
			$properties = $vcard->select($importEntry['property']);
			foreach ($properties as $property) {
				if ($importEntry['type'] == null && !isset($importEntry->additional_property)) {
					return $property;
				}
				foreach ($property->parameters as $parameter) {
					// Filtering types
					if ($parameter->name == 'TYPE' && !strcmp($parameter->getValue(), $importEntry['type'])) {
						$found=0;
						if (isset($importEntry->additional_property)) {
							// Filtering additional properties if necessary (I know, there are a lot of inner loops, sorry)
							foreach($importEntry->additional_property as $additional_property) {
								if ((string)$parameter->name == $additional_property['name']) {
									$found++;
								}
							}
							if ($found == count($importEntry->additional_property)) {
								return $property;
							}
						}
						return $property;
					}
				}
				
				if (isset($importEntry['group']) && $property->group == $importEntry['group']) {
					return $property;
				}
			}		
			
			// Property not found, creating one
			$property = $vcard->createProperty($importEntry['property']);
			$vcard->add($property);
			if ($importEntry['type']!=null) {
				$property->add('TYPE', StringUtil::convertToUTF8($importEntry['type']));
			}
			switch ($importEntry['property']) {
				case "ADR":
					$property->setValue(array('', '', '', '', '', '', ''));
					break;
				case "N":
					$property->setValue(array('', '', '', '', ''));
					break;
			}
			if ($importEntry['group']!=null) {
				$property->group = $importEntry['group'];
			}
			return $property;
		} else {
			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());
}
		}
	}
}

?>



1		<?php
2		/**
3		* ownCloud - CSV Import connector
4		*
5		* @author Nicolas Mora
6		* @copyright 2013-2014 Nicolas Mora [email protected]
7		*
8		* This library is free software; you can redistribute it and/or
9		* modify it under the terms of the GNU AFFERO GENERAL PUBLIC LICENSE
10		* License as published by the Free Software Foundation
11		* version 3 of the License
12		*
13		* This library is distributed in the hope that it will be useful,
14		* but WITHOUT ANY WARRANTY; without even the implied warranty of
15		* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16		* GNU AFFERO GENERAL PUBLIC LICENSE for more details.
17		*
18		* You should have received a copy of the GNU Affero General Public
19		* License along with this library. If not, see <http://www.gnu.org/licenses/>.
20		*
21		*/
22
		0 ignored issues – show Coding Style introduced 2015-11-26 05:51 UTC by Report Bug Copy Issue Report Tabs must be used to indent lines; spaces are not allowed Loading history...
23		namespace OCA\Contacts\Connector;
24
25		use Sabre\VObject\StringUtil;
26
27		/**
28		* Abstract class used to implement import classes
29		*/
30		abstract class ImportConnector {
31
32		// XML Configuration, class SimpleXml format
33		protected $configContent;
34
35		/**
36		* @param \SimpleXMLElement $xml_config
37		*/
38		public function __construct($xml_config = null) {
		0 ignored issues – show Coding Style Naming introduced 2015-11-26 05:51 UTC by Report Bug Copy Issue Report The parameter $xml_config is not named in camelCase. This check marks parameter names that have not been written in camelCase. In camelCase names are written without any punctuation, the start of each new word being marked by a capital letter. Thus the name database connection string becomes `databaseConnectionString`. Loading history... Coding Style Naming introduced 2015-11-26 05:51 UTC by Report Bug Copy Issue Report The variable $xml_config is not named in camelCase. This check marks variable names that have not been written in camelCase. In camelCase names are written without any punctuation, the start of each new word being marked by a capital letter. Thus the name database connection string becomes `databaseConnectionString`. Loading history...
39		if ($xml_config != null) {
40		$this->setConfig($xml_config);
41		}
42		}
43
44		// returns a table containing converted elements from the input file
45		abstract function getElementsFromInput($input, $limit=-1);
		0 ignored issues – show Best Practice introduced 2015-11-26 05:51 UTC by Report Bug Copy Issue Report It is generally recommended to explicitly declare the visibility for methods. Adding explicit visibility (`private`, `protected`, or `public`) is generally recommend to communicate to other developers how, and from where this method is intended to be used. Loading history... Comprehensibility Best Practice introduced 2015-11-26 05:51 UTC by Report Bug Copy Issue Report It is recommend to declare an explicit visibility for `getElementsFromInput`. Generally, we recommend to declare visibility for all methods in your source code. This has the advantage of clearly communication to other developers, and also yourself, how this method should be consumed. If you are not sure which visibility to choose, it is a good idea to start with the most restrictive visibility, and then raise visibility as needed, i.e. start with `private`, and only raise it to `protected` if a sub-class needs to have access, or `public` if an external class needs access. Loading history...
46
47		// returns a single converted element
48		abstract function convertElementToVCard($element);
		0 ignored issues – show Best Practice introduced 2015-11-26 05:51 UTC by Report Bug Copy Issue Report It is generally recommended to explicitly declare the visibility for methods. Adding explicit visibility (`private`, `protected`, or `public`) is generally recommend to communicate to other developers how, and from where this method is intended to be used. Loading history... Comprehensibility Best Practice introduced 2015-11-26 05:51 UTC by Report Bug Copy Issue Report It is recommend to declare an explicit visibility for `convertElementToVCard`. Generally, we recommend to declare visibility for all methods in your source code. This has the advantage of clearly communication to other developers, and also yourself, how this method should be consumed. If you are not sure which visibility to choose, it is a good idea to start with the most restrictive visibility, and then raise visibility as needed, i.e. start with `private`, and only raise it to `protected` if a sub-class needs to have access, or `public` if an external class needs access. Loading history...
49
50		// returns the probability that the file matchs the current format
51		abstract function getFormatMatch($file);
		0 ignored issues – show Best Practice introduced 2015-11-26 05:51 UTC by Report Bug Copy Issue Report It is generally recommended to explicitly declare the visibility for methods. Adding explicit visibility (`private`, `protected`, or `public`) is generally recommend to communicate to other developers how, and from where this method is intended to be used. Loading history... Comprehensibility Best Practice introduced 2015-11-26 05:51 UTC by Report Bug Copy Issue Report It is recommend to declare an explicit visibility for `getFormatMatch`. Generally, we recommend to declare visibility for all methods in your source code. This has the advantage of clearly communication to other developers, and also yourself, how this method should be consumed. If you are not sure which visibility to choose, it is a good idea to start with the most restrictive visibility, and then raise visibility as needed, i.e. start with `private`, and only raise it to `protected` if a sub-class needs to have access, or `public` if an external class needs access. Loading history...
52
53		public function setConfig($xml_config) {
		0 ignored issues – show Coding Style Naming introduced 2015-11-26 05:51 UTC by Report Bug Copy Issue Report The parameter $xml_config is not named in camelCase. This check marks parameter names that have not been written in camelCase. In camelCase names are written without any punctuation, the start of each new word being marked by a capital letter. Thus the name database connection string becomes `databaseConnectionString`. Loading history... Coding Style Naming introduced 2015-11-26 05:51 UTC by Report Bug Copy Issue Report The variable $xml_config is not named in camelCase. This check marks variable names that have not been written in camelCase. In camelCase names are written without any punctuation, the start of each new word being marked by a capital letter. Thus the name database connection string becomes `databaseConnectionString`. Loading history...
54		$this->configContent = $xml_config;
55		}
56
57		/**
58		* @brief updates a property given in parameter with the value and using the importEntry to set the different parameters
59		* @param $property the property to update
60		* @param $importEntry the entry configuration to update in SimpleXml format
61		* @value the value to update
62		*/
63		protected function updateProperty(&$property, $importEntry, $value) {
64		if (isset($property) && isset($importEntry) && isset($value)) {
65		if (isset($importEntry->vcard_entry)) {
66		if (isset($importEntry->vcard_entry['type'])) {
67		$property->add('TYPE', StringUtil::convertToUTF8($importEntry->vcard_entry['type']));
68		}
69		if (isset($importEntry->vcard_entry->additional_property)) {
70		foreach ($importEntry->vcard_entry->additional_property as $additionalProperty) {
71		$property->add($additionalProperty['name'], $additionalProperty['value']);
72		}
73		}
74		if (isset($importEntry->vcard_entry['prefix'])) {
75		$value = $importEntry->vcard_entry['prefix'].$value;
76		}
77		if (isset($importEntry->vcard_entry['group'])) {
78		$property->group = $importEntry->vcard_entry['group'];
79		}
80		if (isset($importEntry->vcard_entry['position'])) {
81		$separator=";";
		0 ignored issues – show Unused Code introduced 2016-01-18 16:26 UTC by Report Bug Copy Issue Report `$separator` is not used, you could remove the assignment. This check looks for variable assignements that are either overwritten by other assignments or where the variable is not used subsequently. $myVar = 'Value'; $higher = false; if (rand(1, 6) > 3) { $higher = true; } else { $higher = false; } Both the `$myVar` assignment in line 1 and the `$higher` assignment in line 2 are dead. The first because `$myVar` is never used and the second because `$higher` is always overwritten for every possible time line. Loading history...
82		if (isset($importEntry->vcard_entry['separator'])) {
83		$separator=$importEntry->vcard_entry['separator'];
		0 ignored issues – show Unused Code introduced 2016-01-18 16:26 UTC by Report Bug Copy Issue Report `$separator` is not used, you could remove the assignment. This check looks for variable assignements that are either overwritten by other assignments or where the variable is not used subsequently. $myVar = 'Value'; $higher = false; if (rand(1, 6) > 3) { $higher = true; } else { $higher = false; } Both the `$myVar` assignment in line 1 and the `$higher` assignment in line 2 are dead. The first because `$myVar` is never used and the second because `$higher` is always overwritten for every possible time line. Loading history...
84		}
85		$position = $importEntry->vcard_entry['position'];
86		$vArray = $property->getParts();
87		$vArray[intval($position)] = StringUtil::convertToUTF8($value);
88		$property->setParts($vArray);
89		} else {
90		if (isset($importEntry->vcard_entry['value'])) {
91		$property->add('TYPE', StringUtil::convertToUTF8($value));
92		} else {
93		$curVal = $property->getParts();
94		$curVal[] = StringUtil::convertToUTF8($value);
95		$property->setValue($curVal);
96		}
97		}
98		}
99		if (isset($importEntry->vcard_parameter)) {
100		$property->add($importEntry->vcard_parameter['parameter'], StringUtil::convertToUTF8($value));
101		}
102		}
103		}
104
105		/**
106		* @brief modifies a vcard property array with the image
107		*/
108		public function updateImageProperty(&$property, $entry, $version=null) {
109		$image = new \OC_Image();
110		$image->loadFromData($entry);
111	View Code Duplication	if (strcmp($version, '4.0') == 0) {
		0 ignored issues – show Duplication introduced 2015-11-26 05:51 UTC by Report Bug Copy Issue Report This code seems to be duplicated across your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
112		$type = $image->mimeType();
113		} else {
114		$arrayType = explode('/', $image->mimeType());
115		$type = strtoupper(array_pop($arrayType));
116		}
117		$property->add('ENCODING', 'b');
118		$property->add('TYPE', $type);
119		$property->setValue($image->__toString());
120		}
121
122		/**
123		* @brief returns the vcard property corresponding to the parameter
124		* creates the property if it doesn't exists yet
125		* @param $vcard the vcard to get or create the properties with
126		* @param $importEntry the parameter to find
127		* @return the property\|false
128		*/
129		protected function getOrCreateVCardProperty(&$vcard, $importEntry) {
		0 ignored issues – show Coding Style Naming introduced 2015-11-26 05:51 UTC by Report Bug Copy Issue Report The variable $additional_property is not named in camelCase. This check marks variable names that have not been written in camelCase. In camelCase names are written without any punctuation, the start of each new word being marked by a capital letter. Thus the name database connection string becomes `databaseConnectionString`. Loading history...
130
131		if (isset($vcard) && isset($importEntry)) {
132		// looking for a property with the same name
133		$properties = $vcard->select($importEntry['property']);
134		foreach ($properties as $property) {
135		if ($importEntry['type'] == null && !isset($importEntry->additional_property)) {
136		return $property;
137		}
138		foreach ($property->parameters as $parameter) {
139		// Filtering types
140		if ($parameter->name == 'TYPE' && !strcmp($parameter->getValue(), $importEntry['type'])) {
141		$found=0;
142		if (isset($importEntry->additional_property)) {
143		// Filtering additional properties if necessary (I know, there are a lot of inner loops, sorry)
144		foreach($importEntry->additional_property as $additional_property) {
145		if ((string)$parameter->name == $additional_property['name']) {
146		$found++;
147		}
148		}
149		if ($found == count($importEntry->additional_property)) {
150		return $property;
151		}
152		}
153		return $property;
154		}
155		}
156
157		if (isset($importEntry['group']) && $property->group == $importEntry['group']) {
158		return $property;
159		}
160		}
161
162		// Property not found, creating one
163		$property = $vcard->createProperty($importEntry['property']);
164		$vcard->add($property);
165		if ($importEntry['type']!=null) {
166		$property->add('TYPE', StringUtil::convertToUTF8($importEntry['type']));
167		}
168		switch ($importEntry['property']) {
169		case "ADR":
170		$property->setValue(array('', '', '', '', '', '', ''));
171		break;
172		case "N":
173		$property->setValue(array('', '', '', '', ''));
174		break;
175		}
176		if ($importEntry['group']!=null) {
177		$property->group = $importEntry['group'];
178		}
179		return $property;
180		} else {
181		return false;
		0 ignored issues – show Bug Best Practice introduced 2015-11-26 05:51 UTC by Report Bug Copy Issue Report The return type of `return false;` (`false`) is incompatible with the return type documented by `OCA\Contacts\Connector\I...etOrCreateVCardProperty` of type `OCA\Contacts\Connector\the`. 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...
182		}
183		}
184		}
185
186		?>
		0 ignored issues – show Best Practice introduced 2015-11-26 05:51 UTC by Report Bug Copy Issue Report It is not recommended to use PHP's closing tag `?>` in files other than templates. Using a closing tag in PHP files that only contain PHP code is not recommended as you might accidentally add whitespace after the closing tag which would then be output by PHP. This can cause severe problems, for example headers cannot be sent anymore. A simple precaution is to leave off the closing tag as it is not required, and it also has no negative effects whatsoever. Loading history...
187

owncloud / contacts

ImportConnector B last analyzed 2016-02-29 12:21 UTC

Complexity

Size/Duplication

Coupling/Cohesion

Test Coverage

Importance

8 Methods

How to fix Duplicated Code

Duplicated Code

Duplication Side-by-Side

Filter issues like

ImportConnector B
last analyzed 2016-02-29 12:21 UTC