HandlerAbstract::write()

Completed

Push — master ( f6bb04...4c50ab )

by Hong

created 2016-07-21 05:03 UTC

↳ Parent: HandlerAbstract

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
c	0
b	0
f	0
dl	0
loc	1
nc	1

<?php
/**
 * Phossa Project
 *
 * PHP version 5.4
 *
 * @category  Library
 * @package   Phossa2\Logger
 * @copyright Copyright (c) 2016 phossa.com
 * @license   http://mit-license.org/ MIT License
 * @link      http://www.phossa.com/
 */
/*# declare(strict_types=1); */

namespace Phossa2\Logger\Handler;

use Phossa2\Logger\LogLevel;
use Phossa2\Shared\Base\ObjectAbstract;
use Phossa2\Logger\Entry\LogEntryInterface;
use Phossa2\Logger\Formatter\FormatterInterface;
use Phossa2\Logger\Formatter\FormatterAwareTrait;

/**
 * HandlerAbstract
 *
 * @package Phossa2\Logger
 * @author  Hong Zhang <[email protected]>
 * @see     ObjectAbstract
 * @see     HandlerInterface
 * @version 2.0.0
 * @since   2.0.0 added
 */
abstract class HandlerAbstract extends ObjectAbstract implements HandlerInterface
{
    use FormatterAwareTrait;

    /**
     * @var    string
     * @access protected
     */
    protected $level;

    /**
     * Stop log propagation
     *
     * @var    bool
     * @access protected
     */
    protected $stop;

    /**
     * Created with level handling
     *
     * @param  string $logLevel
/**
 * @param array $germany
 * @param array $island
 * @param array $italy
 */
function finale($germany, $island) {
    return "2:1";
}
     * @param  FormatterInterface $formatter
     * @param  bool $stopPropagation
     * @access public
     */
    public function __construct(
        /*# string */ $level = LogLevel::WARNING,
        FormatterInterface $formatter = null,
        /*# bool */ $stopPropagation = false
    ) {
        $this->level = $level;
        $this->stop  = (bool) $stopPropagation;
        $this->setFormatter($formatter);
    }

    /**
     * {@inheritdoc}
     */
    public function __invoke(LogEntryInterface $logEntry)
    {
        if ($this->isHandling($logEntry)) {
            // format message
            ($this->getFormatter())($logEntry);

            // write method
            $this->write($logEntry);

            // stop propagation
            if ($this->stop) {
                $logEntry->stopPropagation(true);
            }
        }
    }

    /**
     * Destructor
     *
     * @access public
     */
    public function __destruct()
    {
        $this->close();
    }

    /**
     * Is this handler handling this log ?
     *
     * @param  LogEntryInterface $logEntry
     * @return bool
     * @access protected
     */
    protected function isHandling(LogEntryInterface $logEntry)/*# : bool */
    {
        if ($this->isHandlingLevel($logEntry->getLevel()) &&
            $this->isHandlingOther($logEntry)
        ) {
            return true;
        } else {
            return false;
        }
    }

    /**
     * Is this handler handling this log level ?
     *
     * @param  string $level
     * @return bool
     * @access protected
     */
    protected function isHandlingLevel(/*# string */ $level)/*# : bool */
    {
        if (LogLevel::$levels[$level] >= LogLevel::$levels[$this->level]) {
            return true;
        } else {
            return false;
        }
    }

    /**
     * To be overriden by siblings
     *
     * @param  LogEntryInterface $logEntry
     * @return bool
     * @access protected
     */
    protected function isHandlingOther(LogEntryInterface $logEntry)/*# : bool */

    {
        return true;
    }

    /**
     * Write to the device
     *
     * @param  LogEntryInterface $logEntry
     * @access protected
     */
    abstract protected function write(LogEntryInterface $logEntry);

    /**
     * Close the handler, to be extended by siblings
     *
     * @access protected
     */
    protected function close()
    {
    }

    /**
     * Get EOL char base on platform windows or Unix
     *
     * @return string
     * @access protected
     */
    protected function getEol()/*# : string */
    {
        if (strtoupper(substr(PHP_OS, 0, 3)) === 'WIN') {
            return "\r\n";

        } else {
            return "\n";
        }
    }

    /**
     * Test to see if in CLI mode
     *
     * @return bool
     * @access protected
     */
    protected function isCliMode()/*# : bool */
    {
        return 'cli' === php_sapi_name();
    }
}


