smi2 / phpClickHouse

src/Transport/Stream.php

<?php

Missing declare(strict_types=1).

namespace ClickHouseDB\Transport;

/**
 * Class Stream

Documentation comment contains forbidden comment "Class Stream".

 * @package ClickHouseDB\Transport

Expected 1 lines between description and annotations, found 0.

Use of annotation @package is forbidden.

 */
abstract class Stream implements IStream
{
    /**

Found multi-line comment for property \ClickHouseDB\Transport\Stream::$source with single line content, use one-line comment instead.

     * @var resource
     */
    private $source;
    /**

Found multi-line comment for property \ClickHouseDB\Transport\Stream::$gzip with single line content, use one-line comment instead.

     * @var bool
     */
    private $gzip=false;

Equals sign not aligned correctly; expected 1 space but found 0 spaces

Expected at least 1 space before "="; 0 found

Expected at least 1 space after "="; 0 found

    /**

Found multi-line comment for property \ClickHouseDB\Transport\Stream::$callable with single line content, use one-line comment instead.

     * @var null|callable

Null type hint should be on last position in "null|callable".

     */
    private $callable=null;

Equals sign not aligned correctly; expected 1 space but found 0 spaces

Expected at least 1 space before "="; 0 found

Expected at least 1 space after "="; 0 found

    /**
     * @param resource $source
     */
    public function __construct($source)

Expected 1 blank line before function; 0 found

    {
        if (!is_resource($source)) {

Function is_resource() should not be referenced via a fallback global name, but via a use statement.

Expected 1 lines after "if", found 0.

Expected 1 space after NOT operator; 0 found

            throw new \InvalidArgumentException('Argument $source must be resource');

Class \InvalidArgumentException should not be referenced via a fully qualified name, but via a use statement.

        }
        $this->source = $source;
    }

    /**
     * @return bool
     */
    public function isGzipHeader()

Method \ClickHouseDB\Transport\Stream::isGzipHeader() does not have native return type hint for its return value but it should be possible to add it based on @return annotation "bool".

    {
        return $this->gzip;
    }

    /**
     * @return callable|null
     */
    public function getClosure()

Method \ClickHouseDB\Transport\Stream::getClosure() does not have native return type hint for its return value but it should be possible to add it based on @return annotation "callable|null".

    {
        return $this->callable;
    }

    /**
     * @return resource
     */
    public function getStream()
    {
        return $this->source;
    }

    /**
     * @param callable $callable

Method \ClickHouseDB\Transport\Stream::closure() has useless @param annotation for parameter $callable.

     */
    public function closure(callable $callable)

Method \ClickHouseDB\Transport\Stream::closure() does not have void return type hint.

Method \ClickHouseDB\Transport\Stream::closure() does not need documentation comment.

    {
        $this->callable=$callable;

Equals sign not aligned correctly; expected 1 space but found 0 spaces

Expected at least 1 space before "="; 0 found

Expected at least 1 space after "="; 0 found

    }

    /**

Empty comment

     *
     */
    public function enableGzipHeader()

Method \ClickHouseDB\Transport\Stream::enableGzipHeader() does not have void return type hint.

Method \ClickHouseDB\Transport\Stream::enableGzipHeader() does not need documentation comment.

    {
        $this->gzip=true;

Equals sign not aligned correctly; expected 1 space but found 0 spaces

Expected at least 1 space before "="; 0 found

Expected at least 1 space after "="; 0 found

    }

Expected 0 blank lines after function; 1 found

}

There must be exactly 0 empty lines before class closing brace.