Log::size() - Code Metrics - Inspection of "Feature/all files" - ARCANEDEV/LogViewer - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#269)

unknown

created 2019-04-13 07:12 UTC

Log::size() A

↳ Parent: Log

Complexity

Conditions	1
Paths	1

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	0
CRAP Score	2

Importance

Changes

Metric	Value
cc	1
nc	1
nop	0
dl	0
loc	4
ccs	0
cts	2
cp	0
crap	2
rs	10
c	0
b	0
f	0

<?php namespace Arcanedev\LogViewer\Entities;

use Carbon\Carbon;
use Illuminate\Contracts\Support\Arrayable;
use Illuminate\Contracts\Support\Jsonable;
use JsonSerializable;
use SplFileInfo;

/**
 * Class     Log
 *
 * @package  Arcanedev\LogViewer\Entities
 * @author   ARCANEDEV <[email protected]>
 *
 * @todo     Add a stats method
 */
class Log implements Arrayable, Jsonable, JsonSerializable
{
    /* -----------------------------------------------------------------
     |  Properties
     | -----------------------------------------------------------------
     */

    /** @var string */
    public $date;

    /** @var string */
    private $path;

    /** @var \Arcanedev\LogViewer\Entities\LogEntryCollection */
    private $entries;

    /** @var \SplFileInfo */
    private $file;

    /* -----------------------------------------------------------------
     |  Constructor
     | -----------------------------------------------------------------
     */

    /**
     * Log constructor.
     *
     * @param  string  $date
     * @param  string  $path
     * @param  string  $raw
     */
    public function __construct($date, $path, $raw)
    {
        $this->date    = $date;
        $this->path    = $path;
        $this->file    = new SplFileInfo($path);
        $this->entries = (new LogEntryCollection)->load($raw);
    }

    /* -----------------------------------------------------------------
     |  Getters & Setters
     | -----------------------------------------------------------------
     */

    /**
     * Get log path.
     *
     * @return string
     */
    public function getPath()
    {
        return $this->path;
    }

    /**
     * Get file info.
     *
     * @return \SplFileInfo
     */
    public function file()
    {
        return $this->file;
    }

    /**
     * Get file size.
     *
     * @return string
     */
    public function size()
    {
        return $this->formatSize($this->file->getSize());
    }

    /**
     * Get file creation date.
     *
     * @return \Carbon\Carbon
     */
    public function createdAt()
    {
        return Carbon::createFromTimestamp($this->file()->getATime());
    }

    /**
     * Get file modification date.
     *
     * @return \Carbon\Carbon
     */
    public function updatedAt()
    {
        return Carbon::createFromTimestamp($this->file()->getMTime());
    }

    /* -----------------------------------------------------------------
     |  Main Methods
     | -----------------------------------------------------------------
     */

    /**
     * Make a log object.
     *
     * @param  string  $date
     * @param  string  $path
     * @param  string  $raw
     *
     * @return self
     */
    public static function make($date, $path, $raw)
    {

        return new self($date, $path, $raw);
    }

    /**
     * Get log entries.
     *
     * @param  string  $level
     *
     * @return \Arcanedev\LogViewer\Entities\LogEntryCollection
     */
    public function entries($level = 'all')
    {
        return $level === 'all'
            ? $this->entries
            : $this->getByLevel($level);
    }

    /**
     * Get filtered log entries by level.
     *
     * @param  string  $level
     *
     * @return \Arcanedev\LogViewer\Entities\LogEntryCollection
     */
    public function getByLevel($level)
    {
        return $this->entries->filterByLevel($level);
    }

    /**
     * Get log stats.
     *
     * @return array
     */
    public function stats()
    {
        return $this->entries->stats();
    }

    /**
     * Get the log navigation tree.
     *
     * @param  bool  $trans
     *
     * @return array
     */
    public function tree($trans = false)
    {
        return $this->entries->tree($trans);
    }

    /**
     * Get log entries menu.
     *
     * @param  bool  $trans
     *
     * @return array
     */
    public function menu($trans = true)
    {
        return log_menu()->make($this, $trans);
    }

    /* -----------------------------------------------------------------
     |  Convert Methods
     | -----------------------------------------------------------------
     */

    /**
     * Get the log as a plain array.
     *
     * @return array
     */
    public function toArray()
    {
        return [
            'date'    => $this->date,
            'path'    => $this->path,
            'entries' => $this->entries->toArray()
        ];
    }

    /**
     * Convert the object to its JSON representation.
     *
     * @param  int  $options
     *
     * @return string
     */
    public function toJson($options = 0)
    {
        return json_encode($this->toArray(), $options);
    }

    /**
     * Serialize the log object to json data.
     *
     * @return array
     */
    public function jsonSerialize()
    {
        return $this->toArray();
    }

    /* -----------------------------------------------------------------
     |  Other Methods
     | -----------------------------------------------------------------
     */

    /**
     * Format the file size.
     *
     * @param  int  $bytes
     * @param  int  $precision
     *
     * @return string
     */
    private function formatSize($bytes, $precision = 2)
    {
        $units = ['B', 'KB', 'MB', 'GB', 'TB'];

        $bytes = max($bytes, 0);
        $pow   = floor(($bytes ? log($bytes) : 0) / log(1024));
        $pow   = min($pow, count($units) - 1);

        return round($bytes / pow(1024, $pow), $precision).' '.$units[$pow];
    }
}


