zbateson / stream-decorators

src/UUStream.php

<?php

The PHP open tag does not have a corresponding PHP close tag

Filename "UUStream.php" doesn't match the expected filename "uustream.php"

/**
 * This file is part of the ZBateson\StreamDecorators project.
 *
 * @license http://opensource.org/licenses/bsd-license.php BSD

The tag in position 1 should be the @package tag

 */

PHP version not specified

There must be exactly one blank line after the file comment

Missing @package tag in file comment

Missing @subpackage tag in file comment

Missing @category tag in file comment

Missing @author tag in file comment

Missing @link tag in file comment

namespace ZBateson\StreamDecorators;

use Psr\Http\Message\StreamInterface;
use GuzzleHttp\Psr7\StreamDecoratorTrait;
use GuzzleHttp\Psr7\BufferStream;
use RuntimeException;

/**
 * GuzzleHttp\Psr7 stream decoder extension for UU-Encoded streams.
 *
 * The size of the underlying stream and the position of bytes can't be
 * determined because the number of encoded bytes is indeterminate without
 * reading the entire stream.
 *
 * @author Zaahid Bateson

@author tag is not allowed in class comment

Content of the @author tag must be in the form "Display Name <username@example.com>"

 */

Missing @category tag in class comment

Missing @package tag in class comment

Missing @license tag in class comment

Missing @link tag in class comment

class UUStream implements StreamInterface
{

Opening brace should be on the same line as the declaration for class UUStream

    use StreamDecoratorTrait;

    /**

Missing short description in doc comment

     * @var string name of the UUEncoded file
     */
    protected $filename = null;

Protected member variable "filename" must contain a leading underscore

TRUE, FALSE and NULL should be uppercase as per the configured coding-style; instead of null please use NULL.

    /**

Missing short description in doc comment

     * @var BufferStream of read and decoded bytes
     */
    private $buffer;

Private member variable "buffer" must contain a leading underscore

Private member variable "buffer" must be prefixed with an underscore

    /**

Missing short description in doc comment

     * @var string remainder of write operation if the bytes didn't align to 3
     *      bytes
     */
    private $remainder = '';

Private member variable "remainder" must contain a leading underscore

Private member variable "remainder" must be prefixed with an underscore

    /**

Missing short description in doc comment

     * @var int read/write position
     */
    private $position = 0;

Private member variable "position" must contain a leading underscore

Private member variable "position" must be prefixed with an underscore

    /**

Missing short description in doc comment

     * @var boolean set to true when 'write' is called
     */
    private $isWriting = false;

Private member variable "isWriting" must contain a leading underscore

Private member variable "isWriting" must be prefixed with an underscore

TRUE, FALSE and NULL should be uppercase as per the configured coding-style; instead of false please use FALSE.

    /**

Missing short description in doc comment

     * @param StreamInterface $stream Stream to decorate

Expected 3 spaces after parameter name; 1 found

Parameter comment must end with a full stop

     * @param string $filename optional file name

Expected 10 spaces after parameter type; 1 found

Parameter comment must start with a capital letter

Parameter comment must end with a full stop

     */
    public function __construct(StreamInterface $stream, $filename = null)

Expected 2 blank lines before function; 1 found

Type hint "string" missing for $filename

TRUE, FALSE and NULL should be uppercase as per the configured coding-style; instead of null please use NULL.

    {

Opening brace should be on the same line as the declaration

        $this->stream = $stream;

Equals sign not aligned with surrounding assignments; expected 3 spaces but found 1 space

        $this->filename = $filename;
        $this->buffer = new BufferStream();

Equals sign not aligned with surrounding assignments; expected 3 spaces but found 1 space

    }

Expected 2 blank lines after function; 1 found

Expected 1 blank line before closing function brace; 0 found

Expected //end __construct()

    /**
     * Overridden to return the position in the target encoding.
     *
     * @return int

Expected "integer" but found "int" for function return type

     */
    public function tell()
    {

Opening brace should be on the same line as the declaration

        return $this->position;
    }

Expected 2 blank lines after function; 1 found

Expected 1 blank line before closing function brace; 0 found

Expected //end tell()

    /**
     * Returns null, getSize isn't supported
     *
     * @return null
     */
    public function getSize()
    {

Opening brace should be on the same line as the declaration

        return null;

TRUE, FALSE and NULL should be uppercase as per the configured coding-style; instead of null please use NULL.

    }

Expected 2 blank lines after function; 1 found

Expected 1 blank line before closing function brace; 0 found

Expected //end getSize()

