DatabaseRepository::collectionToArray() - Code Metrics - Inspection of "Settings WIP: Do not merge" - librenms/librenmsv2 - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — develop (#57)

by Tony

created 2016-03-18 05:46 UTC

DatabaseRepository::collectionToArray() A

↳ Parent: DatabaseRepository

Complexity

Conditions	2
Paths	2

Size

Total Lines	8
Code Lines	5

Duplication

Lines	0
Ratio	0 %

Importance

Changes	2
Bugs	0	Features	0

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

<?php
/*
 * Copyright (C) 2016 Tony Murray <[email protected]>
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * This program 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 General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program.  If not, see <http://www.gnu.org/licenses/>.
 */
/**
 * DatabaseRepository.php
 *
 * @package    LibreNMS
 * @author     Tony Murray <[email protected]>
 * @copyright  2016 Tony Murray
 * @license    @license http://opensource.org/licenses/GPL-3.0 GNU Public License v3 or later
 */
namespace App\Settings;


use App\Models\DbConfig;
use App\Models\Notification;

class DatabaseRepository
{
    // 'config_name', 'config_value'

    public function has($key)
    {
        return DbConfig::exactKey($key)->exists();

    }

    public function get($key, $default = null)
    {
        $results = DbConfig::key($key)->get(['config_name', 'config_value']);
        if (count($results) > 1) {
            return $this->collectionToArray($results);
        }
        elseif (count($results) == 1) {
            $entry = $results->first();
            if($entry->config_name != $key) { //FIXME: better test
                // trim the prefix
                $local_key = substr($entry->config_name, strlen($key) + 1);
                return [$local_key => $entry->config_value];
            }

            $value = $entry->config_value;
            return is_null($value) ? $default : $value;
        }
        else {
            return $default;
        }
    }

    private function collectionToArray($collection)
    {
        $ret = array();
        foreach ($collection as $item) {
            $ret[$item->config_name] = $item->config_value;
        }
        return $ret;
    }

    public function set($key, $value = null)
    {
        $config = new DbConfig;
        $config->config_name = $key;
<?php

/**
 * @property int $x
 * @property int $y
 * @property string $text
 */
class MyLabel
{
    private $properties;

    private $allowedProperties = array('x', 'y', 'text');

    public function __get($name)
    {
        if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) {
            return $properties[$name];
        } else {
            return null;
        }
    }

    public function __set($name, $value)
    {
        if (in_array($name, $this->allowedProperties)) {
            $properties[$name] = $value;
        } else {
            throw new \LogicException("Property $name is not defined.");
        }
    }

}
        $config->config_value = $value;
<?php

/**
 * @property int $x
 * @property int $y
 * @property string $text
 */
class MyLabel
{
    private $properties;

    private $allowedProperties = array('x', 'y', 'text');

    public function __get($name)
    {
        if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) {
            return $properties[$name];
        } else {
            return null;
        }
    }

    public function __set($name, $value)
    {
        if (in_array($name, $this->allowedProperties)) {
            $properties[$name] = $value;
        } else {
            throw new \LogicException("Property $name is not defined.");
        }
    }

}
        //FIXME: dummy data
        $config->config_default = "";
<?php

/**
 * @property int $x
 * @property int $y
 * @property string $text
 */
class MyLabel
{
    private $properties;

    private $allowedProperties = array('x', 'y', 'text');

    public function __get($name)
    {
        if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) {
            return $properties[$name];
        } else {
            return null;
        }
    }

    public function __set($name, $value)
    {
        if (in_array($name, $this->allowedProperties)) {
            $properties[$name] = $value;
        } else {
            throw new \LogicException("Property $name is not defined.");
        }
    }

}
        $config->config_descr = "";
<?php

/**
 * @property int $x
 * @property int $y
 * @property string $text
 */
class MyLabel
{
    private $properties;

    private $allowedProperties = array('x', 'y', 'text');

    public function __get($name)
    {
        if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) {
            return $properties[$name];
        } else {
            return null;
        }
    }

    public function __set($name, $value)
    {
        if (in_array($name, $this->allowedProperties)) {
            $properties[$name] = $value;
        } else {
            throw new \LogicException("Property $name is not defined.");
        }
    }

}
        $config->config_group = "";
<?php

/**
 * @property int $x
 * @property int $y
 * @property string $text
 */
class MyLabel
{
    private $properties;

    private $allowedProperties = array('x', 'y', 'text');

