turnaev / monitor-bundle

src/Check/Group.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;

use JMS\Serializer\Annotation as JMS;

/**

Missing short description in doc comment

 * @JMS\AccessorOrder("custom", custom = {"id", "name", "label", "descr", "count"})
 * @JMS\VirtualProperty(
 *     exp="object.count()",
 *     options={@JMS\SerializedName("count")}
 *  )
 *
 * @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

class Group implements \ArrayAccess, \Iterator, \Countable
{
    use CheckArraybleTrait;

    /**

Missing short description in doc comment

     * @JMS\SerializedName("id")
     * @JMS\Type("string")
     *
     * @var string
     */
    protected $id;

    /**

Missing short description in doc comment

     * @JMS\SerializedName("name")
     * @JMS\Type("string")
     *
     * @var string
     */
    protected $name;

    /**

Missing short description in doc comment

     * @JMS\SerializedName("descr")
     * @JMS\Type("string")
     * @JMS\SkipWhenEmpty()
     *
     * @var ?string
     */
    protected $descr;

    /**

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

     * Group constructor.
     *
     * @param ?string $name

Missing parameter comment

Doc comment for parameter $name does not match actual variable name $id

     * @param ?string $descr

Missing parameter comment

Doc comment for parameter $descr does not match actual variable name $name

     */
    public function __construct(string $id, string $name = null, string $descr = null)
    {
        $this->id = $id;
        $this->name = null === $name ? $id : $name;
        $this->descr = $descr;
    }

    public function getId(): string

Missing doc comment for function getId()

    {
        return $this->id;
    }

    /**

Missing short description in doc comment

     * @param mixed $name

Missing parameter comment

     *
     * @return $this
     */
    public function setName(string $name): self
    {
        $this->name = $name;

        return $this;
    }

    public function getName(): string

Missing doc comment for function getName()

    {
        return $this->name;
    }

    /**

Missing short description in doc comment

     * @param ?string $descr

Missing parameter comment

     *
     * @return $this
     */
    public function setDescr(string $descr = null): self
    {
        $this->descr = $descr;

        return $this;
    }

    /**

Missing short description in doc comment

     * @return null|string
     */
    public function getDescr()
    {
        return $this->descr;
    }

    /**

Missing short description in doc comment

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

     * @param CheckInterface|Proxy $check

Missing parameter comment

Doc comment for parameter $check does not match actual variable name $checkId

     *
     * @return $this
     */
    public function addCheck(string $checkId, &$check): self
    {
        $this->checks[$checkId] = &$check;

        return $this;
    }

    /**

Missing short description in doc comment

     * @JMS\SerializedName("label")
     * @JMS\Type("string")
     * @JMS\VirtualProperty()
     *
     * @return string
     */
    public function getLabel()
    {
        return sprintf('%s(%d)', $this->name, $this->count());
    }

    /**

Missing short description in doc comment

     * @JMS\SerializedName("checks")
     * @JMS\SkipWhenEmpty()
     * @JMS\Type("array<string>")
     * @JMS\VirtualProperty()
     *
     * @return string[]
     */
    public function getCheckIds(): array
    {
        return array_keys($this->checks);
    }
}