Zerg\Stream\AbstractStream

Complexity

Total Complexity

2

Size/Duplication

Total Lines	34
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	1

Test Coverage

Coverage

100%

Importance

Changes	9
Bugs	0	Features	1

3 Methods

Rating	Name	Duplication	Size	Complexity
	__construct()	0	1	?
A	getBuffer()	0	4	1
A	skip()	0	4	1

<?php

namespace Zerg\Stream;

/**
 * AbstractStream represents any type of stream - an entity that wraps data source and
 * encapsulates the read and write operations.
 *
 * @since 0.1
 * @package Zerg\Stream
 */
abstract class AbstractStream
{
    /**
     * @var \PhpBio\BitBuffer Object that reads and writes data from|to file|memory stream.
     * */
    protected $buffer;

    /**
     * Implementations should init buffer itself by given value.
     *
     * @param string $path Value to init buffer.
     */
    abstract public function __construct($path);

For interfaces and abstract methods it is generally a good practice to add a @return annotation even if it is just @return void or @return null, so that implementors know what to do in the overridden method.

    /**
     * Getter for $buffer property.
     *
     * @return \PhpBio\BitBuffer Object that reads data from file|memory stream.
     */
    public function getBuffer()
    {
        return $this->buffer;
    }

    /**
     * Move internal pointer by given amount of bits ahead without reading dta.
     *
     * @param int $size Amount of bits to be skipped.
     */
    public function skip($size)
    {
        $this->buffer->setPosition($this->buffer->getPosition() + $size);
    }
}