MyArtJaub\Webtrees\Module\AbstractModuleMaj

Complexity

Total Complexity

8

Size/Duplication

Total Lines	83
Duplicated Lines	0 %

Importance

Changes	1
Bugs	0	Features	0

6 Methods

Rating	Name	Duplication	Size	Complexity
A	resourcesFolder()	0	3	1
A	moduleCssUrl()	0	11	2
A	customModuleSupportUrl()	0	3	1
A	boot()	0	5	1
A	customTranslations()	0	10	2
A	customModuleAuthorName()	0	3	1

<?php
/**
 * webtrees-lib: MyArtJaub library for webtrees
 *
 * @package MyArtJaub\Webtrees
 * @author Jonathan Jaubart <dev@jaubart.com>
 * @copyright Copyright (c) 2020, Jonathan Jaubart
 * @license http://www.gnu.org/licenses/gpl.html GNU General Public License, version 3
 */
declare(strict_types=1);

namespace MyArtJaub\Webtrees\Module;

use Aura\Router\Map;
use Aura\Router\RouterContainer;
use Fisharebest\Localization\Translation;
use Fisharebest\Webtrees\View;
use Fisharebest\Webtrees\Webtrees;
use Fisharebest\Webtrees\Module\AbstractModule;
use Fisharebest\Webtrees\Module\ModuleCustomInterface;
use Fisharebest\Webtrees\Module\ModuleCustomTrait;
use Fisharebest\Webtrees\Module\ModuleThemeInterface;

/**
 * MyArtJaub Module
 */
abstract class AbstractModuleMaj extends AbstractModule implements ModuleCustomInterface
{    
    use ModuleCustomTrait;
    
    /**
     * {@inheritDoc}
     * @see \Fisharebest\Webtrees\Module\AbstractModule::boot()
     */
    public function boot() : void
    {
        View::registerNamespace($this->name(), $this->resourcesFolder() . 'views/');
        
        $this->loadRoutes(app(RouterContainer::class)->getMap());
    }
    
    /**
     * {@inheritDoc}
     * @see \Fisharebest\Webtrees\Module\AbstractModule::resourcesFolder()
     */
    public function resourcesFolder(): string
    {
        return Webtrees::MODULES_DIR . trim($this->name(), '_') . '/resources/';
    }
    
    /**
     * {@inheritDoc}
     * @see \Fisharebest\Webtrees\Module\ModuleCustomInterface::customModuleAuthorName()
     */
    public function customModuleAuthorName() : string
    {
        return 'Jonathan Jaubart';
    }
    
    /**
     * {@inheritDoc}
     * @see \Fisharebest\Webtrees\Module\ModuleCustomInterface::customModuleSupportUrl()
     */
    public function customModuleSupportUrl() : string
    {
        return 'https://github.com/jon48/webtrees-lib';
    }
    
    /**
     * {@inheritDoc}
     * @see \Fisharebest\Webtrees\Module\ModuleCustomInterface::customTranslations()
     */
    public function customTranslations(string $language) : array
    {
        $translation_file = $this->resourcesFolder() . 'lang/' . $language . '/messages.php';
        
        try {
            $translation  = new Translation($translation_file);
            return $translation->asArray();
        } catch (\Exception $e) { }

Consider adding a comment why this CATCH block is empty.

        
        return array();
    }
    
    /**
     * Add module routes to webtrees route loader
     * 
     * @param Map $router
     */
    public abstract function loadRoutes(Map $router) : void;
    
    /**
     * Returns the URL of the module specific stylesheets.
     * It will look for a CSS file matching the theme name (e.g. xenea.min.css),
     * and fallback to default.min.css if none are found
     * 
     * @return string
     */
    public function moduleCssUrl() : string
    {
        /** @var ModuleThemeInterface $theme */
        $theme = app(ModuleThemeInterface::class);
        $css_file = $this->resourcesFolder() . 'css/' . $theme->name() . '.min.css';
        
        if(file_exists($css_file)) {
            return $this->assetUrl('css/' . $theme->name() . '.min.css');
        }
        else {
            return $this->assetUrl('css/default.min.css');
        }
    }
    
}