    /**
     * Not supported.
     *
     * @param int $offset

Missing parameter comment

Expected "integer" but found "int" for parameter type

Tag value indented incorrectly; expected 2 spaces but found 1

     * @param int $whence

Missing parameter comment

Expected "integer" but found "int" for parameter type

Tag value indented incorrectly; expected 2 spaces but found 1

     * @throws RuntimeException

Tag cannot be grouped with parameter tags in a doc comment

Comment missing for @throws tag in function comment

     */

Missing @return tag in function comment

    public function seek($offset, $whence = SEEK_SET)

Type hint "int" missing for $offset

Type hint "int" missing for $whence

    {

Opening brace should be on the same line as the declaration

        throw new RuntimeException('Cannot seek a UUStream');
    }

Expected 2 blank lines after function; 1 found

Expected 1 blank line before closing function brace; 0 found

Expected //end seek()

    /**
     * Overridden to return false
     *
     * @return boolean
     */
    public function isSeekable()
    {

Opening brace should be on the same line as the declaration

        return false;

TRUE, FALSE and NULL should be uppercase as per the configured coding-style; instead of false please use FALSE.

    }

Expected 2 blank lines after function; 1 found

Expected 1 blank line before closing function brace; 0 found

Expected //end isSeekable()

    /**

Parameter $length should have a doc-comment as per coding-style.

     * Finds the next end-of-line character to ensure a line isn't broken up
     * while buffering.
     *
     * @return string
     */
    private function readToEndOfLine($length)

Private method name "UUStream::readToEndOfLine" must be prefixed with an underscore

    {

Opening brace should be on the same line as the declaration

        $str = $this->stream->read($length);
        if ($str === false || $str === '') {

TRUE, FALSE and NULL should be uppercase as per the configured coding-style; instead of false please use FALSE.

            return $str;
        }
        while (substr($str, -1) !== "\n") {
            $chr = $this->stream->read(1);
            if ($chr === false || $chr === '') {

TRUE, FALSE and NULL should be uppercase as per the configured coding-style; instead of false please use FALSE.

                break;
            }
            $str .= $chr;
        }
        return $str;
    }

Expected 2 blank lines after function; 1 found

Expected 1 blank line before closing function brace; 0 found

Expected //end readToEndOfLine()

    /**
     * Removes invalid characters from a uuencoded string, and 'BEGIN' and 'END'
     * line headers and footers from the passed string before returning it.
     *
     * @param string $str

Missing parameter comment

Tag value indented incorrectly; expected 2 spaces but found 1

     * @return string

Tag cannot be grouped with parameter tags in a doc comment

     */
    private function filterAndDecode($str)

Private method name "UUStream::filterAndDecode" must be prefixed with an underscore

Type hint "string" missing for $str

    {

Opening brace should be on the same line as the declaration

        $ret = str_replace("\r", '', $str);
        $ret = preg_replace('/[^\x21-\xf5`\n]/', '`', $ret);
        if ($this->position === 0) {
            $matches = [];

Short array syntax is not allowed

            if (preg_match('/^\s*begin\s+[^\s+]\s+([^\r\n]+)\s*$/im', $ret, $matches)) {
                $this->filename = $matches[1];
            }
            $ret = preg_replace('/^\s*begin[^\r\n]+\s*$/im', '', $ret);
        } else {
            $ret = preg_replace('/^\s*end\s*$/im', '', $ret);
        }
        return convert_uudecode(trim($ret));
    }

Expected 2 blank lines after function; 1 found

Expected 1 blank line before closing function brace; 0 found

Expected //end filterAndDecode()

    /**

Parameter $length should have a doc-comment as per coding-style.

     * Buffers bytes into $this->buffer, removing uuencoding headers and footers
     * and decoding them.
     */

Missing @return tag in function comment

    private function fillBuffer($length)

Private method name "UUStream::fillBuffer" must be prefixed with an underscore

    {

Opening brace should be on the same line as the declaration

        // 5040 = 63 * 80, seems to be good balance for buffering in benchmarks
        // testing with a simple 'if ($length < x)' and calculating a better
        // size reduces speeds by up to 4x
        while ($this->buffer->getSize() < $length) {
            $read = $this->readToEndOfLine(5040);
            if ($read === false || $read === '') {

TRUE, FALSE and NULL should be uppercase as per the configured coding-style; instead of false please use FALSE.

                break;
            }
            $this->buffer->write($this->filterAndDecode($read));
        }
    }

Expected 2 blank lines after function; 1 found

Expected 1 blank line before closing function brace; 0 found

Expected //end fillBuffer()

