turnaev / monitor-bundle

src/Check/CheckManager.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 Symfony\Component\DependencyInjection\ContainerAwareTrait;

/**

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 CheckManager implements \ArrayAccess, \Iterator, \Countable
{
    use ContainerAwareTrait;
    use CheckArraybleTrait;

    /**

Missing short description in doc comment

     * @var Group[]
     */
    protected $groups = [];

    /**

Missing short description in doc comment

     * @var Group[]
     */
    protected $tags = [];

    /**

Missing short description in doc comment

     * @param ?string|string[] $tags

Missing parameter comment

Doc comment for parameter $tags does not match actual variable name $ids

     * @param ?string|string[] $groups

Missing parameter comment

     * @param null|mixed       $ids

Missing parameter comment

Doc comment for parameter $ids does not match actual variable name $tags

     *
     * @return Tag[]
     */
    public function findChecks($ids = null, $groups = null, $tags = null): array
    {
        $ids = (array) (null === $ids ? [] : (\is_string($ids) ? [$ids] : $ids));
        $groups = (array) (null === $groups ? [] : (\is_string($groups) ? [$groups] : $groups));
        $tags = (array) (null === $tags ? [] : (\is_string($tags) ? [$tags] : $tags));

        $check = array_filter($this->toArray(), static function (CheckInterface $c) use ($ids, $groups, $tags) {

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

            $inIds = ($ids) ? \in_array($c->getId(), $ids, true) : true;
            $inGroups = ($groups) ? \in_array($c->getGroup(), $groups, true) : true;
            $inTags = ($tags) ? (bool) array_intersect($c->getTags(), $tags) : true;

            return $inIds && $inGroups && $inTags;
        });

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

        return $check;
    }

    /**

Missing short description in doc comment

     * @param ?string|string[] $groups

Missing parameter comment

     *
     * @return Group[]
     */
    public function findGroups($groups = null): array
    {
        if ($groups) {
            $groups = \is_string($groups) ? [$groups] : $groups;

            return array_filter($this->groups, static function ($t) use ($groups) {

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

                return \in_array($t->getName(), $groups, true);
            });

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

        }

        return $this->groups;
    }

    /**

Missing short description in doc comment

     * @param ?string|string[] $tags

Missing parameter comment

     *
     * @return Group[]
     */
    public function findTags($tags = null): array
    {
        if ($tags) {
            $tags = \is_string($tags) ? [$tags] : $tags;

            return array_filter($this->tags, static function ($t) use ($tags) {
                return \in_array($t->getName(), $tags, true);
            });

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

        }

        return $this->tags;
    }

    public function add(array $checkConfs, array $tagConfs, array $groupConfs)

Missing doc comment for function add()

    {
        $this->addTags($tagConfs);
        $this->addGroups($groupConfs);
        $this->addChecks($checkConfs);
    }

    public function addIfTag(Tag $tag): Tag

Missing doc comment for function addIfTag()

    {
        return empty($this->tags[$tag->getName()]) ? $this->tags[$tag->getName()] = $tag : $this->tags[$tag->getName()];

The expression return empty($this->tags[$tag->getName()]) ? $this->tags[$tag->getName()] = $tag : $this->tags[$tag->getName()] could return the type Tvi\MonitorBundle\Check\Group which is incompatible with the type-hinted return Tvi\MonitorBundle\Check\Tag. Consider adding an additional type-check to rule them out.

    }

    public function addIfGroup(Group $group): Group

Missing doc comment for function addIfGroup()

    {
        return empty($this->groups[$group->getName()]) ? $this->groups[$group->getName()] = $group : $this->groups[$group->getName()];
    }

    public function addIfCheck(CheckInterface $check)

Missing doc comment for function addIfCheck()

    {
        $this->checks[$check->getId()] = $check;

        foreach ($check->getTags() as $tag) {
            $tag = $this->addIfTag(new Tag($tag));
            $tag->addCheck($check->getId(), $this->checks[$check->getId()]);
        }

        $group = $this->addIfGroup(new Group($check->getGroup()));
        $group->addCheck($check->getId(), $this->checks[$check->getId()]);

        $this->groups[$group->getId()] = $group;
    }

    protected function addTags(array $tagConfs)

Missing doc comment for function addTags()

    {
        foreach ($tagConfs as $id => $setting) {
            $tag = new Tag($id, !empty($setting['name']) ? $setting['name'] : null, !empty($setting['descr']) ? $setting['descr'] : null);
            $this->addIfTag($tag);
        }
    }

    protected function addGroups(array $gropConfs)

Missing doc comment for function addGroups()

    {
        foreach ($gropConfs as $id => $setting) {
            $group = new Group($id, !empty($setting['name']) ? $setting['name'] : null, !empty($setting['descr']) ? $setting['descr'] : null);
            $this->addIfGroup($group);
        }
    }

    /**

Missing short description in doc comment

     * @param array $checkConfs

Missing parameter comment

     */

Missing @return tag in function comment

    protected function addChecks($checkConfs)
    {
        foreach ($checkConfs as $id => $setting) {
            $serviceId = $setting['serviceId'];
            $checkProxy = new Proxy(function () use ($serviceId, $id) {

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

                $this->checks[$id] = $this->container->get($serviceId);

                return $this->checks[$id];
            });

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

            $this->checks[$id] = $checkProxy;

            foreach ($setting['tags'] as $tagId) {
                $tag = $this->addIfTag(new Tag($tagId));
                $tag->addCheck($id, $this->checks[$id]);
            }

            $group = $this->addIfGroup(new Group($setting['group']));
            $group->addCheck($id, $this->checks[$id]);

            $this->groups[$group->getId()] = $group;
        }
    }
}