turnaev / monitor-bundle

src/Runner/RunnerManager.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\Runner;

use Tvi\MonitorBundle\Check\CheckInterface;
use Tvi\MonitorBundle\Check\Group;
use Tvi\MonitorBundle\Check\CheckManager;
use Tvi\MonitorBundle\Check\Tag;

/**

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

class RunnerManager
{
    /**

Missing short description in doc comment

     * @var CheckManager
     */
    protected $checkManager;

    public function __construct(CheckManager $checkManager)

Missing doc comment for function __construct()

    {
        $this->checkManager = $checkManager;
    }

    /**

Missing short description in doc comment

     * @param ?string|string[] $ids

Missing parameter comment

     * @param ?string|string[] $groups

Missing parameter comment

     * @param ?string|string[] $tags

Missing parameter comment

     */

Missing @return tag in function comment

    public function getRunner($ids = null, $groups = null, $tags = null): Runner
    {
        $checks = $this->checkManager->findChecks($ids, $groups, $tags);

        return new Runner(null, $checks);
    }

    /**

Missing short description in doc comment

     * @param ?string|string[] $ids

Missing parameter comment

     * @param ?string|string[] $groups

Missing parameter comment

     * @param ?string|string[] $tags

Missing parameter comment

     *
     * @return CheckInterface[]
     */
    public function findChecks($ids = null, $groups = null, $tags = null): array
    {
        return $this->checkManager->findChecks($ids, $groups, $tags);
    }

    /**

Missing short description in doc comment

     * @param ?string|string[] $ids

Missing parameter comment

     * @param ?string|string[] $groups

Missing parameter comment

     * @param ?string|string[] $tags

Missing parameter comment

     *
     * @return CheckInterface[]
     */
    public function findChecksSorted($ids = null, $groups = null, $tags = null): array
    {
        $checks = $this->findChecks($ids, $groups, $tags);

        uasort($checks, static function (CheckInterface $a, CheckInterface $b) {

The opening parenthesis of a multi-line function call should be the last content on the line.

            return ($a->getGroup() === $b->getGroup()) ? 0 : ($a->getGroup() < $b->getGroup() ? -1 : 1);
        });

For multi-line function calls, the closing parenthesis should be on a new line.

        return $checks;
    }

    /**

Missing short description in doc comment

     * @param ?string|string[] $tags

Missing parameter comment

     *
     * @return Tag[]
     */
    public function findTags($tags = null): array
    {
        return $this->checkManager->findTags($tags);

The expression return $this->checkManager->findTags($tags) returns an array which contains values of type Tvi\MonitorBundle\Check\Group which are incompatible with the documented value type Tvi\MonitorBundle\Check\Tag.

    }

    /**

Missing short description in doc comment

     * @param ?string|string[] $groups

Missing parameter comment

     *
     * @return Group[]
     */
    public function findGroups($groups = null): array
    {
        return $this->checkManager->findGroups($groups);
    }
}