RRDXport::getOutput() - Code Metrics - Inspection of "Merge pull request #184 from laf/graphs" - librenms/librenmsv2 - Measure and Improve Code Quality continuously with Scrutinizer

Test Failed

Push — develop ( 55b248...7d9761 )

by Tony

created 2016-11-17 21:23 UTC

RRDXport::getOutput() A

↳ Parent: RRDXport

Complexity

Conditions	2
Paths	2

Size

Total Lines	12
Code Lines	8

Duplication

Lines	0
Ratio	0 %

Importance

Changes

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

<?php
/**
 * RRDXport.php
 *
 * -Description-
 *
 * 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/>.
 *
 * @package    LibreNMS
 * @link       http://librenms.org
 * @copyright  2016 Tony Murray
 * @author     Tony Murray <[email protected]>
 */

namespace App\Data;

use Carbon\Carbon;

class RRDXport extends RRD implements \JsonSerializable
{
    protected $supported_formats = ['json', 'csv'];
    private $output;
    private $headers;

    /**
     * RRDXport constructor.
     *
     * @param string $definition rrdtool definition
     * @param array $headers headers for rrdtool
     * @param string $start start time
     * @param string $end end time
     */
    public function __construct($definition, $headers, $start, $end)
    {
        $args = " xport --json -s $start -e $end $definition";
        parent::__construct($args);

        $this->headers = $headers;
    }

    /**
     * Return the output from this data source
     * May be base64 encoded PNG, Json Data, or CSV Data
     *
     * @param string $format png, json, or csv
     * @return string

     */
    public function fetch($format)
    {
        $this->checkFormatSupported($format);

        if ($format == 'json') {
            return $this->jsonSerialize();
        } elseif ($format == 'csv') {
            return $this->csvSerialize();
        }
        return null;  // shouldn't get here
    }

    /**
     * Get and cache the output of rrdtool as a json object
     *
     * @return mixed
     */
    private function getOutput()
    {
        if (!isset($this->output)) {
            $output = $this->run();
            $output = preg_replace('/\'/', '"', $output);
            $output = preg_replace('/about\:/', '"meta":', $output);
            $output = preg_replace('/meta\:/', '"meta":', $output);
            $this->output = json_decode($output);
        }

        return $this->output;
    }

    function jsonSerialize()

    {
        $response = $this->getOutput();
        $step = $response->meta->step;
        $start = $response->meta->start;
//        $end = $response->meta->end;

        $cur_time = $start;
        $tmp_data = [];

        foreach ($response->data as $data) {
            $tmp_data[] = [$cur_time] + array_map('intval', $data);
            $cur_time += $step;
        }

        return json_encode([
            'data'   => $tmp_data,
            'labels' => $this->headers,
        ]);
    }

    function csvSerialize()

    {
        $response = $this->getOutput();
        $step = $response->meta->step;
        $start = $response->meta->start;
//        $end = $response->meta->end;

        $cur_time = $start;
        $output = 'Date, '.implode(',', $this->headers).PHP_EOL;

        foreach ($response->data as $data) {
            $output .= Carbon::createFromTimestamp($cur_time).',';
            $output .= implode(',', array_map('intval', $data)).PHP_EOL;
            $cur_time += $step;
        }
        return $output;
    }
}


