Logger::__construct() - Code Metrics - Inspection of "inject File adapter to Logger" - gjerokrsteski/pimf-framework - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( f099c7...d4a5ef )

by Gjero

created 2016-10-20 12:38 UTC

Logger::__construct() A

↳ Parent: Logger

Complexity

Conditions	1
Paths	1

Size

Total Lines	9
Code Lines	7

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
cc	1
eloc	7
nc	1
nop	3
dl	0
loc	9
rs	9.6666
c	0
b	0
f	0

<?php
/**
 * Pimf
 *
 * @copyright Copyright (c)  Gjero Krsteski (http://krsteski.de)
 * @license   http://opensource.org/licenses/MIT MIT
 */

namespace Pimf;

/**
 * Logger with common logging options into a file.
 *
 * @package Pimf
 * @author  Gjero Krsteski <[email protected]>
 */
class Logger
{
    /**
     * @var resource
     */
    private $infoHandle;

    /**
     * @var resource
     */
    private $warnHandle;

    /**
     * @var resource
     */
    private $errorHandle;

    /**
     * @var string
     */
    private static $remoteIp;

    /**
     * @var string
     */
    private static $script;

    /**
     * @param string $remoteIp
     * @param string $script
     */
    public static function setup($remoteIp, $script)
    {
        self::$remoteIp = $remoteIp;
        self::$script = $script;
    }

    /**
     * Logger constructor.
     * @param Contracts\Streamable $infoHandle
     * @param Contracts\Streamable $warnHandle
     * @param Contracts\Streamable $errorHandle
     */
    public function __construct(
        Contracts\Streamable $infoHandle,
        Contracts\Streamable $warnHandle,
        Contracts\Streamable $errorHandle)
    {
        $this->infoHandle = $infoHandle->open();
        $this->warnHandle = $warnHandle->open();
        $this->errorHandle = $errorHandle->open();
    }

    /**
     * @throws \RuntimeException If something went wrong on creating the log dir and file.
     */
    public function init()
    {
        if (is_resource($this->errorHandle)
            && is_resource($this->infoHandle)
            && is_resource($this->warnHandle)
        ) {
            return;
        }

        if (!$this->errorHandle || !$this->infoHandle || !$this->warnHandle) {
            throw new \RuntimeException("failed to obtain a Streamable handle for logging");
        }
    }

    /**
     * @param string $msg
     *
     * @return Logger
     */
    public function debug($msg)
    {
        if ($this->iniGetBool('display_errors') === true) {
            $this->write((string)$msg, 'DEBUG');
        }

        return $this;
    }

    /**
     * @param string $msg
     *
     * @return Logger
     */
    public function warn($msg)
    {
        if ($this->iniGetBool('display_errors') === true) {
            $this->write((string)$msg, 'WARNING');
        }

        return $this;
    }

    /**
     * @param string $msg
     *
     * @return Logger
     */
    public function error($msg)
    {
        $this->write((string)$msg, 'ERROR');

        return $this;
    }

    /**
     * @param string $msg
     *
     * @return Logger
     */
    public function info($msg)
    {
        if ($this->iniGetBool('display_errors') === true) {
            $this->write((string)$msg, 'INFO');
        }

        return $this;
    }

    /**
     * @param string $msg
     * @param string $severity
     */
    protected function write($msg, $severity = 'DEBUG')
    {
        $msg = $this->format($msg, $severity);

        if ($severity == 'WARNING') {
            fwrite($this->warnHandle, $msg);
        } elseif ($severity == 'ERROR') {
            fwrite($this->errorHandle, $msg);
        } else {
            fwrite($this->infoHandle, $msg);

        }
    }

    public function __destruct()
    {
        if (is_resource($this->infoHandle)
            && is_resource($this->warnHandle)
            && is_resource($this->errorHandle)
        ) {

            if (fclose($this->infoHandle) === false) {
                $this->error('Logger failed to close the handle to the log file');
            }

            fclose($this->warnHandle);
            fclose($this->errorHandle);
        }
    }

    /**
     * Formats the error message in representable manner.
     *
     * @param string $message
     * @param string $severity
     *
     * @return string
     */
    private function format($message, $severity)
    {
        $msg = date("m-d-Y") . " " . date("G:i:s") . " " . self::$remoteIp;

        $IPLength = strlen(self::$remoteIp);
        $numWhitespaces = 15 - $IPLength;

        for ($i = 0; $i < $numWhitespaces; $i++) {
            $msg .= " ";
        }

        $msg .= " " . $severity . ": ";

        $lastSlashIndex = strrpos(self::$script, "/");
        $fileName = self::$script;

        if ($lastSlashIndex !== false) {
            $fileName = substr(self::$script, $lastSlashIndex + 1);
        }

        $msg .= $fileName . "\t";
        $msg .= ": " . $message . "\r\n";

        return $msg;
    }

    /**
     * @param string $varname
     *
     * @return bool
     */
    protected function iniGetBool($varname)
    {
        $varvalue = ini_get($varname);

        switch (strtolower($varvalue)) {
            case 'on':
            case 'yes':
            case 'true':
                return 'assert.active' !== $varname;
            case 'stdout':
            case 'stderr':
                return 'display_errors' === $varname;
            default:
                return (bool)(int)$varvalue;
        }
    }
}


