File::create() - Code Metrics - Inspection of "Master" - rugk/threema-msgapi-sdk-php - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#39)

unknown

created 2016-03-08 18:21 UTC

File::create() A

↳ Parent: File

Complexity

Conditions	2
Paths	2

Size

Total Lines	8
Code Lines	4

Duplication

Lines	0
Ratio	0 %

Importance

Changes	1
Bugs	0	Features	1

Metric	Value
c	1
b	0
f	1
dl	0
loc	8
rs	9.4285
cc	2
eloc	4
nc	2
nop	1

<?php
/**
 * @author Threema GmbH
 * @copyright Copyright (c) 2015-2016 Threema GmbH
 */

namespace Threema\MsgApi\PublicKeyStores;

use Threema\Core\Exception;
use Threema\MsgApi\PublicKeyStore;

/**
 * Store the PublicKeys in a ascii file
 *
 * @package Threema\MsgApi\PublicKeyStores
 */
class File extends PublicKeyStore {
	/**
	 * @var string
	 */
	private $file;

	/**
	 * @param string $file Valid, read and writable file
	 * @throws Exception if the file does not exist or not writable
	 */
	public function __construct($file) {
		if(false === is_writable($file)) {
			throw new Exception('file '.$file.' does not exist or is not writable');
		}
		$this->file = $file;
	}

	/**
	 * return null if the public key not found in the store
	 * @param string $threemaId
	 * @return null|string
	 * @throws Exception
	 */
	function findPublicKey($threemaId) {

		$storeHandle = fopen($this->file, 'r');
		if(false === $storeHandle) {
			throw new Exception('could not open file '.$this->file);
		}
		else {
			$threemaId = strtoupper($threemaId);
			$publicKey = null;
			while (!feof($storeHandle)) {
				$buffer = fgets($storeHandle, 4096);
				if(substr($buffer, 0, 8) == $threemaId) {
					$publicKey = str_replace("\n", '', substr($buffer, 8));
					continue;
				}
				// Process buffer here..
			}
			fclose($storeHandle);
			return $publicKey;
		}
	}

	/**
	 * save a public key
	 * @param string $threemaId
	 * @param string $publicKey
	 * @return bool
	 */
	function savePublicKey($threemaId, $publicKey) {

		return file_put_contents($this->file, $threemaId.$publicKey."\n", FILE_APPEND) !== false;
	}

	/**
	 * Initialize a new File Public Key Store
	 * @param string $path the file will be created if it does not exist
	 * @return File
	 */
	public static function create($path) {
		if(false === file_exists($path)) {
			//touch
			touch($path);
		}

		return new File($path);
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			* @author Threema GmbH
4			* @copyright Copyright (c) 2015-2016 Threema GmbH
5			*/
6
7			namespace Threema\MsgApi\PublicKeyStores;
8
9			use Threema\Core\Exception;
10			use Threema\MsgApi\PublicKeyStore;
11
12			/**
13			* Store the PublicKeys in a ascii file
14			*
15			* @package Threema\MsgApi\PublicKeyStores
16			*/
17			class File extends PublicKeyStore {
18			/**
19			* @var string
20			*/
21			private $file;
22
23			/**
24			* @param string $file Valid, read and writable file
25			* @throws Exception if the file does not exist or not writable
26			*/
27			public function __construct($file) {
28			if(false === is_writable($file)) {
29			throw new Exception('file '.$file.' does not exist or is not writable');
30			}
31			$this->file = $file;
32			}
33
34			/**
35			* return null if the public key not found in the store
36			* @param string $threemaId
37			* @return null\|string
38			* @throws Exception
39			*/
40			function findPublicKey($threemaId) {
			0 ignored issues – show Best Practice introduced 2015-11-21 10:39 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...
41			$storeHandle = fopen($this->file, 'r');
42			if(false === $storeHandle) {
43			throw new Exception('could not open file '.$this->file);
44			}
45			else {
46			$threemaId = strtoupper($threemaId);
47			$publicKey = null;
48			while (!feof($storeHandle)) {
49			$buffer = fgets($storeHandle, 4096);
50			if(substr($buffer, 0, 8) == $threemaId) {
51			$publicKey = str_replace("\n", '', substr($buffer, 8));
52			continue;
53			}
54			// Process buffer here..
55			}
56			fclose($storeHandle);
57			return $publicKey;
58			}
59			}
60
61			/**
62			* save a public key
63			* @param string $threemaId
64			* @param string $publicKey
65			* @return bool
66			*/
67			function savePublicKey($threemaId, $publicKey) {
			0 ignored issues – show Best Practice introduced 2015-11-21 10:39 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...
68			return file_put_contents($this->file, $threemaId.$publicKey."\n", FILE_APPEND) !== false;
69			}
70
71			/**
72			* Initialize a new File Public Key Store
73			* @param string $path the file will be created if it does not exist
74			* @return File
75			*/
76			public static function create($path) {
77			if(false === file_exists($path)) {
78			//touch
79			touch($path);
80			}
81
82			return new File($path);
			0 ignored issues – show Bug Best Practice introduced 2016-03-08 18:23 UTC by Report Bug Copy Issue Report The return type of `return new \Threema\MsgA...cKeyStores\File($path);` (`Threema\MsgApi\PublicKeyStores\File`) is incompatible with the return type declared by the abstract method `Threema\MsgApi\PublicKeyStore::create` of type `Threema\MsgApi\File\|Threema\MsgApi\PhpFile`. 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...
83			}
84			}
85

rugk / threema-msgapi-sdk-php

Pull Request — master (#39)

File::create() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like