Sign upLogin

pluf/shop

View on GitHub
Star
src/Shop/OrderAttachment.php

Summary

Maintainability
A
2 hrs
Test Coverage

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

    function init()
    {
        $this->_a['table'] = 'shop_order_attachments';
        $this->_a['cols'] = array(
            // شناسه‌ها
Severity: Major
Found in src/Shop/OrderAttachment.php - About 2 hrs to fix

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

        function postSave($create = false)
    Severity: Minor
    Found in src/Shop/OrderAttachment.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

    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/OrderAttachment.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

    The method preSave uses an else expression. Else clauses are basically not necessary and you can simplify the code by not using them.
    Open

            } else {
            $this->file_size = 0;
        }
    Severity: Minor
    Found in src/Shop/OrderAttachment.php by phpmd

    ElseExpression

    Since: 1.4.0

    An if expression with an else branch is basically not necessary. You can rewrite the conditions in a way that the else clause is not necessary and the code becomes simpler to read. To achieve this, use early return statements, though you may need to split the code it several smaller methods. For very simple assignments you could also use the ternary operations.

    Example

    class Foo
{
    public function bar($flag)
    {
        if ($flag) {
            // one branch
        } else {
            // another branch
        }
    }
}

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

    Avoid using static access to class 'Pluf_FileUtil' in method 'preSave'.
    Open

                $fileInfo = Pluf_FileUtil::getMimeType($this->file_name);
    Severity: Minor
    Found in src/Shop/OrderAttachment.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 "verbose" 6 times.
    Open

                    'verbose' => 'first name',
    Severity: Critical
    Found in src/Shop/OrderAttachment.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 "blank" 7 times.
    Open

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

                    'editable' => false
    Severity: Critical
    Found in src/Shop/OrderAttachment.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 "default" 4 times.
    Open

                    'default' => 'auto created content',
    Severity: Critical
    Found in src/Shop/OrderAttachment.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 "Varchar" 4 times.
    Open

                    'type' => 'Varchar',
    Severity: Critical
    Found in src/Shop/OrderAttachment.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 "help_text" 6 times.
    Open

                    'help_text' => 'id',
    Severity: Critical
    Found in src/Shop/OrderAttachment.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/OrderAttachment.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

    Avoid unused parameters such as '$create'.
    Open

        function postSave($create = false)
    Severity: Minor
    Found in src/Shop/OrderAttachment.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_OrderAttachment extends Pluf_Model
    Severity: Minor
    Found in src/Shop/OrderAttachment.php by phpcodesniffer

    The class Shop_OrderAttachment is not named in CamelCase.
    Open

    class Shop_OrderAttachment extends Pluf_Model
{

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

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

    Visibility must be declared on method "preDelete"
    Open

        function preDelete()
    Severity: Minor
    Found in src/Shop/OrderAttachment.php by phpcodesniffer

    Visibility must be declared on method "init"
    Open

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

    Visibility must be declared on method "postSave"
    Open

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

    Line exceeds 120 characters; contains 128 characters
    Open

         * در این متد فایل مربوط به است حذف می شود. این عملیات قابل بازگشت نیست
    Severity: Minor
    Found in src/Shop/OrderAttachment.php by phpcodesniffer

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

    class Shop_OrderAttachment extends Pluf_Model
    Severity: Minor
    Found in src/Shop/OrderAttachment.php by phpcodesniffer

    Whitespace found at end of line
    Open

     *
    Severity: Minor
    Found in src/Shop/OrderAttachment.php by phpcodesniffer

    Expected 1 space after closing parenthesis; found 0
    Open

            if(!isset($mime_type) || $mime_type === 'application/octet-stream'){
    Severity: Minor
    Found in src/Shop/OrderAttachment.php by phpcodesniffer

    Expected 1 space after IF keyword; 0 found
    Open

            if(!isset($mime_type) || $mime_type === 'application/octet-stream'){
    Severity: Minor
    Found in src/Shop/OrderAttachment.php by phpcodesniffer

    Expected 1 newline at end of file; 0 found
    Open

    }
    Severity: Minor
    Found in src/Shop/OrderAttachment.php by phpcodesniffer

    The variable $mime_type is not named in camelCase.
    Open

        function preSave($create = false)
    {
        // File path
        $path = $this->getAbsloutPath();
        // file size
    Severity: Minor
    Found in src/Shop/OrderAttachment.php by phpmd

    CamelCaseVariableName

    Since: 0.2

    It is considered best practice to use the camelCase notation to name variables.

    Example

    class ClassName {
    public function doSomething() {
        $data_module = new DataModule();
    }
}

    Source

    The variable $mime_type is not named in camelCase.
    Open

        function preSave($create = false)
    {
        // File path
        $path = $this->getAbsloutPath();
        // file size
    Severity: Minor
    Found in src/Shop/OrderAttachment.php by phpmd

    CamelCaseVariableName

    Since: 0.2

    It is considered best practice to use the camelCase notation to name variables.

    Example

    class ClassName {
    public function doSomething() {
        $data_module = new DataModule();
    }
}

    Source

    The variable $mime_type is not named in camelCase.
    Open

        function preSave($create = false)
    {
        // File path
        $path = $this->getAbsloutPath();
        // file size
    Severity: Minor
    Found in src/Shop/OrderAttachment.php by phpmd

    CamelCaseVariableName

    Since: 0.2

    It is considered best practice to use the camelCase notation to name variables.

    Example

    class ClassName {
    public function doSomething() {
        $data_module = new DataModule();
    }
}

    Source

    There are no issues that match your filters.

    Category
    Status