turnaev / monitor-bundle

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

 * @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 CheckArraybleTrait // implements \ArrayAccess, \Iterator, \Countable
{
    /**

Missing short description in doc comment

     * @JMS\Exclude()
     *
     * @var CheckInterface[]
     */
    protected $checks = [];

    public function count(): int

Missing doc comment for function count()

    {
        return \count($this->checks);
    }

    /**

Missing short description in doc comment

     * @param string $offset

Missing parameter comment

     *
     * @return bool
     */
    public function offsetExists($offset)
    {
        return isset($this->checks[$offset]);
    }

    /**

Missing short description in doc comment

     * @param string $offset

Missing parameter comment

     *
     * @return CheckInterface
     */
    public function offsetGet($offset)
    {
        if ($this->checks[$offset] instanceof Proxy) {
            $this->checks[$offset] = $this->checks[$offset]();
        }

        return $this->checks[$offset];
    }

    /**

Missing short description in doc comment

     * @param string         $offset

Missing parameter comment

     * @param CheckInterface $value

Missing parameter comment

     */

Missing @return tag in function comment

    public function offsetSet($offset, $value)
    {
        $this->checks[$offset] = $value;
    }

    /**

Missing short description in doc comment

     * @param string $offset

Missing parameter comment

     *
     * @return CheckInterface
     */
    public function offsetUnset($offset)
    {
        unset($this->checks[$offset]);
    }

    /**

Missing short description in doc comment

     * @return CheckInterface
     */
    public function current()
    {
        $key = $this->key();

        return $this->offsetGet($key);
    }

    /**

Missing short description in doc comment

     * @return CheckInterface
     */
    public function next()
    {
        return next($this->checks);
    }

    /**

Missing short description in doc comment

     * @return string
     */
    public function key()
    {
        return key($this->checks);
    }

    /**

Missing short description in doc comment

     * @return bool
     */
    public function valid()
    {
        return (bool) key($this->checks);
    }

    public function rewind()

Missing doc comment for function rewind()

    {
        reset($this->checks);
    }

    /**

Missing short description in doc comment

     * @return CheckInterface[]
     */
    public function toArray()
    {
        $out = [];
        foreach ($this as $k => $v) {
            $out[$k] = $v;
        }

        return $out;
    }
}