1		<?php namespace Arcanedev\LogViewer\Entities;
2
3		use Carbon\Carbon;
4		use Illuminate\Contracts\Support\Arrayable;
5		use Illuminate\Contracts\Support\Jsonable;
6		use JsonSerializable;
7		use SplFileInfo;
8
9		/**
10		* Class Log
11		*
12		* @package Arcanedev\LogViewer\Entities
13		* @author ARCANEDEV <[email protected]>
14		*
15		* @todo Add a stats method
16		*/
17		class Log implements Arrayable, Jsonable, JsonSerializable
18		{
19		/* -----------------------------------------------------------------
20		\| Properties
21		\| -----------------------------------------------------------------
22		*/
23
24		/** @var string */
25		public $date;
26
27		/** @var string */
28		private $path;
29
30		/** @var \Arcanedev\LogViewer\Entities\LogEntryCollection */
31		private $entries;
32
33		/** @var \SplFileInfo */
34		private $file;
35
36		/* -----------------------------------------------------------------
37		\| Constructor
38		\| -----------------------------------------------------------------
39		*/
40
41		/**
42		* Log constructor.
43		*
44		* @param string $date
45		* @param string $path
46		* @param string $raw
47		*/
48	171	public function __construct($date, $path, $raw)
49		{
50	171	$this->date = $date;
51	171	$this->path = $path;
52	171	$this->file = new SplFileInfo($path);
53	171	$this->entries = (new LogEntryCollection)->load($raw);
54	171	}
55
56		/* -----------------------------------------------------------------
57		\| Getters & Setters
58		\| -----------------------------------------------------------------
59		*/
60
61		/**
62		* Get log path.
63		*
64		* @return string
65		*/
66		public function getPath()
67		{
68		return $this->path;
69		}
70
71		/**
72		* Get file info.
73		*
74		* @return \SplFileInfo
75		*/
76		public function file()
77		{
78		return $this->file;
79		}
80
81		/**
82		* Get file size.
83		*
84		* @return string
85		*/
86		public function size()
87		{
88		return $this->formatSize($this->file->getSize());
89		}
90
91		/**
92		* Get file creation date.
93		*
94		* @return \Carbon\Carbon
95		*/
96		public function createdAt()
97		{
98		return Carbon::createFromTimestamp($this->file()->getATime());
99		}
100
101		/**
102		* Get file modification date.
103		*
104		* @return \Carbon\Carbon
105		*/
106		public function updatedAt()
107		{
108		return Carbon::createFromTimestamp($this->file()->getMTime());
109		}
110
111		/* -----------------------------------------------------------------
112		\| Main Methods
113		\| -----------------------------------------------------------------
114		*/
115
116		/**
117		* Make a log object.
118		*
119		* @param string $date
120		* @param string $path
121		* @param string $raw
122		*
123		* @return self
124		*/
125	171	public static function make($date, $path, $raw)
126		{
127
128	171	return new self($date, $path, $raw);
129		}
130
131		/**
132		* Get log entries.
133		*
134		* @param string $level
135		*
136		* @return \Arcanedev\LogViewer\Entities\LogEntryCollection
137		*/
138	12	public function entries($level = 'all')
139		{
140	12	return $level === 'all'
141	6	? $this->entries
142	12	: $this->getByLevel($level);
143		}
144
145		/**
146		* Get filtered log entries by level.
147		*
148		* @param string $level
149		*
150		* @return \Arcanedev\LogViewer\Entities\LogEntryCollection
151		*/
152	6	public function getByLevel($level)
153		{
154	6	return $this->entries->filterByLevel($level);
155		}
156
157		/**
158		* Get log stats.
159		*
160		* @return array
161		*/
162	45	public function stats()
163		{
164	45	return $this->entries->stats();
165		}
166
167		/**
168		* Get the log navigation tree.
169		*
170		* @param bool $trans
171		*
172		* @return array
173		*/
174	24	public function tree($trans = false)
175		{
176	24	return $this->entries->tree($trans);
177		}
178
179		/**
180		* Get log entries menu.
181		*
182		* @param bool $trans
183		*
184		* @return array
185		*/
186	12	public function menu($trans = true)
187		{
188	12	return log_menu()->make($this, $trans);
189		}
190
191		/* -----------------------------------------------------------------
192		\| Convert Methods
193		\| -----------------------------------------------------------------
194		*/
195
196		/**
197		* Get the log as a plain array.
198		*
199		* @return array
200		*/
201		public function toArray()
202		{
203		return [
204		'date' => $this->date,
205		'path' => $this->path,
206		'entries' => $this->entries->toArray()
207		];
208		}
209
210		/**
211		* Convert the object to its JSON representation.
212		*
213		* @param int $options
214		*
215		* @return string
216		*/
217		public function toJson($options = 0)
218		{
219		return json_encode($this->toArray(), $options);
220		}
221
222		/**
223		* Serialize the log object to json data.
224		*
225		* @return array
226		*/
227		public function jsonSerialize()
228		{
229		return $this->toArray();
230		}
231
232		/* -----------------------------------------------------------------
233		\| Other Methods
234		\| -----------------------------------------------------------------
235		*/
236
237		/**
238		* Format the file size.
239		*
240		* @param int $bytes
241		* @param int $precision
242		*
243		* @return string
244		*/
245		private function formatSize($bytes, $precision = 2)
246		{
247		$units = ['B', 'KB', 'MB', 'GB', 'TB'];
248
249		$bytes = max($bytes, 0);
250		$pow = floor(($bytes ? log($bytes) : 0) / log(1024));
251		$pow = min($pow, count($units) - 1);
252
253		return round($bytes / pow(1024, $pow), $precision).' '.$units[$pow];
254		}
255		}
256

ARCANEDEV / LogViewer

Pull Request — master (#269)

Log::size() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like