ZBateson\StreamDecorators\Base64Stream

Complexity

Total Complexity

21

Size/Duplication

Total Lines	185
Duplicated Lines	0 %

Test Coverage

Coverage

100%

Importance

Changes

0

12 Methods

Rating	Name	Duplication	Size	Complexity
A	write()	0	14	2
A	tell()	0	3	1
A	close()	0	4	1
A	detach()	0	4	1
A	eof()	0	3	2
A	getSize()	0	3	1
A	__construct()	0	4	1
A	isSeekable()	0	3	1
A	seek()	0	3	1
A	read()	0	10	3
A	fillBuffer()	0	9	4
A	beforeClose()	0	5	3

<?php

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

Filename "Base64Stream.php" doesn't match the expected filename "base64stream.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 base64 streams.
 *
 * Note that it's expected the underlying stream will only contain valid base64
 * characters (normally the stream should be wrapped in a
 * PregReplaceFilterStream to filter out non-base64 characters for reading).
 *
 * ```
 * $f = fopen(...);
 * $stream = new Base64Stream(new PregReplaceFilterStream(
 *      Psr7\stream_for($f), '/[^a-zA-Z0-9\/\+=]/', ''
 * ));
 * //...
 * ```
 *
 * For writing, a ChunkSplitStream could come in handy so the output is split
 * into lines:
 *
 * ```
 * $f = fopen(...);
 * $stream = new Base64Stream(new ChunkSplitStream(new PregReplaceFilterStream(
 *      Psr7\stream_for($f), '/[^a-zA-Z0-9\/\+=]/', ''
 * )));
 * //...
 * ```
 *
 * @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 Base64Stream implements StreamInterface
{

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

    use StreamDecoratorTrait;

    /**

Missing short description in doc comment

     * @var BufferStream buffered 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 current number of read/written bytes (for tell())
     */
    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

     * @param StreamInterface $stream

Missing parameter comment

     */
    public function __construct(StreamInterface $stream)

Expected 2 blank lines before function; 1 found

    {

Opening brace should be on the same line as the declaration

        $this->stream = $stream;
        $this->buffer = new BufferStream();
    }

Expected 2 blank lines after function; 1 found

Expected 1 blank line before closing function brace; 0 found

Expected //end __construct()

    /**
     * Returns the current position of the file read/write pointer
     *
     * @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 implemented (yet).
     *
     * Seek position can be calculated.
     *
     * @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 Base64Stream');
    }

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

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

    /**
     * Fills the internal byte buffer after reading and decoding data from the
     * underlying stream.
     *
     * Note that it's expected the underlying stream will only contain valid
     * base64 characters (normally the stream should be wrapped in a
     * PregReplaceFilterStream to filter out non-base64 characters).
     *
     * @param int $length

Missing parameter comment

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

     */

Missing @return tag in function comment

    private function fillBuffer($length)

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

Type hint "int" missing for $length

    {

Opening brace should be on the same line as the declaration

        $fill = 8192;
        while ($this->buffer->getSize() < $length) {
            $read = $this->stream->read($fill);
            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(base64_decode($read));
        }
    }

Expected 2 blank lines after function; 1 found

Expected 1 blank line before closing function brace; 0 found

Expected //end fillBuffer()

    /**
     * Attempts to read $length bytes after decoding them, and returns them.
     *
     * Note that reading and writing to the same stream may result in wrongly
     * encoded data and is not supported.
     *
     * @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);
        $ret = $this->buffer->read($length);

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

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

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 to
     * base64.
     *
     * Base64Stream::close or detach must be called.  Failing to do so may
     * result in 1-2 bytes missing from the end of the stream if there's a
     * remainder.  Note that the default Stream destructor calls close as well.
     *
     * Note that reading and writing to the same stream may result in wrongly
     * encoded data and 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

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

Concat operator must not be surrounded by spaces

        $len = strlen($bytes);

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

        if (($len % 3) !== 0) {
            $this->remainder = substr($bytes, -($len % 3));
            $bytes = substr($bytes, 0, $len - ($len % 3));

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

Arithmetic operation must be bracketed

        } else {
            $this->remainder = '';
        }
        $this->stream->write(base64_encode($bytes));
        $written = strlen($string);

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

        $this->position += $len;
        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 any remaining bytes at the end of the stream and closes.
     */

Missing @return tag in function comment

    private function beforeClose()

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

    {

Opening brace should be on the same line as the declaration

        if ($this->isWritable() && $this->remainder !== '') {
            $this->stream->write(base64_encode($this->remainder));
            $this->remainder = '';
        }
    }

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 after writing out any remaining bytes
     * needing to be encoded.
     */

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 underlying stream after writing out any remaining bytes
     * needing to be encoded.
     */

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.