    /**
     * Returns true if the end of stream has been reached.
     *
     * @return boolean
     */
    public function eof()
    {

Opening brace should be on the same line as the declaration

        return ($this->buffer->eof() && $this->stream->eof());

Boolean operators are not allowed outside of control structure conditions

    }

Expected 2 blank lines after function; 1 found

Expected 1 blank line before closing function brace; 0 found

Expected //end eof()

    /**
     * Attempts to read $length bytes after decoding them, and returns them.
     *
     * @param int $length

Missing parameter comment

Expected "integer" but found "int" for parameter type

Tag value indented incorrectly; expected 2 spaces but found 1

     * @return string

Tag cannot be grouped with parameter tags in a doc comment

     */
    public function read($length)

Type hint "int" missing for $length

    {

Opening brace should be on the same line as the declaration

        // let Guzzle decide what to do.

Inline comments must start with a capital letter

        if ($length <= 0 || $this->eof()) {
            return $this->stream->read($length);
        }
        $this->fillBuffer($length);
        $read = $this->buffer->read($length);

Equals sign not aligned with surrounding assignments; expected 12 spaces but found 1 space

        $this->position += strlen($read);
        return $read;
    }

Expected 2 blank lines after function; 1 found

Expected 1 blank line before closing function brace; 0 found

Expected //end read()

    /**
     * Writes the 'begin' UU header line.
     */

Missing @return tag in function comment

    private function writeUUHeader()

Private method name "UUStream::writeUUHeader" must be prefixed with an underscore

This method is not in camel caps format.

    {

Opening brace should be on the same line as the declaration

        $filename = (empty($this->filename)) ? 'null' : $this->filename;

The value of a comparison must not be assigned to a variable

Inline IF statements are not allowed

        $this->stream->write("begin 666 $filename");

As per coding-style, please use concatenation or sprintf for the variable $filename instead of interpolation.

    }

Expected 2 blank lines after function; 1 found

Expected 1 blank line before closing function brace; 0 found

Expected //end writeUUHeader()

    /**
     * Writes the '`' and 'end' UU footer lines.
     */

Missing @return tag in function comment

    private function writeUUFooter()

Private method name "UUStream::writeUUFooter" must be prefixed with an underscore

This method is not in camel caps format.

    {

Opening brace should be on the same line as the declaration

        $this->stream->write("\r\n`\r\nend\r\n");
    }

Expected 2 blank lines after function; 1 found

Expected 1 blank line before closing function brace; 0 found

Expected //end writeUUFooter()

    /**
     * Writes the passed bytes to the underlying stream after encoding them.
     *
     * @param string $bytes

Missing parameter comment

     */

Missing @return tag in function comment

    private function writeEncoded($bytes)

Private method name "UUStream::writeEncoded" must be prefixed with an underscore

Type hint "string" missing for $bytes

    {

Opening brace should be on the same line as the declaration

        $encoded = preg_replace('/\r\n|\r|\n/', "\r\n", rtrim(convert_uuencode($bytes)));
        // removes ending '`' line

Inline comments must start with a capital letter

Inline comments must end in full-stops, exclamation marks, or question marks

        $this->stream->write("\r\n" . rtrim(substr($encoded, 0, -1)));

Concat operator must not be surrounded by spaces

    }

Expected 2 blank lines after function; 1 found

Expected 1 blank line before closing function brace; 0 found

Expected //end writeEncoded()

    /**
     * Prepends any existing remainder to the passed string, then checks if the
     * string fits into a uuencoded line, and removes and keeps any remainder
     * from the string to write.  Full lines ready for writing are returned.
     * 
     * @param string $string

Missing parameter comment

Tag value indented incorrectly; expected 2 spaces but found 1

     * @return string

Tag cannot be grouped with parameter tags in a doc comment

     */
    private function handleRemainder($string)

Private method name "UUStream::handleRemainder" must be prefixed with an underscore

Type hint "string" missing for $string

