jaxon-php / jaxon-core

src/App/Config/ConfigEventManager.php

<?php

Missing file doc comment

namespace Jaxon\App\Config;

/**

Block comments must be started with /*

 * ConfigEventManager.php
 *
 * Call listeners on config changes.
 *
 * @package jaxon-core
 * @author Thierry Feuzeu <thierry.feuzeu@gmail.com>
 * @copyright 2022 Thierry Feuzeu <thierry.feuzeu@gmail.com>
 * @license https://opensource.org/licenses/BSD-3-Clause BSD 3-Clause License
 * @link https://github.com/jaxon-php/jaxon-core
 */

use Jaxon\Di\Container;
use Jaxon\Utils\Config\Config;

class ConfigEventManager implements ConfigListenerInterface

Missing doc comment for class ConfigEventManager

{
    /**
     * @var Container
     */
    protected $di;

Expected 1 blank line(s) before first member var; 0 found

    /**
     * @var string[]
     */
    protected $aListeners = [];

    /**
     * The constructor
     *
     * @param Container $di

Missing parameter comment

     */
    public function __construct(Container $di)

Expected 2 blank lines before function; 1 found

    {
        $this->di = $di;
    }

Expected 2 blank lines after function; 1 found

    /**
     * Add a listener
     *
     * @param string $sClassName

Missing parameter comment

     *
     * @return void
     */
    public function addListener(string $sClassName)
    {
        $this->aListeners[] = $sClassName;
    }

Expected 2 blank lines after function; 1 found

    /**

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

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

     * @inheritDoc
     */

Missing @return tag in function comment

    public function onChange(Config $xConfig, string $sName)
    {
        foreach($this->aListeners as $sListener)
        {
            $this->di->g($sListener)->onChange($xConfig, $sName);
        }
    }

Expected 2 blank lines after function; 0 found

}