jaxon-php / jaxon-core

src/App/I18n/Translator.php

<?php

Missing file doc comment

namespace Jaxon\App\I18n;

/**

Block comments must be started with /*

 * Translator.php
 *
 * A translator coupled with a config event listener.
 *
 * @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\App\Config\ConfigListenerInterface;
use Jaxon\Utils\Config\Config;
use Jaxon\Utils\Translation\Translator as BaseTranslator;

class Translator extends BaseTranslator implements ConfigListenerInterface

Missing doc comment for class Translator

{
    /**

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)

Expected 2 blank lines before function; 0 found

    {
        // Set the library language any time the config is changed.
        if($sName === '' || $sName === 'core.language')
        {
            $this->setLocale($xConfig->getOption('core.language'));

It seems like $xConfig->getOption('core.language') can also be of type null; however, parameter $sLocale of Jaxon\Utils\Translation\Translator::setLocale() does only seem to accept string, maybe add an additional type check?

        }
    }

Expected 2 blank lines after function; 0 found

}