    public function __get($name)
    {
        if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) {
            return $properties[$name];
        } else {
            return null;
        }
    }

    public function __set($name, $value)
    {
        if (in_array($name, $this->allowedProperties)) {
            $properties[$name] = $value;
        } else {
            throw new \LogicException("Property $name is not defined.");
        }
    }

}
        $config->config_group_order = "";
<?php

/**
 * @property int $x
 * @property int $y
 * @property string $text
 */
class MyLabel
{
    private $properties;

    private $allowedProperties = array('x', 'y', 'text');

    public function __get($name)
    {
        if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) {
            return $properties[$name];
        } else {
            return null;
        }
    }

    public function __set($name, $value)
    {
        if (in_array($name, $this->allowedProperties)) {
            $properties[$name] = $value;
        } else {
            throw new \LogicException("Property $name is not defined.");
        }
    }

}
        $config->config_sub_group = "";
<?php

/**
 * @property int $x
 * @property int $y
 * @property string $text
 */
class MyLabel
{
    private $properties;

    private $allowedProperties = array('x', 'y', 'text');

    public function __get($name)
    {
        if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) {
            return $properties[$name];
        } else {
            return null;
        }
    }

    public function __set($name, $value)
    {
        if (in_array($name, $this->allowedProperties)) {
            $properties[$name] = $value;
        } else {
            throw new \LogicException("Property $name is not defined.");
        }
    }

}
        $config->config_sub_group_order = "";
<?php

/**
 * @property int $x
 * @property int $y
 * @property string $text
 */
class MyLabel
{
    private $properties;

    private $allowedProperties = array('x', 'y', 'text');

    public function __get($name)
    {
        if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) {
            return $properties[$name];
        } else {
            return null;
        }
    }

    public function __set($name, $value)
    {
        if (in_array($name, $this->allowedProperties)) {
            $properties[$name] = $value;
        } else {
            throw new \LogicException("Property $name is not defined.");
        }
    }

}

        $config->save();
    }

    public function reset($key)
    {
        DbConfig::key($key)->delete();
    }

    public function forget($key)
    {
        // set to null to prevent falling back to Config
        DbConfig::key($key)->update(['config_value' => null]);
    }

    public function all()
    {
        $settings = DbConfig::all();
        return $this->objsToArray($settings);
    }

    private function objsToArray($objs)
    {
        $ret = array();
        foreach ($objs as $obj) {
            $ret[$obj->key] = $obj->value;
        }
        return $ret;
    }
}

