Module::getRequiredFileLists() - Code Metrics - Inspection of "Issue #512" - cross-solution/YAWIK - Measure and Improve Code Quality continuously with Scrutinizer

Completed
Pull Request — develop (#521)

unknown
created 2018-11-22 04:24 UTC
Module::getRequiredFileLists() A

↳ Parent: Module
Complexity

Conditions	1
Paths	1
Size

Total Lines	4
Code Lines	2
Duplication

Lines	0
Ratio	0 %
Importance

Changes
Metric	Value
eloc	2
dl	0
loc	4
rs	10
c	0
b	0
f	0
cc	1
nc	1
nop	1
<?php
/**
 * YAWIK
 * Core Module Bootstrap
 *
 * @copyright (c) 2013 - 2016 Cross Solution (http://cross-solution.de)
 * @license   MIT
 * @author Carsten Bleek <[email protected]>
 * @author Mathias Gelhausen <[email protected]>
 * @author Miroslav Fedeleš <[email protected]>
 */

/** Core */
namespace Core;

use Core\Listener\AjaxRouteListener;
use Core\Options\ModuleOptions;
use Yawik\Composer\RequireDirectoryPermissionInterface;
use Yawik\Composer\RequireFilePermissionInterface;
use Zend\ModuleManager\Feature\ConsoleUsageProviderInterface;
use Zend\ModuleManager\ModuleEvent;
use Zend\ModuleManager\ModuleManager;
use Zend\Mvc\MvcEvent;
use Core\Listener\LanguageRouteListener;
use Core\Listener\AjaxRenderListener;
use Core\Listener\XmlRenderListener;
use Core\Listener\EnforceJsonResponseListener;
use Core\Listener\StringListener;
use Zend\ModuleManager\Feature\ConsoleBannerProviderInterface;
use Zend\Console\Adapter\AdapterInterface as Console;
use Core\Listener\ErrorHandlerListener;
use Core\Listener\NotificationAjaxHandler;
use Core\Listener\Events\NotificationEvent;
use Doctrine\ODM\MongoDB\Types\Type as DoctrineType;
use Zend\Stdlib\ArrayUtils;

/**
 * Bootstrap class of the Core module
 */
class Module implements
    ConsoleBannerProviderInterface,
    ConsoleUsageProviderInterface,
    RequireFilePermissionInterface,
    RequireDirectoryPermissionInterface
{
    const VERSION = '0.32-dev';

    /**
     * @param ModuleOptions $options
     * @inheritdoc
     * @return array
     */
    public function getRequiredFileLists(ModuleOptions $options)
    {
        return [
            $options->getLogDir().'/yawik.log'
        ];
    }

    /**
     * @param ModuleOptions $options
     * @return array
     */
    public function getRequiredDirectoryLists(ModuleOptions $options)
    {
        return [
            $options->getConfigDir().'/autoload',
            $options->getCacheDir(),
            $options->getLogDir(),
            $options->getLogDir().'/tracy'
        ];
    }


    public function getConsoleBanner(Console $console)
    {
        $name = Application::getCompleteVersion();
        $width = $console->getWidth();
        return sprintf(
            "==%1\$s==\n%2\$s%3\$s\n**%1\$s**\n",
            str_repeat('-', $width - 4),
            str_repeat(' ', floor(($width - strlen($name)) / 2)),
            str_repeat(' ', /** @scrutinizer ignore-type */ floor(($width - strlen($name)) / 2)),
            $name
        );
    }

    public function getConsoleUsage(Console $console)
    {
        $info = [
            'purge [--no-check] [--options=] <entity> [<id>]'  => 'Purge entities',
            'This command will load entities to be purged, checks the dependency of each and removes all entities completely from the',
            'database. However, called with no <entity> and options it will output a list of all available entity loaders and its options.',
            '',
            ['--no-check', 'Skip the dependency check and remove all entities and dependencies straight away.'],
            ['--options=STRING', 'JSON string represents options for the specific entity loader used.'],
            "",
            // assets-install info
            'assets-install [--symlink] [--relative] <target>' => 'Install assets in the given target',
            'The assets-install command will install assets in the given <target> directory. If no option given this command will copy assets into the target.',
            ['--symlink','This option will install assets using absolute symlink directory'],
            ['--relative','This option will install assets using relative symlink'],
            ""
        ];

        if ($this->isInMainDevelopment()) {
            $info = ArrayUtils::merge($info, [
                // subsplit command info
                'subsplit [--heads] [--tags] [--skip-update] [--dry-run] [--verbose|v]' => 'Subsplit development repository',
                'The subsplit command will automatically subsplit all changes in the develop into github yawik/* repository'.PHP_EOL
                .'This command will available only in the Yawik main development repository',
                ['--heads','If defined then will subsplit that branch.'],
                ['--tags','Subsplit given tags only'],
                ['--skip-update','Directly subsplit repository without pull remote branch'],
                ['--dry-run','Only show the list of git command that will be executed.'],
                ['--verbose | -v', 'Show debug output.'],
            ]);
        }
        return $info;
    }

    /**
     * Sets up services on the bootstrap event.
     *
     * @internal
     *     Creates the translation service and a ModuleRouteListener
     *
     * @param MvcEvent $e
     * @throws \Doctrine\ODM\MongoDB\Mapping\MappingException
     */
    public function onBootstrap(MvcEvent $e)
    {
        // Register the TimezoneAwareDate type with DoctrineMongoODM
        // Use it in Annotations ( @Field(type="tz_date") )
        if (!DoctrineType::hasType('tz_date')) {
            DoctrineType::addType(
                'tz_date',
                '\Core\Repository\DoctrineMongoODM\Types\TimezoneAwareDate'
            );
        }
        
        $sm = $e->getApplication()->getServiceManager();
        $translator = $sm->get('translator'); // initialize translator!
        \Zend\Validator\AbstractValidator::setDefaultTranslator($translator);
        $eventManager        = $e->getApplication()->getEventManager();
        $sharedManager       = $eventManager->getSharedManager();

        if (!\Zend\Console\Console::isConsole()) {
            (new ErrorHandlerListener())->attach($eventManager);

            /* @var \Core\Options\ModuleOptions $options */
            $languageRouteListener = new LanguageRouteListener(
                $sm->get('Core/Locale'),
                $sm->get('Core/Options')
            );
            $languageRouteListener->attach($eventManager);
        
            $ajaxRenderListener = new AjaxRenderListener();
            $ajaxRenderListener->attach($eventManager);

            $ajaxRouteListener = $sm->get(AjaxRouteListener::class);
            $ajaxRouteListener->attach($eventManager);

            $xmlRenderListener = new XmlRenderListener();
            $xmlRenderListener->attach($eventManager);
        
            $enforceJsonResponseListener = new EnforceJsonResponseListener();
            $enforceJsonResponseListener->attach($eventManager);
        
            $stringListener = new StringListener();
            $stringListener->attach($eventManager);
        }

        $notificationListener = $sm->get('Core/Listener/Notification');
        $notificationListener->attachShared($sharedManager);
        $notificationAjaxHandler = new NotificationAjaxHandler();
        $eventManager->attach(MvcEvent::EVENT_DISPATCH, array($notificationAjaxHandler, 'injectView'), -20);
        $notificationListener->attach(NotificationEvent::EVENT_NOTIFICATION_HTML, array($notificationAjaxHandler, 'render'), -20);
        

        $eventManager->attach(
            MvcEvent::EVENT_DISPATCH_ERROR,
            function ($event) {
                if ($event instanceof MvcEvent) {
                    $application = $event->getApplication();
                    
                    if ($application::ERROR_EXCEPTION == $event->getError()) {

                        $ex = $event->getParam('exception');
                        if (404 == $ex->getCode()) {
                            $event->setError($application::ERROR_CONTROLLER_NOT_FOUND);

                        }
                    }
                }
            },
            500
        );
        $eventManager->attach(
            MvcEvent::EVENT_DISPATCH,
            function ($event) use ($eventManager) {
                $eventManager->trigger('postDispatch', $event);
            },
            -150
        );

        $sm->get('Tracy')->startDebug();
    }

    /**
     * Loads module specific configuration.
     *
     * @return array
     */
    public function getConfig()
    {
        $config = include __DIR__ . '/../config/module.config.php';
        return $config;
    }

    /**
     * @param ModuleManager $manager
     */
    public function init(ModuleManager $manager)
    {
        $events = $manager->getEventManager();
        $events->attach(ModuleEvent::EVENT_MERGE_CONFIG, [$this,'onMergeConfig']);
    }

    /**
     * Manipulate configuration
     * @param ModuleEvent $event
     */
    public function onMergeConfig(ModuleEvent $event)
    {
        $listener = $event->getConfigListener();
        $config = $listener->getMergedConfig(false);

        // disable subsplit command if we not in main development
        if (
            isset($config['console'])
            && !$this->isInMainDevelopment()
            && isset($config['console']['router']['routes']['subsplit'])
        ) {
            unset($config['console']['router']['routes']['subsplit']);
        }

        $listener->setMergedConfig($config);
    }

    /**
     * Returns true if this module in the main development mode
     * @return bool
     */
    private function isInMainDevelopment()
    {
        return strpos(__DIR__, 'module/Core') !== false;
    }
}

cross-solution / YAWIK

Pull Request — develop (#521)

Module::getRequiredFileLists() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like