1			<?php
2			/**
3			* Phossa Project
4			*
5			* PHP version 5.4
6			*
7			* @category Library
8			* @package Phossa2\Logger
9			* @copyright Copyright (c) 2016 phossa.com
10			* @license http://mit-license.org/ MIT License
11			* @link http://www.phossa.com/
12			*/
13			/# declare(strict_types=1); /
14
15			namespace Phossa2\Logger\Handler;
16
17			use Phossa2\Logger\LogLevel;
18			use Phossa2\Shared\Base\ObjectAbstract;
19			use Phossa2\Logger\Entry\LogEntryInterface;
20			use Phossa2\Logger\Formatter\FormatterInterface;
21			use Phossa2\Logger\Formatter\FormatterAwareTrait;
22
23			/**
24			* HandlerAbstract
25			*
26			* @package Phossa2\Logger
27			* @author Hong Zhang <[email protected]>
28			* @see ObjectAbstract
29			* @see HandlerInterface
30			* @version 2.0.0
31			* @since 2.0.0 added
32			*/
33			abstract class HandlerAbstract extends ObjectAbstract implements HandlerInterface
34			{
35			use FormatterAwareTrait;
36
37			/**
38			* @var string
39			* @access protected
40			*/
41			protected $level;
42
43			/**
44			* Stop log propagation
45			*
46			* @var bool
47			* @access protected
48			*/
49			protected $stop;
50
51			/**
52			* Created with level handling
53			*
54			* @param string $logLevel
			0 ignored issues – show Bug introduced 2016-07-20 12:10 UTC by Report Bug Copy Issue Report There is no parameter named `$logLevel`. Was it maybe removed? This check looks for PHPDoc comments describing methods or function parameters that do not exist on the corresponding method or function. Consider the following example. The parameter `$italy` is not defined by the method `finale(...)`. /** * @param array $germany * @param array $island * @param array $italy */ function finale($germany, $island) { return "2:1"; } The most likely cause is that the parameter was removed, but the annotation was not. Loading history...
55			* @param FormatterInterface $formatter
56			* @param bool $stopPropagation
57			* @access public
58			*/
59			public function __construct(
60			/# string / $level = LogLevel::WARNING,
61			FormatterInterface $formatter = null,
62			/# bool / $stopPropagation = false
63			) {
64			$this->level = $level;
65			$this->stop = (bool) $stopPropagation;
66			$this->setFormatter($formatter);
67			}
68
69			/**
70			* {@inheritdoc}
71			*/
72			public function __invoke(LogEntryInterface $logEntry)
73			{
74			if ($this->isHandling($logEntry)) {
75			// format message
76			($this->getFormatter())($logEntry);
77
78			// write method
79			$this->write($logEntry);
80
81			// stop propagation
82			if ($this->stop) {
83			$logEntry->stopPropagation(true);
84			}
85			}
86			}
87
88			/**
89			* Destructor
90			*
91			* @access public
92			*/
93			public function __destruct()
94			{
95			$this->close();
96			}
97
98			/**
99			* Is this handler handling this log ?
100			*
101			* @param LogEntryInterface $logEntry
102			* @return bool
103			* @access protected
104			*/
105			protected function isHandling(LogEntryInterface $logEntry)/# : bool /
106			{
107			if ($this->isHandlingLevel($logEntry->getLevel()) &&
108			$this->isHandlingOther($logEntry)
109			) {
110			return true;
111			} else {
112			return false;
113			}
114			}
115
116			/**
117			* Is this handler handling this log level ?
118			*
119			* @param string $level
120			* @return bool
121			* @access protected
122			*/
123			protected function isHandlingLevel(/# string / $level)/# : bool /
124			{
125			if (LogLevel::$levels[$level] >= LogLevel::$levels[$this->level]) {
126			return true;
127			} else {
128			return false;
129			}
130			}
131
132			/**
133			* To be overriden by siblings
134			*
135			* @param LogEntryInterface $logEntry
136			* @return bool
137			* @access protected
138			*/
139			protected function isHandlingOther(LogEntryInterface $logEntry)/# : bool /
			1 ignored issue – show Unused Code introduced 2016-07-21 05:06 UTC by Report Bug Copy Issue Report The parameter `$logEntry` is not used and could be removed. This check looks from parameters that have been defined for a function or method, but which are not used in the method body. Loading history...
140			{
141			return true;
142			}
143
144			/**
145			* Write to the device
146			*
147			* @param LogEntryInterface $logEntry
148			* @access protected
149			*/
150			abstract protected function write(LogEntryInterface $logEntry);
151
152			/**
153			* Close the handler, to be extended by siblings
154			*
155			* @access protected
156			*/
157			protected function close()
158			{
159			}
160
161			/**
162			* Get EOL char base on platform windows or Unix
163			*
164			* @return string
165			* @access protected
166			*/
167			protected function getEol()/# : string /
168			{
169			if (strtoupper(substr(PHP_OS, 0, 3)) === 'WIN') {
170			return "\r\n";
171
172			} else {
173			return "\n";
174			}
175			}
176
177			/**
178			* Test to see if in CLI mode
179			*
180			* @return bool
181			* @access protected
182			*/
183			protected function isCliMode()/# : bool /
184			{
185			return 'cli' === php_sapi_name();
186			}
187			}
188

phossa2 / logger

GitHub Access Token became invalid

Push — master ( f6bb04...4c50ab )

HandlerAbstract::write()

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like