    {

Opening brace should be on the same line as the declaration

        $write = $this->remainder . $string;

Equals sign not aligned with surrounding assignments; expected 11 spaces but found 1 space

Concat operator must not be surrounded by spaces

        $nRem = strlen($write) % 45;

Equals sign not aligned with surrounding assignments; expected 12 spaces but found 1 space

Arithmetic operation must be bracketed

        $this->remainder = '';
        if ($nRem !== 0) {
            $this->remainder = substr($write, -$nRem);
            $write = substr($write, 0, -$nRem);

Equals sign not aligned with surrounding assignments; expected 11 spaces but found 1 space

        }
        return $write;
    }

Expected 2 blank lines after function; 1 found

Expected 1 blank line before closing function brace; 0 found

Expected //end handleRemainder()

    /**
     * Writes the passed string to the underlying stream after encoding it.
     *
     * Note that reading and writing to the same stream without rewinding is not
     * supported.
     *
     * Also note that some bytes may not be written until close or detach are
     * called.  This happens if written data doesn't align to a complete
     * uuencoded 'line' of 45 bytes.  In addition, the UU footer is only written
     * when closing or detaching as well.
     *
     * @param string $string

Missing parameter comment

Tag value indented incorrectly; expected 2 spaces but found 1

     * @return int the number of bytes written

Tag cannot be grouped with parameter tags in a doc comment

Expected "integer" but found "int" for function return type

     */
    public function write($string)

Type hint "string" missing for $string

    {

Opening brace should be on the same line as the declaration

        $this->isWriting = true;

TRUE, FALSE and NULL should be uppercase as per the configured coding-style; instead of true please use TRUE.

        if ($this->position === 0) {
            $this->writeUUHeader();
        }
        $write = $this->handleRemainder($string);
        if ($write !== '') {
            $this->writeEncoded($write);
        }
        $written = strlen($string);

Equals sign not aligned with surrounding assignments; expected 9 spaces but found 1 space

        $this->position += $written;
        return $written;
    }

Expected 2 blank lines after function; 1 found

Expected 1 blank line before closing function brace; 0 found

Expected //end write()

    /**
     * Returns the filename set in the UUEncoded header (or null)
     *
     * @return string
     */
    public function getFilename()
    {

Opening brace should be on the same line as the declaration

        return $this->filename;
    }

Expected 2 blank lines after function; 1 found

Expected 1 blank line before closing function brace; 0 found

Expected //end getFilename()

    /**
     * Sets the UUEncoded header file name written in the 'begin' header line.
     *
     * @param string $filename

Missing parameter comment

     */

Missing @return tag in function comment

    public function setFilename($filename)

Type hint "string" missing for $filename

    {

Opening brace should be on the same line as the declaration

        $this->filename = $filename;
    }

Expected 2 blank lines after function; 1 found

Expected 1 blank line before closing function brace; 0 found

Expected //end setFilename()

    /**
     * Writes out any remaining bytes and the UU footer.
     */

Missing @return tag in function comment

    private function beforeClose()

Private method name "UUStream::beforeClose" must be prefixed with an underscore

    {

Opening brace should be on the same line as the declaration

        if (!$this->isWriting) {

There must be a single space after a NOT operator; 0 found

            return;
        }
        if ($this->remainder !== '') {
            $this->writeEncoded($this->remainder);
        }
        $this->remainder = '';
        $this->isWriting = false;

TRUE, FALSE and NULL should be uppercase as per the configured coding-style; instead of false please use FALSE.

        $this->writeUUFooter();
    }

Expected 2 blank lines after function; 1 found

Expected 1 blank line before closing function brace; 0 found

Expected //end beforeClose()

    /**
     * Writes any remaining bytes out followed by the uu-encoded footer, then
     * closes the stream.
     */

Missing @return tag in function comment

    public function close()
    {

Opening brace should be on the same line as the declaration

        $this->beforeClose();
        $this->stream->close();
    }

Expected 2 blank lines after function; 1 found

Expected 1 blank line before closing function brace; 0 found

Expected //end close()

    /**
     * Writes any remaining bytes out followed by the uu-encoded footer, then
     * detaches the stream.
     */

Missing @return tag in function comment

    public function detach()
    {

Opening brace should be on the same line as the declaration

        $this->beforeClose();
        $this->stream->detach();
    }

Expected 2 blank lines after function; 0 found

Expected 1 blank line before closing function brace; 0 found

Expected //end detach()

}

Expected //end class

As per coding style, files should not end with a newline character.