1			<?php
2			/*
3			* Copyright (C) 2016 Tony Murray <[email protected]>
4			* This program is free software: you can redistribute it and/or modify
5			* it under the terms of the GNU General Public License as published by
6			* the Free Software Foundation, either version 3 of the License, or
7			* (at your option) any later version.
8			*
9			* This program is distributed in the hope that it will be useful,
10			* but WITHOUT ANY WARRANTY; without even the implied warranty of
11			* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.See the
12			* GNU General Public License for more details.
13			*
14			* You should have received a copy of the GNU General Public License
15			* along with this program. If not, see <http://www.gnu.org/licenses/>.
16			*/
17			/**
18			* DatabaseRepository.php
19			*
20			* @package LibreNMS
21			* @author Tony Murray <[email protected]>
22			* @copyright 2016 Tony Murray
23			* @license @license http://opensource.org/licenses/GPL-3.0 GNU Public License v3 or later
24			*/
25			namespace App\Settings;
26
27
28			use App\Models\DbConfig;
29			use App\Models\Notification;
30
31			class DatabaseRepository
32			{
33			// 'config_name', 'config_value'
34
35			public function has($key)
36			{
37			return DbConfig::exactKey($key)->exists();
			0 ignored issues – show Bug introduced 2016-03-16 06:04 UTC by Report Bug Copy Issue Report The method `exactKey()` does not exist on `App\Models\DbConfig`. Did you maybe mean `scopeExactKey()`? This check marks calls to methods that do not seem to exist on an object. This is most likely the result of a method being renamed without all references to it being renamed likewise. Loading history...
38			}
39
40			public function get($key, $default = null)
41			{
42			$results = DbConfig::key($key)->get(['config_name', 'config_value']);
43			if (count($results) > 1) {
44			return $this->collectionToArray($results);
45			}
46			elseif (count($results) == 1) {
47			$entry = $results->first();
48			if($entry->config_name != $key) { //FIXME: better test
49			// trim the prefix
50			$local_key = substr($entry->config_name, strlen($key) + 1);
51			return [$local_key => $entry->config_value];
52			}
53
54			$value = $entry->config_value;
55			return is_null($value) ? $default : $value;
56			}
57			else {
58			return $default;
59			}
60			}
61
62			private function collectionToArray($collection)
63			{
64			$ret = array();
65			foreach ($collection as $item) {
66			$ret[$item->config_name] = $item->config_value;
67			}
68			return $ret;
69			}
70
71			public function set($key, $value = null)
72			{
73			$config = new DbConfig;
74			$config->config_name = $key;
			0 ignored issues – show Documentation introduced 2016-03-16 06:04 UTC by Report Bug Copy Issue Report The property `config_name` does not exist on `object<App\Models\DbConfig>`. Since you implemented `__set`, maybe consider adding a @property annotation. Since your code implements the magic setter `_set`, this function will be called for any write access on an undefined variable. You can add the `@property` annotation to your class or interface to document the existence of this variable. <?php /** * @property int $x * @property int $y * @property string $text */ class MyLabel { private $properties; private $allowedProperties = array('x', 'y', 'text'); public function __get($name) { if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) { return $properties[$name]; } else { return null; } } public function __set($name, $value) { if (in_array($name, $this->allowedProperties)) { $properties[$name] = $value; } else { throw new \LogicException("Property $name is not defined."); } } } Since the property has write access only, you can use the @property-write annotation instead. Of course, you may also just have mistyped another name, in which case you should fix the error. See also the PhpDoc documentation for @property. Loading history...
75			$config->config_value = $value;
			0 ignored issues – show Documentation introduced 2016-03-16 06:04 UTC by Report Bug Copy Issue Report The property `config_value` does not exist on `object<App\Models\DbConfig>`. Since you implemented `__set`, maybe consider adding a @property annotation. Since your code implements the magic setter `_set`, this function will be called for any write access on an undefined variable. You can add the `@property` annotation to your class or interface to document the existence of this variable. <?php /** * @property int $x * @property int $y * @property string $text */ class MyLabel { private $properties; private $allowedProperties = array('x', 'y', 'text'); public function __get($name) { if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) { return $properties[$name]; } else { return null; } } public function __set($name, $value) { if (in_array($name, $this->allowedProperties)) { $properties[$name] = $value; } else { throw new \LogicException("Property $name is not defined."); } } } Since the property has write access only, you can use the @property-write annotation instead. Of course, you may also just have mistyped another name, in which case you should fix the error. See also the PhpDoc documentation for @property. Loading history...
76			//FIXME: dummy data
77			$config->config_default = "";
			0 ignored issues – show Documentation introduced 2016-03-16 06:04 UTC by Report Bug Copy Issue Report The property `config_default` does not exist on `object<App\Models\DbConfig>`. Since you implemented `__set`, maybe consider adding a @property annotation. Since your code implements the magic setter `_set`, this function will be called for any write access on an undefined variable. You can add the `@property` annotation to your class or interface to document the existence of this variable. <?php /** * @property int $x * @property int $y * @property string $text */ class MyLabel { private $properties; private $allowedProperties = array('x', 'y', 'text'); public function __get($name) { if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) { return $properties[$name]; } else { return null; } } public function __set($name, $value) { if (in_array($name, $this->allowedProperties)) { $properties[$name] = $value; } else { throw new \LogicException("Property $name is not defined."); } } } Since the property has write access only, you can use the @property-write annotation instead. Of course, you may also just have mistyped another name, in which case you should fix the error. See also the PhpDoc documentation for @property. Loading history...
78			$config->config_descr = "";
			0 ignored issues – show Documentation introduced 2016-03-16 06:04 UTC by Report Bug Copy Issue Report The property `config_descr` does not exist on `object<App\Models\DbConfig>`. Since you implemented `__set`, maybe consider adding a @property annotation. Since your code implements the magic setter `_set`, this function will be called for any write access on an undefined variable. You can add the `@property` annotation to your class or interface to document the existence of this variable. <?php /** * @property int $x * @property int $y * @property string $text */ class MyLabel { private $properties; private $allowedProperties = array('x', 'y', 'text'); public function __get($name) { if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) { return $properties[$name]; } else { return null; } } public function __set($name, $value) { if (in_array($name, $this->allowedProperties)) { $properties[$name] = $value; } else { throw new \LogicException("Property $name is not defined."); } } } Since the property has write access only, you can use the @property-write annotation instead. Of course, you may also just have mistyped another name, in which case you should fix the error. See also the PhpDoc documentation for @property. Loading history...
