LangCollectorTask

Complexity

Total Complexity

17

Size/Duplication

Total Lines	125
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	9

Importance

Changes

0

5 Methods

Rating	Name	Duplication	Size	Complexity
A	init()	0	8	4
A	run()	0	14	2
B	runCollector()	0	26	6
A	writeMessage()	0	3	1
A	mergeWith()	0	11	4

<?php

/**
 * @author    Donatas Navidonskis <donatas@navidonskis.com>
 * @since     2017
 * @class     LangCollectorTask
 *
 */
class LangCollectorTask extends BuildTask {

PSR1 recommends that each class must be in a namespace of at least one level to avoid collisions.

    protected $title = "Lang Collector Task";

    protected $description = "Parameters:
- module: One or more modules to limit collection (comma-separated)
- merge: Merge new strings with existing ones already defined (default: FALSE)
- example: /dev/tasks/LangCollectorTask \"module=mysite,themes/default&merge=true\"
";

    /**
     * Merge the same created entities if task is running again
     *
     * @var bool
     */
    protected $merge = false;

    /**
     * Given modules from the user
     *
     * @var array
     */
    protected $module = [];

    /**
     * Text Collector instance to parse an entities
     *
     * @var i18nTextCollector
     */
    protected $textCollector;

    /**
     * Initialize within permissions
     *
     * @return SS_HTTPResponse
     */
    public function init() {
        parent::init();

It seems like you code against a specific sub-type and not the parent class BuildTask as the method init() does only exist in the following sub-classes of BuildTask: CleanImageManipulationCache, EncryptAllPasswordsTask, LangCollectorTask, RegenerateCachedImagesTask, i18nTextCollectorTask. Maybe you want to instanceof check for one of these explicitly?

        $canAccess = (Director::isDev() || Director::is_cli() || Permission::check("ADMIN"));
        if (! $canAccess) {
            return Security::permissionFailure($this);

$this is of type this<LangCollectorTask>, but the function expects a object<Controller>|null.

        }
    }

    public function run($request) {
        increase_time_limit_to();

        $this->writeMessage($this->description);

        try {
            $this->mergeWith($request->getVars());
        } catch (LangCollectorException $ex) {
            $this->writeMessage($ex->getMessage());
            exit;

The method run() contains an exit expression.

        }

        $this->runCollector();
    }

    /**
     * Run text collector
     *
     * @return void
     */
    protected function runCollector() {
        $this->textCollector = new i18nTextCollector();

        $modules = @$this->textCollector->collect($this->module, $this->merge);

        foreach ($modules as $moduleName => $entities) {
            if (count($entities) <= 0) {
                continue;
            }

            // find or create a new module
            $module = LangModule::findOrCreate($moduleName);
            $this->writeMessage("Collecting module {$module->Name}");

            foreach ($entities as $namespace => $options) {
                $value = $options[0];
                $title = isset($options[1]) ? $options[1] : '';

                $entity = $module->mergeOrAddEntity($namespace, $value, $title, $this->merge);

                if ($entity instanceof LangEntity) {
                    $this->writeMessage("{$namespace} - $value");
                }
            }
        }
    }

    /**
     * Write output message
     *
     * @param string $message
     *
     * @return void
     */
    protected function writeMessage($message) {
        Debug::message($message, false);
    }

    /**
     * Collect parameters from given options array and merge
     * it with class properties
     *
     * @param array $options
     *
     * @return void
     * @throws EmptyModuleException
     * @throws InvalidLocaleException
     */
    protected function mergeWith($options = []) {
        if (! array_key_exists('module', $options) || empty($options['module'])) {
            throw new EmptyModuleException("Please set one or more (comma-separated) module names");
        }

        $this->module = explode(',', $options['module']);

        if (array_key_exists('merge', $options)) {
            $this->merge = (bool) $options['merge'];
        }
    }
}