phingofficial / phing

src/Phing/Io/LogWriter.php

<?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 <mrook@php.net>
 */
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

Are you sure the doc-type for parameter $off is correct as it would always require null to be passed?

     * @param null   $len

Are you sure the doc-type for parameter $len is correct as it would always require null to be passed?

     *
     * @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;
    }
}