Sign upLogin

pluf/shop

View on GitHub
Star
src/Shop/DetailedObject.php

Summary

Maintainability
A
1 hr
Test Coverage

Method init has 44 lines of code (exceeds 25 allowed). Consider refactoring.
Open

    function init()
    {
//         $this->_a['table'] = 'shop_detailedobject';
//         $this->_a['verbose'] = 'Shop_DetailedObject';
        $this->_a['cols'] = array(
Severity: Minor
Found in src/Shop/DetailedObject.php - About 1 hr to fix

    The method preSave has a boolean flag argument $create, which is a certain sign of a Single Responsibility Principle violation.
    Open

        function preSave($create = false)
    Severity: Minor
    Found in src/Shop/DetailedObject.php by phpmd

    BooleanArgumentFlag

    Since: 1.4.0

    A boolean flag argument is a reliable indicator for a violation of the Single Responsibility Principle (SRP). You can fix this problem by extracting the logic in the boolean flag into its own class or method.

    Example

    class Foo {
    public function bar($flag = true) {
    }
}

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

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

                    'readable' => true
    Severity: Critical
    Found in src/Shop/DetailedObject.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.

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

                    'editable' => false,
    Severity: Critical
    Found in src/Shop/DetailedObject.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.

    Remove this commented out code.
    Open

    //         $this->_a['table'] = 'shop_detailedobject';
    Severity: Major
    Found in src/Shop/DetailedObject.php by sonar-php

    Programmers should not comment out code as it bloats programs and reduces readability.

    Unused code should be deleted and can be retrieved from source control history if required.

    See

    • MISRA C:2004, 2.4 - Sections of code should not be "commented out".
    • MISRA C++:2008, 2-7-2 - Sections of code shall not be "commented out" using C-style comments.
    • MISRA C++:2008, 2-7-3 - Sections of code should not be "commented out" using C++ comments.
    • MISRA C:2012, Dir. 4.4 - Sections of code should not be "commented out"

    Define a constant instead of duplicating this literal "Varchar" 3 times.
    Open

                    'type' => 'Varchar',
    Severity: Critical
    Found in src/Shop/DetailedObject.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.

    Remove this commented out code.
    Open

    //         );
    Severity: Major
    Found in src/Shop/DetailedObject.php by sonar-php

    Programmers should not comment out code as it bloats programs and reduces readability.

    Unused code should be deleted and can be retrieved from source control history if required.

    See

    • MISRA C:2004, 2.4 - Sections of code should not be "commented out".
    • MISRA C++:2008, 2-7-2 - Sections of code shall not be "commented out" using C-style comments.
    • MISRA C++:2008, 2-7-3 - Sections of code should not be "commented out" using C++ comments.
    • MISRA C:2012, Dir. 4.4 - Sections of code should not be "commented out"

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

                    'blank' => false,
    Severity: Critical
    Found in src/Shop/DetailedObject.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.

    Define a constant instead of duplicating this literal "is_null" 3 times.
    Open

                    'is_null' => false,
    Severity: Critical
    Found in src/Shop/DetailedObject.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.

    Avoid unused parameters such as '$create'.
    Open

        function preSave($create = false)
    Severity: Minor
    Found in src/Shop/DetailedObject.php by phpmd

    UnusedFormalParameter

    Since: 0.2

    Avoid passing parameters to methods or constructors and then not using those parameters.

    Example

    class Foo
{
    private function bar($howdy)
    {
        // $howdy is not used
    }
}

    Source https://phpmd.org/rules/unusedcode.html#unusedformalparameter

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

    class Shop_DetailedObject extends Pluf_Model
    Severity: Minor
    Found in src/Shop/DetailedObject.php by phpcodesniffer

    The class Shop_DetailedObject is not named in CamelCase.
    Open

    class Shop_DetailedObject extends Pluf_Model
{

    /**
     * @brief مدل داده‌ای را بارگذاری می‌کند.
    Severity: Minor
    Found in src/Shop/DetailedObject.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

    Visibility must be declared on method "init"
    Open

        function init()
    Severity: Minor
    Found in src/Shop/DetailedObject.php by phpcodesniffer

    Visibility must be declared on method "preSave"
    Open

        function preSave($create = false)
    Severity: Minor
    Found in src/Shop/DetailedObject.php by phpcodesniffer

    Visibility must be declared on method "toString"
    Open

        function toString(){
    Severity: Minor
    Found in src/Shop/DetailedObject.php by phpcodesniffer

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

    class Shop_DetailedObject extends Pluf_Model
    Severity: Minor
    Found in src/Shop/DetailedObject.php by phpcodesniffer

    Opening brace should be on a new line
    Open

        function toString(){
    Severity: Minor
    Found in src/Shop/DetailedObject.php by phpcodesniffer

    There are no issues that match your filters.

    Category
    Status