zbateson / stream-decorators

src/QuotedPrintableStream.php

<?php

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

Filename "QuotedPrintableStream.php" doesn't match the expected filename "quotedprintablestream.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 RuntimeException;

/**
 * GuzzleHttp\Psr7 stream decoder decorator for quoted printable streams.
 *
 * @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 QuotedPrintableStream implements StreamInterface
{

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

    use StreamDecoratorTrait;

    /**

Missing short description in doc comment

     * @var int current 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 string Last line of written text (used to maintain good line-breaks)
     */
    private $lastLine = '';

Private member variable "lastLine" must contain a leading underscore

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

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

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

     */
    public function tell()

Expected 2 blank lines before function; 1 found

    {

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 QuotedPrintableStream');
    }

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()

    /**
     * Reads $length chars from the underlying stream, prepending the past $pre
     * to it first.
     *
     * If the characters read (including the prepended $pre) contain invalid
     * quoted-printable characters, the underlying stream is rewound by the
     * total number of characters ($length + strlen($pre)).
     *
     * The quoted-printable encoded characters are returned.  If the characters
     * read are invalid, '3D' is returned indicating an '=' character.
     *
     * @param int $length

Missing parameter comment

Expected 4 spaces after parameter type; 1 found

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

Tag value indented incorrectly; expected 2 spaces but found 1

     * @param string $pre

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 readEncodedChars($length, $pre = '')

Private method name "QuotedPrintableStream::readEncodedChars" must be prefixed with an underscore

Type hint "int" missing for $length

Type hint "string" missing for $pre

    {

Opening brace should be on the same line as the declaration

        $str = $pre . $this->stream->read($length);

Concat operator must not be surrounded by spaces

        $len = strlen($str);
        if ($len > 0 && !preg_match('/^[0-9a-f]{2}$|^[\r\n].$/is', $str) && $this->stream->isSeekable()) {

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

            $this->stream->seek(-$len, SEEK_CUR);
            return '3D';    // '=' character

Comments may not appear after statements

        }
        return $str;
    }

Expected 2 blank lines after function; 1 found

Expected 1 blank line before closing function brace; 0 found

Expected //end readEncodedChars()

    /**
     * Decodes the passed $block of text.
     *
     * If the last or before last character is an '=' char, indicating the
     * beginning of a quoted-printable encoded char, 1 or 2 additional bytes are
     * read from the underlying stream respectively.
     *
     * The decoded string is returned.
     *
     * @param string $block

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 decodeBlock($block)

Private method name "QuotedPrintableStream::decodeBlock" must be prefixed with an underscore

Type hint "string" missing for $block

    {

Opening brace should be on the same line as the declaration

        if (substr($block, -1) === '=') {
            $block .= $this->readEncodedChars(2);
        } elseif (substr($block, -2, 1) === '=') {

Usage of ELSEIF not allowed; use ELSE IF instead

            $first = substr($block, -1);

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

            $block = substr($block, 0, -1);

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

            $block .= $this->readEncodedChars(1, $first);
        }
        return quoted_printable_decode($block);
    }

Expected 2 blank lines after function; 1 found

Expected 1 blank line before closing function brace; 0 found

Expected //end decodeBlock()

    /**

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

     * Reads up to $length characters, appends them to the passed $str string,
     * and returns the total number of characters read.
     *
     * -1 is returned if there are no more bytes to read.
     *
     * @param int $length

Missing parameter comment

Expected 4 spaces after parameter type; 1 found

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

Tag value indented incorrectly; expected 2 spaces but found 1

     * @param string $append

Missing parameter comment

Doc comment for parameter $append does not match actual variable name $str

Tag value indented incorrectly; expected 2 spaces but found 1

     * @return int

Tag cannot be grouped with parameter tags in a doc comment

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

     */
    private function readRawDecodeAndAppend($length, &$str)

Private method name "QuotedPrintableStream::readRawDecodeAndAppend" must be prefixed with an underscore

Type hint "int" missing for $length

Type hint "string" missing for $append

    {

Opening brace should be on the same line as the declaration

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

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

            return -1;
        }
        $decoded = $this->decodeBlock($block);
        $count = strlen($decoded);

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

        $str .= $decoded;

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

        return $count;
    }

Expected 2 blank lines after function; 1 found

Expected 1 blank line before closing function brace; 0 found

Expected //end readRawDecodeAndAppend()

    /**
     * Reads up to $length decoded bytes from the underlying quoted-printable
     * encoded stream 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);
        }
        $count = 0;
        $bytes = '';
        while ($count < $length) {
            $nRead = $this->readRawDecodeAndAppend($length - $count, $bytes);

Arithmetic operation must be bracketed

            if ($nRead === -1) {
                break;
            }
            $this->position += $nRead;
            $count += $nRead;

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

        }
        return $bytes;
    }

Expected 2 blank lines after function; 1 found

Expected 1 blank line before closing function brace; 0 found

Expected //end read()

    /**
     * Writes the passed string to the underlying stream after encoding it as
     * quoted-printable.
     *
     * Note that reading and writing to the same stream without rewinding is not
     * supported.
     *
     * @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

        $encodedLine = quoted_printable_encode($this->lastLine);

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

        $lineAndString = rtrim(quoted_printable_encode($this->lastLine . $string), "\r\n");

Concat operator must not be surrounded by spaces

        $write = substr($lineAndString, strlen($encodedLine));

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

        $this->stream->write($write);
        $written = strlen($string);

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

        $this->position += $written;

        $lpos = strrpos($lineAndString, "\n");

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

        $lastLine = $lineAndString;
        if ($lpos !== false) {

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

            $lastLine = substr($lineAndString, $lpos + 1);

Arithmetic operation must be bracketed

        }
        $this->lastLine = quoted_printable_decode($lastLine);
        return $written;
    }

Expected 2 blank lines after function; 1 found

Expected 1 blank line before closing function brace; 0 found

Expected //end write()

    /**
     * Writes out a final CRLF if the current line isn't empty.
     */

Missing @return tag in function comment

    private function beforeClose()

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

    {

Opening brace should be on the same line as the declaration

        if ($this->isWritable() && $this->lastLine !== '') {
            $this->stream->write("\r\n");
            $this->lastLine = '';
        }
    }

Expected 2 blank lines after function; 1 found

Expected 1 blank line before closing function brace; 0 found

Expected //end beforeClose()

    /**
     * Closes the underlying stream and writes a final CRLF if the current line
     * isn't empty.
     */

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()

    /**
     * Closes the underlying stream and writes a final CRLF if the current line
     * isn't empty.
     */

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.