mambax7/alumni-26x

View on GitHub
class/category.php

Summary

Maintainability
A
2 hrs
Test Coverage

Method getCategoriesForSearch has 30 lines of code (exceeds 25 allowed). Consider refactoring.
Open

    public function &getCategoriesForSearch()
    {
        global $theresult, $xoops, $alumni;
        $xoops    = Xoops::getInstance();
        $alumni   = Alumni::getInstance();
Severity: Minor
Found in class/category.php - About 1 hr to fix

    Function getCategoriesCount has a Cognitive Complexity of 9 (exceeds 5 allowed). Consider refactoring.
    Open

        public function getCategoriesCount($pid = 0)
        {
            $xoops = Xoops::getInstance();
            if ($pid == -1) {
                return $this->getCount();
    Severity: Minor
    Found in class/category.php - About 55 mins to fix

    Cognitive Complexity

    Cognitive Complexity is a measure of how difficult a unit of code is to intuitively understand. Unlike Cyclomatic Complexity, which determines how difficult your code will be to test, Cognitive Complexity tells you how difficult your code will be to read and comprehend.

    A method's cognitive complexity is based on a few simple rules:

    • Code is not considered more complex when it uses shorthand that the language provides for collapsing multiple statements into one
    • Code is considered more complex for each "break in the linear flow of the code"
    • Code is considered more complex when "flow breaking structures are nested"

    Further reading

    Avoid using static access to class 'Xoops' in method 'getCategoriesForSearch'.
    Open

            $xoops    = Xoops::getInstance();
    Severity: Minor
    Found in class/category.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 'Alumni' in method 'getCategoriesForSearch'.
    Open

            $alumni   = Alumni::getInstance();
    Severity: Minor
    Found in class/category.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 'Alumni' in method '__construct'.
    Open

            $this->alumni = Alumni::getInstance();
    Severity: Minor
    Found in class/category.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 'Xoops' in method 'getCategoriesCount'.
    Open

            $xoops = Xoops::getInstance();
    Severity: Minor
    Found in class/category.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 'Alumni' in method '__construct'.
    Open

            $this->alumni = Alumni::getInstance();
    Severity: Minor
    Found in class/category.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

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

                    } else {
                        return 0;
                    }
    Severity: Minor
    Found in class/category.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 'MyTextSanitizer' in method 'getPathFromId'.
    Open

            $myts = MyTextSanitizer::getInstance();
    Severity: Minor
    Found in class/category.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

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

    class AlumniCategoryHandler extends XoopsPersistableObjectHandler
    Severity: Minor
    Found in class/category.php by phpcodesniffer

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

    class AlumniCategory extends XoopsObject
    Severity: Minor
    Found in class/category.php by phpcodesniffer

    Avoid variables with short names like $id. Configured minimum length is 3.
    Open

        public function getPathFromId($id = null, $path = '')
    Severity: Minor
    Found in class/category.php by phpmd

    ShortVariable

    Since: 0.2

    Detects when a field, local, or parameter has a very short name.

    Example

    class Something {
        private $q = 15; // VIOLATION - Field
        public static function main( array $as ) { // VIOLATION - Formal
            $r = 20 + $this->q; // VIOLATION - Local
            for (int $i = 0; $i < 10; $i++) { // Not a Violation (inside FOR)
                $r += $this->q;
            }
        }
    }

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

    The property $_categoryPath is not named in camelCase.
    Open

    class AlumniCategory extends XoopsObject
    {
        public $alumni = null;
    
        /**
    Severity: Minor
    Found in class/category.php by phpmd

    CamelCasePropertyName

    Since: 0.2

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

    Example

    class ClassName {
        protected $property_name;
    }

    Source

    The parameter $by_cat is not named in camelCase.
    Open

        public function getSubCatArray($by_cat, $level, $cat_array, $cat_result)
        {
            global $theresult;
            $spaces = '';
            for ($j = 0; $j < $level; ++$j) {
    Severity: Minor
    Found in class/category.php by phpmd

    CamelCaseParameterName

    Since: 0.2

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

    Example

    class ClassName {
        public function doSomething($user_name) {
        }
    }

    Source

    The parameter $cat_array is not named in camelCase.
    Open

        public function getSubCatArray($by_cat, $level, $cat_array, $cat_result)
        {
            global $theresult;
            $spaces = '';
            for ($j = 0; $j < $level; ++$j) {
    Severity: Minor
    Found in class/category.php by phpmd

    CamelCaseParameterName

    Since: 0.2

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

    Example

    class ClassName {
        public function doSomething($user_name) {
        }
    }

    Source

    The parameter $cat_result is not named in camelCase.
    Open

        public function getSubCatArray($by_cat, $level, $cat_array, $cat_result)
        {
            global $theresult;
            $spaces = '';
            for ($j = 0; $j < $level; ++$j) {
    Severity: Minor
    Found in class/category.php by phpmd

    CamelCaseParameterName

    Since: 0.2

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

    Example

    class ClassName {
        public function doSomething($user_name) {
        }
    }

    Source

    Avoid variables with short names like $db. Configured minimum length is 3.
    Open

        public function __construct(Connection $db = null)
    Severity: Minor
    Found in class/category.php by phpmd

    ShortVariable

    Since: 0.2

    Detects when a field, local, or parameter has a very short name.

    Example

    class Something {
        private $q = 15; // VIOLATION - Field
        public static function main( array $as ) { // VIOLATION - Formal
            $r = 20 + $this->q; // VIOLATION - Local
            for (int $i = 0; $i < 10; $i++) { // Not a Violation (inside FOR)
                $r += $this->q;
            }
        }
    }

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

    Each class must be in a file by itself
    Open

    class AlumniCategoryHandler extends XoopsPersistableObjectHandler
    Severity: Minor
    Found in class/category.php by phpcodesniffer

    Property name "$_categoryPath" should not be prefixed with an underscore to indicate visibility
    Open

        public $_categoryPath = false;
    Severity: Minor
    Found in class/category.php by phpcodesniffer

    Method name "AlumniCategory::getGroups_view" is not in camel caps format
    Open

        public function getGroups_view()
    Severity: Minor
    Found in class/category.php by phpcodesniffer

    The variable $by_cat is not named in camelCase.
    Open

        public function getSubCatArray($by_cat, $level, $cat_array, $cat_result)
        {
            global $theresult;
            $spaces = '';
            for ($j = 0; $j < $level; ++$j) {
    Severity: Minor
    Found in class/category.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 $cat_array is not named in camelCase.
    Open

        public function getSubCatArray($by_cat, $level, $cat_array, $cat_result)
        {
            global $theresult;
            $spaces = '';
            for ($j = 0; $j < $level; ++$j) {
    Severity: Minor
    Found in class/category.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 $cat_array is not named in camelCase.
    Open

        public function getSubCatArray($by_cat, $level, $cat_array, $cat_result)
        {
            global $theresult;
            $spaces = '';
            for ($j = 0; $j < $level; ++$j) {
    Severity: Minor
    Found in class/category.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 $cat_array is not named in camelCase.
    Open

        public function &getCategoriesForSearch()
        {
            global $theresult, $xoops, $alumni;
            $xoops    = Xoops::getInstance();
            $alumni   = Alumni::getInstance();
    Severity: Minor
    Found in class/category.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 $cat_array is not named in camelCase.
    Open

        public function &getCategoriesForSearch()
        {
            global $theresult, $xoops, $alumni;
            $xoops    = Xoops::getInstance();
            $alumni   = Alumni::getInstance();
    Severity: Minor
    Found in class/category.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 $cat_array is not named in camelCase.
    Open

        public function &getCategoriesForSearch()
        {
            global $theresult, $xoops, $alumni;
            $xoops    = Xoops::getInstance();
            $alumni   = Alumni::getInstance();
    Severity: Minor
    Found in class/category.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 $by_cat is not named in camelCase.
    Open

        public function getSubCatArray($by_cat, $level, $cat_array, $cat_result)
        {
            global $theresult;
            $spaces = '';
            for ($j = 0; $j < $level; ++$j) {
    Severity: Minor
    Found in class/category.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 $cat_array is not named in camelCase.
    Open

        public function getSubCatArray($by_cat, $level, $cat_array, $cat_result)
        {
            global $theresult;
            $spaces = '';
            for ($j = 0; $j < $level; ++$j) {
    Severity: Minor
    Found in class/category.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 $cat_array is not named in camelCase.
    Open

        public function &getCategoriesForSearch()
        {
            global $theresult, $xoops, $alumni;
            $xoops    = Xoops::getInstance();
            $alumni   = Alumni::getInstance();
    Severity: Minor
    Found in class/category.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 $by_cat is not named in camelCase.
    Open

        public function getSubCatArray($by_cat, $level, $cat_array, $cat_result)
        {
            global $theresult;
            $spaces = '';
            for ($j = 0; $j < $level; ++$j) {
    Severity: Minor
    Found in class/category.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 $by_cat is not named in camelCase.
    Open

        public function getSubCatArray($by_cat, $level, $cat_array, $cat_result)
        {
            global $theresult;
            $spaces = '';
            for ($j = 0; $j < $level; ++$j) {
    Severity: Minor
    Found in class/category.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 $cat_array is not named in camelCase.
    Open

        public function &getCategoriesForSearch()
        {
            global $theresult, $xoops, $alumni;
            $xoops    = Xoops::getInstance();
            $alumni   = Alumni::getInstance();
    Severity: Minor
    Found in class/category.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 $cat_result is not named in camelCase.
    Open

        public function &getCategoriesForSearch()
        {
            global $theresult, $xoops, $alumni;
            $xoops    = Xoops::getInstance();
            $alumni   = Alumni::getInstance();
    Severity: Minor
    Found in class/category.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 $cat_result is not named in camelCase.
    Open

        public function &getCategoriesForSearch()
        {
            global $theresult, $xoops, $alumni;
            $xoops    = Xoops::getInstance();
            $alumni   = Alumni::getInstance();
    Severity: Minor
    Found in class/category.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 $cat_result is not named in camelCase.
    Open

        public function getSubCatArray($by_cat, $level, $cat_array, $cat_result)
        {
            global $theresult;
            $spaces = '';
            for ($j = 0; $j < $level; ++$j) {
    Severity: Minor
    Found in class/category.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 method getGroups_view is not named in camelCase.
    Open

        public function getGroups_view()
        {
            return $this->alumni->getPermissionHandler()->getGrantedGroupsById('alumni_view', $this->getVar('cid'));
        }
    Severity: Minor
    Found in class/category.php by phpmd

    CamelCaseMethodName

    Since: 0.2

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

    Example

    class ClassName {
        public function get_name() {
        }
    }

    Source

    There are no issues that match your filters.

    Category
    Status