zbateson / stream-decorators

src/ChunkSplitStream.php

<?php

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

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

/**
 * Inserts line ending characters after the set number of characters have been
 * written to the underlying 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 ChunkSplitStream implements StreamInterface
{

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

    use StreamDecoratorTrait;

    /**

Missing short description in doc comment

     * @var int Number of bytes written, and importantly, if non-zero, writes a
     *      final $lineEnding on close (and so maintained instead of using
     *      tell() directly)
     */
    private $position;

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 int The number of characters in a line before inserting $lineEnding.
     */
    private $lineLength;

Private member variable "lineLength" must contain a leading underscore

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

    /**

Missing short description in doc comment

     * @var string The line ending characters to insert.
     */
    private $lineEnding;

Private member variable "lineEnding" must contain a leading underscore

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

    /**

Missing short description in doc comment

     * @var int The strlen() of $lineEnding
     */
    private $lineEndingLength;

Private member variable "lineEndingLength" must contain a leading underscore

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

    /**

Missing short description in doc comment

     * @param StreamInterface $stream

Missing parameter comment

     * @param int $lineLength

Missing parameter comment

Expected 13 spaces after parameter type; 1 found

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

     * @param string $lineEnding

Missing parameter comment

Expected 10 spaces after parameter type; 1 found

     */
    public function __construct(StreamInterface $stream, $lineLength = 76, $lineEnding = "\r\n")

Expected 2 blank lines before function; 1 found

Type hint "int" missing for $lineLength

Type hint "string" missing for $lineEnding

    {

Opening brace should be on the same line as the declaration

        $this->stream = $stream;

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

        $this->lineLength = $lineLength;

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

        $this->lineEnding = $lineEnding;

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

        $this->lineEndingLength = strlen($this->lineEnding);
    }

Expected 2 blank lines after function; 1 found

Expected 1 blank line before closing function brace; 0 found

Expected //end __construct()

    /**
     * Inserts the line ending character after each line length characters in
     * the passed string, making sure previously written bytes are taken into
     * account.
     *
     * @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 getChunkedString($string)

Private method name "ChunkSplitStream::getChunkedString" must be prefixed with an underscore

Type hint "string" missing for $string

    {

Opening brace should be on the same line as the declaration

        $firstLine = '';
        if ($this->tell() !== 0) {
            $next = $this->lineLength - ($this->position % ($this->lineLength + $this->lineEndingLength));

Arithmetic operation must be bracketed

            if (strlen($string) > $next) {
                $firstLine = substr($string, 0, $next) . $this->lineEnding;

Concat operator must not be surrounded by spaces

                $string = substr($string, $next);

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

            }
        }
        // chunk_split always ends with the passed line ending

Inline comments must start with a capital letter

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

        $chunked = $firstLine . chunk_split($string, $this->lineLength, $this->lineEnding);

Concat operator must not be surrounded by spaces

        return substr($chunked, 0, strlen($chunked) - $this->lineEndingLength);

Arithmetic operation must be bracketed

    }

Expected 2 blank lines after function; 1 found

Expected 1 blank line before closing function brace; 0 found

Expected //end getChunkedString()

    /**
     * Writes the passed string to the underlying stream, ensuring line endings
     * are inserted every "line length" characters in the string.
     *
     * @param string $string

Missing parameter comment

Tag value indented incorrectly; expected 2 spaces but found 1

     * @return number of bytes written

Tag cannot be grouped with parameter tags in a doc comment

     */
    public function write($string)

Type hint "string" missing for $string

    {

Opening brace should be on the same line as the declaration

        $chunked = $this->getChunkedString($string);

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

        $this->position += strlen($chunked);
        return $this->stream->write($chunked);
    }

Expected 2 blank lines after function; 1 found

Expected 1 blank line before closing function brace; 0 found

Expected //end write()

    /**
     * Inserts a final line ending character.
     */

Missing @return tag in function comment

    private function beforeClose()

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

    {

Opening brace should be on the same line as the declaration

        if ($this->position !== 0) {
            $this->stream->write($this->lineEnding);
        }
    }

Expected 2 blank lines after function; 1 found

Expected 1 blank line before closing function brace; 0 found

Expected //end beforeClose()

    /**
     * Closes the stream after ensuring a final line ending character is
     * inserted.
     */

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

    /**
     * Detaches the stream after ensuring a final line ending character is
     * inserted.
     */

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.