LogWriter::reset() - Code Metrics - phingofficial/phing - Measure and Improve Code Quality continuously with Scrutinizer

LogWriter::reset() A
last analyzed 2025-06-06 15:23 UTC

↳ Parent: LogWriter

Complexity

Conditions	1
Paths	1

Size

Total Lines	2
Code Lines	0

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
eloc	0
dl	0
loc	2
rs	10
c	0
b	0
f	0
cc	1
nc	1
nop	0

<?php

/**
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 *
 * This software consists of voluntary contributions made by many individuals
 * and is licensed under the LGPL. For more information please see
 * <http://phing.info>.
 */

namespace Phing\Io;

use Phing\Project;
use Phing\Task;

/**
 * Extends the Writer class to output messages to Phing's log.
 *
 * @author  Michiel Rook <[email protected]>
 */
class LogWriter extends Writer
{
    private $task;

    private $level;

    /**
     * Constructs a new LogWriter object.
     *
     * @param int $level
     */
    public function __construct(Task $task, $level = Project::MSG_INFO)
    {
        $this->task = $task;
        $this->level = $level;
    }

    /**
     * @param string $buf
     * @param null   $off

     * @param null   $len

     *
     * @see Writer::write()
     */
    public function write($buf, $off = null, $len = null)
    {
        $lines = explode("\n", $buf);

        foreach ($lines as $line) {
            if ('' == $line) {
                continue;
            }

            $this->task->log($line, $this->level);
        }
    }

    /**
     * @see Writer::reset()
     */
    public function reset()
    {
    }

    /**
     * @see Writer::close()
     */
    public function close()
    {
    }

    /**
     * @see Writer::open()
     */
    public function open()
    {
    }

    /**
     * @see Writer::getResource()
     */
    public function getResource()
    {
        return $this->task;
interface HasName {
    /** @return string */
    public function getName();
}

class Name {
    public $name;
}

class User implements HasName {
    /** @return string|Name */
    public function getName() {
        return new Name('foo'); // This is a violation of the ``HasName`` interface
                                // which only allows a string value to be returned.
    }
}
    }
}


1			<?php
2
3			/**
4			* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
5			* "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
6			* LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
7			* A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
8			* OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
9			* SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
10			* LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
11			* DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
12			* THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
13			* (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
14			* OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
15			*
16			* This software consists of voluntary contributions made by many individuals
17			* and is licensed under the LGPL. For more information please see
18			* <http://phing.info>.
19			*/
20
21			namespace Phing\Io;
22
23			use Phing\Project;
24			use Phing\Task;
25
26			/**
27			* Extends the Writer class to output messages to Phing's log.
28			*
29			* @author Michiel Rook <[email protected]>
30			*/
31			class LogWriter extends Writer
32			{
33			private $task;
34
35			private $level;
36
37			/**
38			* Constructs a new LogWriter object.
39			*
40			* @param int $level
41			*/
42			public function __construct(Task $task, $level = Project::MSG_INFO)
43			{
44			$this->task = $task;
45			$this->level = $level;
46			}
47
48			/**
49			* @param string $buf
50			* @param null $off
			0 ignored issues – show Documentation Bug introduced 2019-07-31 09:36 UTC by Report Bug Copy Issue Report Are you sure the doc-type for parameter `$off` is correct as it would always require `null` to be passed? Loading history...
51			* @param null $len
			0 ignored issues – show Documentation Bug introduced 2021-01-24 21:13 UTC by Report Bug Copy Issue Report Are you sure the doc-type for parameter `$len` is correct as it would always require `null` to be passed? Loading history...
52			*
53			* @see Writer::write()
54			*/
55			public function write($buf, $off = null, $len = null)
56			{
57			$lines = explode("\n", $buf);
58
59			foreach ($lines as $line) {
60			if ('' == $line) {
61			continue;
62			}
63
64			$this->task->log($line, $this->level);
65			}
66			}
67
68			/**
69			* @see Writer::reset()
70			*/
71			public function reset()
72			{
73			}
74
75			/**
76			* @see Writer::close()
77			*/
78			public function close()
79			{
80			}
81
82			/**
83			* @see Writer::open()
84			*/
85			public function open()
86			{
87			}
88
89			/**
90			* @see Writer::getResource()
91			*/
92			public function getResource()
93			{
94			return $this->task;
			0 ignored issues – show Bug Best Practice introduced 2021-01-24 21:13 UTC by Report Bug Copy Issue Report The expression `return $this->task` returns the type `Phing\Task` which is incompatible with the return type mandated by `Phing\Io\Writer::getResource()` of `string`. In the issue above, the returned value is violating the contract defined by the mentioned interface. Let's take a look at an example: interface HasName { /** @return string / public function getName(); } class Name { public $name; } class User implements HasName { /* @return string\|Name */ public function getName() { return new Name('foo'); // This is a violation of the ``HasName`` interface // which only allows a string value to be returned. } } Loading history...
95			}
96			}
97

phingofficial / phing

LogWriter::reset() A last analyzed 2025-06-06 15:23 UTC

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like

LogWriter::reset() A
last analyzed 2025-06-06 15:23 UTC