1			<?php
2			/**
3			* RRDXport.php
4			*
5			* -Description-
6			*
7			* This program is free software: you can redistribute it and/or modify
8			* it under the terms of the GNU General Public License as published by
9			* the Free Software Foundation, either version 3 of the License, or
10			* (at your option) any later version.
11			*
12			* This program is distributed in the hope that it will be useful,
13			* but WITHOUT ANY WARRANTY; without even the implied warranty of
14			* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.See the
15			* GNU General Public License for more details.
16			*
17			* You should have received a copy of the GNU General Public License
18			* along with this program. If not, see <http://www.gnu.org/licenses/>.
19			*
20			* @package LibreNMS
21			* @link http://librenms.org
22			* @copyright 2016 Tony Murray
23			* @author Tony Murray <[email protected]>
24			*/
25
26			namespace App\Data;
27
28			use Carbon\Carbon;
29
30			class RRDXport extends RRD implements \JsonSerializable
31			{
32			protected $supported_formats = ['json', 'csv'];
33			private $output;
34			private $headers;
35
36			/**
37			* RRDXport constructor.
38			*
39			* @param string $definition rrdtool definition
40			* @param array $headers headers for rrdtool
41			* @param string $start start time
42			* @param string $end end time
43			*/
44			public function __construct($definition, $headers, $start, $end)
45			{
46			$args = " xport --json -s $start -e $end $definition";
47			parent::__construct($args);
48
49			$this->headers = $headers;
50			}
51
52			/**
53			* Return the output from this data source
54			* May be base64 encoded PNG, Json Data, or CSV Data
55			*
56			* @param string $format png, json, or csv
57			* @return string
			0 ignored issues – show Documentation introduced 2016-11-17 08:49 UTC by Report Bug Copy Issue Report Should the return type not be `string\|null`? This check compares the return type specified in the `@return` annotation of a function or method doc comment with the types returned by the function and raises an issue if they mismatch. Loading history...
58			*/
59			public function fetch($format)
60			{
61			$this->checkFormatSupported($format);
62
63			if ($format == 'json') {
64			return $this->jsonSerialize();
65			} elseif ($format == 'csv') {
66			return $this->csvSerialize();
67			}
68			return null; // shouldn't get here
69			}
70
71			/**
72			* Get and cache the output of rrdtool as a json object
73			*
74			* @return mixed
75			*/
76			private function getOutput()
77			{
78			if (!isset($this->output)) {
79			$output = $this->run();
80			$output = preg_replace('/\'/', '"', $output);
81			$output = preg_replace('/about\:/', '"meta":', $output);
82			$output = preg_replace('/meta\:/', '"meta":', $output);
83			$this->output = json_decode($output);
84			}
85
86			return $this->output;
87			}
88
89			function jsonSerialize()
			0 ignored issues – show Best Practice introduced 2016-11-17 08:49 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...
90			{
91			$response = $this->getOutput();
92			$step = $response->meta->step;
93			$start = $response->meta->start;
94			// $end = $response->meta->end;
			0 ignored issues – show Unused Code Comprehensibility introduced 2016-11-17 20:42 UTC by Report Bug Copy Issue Report `46%` of this comment could be valid code. Did you maybe forget this after debugging? Sometimes obsolete code just ends up commented out instead of removed. In this case it is better to remove the code once you have checked you do not need it. The code might also have been commented out for debugging purposes. In this case it is vital that someone uncomments it again or your project may behave in very unexpected ways in production. This check looks for comments that seem to be mostly valid code and reports them. Loading history...
95			$cur_time = $start;
96			$tmp_data = [];
97
98			foreach ($response->data as $data) {
99			$tmp_data[] = [$cur_time] + array_map('intval', $data);
100			$cur_time += $step;
101			}
102
103			return json_encode([
104			'data' => $tmp_data,
105			'labels' => $this->headers,
106			]);
107			}
108
109			function csvSerialize()
			0 ignored issues – show Best Practice introduced 2016-11-17 08:49 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...
110			{
111			$response = $this->getOutput();
112			$step = $response->meta->step;
113			$start = $response->meta->start;
114			// $end = $response->meta->end;
			0 ignored issues – show Unused Code Comprehensibility introduced 2016-11-17 20:42 UTC by Report Bug Copy Issue Report `46%` of this comment could be valid code. Did you maybe forget this after debugging? Sometimes obsolete code just ends up commented out instead of removed. In this case it is better to remove the code once you have checked you do not need it. The code might also have been commented out for debugging purposes. In this case it is vital that someone uncomments it again or your project may behave in very unexpected ways in production. This check looks for comments that seem to be mostly valid code and reports them. Loading history...
115			$cur_time = $start;
116			$output = 'Date, '.implode(',', $this->headers).PHP_EOL;
117
118			foreach ($response->data as $data) {
119			$output .= Carbon::createFromTimestamp($cur_time).',';
120			$output .= implode(',', array_map('intval', $data)).PHP_EOL;
121			$cur_time += $step;
122			}
123			return $output;
124			}
125			}
126

librenms / librenmsv2

Push — develop ( 55b248...7d9761 )

RRDXport::getOutput() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like