1			<?php
2			/**
3			* Pimf
4			*
5			* @copyright Copyright (c) Gjero Krsteski (http://krsteski.de)
6			* @license http://opensource.org/licenses/MIT MIT
7			*/
8
9			namespace Pimf;
10
11			/**
12			* Logger with common logging options into a file.
13			*
14			* @package Pimf
15			* @author Gjero Krsteski <[email protected]>
16			*/
17			class Logger
18			{
19			/**
20			* @var resource
21			*/
22			private $infoHandle;
23
24			/**
25			* @var resource
26			*/
27			private $warnHandle;
28
29			/**
30			* @var resource
31			*/
32			private $errorHandle;
33
34			/**
35			* @var string
36			*/
37			private static $remoteIp;
38
39			/**
40			* @var string
41			*/
42			private static $script;
43
44			/**
45			* @param string $remoteIp
46			* @param string $script
47			*/
48			public static function setup($remoteIp, $script)
49			{
50			self::$remoteIp = $remoteIp;
51			self::$script = $script;
52			}
53
54			/**
55			* Logger constructor.
56			* @param Contracts\Streamable $infoHandle
57			* @param Contracts\Streamable $warnHandle
58			* @param Contracts\Streamable $errorHandle
59			*/
60			public function __construct(
61			Contracts\Streamable $infoHandle,
62			Contracts\Streamable $warnHandle,
63			Contracts\Streamable $errorHandle)
64			{
65			$this->infoHandle = $infoHandle->open();
66			$this->warnHandle = $warnHandle->open();
67			$this->errorHandle = $errorHandle->open();
68			}
69
70			/**
71			* @throws \RuntimeException If something went wrong on creating the log dir and file.
72			*/
73			public function init()
74			{
75			if (is_resource($this->errorHandle)
76			&& is_resource($this->infoHandle)
77			&& is_resource($this->warnHandle)
78			) {
79			return;
80			}
81
82			if (!$this->errorHandle \|\| !$this->infoHandle \|\| !$this->warnHandle) {
83			throw new \RuntimeException("failed to obtain a Streamable handle for logging");
84			}
85			}
86
87			/**
88			* @param string $msg
89			*
90			* @return Logger
91			*/
92			public function debug($msg)
93			{
94			if ($this->iniGetBool('display_errors') === true) {
95			$this->write((string)$msg, 'DEBUG');
96			}
97
98			return $this;
99			}
100
101			/**
102			* @param string $msg
103			*
104			* @return Logger
105			*/
106			public function warn($msg)
107			{
108			if ($this->iniGetBool('display_errors') === true) {
109			$this->write((string)$msg, 'WARNING');
110			}
111
112			return $this;
113			}
114
115			/**
116			* @param string $msg
117			*
118			* @return Logger
119			*/
120			public function error($msg)
121			{
122			$this->write((string)$msg, 'ERROR');
123
124			return $this;
125			}
126
127			/**
128			* @param string $msg
129			*
130			* @return Logger
131			*/
132			public function info($msg)
133			{
134			if ($this->iniGetBool('display_errors') === true) {
135			$this->write((string)$msg, 'INFO');
136			}
137
138			return $this;
139			}
140
141			/**
142			* @param string $msg
143			* @param string $severity
144			*/
145			protected function write($msg, $severity = 'DEBUG')
146			{
147			$msg = $this->format($msg, $severity);
148
149			if ($severity == 'WARNING') {
150			fwrite($this->warnHandle, $msg);
151			} elseif ($severity == 'ERROR') {
152			fwrite($this->errorHandle, $msg);
153			} else {
154			fwrite($this->infoHandle, $msg);
155
156			}
157			}
158
159			public function __destruct()
160			{
161			if (is_resource($this->infoHandle)
162			&& is_resource($this->warnHandle)
163			&& is_resource($this->errorHandle)
164			) {
165
166			if (fclose($this->infoHandle) === false) {
167			$this->error('Logger failed to close the handle to the log file');
168			}
169
170			fclose($this->warnHandle);
171			fclose($this->errorHandle);
172			}
173			}
174
175			/**
176			* Formats the error message in representable manner.
177			*
178			* @param string $message
179			* @param string $severity
180			*
181			* @return string
182			*/
183			private function format($message, $severity)
184			{
185			$msg = date("m-d-Y") . " " . date("G:i:s") . " " . self::$remoteIp;
186
187			$IPLength = strlen(self::$remoteIp);
188			$numWhitespaces = 15 - $IPLength;
189
190			for ($i = 0; $i < $numWhitespaces; $i++) {
191			$msg .= " ";
192			}
193
194			$msg .= " " . $severity . ": ";
195
196			$lastSlashIndex = strrpos(self::$script, "/");
197			$fileName = self::$script;
198
199			if ($lastSlashIndex !== false) {
200			$fileName = substr(self::$script, $lastSlashIndex + 1);
201			}
202
203			$msg .= $fileName . "\t";
204			$msg .= ": " . $message . "\r\n";
205
206			return $msg;
207			}
208
209			/**
210			* @param string $varname
211			*
212			* @return bool
213			*/
214			protected function iniGetBool($varname)
215			{
216			$varvalue = ini_get($varname);
217
218			switch (strtolower($varvalue)) {
219			case 'on':
220			case 'yes':
221			case 'true':
222			return 'assert.active' !== $varname;
223			case 'stdout':
224			case 'stderr':
225			return 'display_errors' === $varname;
226			default:
227			return (bool)(int)$varvalue;
228			}
229			}
230			}
231

gjerokrsteski / pimf-framework

GitHub Access Token became invalid

Push — master ( f099c7...d4a5ef )

Logger::__construct() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like