turnaev / monitor-bundle

src/Check/CheckTrait.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;
use ZendDiagnostics\Result\ResultInterface;

/**

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

trait CheckTrait
{
    /**

Missing short description in doc comment

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

    /**

Missing short description in doc comment

     * @var ?string
     */
    protected $label;

    /**

Missing short description in doc comment

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

    /**

Missing short description in doc comment

     * @JMS\SerializedName("descr")
     * @JMS\Type("string")
     * @JMS\SkipWhenEmpty()
     * @JMS\Expose()
     *
     * @var string?

The doc comment string? at position 0 could not be parsed: Unknown type name 'string?' at position 0 in string?.

     */
    protected $descr;

    /**

Missing short description in doc comment

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

    /**

Missing short description in doc comment

     * @JMS\SerializedName("tags")
     * @JMS\SkipWhenEmpty()
     * @JMS\Type("array<string>")
     * @JMS\Expose()
     *
     * @var string[]
     */
    protected $tags = [];

    /**
     * Perform the actual check and return a ResultInterface.
     *
     * @return ResultInterface
     */
    abstract public function check();

    public function getId(): string

Missing doc comment for function getId()

    {
        return $this->id;
    }

    public function setId(string $id)

Missing doc comment for function setId()

    {
        $this->id = $id;
    }

    public function getImportance()

Missing doc comment for function getImportance()

    {
        return $this->importance;
    }

    public function setImportance($importance)

Missing doc comment for function setImportance()

    {
        $this->importance = $importance;
    }

    /**

Missing short description in doc comment

     * @return string[]
     */
    public function getTags(): array
    {
        return $this->tags;
    }

    /**

Missing short description in doc comment

     * @param string[] $tags

Missing parameter comment

     */

Missing @return tag in function comment

    public function setTags(array $tags)
    {
        $this->tags = $tags;
        $this->tags = array_unique($this->tags);
    }

    /**

Missing short description in doc comment

     * @param string $tag

Missing parameter comment

     */

Missing @return tag in function comment

    public function addTag($tag)
    {
        $this->tags[$tag];
        $this->tags = array_unique($this->tags);
    }

    public function getGroup(): string

Missing doc comment for function getGroup()

    {
        return $this->group;
    }

    public function setGroup(string $group)

Missing doc comment for function setGroup()

    {
        $this->group = $group;
    }

    /**

Missing short description in doc comment

     * @JMS\SerializedName("label")
     * @JMS\Type("string")
     * @JMS\VirtualProperty()
     * @JMS\Expose()
     */

Missing @return tag in function comment

    public function getLabel(): string
    {
        if (null !== $this->label) {
            return $this->label;
        }

        return sprintf('Check %s', $this->id);
    }

    public function setLabel($label)

Missing doc comment for function setLabel()

    {
        $this->label = $label;
    }

    /**

Missing short description in doc comment

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

    /**

Missing short description in doc comment

     * @param ?string $descr

Missing parameter comment

     */

Missing @return tag in function comment

    public function setDescr(string $descr = null)
    {
        $this->descr = $descr;
    }

    public function setAdditionParams(array $data)

Missing doc comment for function setAdditionParams()

    {
        if (array_key_exists('id', $data)) {
            $this->setId($data['id']);
        }

        if (array_key_exists('group', $data)) {
            $this->setGroup($data['group']);
        }

        if (array_key_exists('importance', $data)) {
            $this->setImportance($data['importance']);
        }

        if (array_key_exists('tags', $data)) {
            $this->setTags($data['tags']);
        }

        if (array_key_exists('label', $data)) {
            $this->setLabel($data['label']);
        }

        if (array_key_exists('descr', $data)) {
            $this->setDescr($data['descr']);
        }
    }
}