FileTrait::_loadUser() - Code Metrics - Inspection of "Implement and with it, improve logging" - Tiqr/tiqr-server-libphp - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Pull Request — develop (#27)

by Michiel

created 2022-04-05 11:46 UTC

FileTrait::_loadUser() A

↳ Parent: FileTrait

Complexity

Conditions	4
Paths	6

Size

Total Lines	18
Code Lines	12

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	10
CRAP Score	4.0119

Importance

Changes	1
Bugs	0	Features	0

Metric	Value
eloc	12
c	1
b	0
f	0
dl	0
loc	18
ccs	10
cts	11
cp	0.9091
rs	9.8666
cc	4
nc	6
nop	2
crap	4.0119

<?php
trait FileTrait
{
    /**
     * This function takes care of actually saving the user data to a JSON file.
     * @param String $userId
     * @param array $data
     */
    protected function _saveUser($userId, $data)
    {
        if (file_put_contents($this->getPath().$userId.".json", json_encode($data)) === false) {
            $this->logger->error('Unable to save the user to user storage (file storage)');
            return false;
        }
        return true;
    }

    /**
     * This function takes care of loading the user data from a JSON file.
     *
     * @param string $userId
     * @param boolean $failIfNotFound
     *
     * @return false if the data is not present, or an array containing the data.
     *
     * @throws Exception when the data can not be found and failIfNotFound is set to true
     */
    protected function _loadUser($userId, $failIfNotFound = TRUE)
    {
        $fileName = $this->getPath().$userId.".json";

        $data = NULL;
        if (file_exists($fileName)) {
            $data = json_decode(file_get_contents($this->getPath().$userId.".json"), true);
        }

        if ($data === NULL) {
            if ($failIfNotFound) {
                throw new Exception('Error loading data for user: ' . var_export($userId, TRUE));
            } else {
                $this->logger->error('Error loading data for user from user storage (file storage)');
                return false;
            }
        } else {
            return $data;
        }
    }

    /**
     * Retrieve the path where the json files are stored.
     * @return String
     */
    public function getPath()
    {
        if (substr($this->path, -1)!="/") return $this->path."/";
        return $this->path;
    }
}


1		<?php
2		trait FileTrait
3		{
4		/**
5		* This function takes care of actually saving the user data to a JSON file.
6		* @param String $userId
7		* @param array $data
8		*/
9	2	protected function _saveUser($userId, $data)
10		{
11	2	if (file_put_contents($this->getPath().$userId.".json", json_encode($data)) === false) {
12		$this->logger->error('Unable to save the user to user storage (file storage)');
13		return false;
14		}
15	2	return true;
16		}
17
18		/**
19		* This function takes care of loading the user data from a JSON file.
20		*
21		* @param string $userId
22		* @param boolean $failIfNotFound
23		*
24		* @return false if the data is not present, or an array containing the data.
25		*
26		* @throws Exception when the data can not be found and failIfNotFound is set to true
27		*/
28	2	protected function _loadUser($userId, $failIfNotFound = TRUE)
29		{
30	2	$fileName = $this->getPath().$userId.".json";
31
32	2	$data = NULL;
33	2	if (file_exists($fileName)) {
34	2	$data = json_decode(file_get_contents($this->getPath().$userId.".json"), true);
35		}
36
37	2	if ($data === NULL) {
38	2	if ($failIfNotFound) {
39		throw new Exception('Error loading data for user: ' . var_export($userId, TRUE));
40		} else {
41	2	$this->logger->error('Error loading data for user from user storage (file storage)');
42	2	return false;
43		}
44		} else {
45	2	return $data;
46		}
47		}
48
49		/**
50		* Retrieve the path where the json files are stored.
51		* @return String
52		*/
53	2	public function getPath()
54		{
55	2	if (substr($this->path, -1)!="/") return $this->path."/";
56		return $this->path;
57		}
58		}
59

Tiqr / tiqr-server-libphp

Pull Request — develop (#27)

FileTrait::_loadUser() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like