Sign upLogin

YetiForceCompany/YetiForceCRM

View on GitHub
Star
modules/OpenStreetMap/actions/GetRoute.php

Summary

Maintainability
A
1 hr
Test Coverage
F
0%

Method process has 26 lines of code (exceeds 25 allowed). Consider refactoring.
Open

    public function process(App\Request $request)
    {
        $response = new Vtiger_Response();
        try {
            $ilon = $request->getByType('ilon', 'float');
Severity: Minor
Found in modules/OpenStreetMap/actions/GetRoute.php - About 1 hr to fix

    Missing class import via use statement (line '23', column '14').
    Open

                throw new \App\Exceptions\NoPermitted('LBL_PERMISSION_DENIED', 406);
    Severity: Minor
    Found in modules/OpenStreetMap/actions/GetRoute.php by phpmd

    MissingImport

    Since: 2.7.0

    Importing all external classes in a file through use statements makes them clearly visible.

    Example

    function make() {
    return new \stdClass();
}

    Source http://phpmd.org/rules/cleancode.html#MissingImport

    Missing class import via use statement (line '38', column '19').
    Open

            $response = new Vtiger_Response();
    Severity: Minor
    Found in modules/OpenStreetMap/actions/GetRoute.php by phpmd

    MissingImport

    Since: 2.7.0

    Importing all external classes in a file through use statements makes them clearly visible.

    Example

    function make() {
    return new \stdClass();
}

    Source http://phpmd.org/rules/cleancode.html#MissingImport

    Avoid using static access to class '\App\Log' in method 'process'.
    Open

                \App\Log::error($th->getMessage(), __CLASS__);
    Severity: Minor
    Found in modules/OpenStreetMap/actions/GetRoute.php by phpmd

    StaticAccess

    Since: 1.4.0

    Static access causes unexchangeable dependencies to other classes and leads to hard to test code. Avoid using static access at all costs and instead inject dependencies through the constructor. The only case when static access is acceptable is when used for factory methods.

    Example

    class Foo
{
    public function bar()
    {
        Bar::baz();
    }
}

    Source https://phpmd.org/rules/cleancode.html#staticaccess

    Avoid using static access to class 'App\Purifier' in method 'process'.
    Open

                        'description' => App\Purifier::purifyHtml($routingConnector->getDescription()),
    Severity: Minor
    Found in modules/OpenStreetMap/actions/GetRoute.php by phpmd

    StaticAccess

    Since: 1.4.0

    Static access causes unexchangeable dependencies to other classes and leads to hard to test code. Avoid using static access at all costs and instead inject dependencies through the constructor. The only case when static access is acceptable is when used for factory methods.

    Example

    class Foo
{
    public function bar()
    {
        Bar::baz();
    }
}

    Source https://phpmd.org/rules/cleancode.html#staticaccess

    Avoid using static access to class 'Users_Privileges_Model' in method 'checkPermission'.
    Open

            $currentUserPrivilegesModel = Users_Privileges_Model::getCurrentUserPrivilegesModel();
    Severity: Minor
    Found in modules/OpenStreetMap/actions/GetRoute.php by phpmd

    StaticAccess

    Since: 1.4.0

    Static access causes unexchangeable dependencies to other classes and leads to hard to test code. Avoid using static access at all costs and instead inject dependencies through the constructor. The only case when static access is acceptable is when used for factory methods.

    Example

    class Foo
{
    public function bar()
    {
        Bar::baz();
    }
}

    Source https://phpmd.org/rules/cleancode.html#staticaccess

    Avoid using static access to class '\App\Map\Routing' in method 'process'.
    Open

                $routingConnector = \App\Map\Routing::getInstance();
    Severity: Minor
    Found in modules/OpenStreetMap/actions/GetRoute.php by phpmd

    StaticAccess

    Since: 1.4.0

    Static access causes unexchangeable dependencies to other classes and leads to hard to test code. Avoid using static access at all costs and instead inject dependencies through the constructor. The only case when static access is acceptable is when used for factory methods.

    Example

    class Foo
{
    public function bar()
    {
        Bar::baz();
    }
}

    Source https://phpmd.org/rules/cleancode.html#staticaccess

    Define a constant instead of duplicating this literal "float" 6 times.
    Open

                $ilon = $request->getByType('ilon', 'float');
    Severity: Critical
    Found in modules/OpenStreetMap/actions/GetRoute.php by sonar-php

    Duplicated string literals make the process of refactoring error-prone, since you must be sure to update all occurrences.

    On the other hand, constants can be referenced from many places, but only need to be updated in a single place.

    Noncompliant Code Example

    With the default threshold of 3:

    function run() {
  prepare('action1');                              // Non-Compliant - 'action1' is duplicated 3 times
  execute('action1');
  release('action1');
}

    Compliant Solution

    ACTION_1 = 'action1';

function run() {
  prepare(ACTION_1);
  execute(ACTION_1);
  release(ACTION_1);
}

    Exceptions

    To prevent generating some false-positives, literals having less than 5 characters are excluded.

    Argument 1 (mixed) is string but \Users_Privileges_Model::hasModulePermission() takes int defined at /code/modules/Users/models/Privileges.php:101
    Open

            if (!$currentUserPrivilegesModel->hasModulePermission($request->getModule())) {
    Severity: Minor
    Found in modules/OpenStreetMap/actions/GetRoute.php by phan

    Call to method error from undeclared class \App\Log
    Open

                \App\Log::error($th->getMessage(), __CLASS__);
    Severity: Critical
    Found in modules/OpenStreetMap/actions/GetRoute.php by phan

    Avoid excessively long variable names like $currentUserPrivilegesModel. Keep variable name length under 20.
    Open

            $currentUserPrivilegesModel = Users_Privileges_Model::getCurrentUserPrivilegesModel();
    Severity: Minor
    Found in modules/OpenStreetMap/actions/GetRoute.php by phpmd

    LongVariable

    Since: 0.2

    Detects when a field, formal or local variable is declared with a long name.

    Example

    class Something {
    protected $reallyLongIntName = -3; // VIOLATION - Field
    public static function main( array $interestingArgumentsList[] ) { // VIOLATION - Formal
        $otherReallyLongName = -5; // VIOLATION - Local
        for ($interestingIntIndex = 0; // VIOLATION - For
             $interestingIntIndex < 10;
             $interestingIntIndex++ ) {
        }
    }
}

    Source https://phpmd.org/rules/naming.html#longvariable

    Each class must be in a namespace of at least one level (a top-level vendor name)
    Open

    class OpenStreetMap_GetRoute_Action extends Vtiger_BasicAjax_Action
    Severity: Minor
    Found in modules/OpenStreetMap/actions/GetRoute.php by phpcodesniffer

    The class OpenStreetMap_GetRoute_Action is not named in CamelCase.
    Open

    class OpenStreetMap_GetRoute_Action extends Vtiger_BasicAjax_Action
{
    /**
     * Function to check permission.
     *
    Severity: Minor
    Found in modules/OpenStreetMap/actions/GetRoute.php by phpmd

    CamelCaseClassName

    Since: 0.2

    It is considered best practice to use the CamelCase notation to name classes.

    Example

    class class_name {
}

    Source

    Spaces must be used to indent lines; tabs are not allowed
    Open

            } catch (\Throwable $th) {
    Severity: Minor
    Found in modules/OpenStreetMap/actions/GetRoute.php by phpcodesniffer

    Spaces must be used to indent lines; tabs are not allowed
    Open

            if (!$currentUserPrivilegesModel->hasModulePermission($request->getModule())) {
    Severity: Minor
    Found in modules/OpenStreetMap/actions/GetRoute.php by phpcodesniffer

    Spaces must be used to indent lines; tabs are not allowed
    Open

                    }
    Severity: Minor
    Found in modules/OpenStreetMap/actions/GetRoute.php by phpcodesniffer

    Spaces must be used to indent lines; tabs are not allowed
    Open

                        'traveltime' => $routingConnector->getTravelTime(),
    Severity: Minor
    Found in modules/OpenStreetMap/actions/GetRoute.php by phpcodesniffer

    Spaces must be used to indent lines; tabs are not allowed
    Open

                ]);
    Severity: Minor
    Found in modules/OpenStreetMap/actions/GetRoute.php by phpcodesniffer

    Spaces must be used to indent lines; tabs are not allowed
    Open

         *
    Severity: Minor
    Found in modules/OpenStreetMap/actions/GetRoute.php by phpcodesniffer

    Spaces must be used to indent lines; tabs are not allowed
    Open

         * @throws \App\Exceptions\AppException
    Severity: Minor
    Found in modules/OpenStreetMap/actions/GetRoute.php by phpcodesniffer

    Spaces must be used to indent lines; tabs are not allowed
    Open

            }
    Severity: Minor
    Found in modules/OpenStreetMap/actions/GetRoute.php by phpcodesniffer

    Spaces must be used to indent lines; tabs are not allowed
    Open

            $currentUserPrivilegesModel = Users_Privileges_Model::getCurrentUserPrivilegesModel();
    Severity: Minor
    Found in modules/OpenStreetMap/actions/GetRoute.php by phpcodesniffer

    Spaces must be used to indent lines; tabs are not allowed
    Open

                throw new \App\Exceptions\NoPermitted('LBL_PERMISSION_DENIED', 406);
    Severity: Minor
    Found in modules/OpenStreetMap/actions/GetRoute.php by phpcodesniffer

    Spaces must be used to indent lines; tabs are not allowed
    Open

            $response = new Vtiger_Response();
    Severity: Minor
    Found in modules/OpenStreetMap/actions/GetRoute.php by phpcodesniffer

    Spaces must be used to indent lines; tabs are not allowed
    Open

            try {
    Severity: Minor
    Found in modules/OpenStreetMap/actions/GetRoute.php by phpcodesniffer

    Spaces must be used to indent lines; tabs are not allowed
    Open

                $response->setResult([
    Severity: Minor
    Found in modules/OpenStreetMap/actions/GetRoute.php by phpcodesniffer

    Spaces must be used to indent lines; tabs are not allowed
    Open

         *
    Severity: Minor
    Found in modules/OpenStreetMap/actions/GetRoute.php by phpcodesniffer

    Spaces must be used to indent lines; tabs are not allowed
    Open

                $ilat = $request->getByType('ilat', 'float');
    Severity: Minor
    Found in modules/OpenStreetMap/actions/GetRoute.php by phpcodesniffer

    Spaces must be used to indent lines; tabs are not allowed
    Open

                    foreach ($ilon as $key => $lon) {
    Severity: Minor
    Found in modules/OpenStreetMap/actions/GetRoute.php by phpcodesniffer

    Spaces must be used to indent lines; tabs are not allowed
    Open

                $routingConnector->setEnd($request->getByType('tlat', 'float'), $request->getByType('tlon', 'float'));
    Severity: Minor
    Found in modules/OpenStreetMap/actions/GetRoute.php by phpcodesniffer

    Spaces must be used to indent lines; tabs are not allowed
    Open

                $routingConnector->calculate();
    Severity: Minor
    Found in modules/OpenStreetMap/actions/GetRoute.php by phpcodesniffer

    Spaces must be used to indent lines; tabs are not allowed
    Open

        /**
    Severity: Minor
    Found in modules/OpenStreetMap/actions/GetRoute.php by phpcodesniffer

    Spaces must be used to indent lines; tabs are not allowed
    Open

        {
    Severity: Minor
    Found in modules/OpenStreetMap/actions/GetRoute.php by phpcodesniffer

    Spaces must be used to indent lines; tabs are not allowed
    Open

        }
    Severity: Minor
    Found in modules/OpenStreetMap/actions/GetRoute.php by phpcodesniffer

    Spaces must be used to indent lines; tabs are not allowed
    Open

         * Main process.
    Severity: Minor
    Found in modules/OpenStreetMap/actions/GetRoute.php by phpcodesniffer

    Spaces must be used to indent lines; tabs are not allowed
    Open

         *
    Severity: Minor
    Found in modules/OpenStreetMap/actions/GetRoute.php by phpcodesniffer

    Spaces must be used to indent lines; tabs are not allowed
    Open

         *
    Severity: Minor
    Found in modules/OpenStreetMap/actions/GetRoute.php by phpcodesniffer

    Spaces must be used to indent lines; tabs are not allowed
    Open

         * @return bool|void
    Severity: Minor
    Found in modules/OpenStreetMap/actions/GetRoute.php by phpcodesniffer

    Spaces must be used to indent lines; tabs are not allowed
    Open

                $ilon = $request->getByType('ilon', 'float');
    Severity: Minor
    Found in modules/OpenStreetMap/actions/GetRoute.php by phpcodesniffer

    Spaces must be used to indent lines; tabs are not allowed
    Open

                if (!empty($ilon) && !empty($ilat)) {
    Severity: Minor
    Found in modules/OpenStreetMap/actions/GetRoute.php by phpcodesniffer

    Spaces must be used to indent lines; tabs are not allowed
    Open

         *
    Severity: Minor
    Found in modules/OpenStreetMap/actions/GetRoute.php by phpcodesniffer

    Spaces must be used to indent lines; tabs are not allowed
    Open

                $routingConnector->setStart($request->getByType('flat', 'float'), $request->getByType('flon', 'float'));
    Severity: Minor
    Found in modules/OpenStreetMap/actions/GetRoute.php by phpcodesniffer

    Spaces must be used to indent lines; tabs are not allowed
    Open

                    'properties' => [
    Severity: Minor
    Found in modules/OpenStreetMap/actions/GetRoute.php by phpcodesniffer

    Spaces must be used to indent lines; tabs are not allowed
    Open

                $response->setException($th);
    Severity: Minor
    Found in modules/OpenStreetMap/actions/GetRoute.php by phpcodesniffer

    Spaces must be used to indent lines; tabs are not allowed
    Open

            $response->emit();
    Severity: Minor
    Found in modules/OpenStreetMap/actions/GetRoute.php by phpcodesniffer

    Spaces must be used to indent lines; tabs are not allowed
    Open

         */
    Severity: Minor
    Found in modules/OpenStreetMap/actions/GetRoute.php by phpcodesniffer

    Spaces must be used to indent lines; tabs are not allowed
    Open

                        $routingConnector->addIndirectPoint($ilat[$key], $lon);
    Severity: Minor
    Found in modules/OpenStreetMap/actions/GetRoute.php by phpcodesniffer

    Spaces must be used to indent lines; tabs are not allowed
    Open

                }
    Severity: Minor
    Found in modules/OpenStreetMap/actions/GetRoute.php by phpcodesniffer

    Spaces must be used to indent lines; tabs are not allowed
    Open

                        'distance' => $routingConnector->getDistance(),
    Severity: Minor
    Found in modules/OpenStreetMap/actions/GetRoute.php by phpcodesniffer

    Spaces must be used to indent lines; tabs are not allowed
    Open

                    ],
    Severity: Minor
    Found in modules/OpenStreetMap/actions/GetRoute.php by phpcodesniffer

    Spaces must be used to indent lines; tabs are not allowed
    Open

            }
    Severity: Minor
    Found in modules/OpenStreetMap/actions/GetRoute.php by phpcodesniffer

    Spaces must be used to indent lines; tabs are not allowed
    Open

                $routingConnector = \App\Map\Routing::getInstance();
    Severity: Minor
    Found in modules/OpenStreetMap/actions/GetRoute.php by phpcodesniffer

    Spaces must be used to indent lines; tabs are not allowed
    Open

        }
    Severity: Minor
    Found in modules/OpenStreetMap/actions/GetRoute.php by phpcodesniffer

    Spaces must be used to indent lines; tabs are not allowed
    Open

        public function checkPermission(App\Request $request)
    Severity: Minor
    Found in modules/OpenStreetMap/actions/GetRoute.php by phpcodesniffer

    Spaces must be used to indent lines; tabs are not allowed
    Open

         * @param \App\Request $request
    Severity: Minor
    Found in modules/OpenStreetMap/actions/GetRoute.php by phpcodesniffer

    Spaces must be used to indent lines; tabs are not allowed
    Open

                \App\Log::error($th->getMessage(), __CLASS__);
    Severity: Minor
    Found in modules/OpenStreetMap/actions/GetRoute.php by phpcodesniffer

    Spaces must be used to indent lines; tabs are not allowed
    Open

         */
    Severity: Minor
    Found in modules/OpenStreetMap/actions/GetRoute.php by phpcodesniffer

    Spaces must be used to indent lines; tabs are not allowed
    Open

        /**
    Severity: Minor
    Found in modules/OpenStreetMap/actions/GetRoute.php by phpcodesniffer

    Spaces must be used to indent lines; tabs are not allowed
    Open

         * Function to check permission.
    Severity: Minor
    Found in modules/OpenStreetMap/actions/GetRoute.php by phpcodesniffer

    Spaces must be used to indent lines; tabs are not allowed
    Open

         * @param \App\Request $request
    Severity: Minor
    Found in modules/OpenStreetMap/actions/GetRoute.php by phpcodesniffer

    Spaces must be used to indent lines; tabs are not allowed
    Open

                    'geoJson' => $routingConnector->getGeoJson(),
    Severity: Minor
    Found in modules/OpenStreetMap/actions/GetRoute.php by phpcodesniffer

    Spaces must be used to indent lines; tabs are not allowed
    Open

                        'description' => App\Purifier::purifyHtml($routingConnector->getDescription()),
    Severity: Minor
    Found in modules/OpenStreetMap/actions/GetRoute.php by phpcodesniffer

    Spaces must be used to indent lines; tabs are not allowed
    Open

         * @throws \App\Exceptions\NoPermitted
    Severity: Minor
    Found in modules/OpenStreetMap/actions/GetRoute.php by phpcodesniffer

    Spaces must be used to indent lines; tabs are not allowed
    Open

        public function process(App\Request $request)
    Severity: Minor
    Found in modules/OpenStreetMap/actions/GetRoute.php by phpcodesniffer

    Spaces must be used to indent lines; tabs are not allowed
    Open

        {
    Severity: Minor
    Found in modules/OpenStreetMap/actions/GetRoute.php by phpcodesniffer

    Class name "OpenStreetMap_GetRoute_Action" is not in camel caps format
    Open

    class OpenStreetMap_GetRoute_Action extends Vtiger_BasicAjax_Action
    Severity: Minor
    Found in modules/OpenStreetMap/actions/GetRoute.php by phpcodesniffer

    There are no issues that match your filters.

    Category
    Status