79			$config->config_group = "";
			0 ignored issues – show Documentation introduced 2016-03-16 06:04 UTC by Report Bug Copy Issue Report The property `config_group` does not exist on `object<App\Models\DbConfig>`. Since you implemented `__set`, maybe consider adding a @property annotation. Since your code implements the magic setter `_set`, this function will be called for any write access on an undefined variable. You can add the `@property` annotation to your class or interface to document the existence of this variable. <?php /** * @property int $x * @property int $y * @property string $text */ class MyLabel { private $properties; private $allowedProperties = array('x', 'y', 'text'); public function __get($name) { if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) { return $properties[$name]; } else { return null; } } public function __set($name, $value) { if (in_array($name, $this->allowedProperties)) { $properties[$name] = $value; } else { throw new \LogicException("Property $name is not defined."); } } } Since the property has write access only, you can use the @property-write annotation instead. Of course, you may also just have mistyped another name, in which case you should fix the error. See also the PhpDoc documentation for @property. Loading history...
80			$config->config_group_order = "";
			0 ignored issues – show Documentation introduced 2016-03-16 06:04 UTC by Report Bug Copy Issue Report The property `config_group_order` does not exist on `object<App\Models\DbConfig>`. Since you implemented `__set`, maybe consider adding a @property annotation. Since your code implements the magic setter `_set`, this function will be called for any write access on an undefined variable. You can add the `@property` annotation to your class or interface to document the existence of this variable. <?php /** * @property int $x * @property int $y * @property string $text */ class MyLabel { private $properties; private $allowedProperties = array('x', 'y', 'text'); public function __get($name) { if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) { return $properties[$name]; } else { return null; } } public function __set($name, $value) { if (in_array($name, $this->allowedProperties)) { $properties[$name] = $value; } else { throw new \LogicException("Property $name is not defined."); } } } Since the property has write access only, you can use the @property-write annotation instead. Of course, you may also just have mistyped another name, in which case you should fix the error. See also the PhpDoc documentation for @property. Loading history...
81			$config->config_sub_group = "";
			0 ignored issues – show Documentation introduced 2016-03-16 06:04 UTC by Report Bug Copy Issue Report The property `config_sub_group` does not exist on `object<App\Models\DbConfig>`. Since you implemented `__set`, maybe consider adding a @property annotation. Since your code implements the magic setter `_set`, this function will be called for any write access on an undefined variable. You can add the `@property` annotation to your class or interface to document the existence of this variable. <?php /** * @property int $x * @property int $y * @property string $text */ class MyLabel { private $properties; private $allowedProperties = array('x', 'y', 'text'); public function __get($name) { if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) { return $properties[$name]; } else { return null; } } public function __set($name, $value) { if (in_array($name, $this->allowedProperties)) { $properties[$name] = $value; } else { throw new \LogicException("Property $name is not defined."); } } } Since the property has write access only, you can use the @property-write annotation instead. Of course, you may also just have mistyped another name, in which case you should fix the error. See also the PhpDoc documentation for @property. Loading history...
82			$config->config_sub_group_order = "";
			0 ignored issues – show Documentation introduced 2016-03-16 06:04 UTC by Report Bug Copy Issue Report The property `config_sub_group_order` does not exist on `object<App\Models\DbConfig>`. Since you implemented `__set`, maybe consider adding a @property annotation. Since your code implements the magic setter `_set`, this function will be called for any write access on an undefined variable. You can add the `@property` annotation to your class or interface to document the existence of this variable. <?php /** * @property int $x * @property int $y * @property string $text */ class MyLabel { private $properties; private $allowedProperties = array('x', 'y', 'text'); public function __get($name) { if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) { return $properties[$name]; } else { return null; } } public function __set($name, $value) { if (in_array($name, $this->allowedProperties)) { $properties[$name] = $value; } else { throw new \LogicException("Property $name is not defined."); } } } Since the property has write access only, you can use the @property-write annotation instead. Of course, you may also just have mistyped another name, in which case you should fix the error. See also the PhpDoc documentation for @property. Loading history...
83
84			$config->save();
85			}
86
87			public function reset($key)
88			{
89			DbConfig::key($key)->delete();
90			}
91
92			public function forget($key)
93			{
94			// set to null to prevent falling back to Config
95			DbConfig::key($key)->update(['config_value' => null]);
96			}
97
98			public function all()
99			{
100			$settings = DbConfig::all();
101			return $this->objsToArray($settings);
102			}
103
104			private function objsToArray($objs)
105			{
106			$ret = array();
107			foreach ($objs as $obj) {
108			$ret[$obj->key] = $obj->value;
109			}
110			return $ret;
111			}
112			}

librenms / librenmsv2

Pull Request — develop (#57)

DatabaseRepository::collectionToArray() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like