turnaev / monitor-bundle

src/Check/CheckInterface.php

<?php

/**
 * This file is part of the `tvi/monitor-bundle` project.
 *
 * (c) https://github.com/turnaev/monitor-bundle/graphs/contributors
 *
 * For the full copyright and license information, please view the LICENSE.md
 * file that was distributed with this source code.
 */

PHP version not specified

Missing @category tag in file comment

Missing @package tag in file comment

Missing @author tag in file comment

Missing @license tag in file comment

Missing @link tag in file comment

namespace Tvi\MonitorBundle\Check;

/**

Missing short description in doc comment

 * @author Vladimir Turnaev <turnaev@gmail.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

interface CheckInterface
{
    public function getId(): string;

Missing doc comment for function getId()

    /**

Missing short description in doc comment

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

     * @return $this
     */
    public function setId(string $id);

    /**

Missing short description in doc comment

     * @return string[]
     */
    public function getTags(): array;

    /**

Missing short description in doc comment

     * @param string[] $tags

Missing parameter comment

     */

Missing @return tag in function comment

    public function setTags(array $tags);

    public function getGroup(): string;

Missing doc comment for function getGroup()

    public function setGroup(string $group);

Missing doc comment for function setGroup()

    public function setAdditionParams(array $data);

Missing doc comment for function setAdditionParams()

    /**

Missing short description in doc comment

     * @return ?string
     */
    public function getDescr();

    /**

Missing short description in doc comment

     * @param ?null $descr

Are you sure the doc-type for parameter $descr is correct as it would always require null to be passed?

Missing parameter comment

     */

Missing @return tag in function comment

    public function setDescr(string $descr = null);
}