Sign upLogin

qcubed/framework

View on GitHub
Star
includes/base_controls/QControlProxy.class.php

Summary

Maintainability
A
1 hr
Test Coverage

The class QControlProxy has 11 public methods. Consider refactoring QControlProxy to keep number of public methods under 10.
Open

    class QControlProxy extends QControl {
        /**
         * @var string HTML element ID which is to be rendered/sent to the browser
         * @deprecated This is not needed by newer implementation which uses HTML5 data tags.
         */
Severity: Minor
Found in includes/base_controls/QControlProxy.class.php by phpmd

TooManyPublicMethods

Since: 0.1

A class with too many public methods is probably a good suspect for refactoring, in order to reduce its complexity and find a way to have more fine grained objects.

By default it ignores methods starting with 'get' or 'set'.

Example

Source https://phpmd.org/rules/codesize.html#toomanypublicmethods

Function RenderAsEvents has a Cognitive Complexity of 8 (exceeds 5 allowed). Consider refactoring.
Open

        public function RenderAsEvents($strActionParameter = null, $blnDisplayOutput = true, $strTargetControlId = null, $blnRenderControlId = true) {
            $this->RenderAttributes();
            if ($strTargetControlId)
                $this->strTargetControlId = $strTargetControlId;
            else
Severity: Minor
Found in includes/base_controls/QControlProxy.class.php - About 45 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

Method RenderAsLink has 5 arguments (exceeds 4 allowed). Consider refactoring.
Open

        public function RenderAsLink($strLabel, $strActionParameter = null, $attributes = [], $strTag = 'a', $blnHtmlEntities = true) {
Severity: Minor
Found in includes/base_controls/QControlProxy.class.php - About 35 mins to fix

    Function RenderAsHref has a Cognitive Complexity of 6 (exceeds 5 allowed). Consider refactoring.
    Open

            public function RenderAsHref($strActionParameter = null, $blnDisplayOutput = true, $strTargetControlId = null) {
            if ($strTargetControlId)
                $this->strTargetControlId = $strTargetControlId;
            else
                $this->strTargetControlId = $this->objForm->GenerateControlId();
    Severity: Minor
    Found in includes/base_controls/QControlProxy.class.php - About 25 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 undefined variables such as '$attributes' which will lead to PHP notices.
    Open

                return QHtml::RenderHtmlAttributes($attributes);
    Severity: Minor
    Found in includes/base_controls/QControlProxy.class.php by phpmd

    UndefinedVariable

    Since: 2.8.0

    Detects when a variable is used that has not been defined before.

    Example

    class Foo
{
    private function bar()
    {
        // $message is undefined
        echo $message;
    }
}

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

    Avoid using undefined variables such as '$defaults' which will lead to PHP notices.
    Open

                    $defaults['data-qap'] = $strActionParameter;
    Severity: Minor
    Found in includes/base_controls/QControlProxy.class.php by phpmd

    UndefinedVariable

    Since: 2.8.0

    Detects when a variable is used that has not been defined before.

    Example

    class Foo
{
    private function bar()
    {
        // $message is undefined
        echo $message;
    }
}

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

    Avoid using undefined variables such as '$defaults' which will lead to PHP notices.
    Open

                $defaults['onclick']='return false';
    Severity: Minor
    Found in includes/base_controls/QControlProxy.class.php by phpmd

    UndefinedVariable

    Since: 2.8.0

    Detects when a variable is used that has not been defined before.

    Example

    class Foo
{
    private function bar()
    {
        // $message is undefined
        echo $message;
    }
}

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

    Avoid using undefined variables such as '$attributes' which will lead to PHP notices.
    Open

                    $attributes['data-qap'] = $strActionParameter;
    Severity: Minor
    Found in includes/base_controls/QControlProxy.class.php by phpmd

    UndefinedVariable

    Since: 2.8.0

    Detects when a variable is used that has not been defined before.

    Example

    class Foo
{
    private function bar()
    {
        // $message is undefined
        echo $message;
    }
}

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

    Avoid using undefined variables such as '$defaults' which will lead to PHP notices.
    Open

                $attributes = array_merge($defaults, $attributes); // will only apply defaults that are not in attributes
    Severity: Minor
    Found in includes/base_controls/QControlProxy.class.php by phpmd

    UndefinedVariable

    Since: 2.8.0

    Detects when a variable is used that has not been defined before.

    Example

    class Foo
{
    private function bar()
    {
        // $message is undefined
        echo $message;
    }
}

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

    Avoid using undefined variables such as '$attributes' which will lead to PHP notices.
    Open

                $attributes['data-qpxy'] = $this->ControlId;
    Severity: Minor
    Found in includes/base_controls/QControlProxy.class.php by phpmd

    UndefinedVariable

    Since: 2.8.0

    Detects when a variable is used that has not been defined before.

    Example

    class Foo
{
    private function bar()
    {
        // $message is undefined
        echo $message;
    }
}

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

    Avoid using undefined variables such as '$defaults' which will lead to PHP notices.
    Open

                $attributes = array_merge($defaults, $attributes); // will only apply defaults that are not in attributes
    Severity: Minor
    Found in includes/base_controls/QControlProxy.class.php by phpmd

    UndefinedVariable

    Since: 2.8.0

    Detects when a variable is used that has not been defined before.

    Example

    class Foo
{
    private function bar()
    {
        // $message is undefined
        echo $message;
    }
}

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

    Avoid using undefined variables such as '$defaults' which will lead to PHP notices.
    Open

                $defaults['href'] = 'javascript:;';
    Severity: Minor
    Found in includes/base_controls/QControlProxy.class.php by phpmd

    UndefinedVariable

    Since: 2.8.0

    Detects when a variable is used that has not been defined before.

    Example

    class Foo
{
    private function bar()
    {
        // $message is undefined
        echo $message;
    }
}

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

    Avoid using undefined variables such as '$defaults' which will lead to PHP notices.
    Open

                $defaults['type']='button';
    Severity: Minor
    Found in includes/base_controls/QControlProxy.class.php by phpmd

    UndefinedVariable

    Since: 2.8.0

    Detects when a variable is used that has not been defined before.

    Example

    class Foo
{
    private function bar()
    {
        // $message is undefined
        echo $message;
    }
}

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

    Avoid using undefined variables such as '$defaults' which will lead to PHP notices.
    Open

                $defaults['data-qpxy'] = $this->strControlId;
    Severity: Minor
    Found in includes/base_controls/QControlProxy.class.php by phpmd

    UndefinedVariable

    Since: 2.8.0

    Detects when a variable is used that has not been defined before.

    Example

    class Foo
{
    private function bar()
    {
        // $message is undefined
        echo $message;
    }
}

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

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

            public function RenderAsEvents($strActionParameter = null, $blnDisplayOutput = true, $strTargetControlId = null, $blnRenderControlId = true) {
    Severity: Minor
    Found in includes/base_controls/QControlProxy.class.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 RenderAsButton has a boolean flag argument $blnHtmlEntities, which is a certain sign of a Single Responsibility Principle violation.
    Open

            public function RenderAsButton($strLabel, $strActionParameter = null, $attributes = [], $blnHtmlEntities = true) {
    Severity: Minor
    Found in includes/base_controls/QControlProxy.class.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 RenderAsLink has a boolean flag argument $blnHtmlEntities, which is a certain sign of a Single Responsibility Principle violation.
    Open

            public function RenderAsLink($strLabel, $strActionParameter = null, $attributes = [], $strTag = 'a', $blnHtmlEntities = true) {
    Severity: Minor
    Found in includes/base_controls/QControlProxy.class.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

    Missing class import via use statement (line '34', column '36').
    Open

                $this->mixActionParameter = new QJsClosure('return $j(this).data("qap")');
    Severity: Minor
    Found in includes/base_controls/QControlProxy.class.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 '41', column '14').
    Open

                throw new QCallerException('QControlProxies cannot be rendered.  Use RenderAsEvents() within an HTML tag.');
    Severity: Minor
    Found in includes/base_controls/QControlProxy.class.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

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

            public function RenderAsHref($strActionParameter = null, $blnDisplayOutput = true, $strTargetControlId = null) {
    Severity: Minor
    Found in includes/base_controls/QControlProxy.class.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 RenderAsEvents has a boolean flag argument $blnDisplayOutput, which is a certain sign of a Single Responsibility Principle violation.
    Open

            public function RenderAsEvents($strActionParameter = null, $blnDisplayOutput = true, $strTargetControlId = null, $blnRenderControlId = true) {
    Severity: Minor
    Found in includes/base_controls/QControlProxy.class.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

    Avoid using static access to class 'QHtml' in method 'RenderAttributes'.
    Open

                return QHtml::RenderHtmlAttributes($attributes);
    Severity: Minor
    Found in includes/base_controls/QControlProxy.class.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 'QHtml' in method 'RenderAsLink'.
    Open

                return QHtml::RenderTag($strTag, $attributes, $strLabel);
    Severity: Minor
    Found in includes/base_controls/QControlProxy.class.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 'QType' in method '__set'.
    Open

                            return ($this->strTargetControlId = QType::Cast($mixValue, QType::String));
    Severity: Minor
    Found in includes/base_controls/QControlProxy.class.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 'QApplication' in method 'RenderAsLink'.
    Open

                    $strLabel = QApplication::HtmlEntities($strLabel);
    Severity: Minor
    Found in includes/base_controls/QControlProxy.class.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 'QApplication' in method 'RenderAsEvents'.
    Open

                QApplication::ExecuteJavaScript($strToReturn);
    Severity: Minor
    Found in includes/base_controls/QControlProxy.class.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 excessively long variable names like $blnActionsMustTerminate. Keep variable name length under 20.
    Open

            protected $blnActionsMustTerminate = true;
    Severity: Minor
    Found in includes/base_controls/QControlProxy.class.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

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

            protected $strPreferredRenderMethod = null;
    Severity: Minor
    Found in includes/base_controls/QControlProxy.class.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

    The method RenderAsScript is not named in camelCase.
    Open

            public function RenderAsScript($strEventType='QClickEvent') {
            $objActions     = $this->GetAllActions($strEventType);
            $strToReturn     = '';
            foreach ($objActions as $objAction) {
                $strToReturn .= $objAction->RenderScript($this);
    Severity: Minor
    Found in includes/base_controls/QControlProxy.class.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

    The method RenderAttributes is not named in camelCase.
    Open

            public function RenderAttributes($strActionParameter = null) {
            $attributes['data-qpxy'] = $this->ControlId;
            if ($strActionParameter) {
                $attributes['data-qap'] = $strActionParameter;
            }
    Severity: Minor
    Found in includes/base_controls/QControlProxy.class.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

    The method RenderAsButton is not named in camelCase.
    Open

            public function RenderAsButton($strLabel, $strActionParameter = null, $attributes = [], $blnHtmlEntities = true) {
            $defaults['onclick']='return false';
            $defaults['type']='button';
            $attributes = array_merge($defaults, $attributes); // will only apply defaults that are not in attributes
            return $this->RenderAsLink($strLabel, $strActionParameter, $attributes, 'button', $blnHtmlEntities);
    Severity: Minor
    Found in includes/base_controls/QControlProxy.class.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

    The method RenderAsEvents is not named in camelCase.
    Open

            public function RenderAsEvents($strActionParameter = null, $blnDisplayOutput = true, $strTargetControlId = null, $blnRenderControlId = true) {
            $this->RenderAttributes();
            if ($strTargetControlId)
                $this->strTargetControlId = $strTargetControlId;
            else
    Severity: Minor
    Found in includes/base_controls/QControlProxy.class.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

    The method RenderAsHref is not named in camelCase.
    Open

            public function RenderAsHref($strActionParameter = null, $blnDisplayOutput = true, $strTargetControlId = null) {
            if ($strTargetControlId)
                $this->strTargetControlId = $strTargetControlId;
            else
                $this->strTargetControlId = $this->objForm->GenerateControlId();
    Severity: Minor
    Found in includes/base_controls/QControlProxy.class.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

    The method GetControlHtml is not named in camelCase.
    Open

            public function GetControlHtml() {
            throw new QCallerException('QControlProxies cannot be rendered.  Use RenderAsEvents() within an HTML tag.');
        }
    Severity: Minor
    Found in includes/base_controls/QControlProxy.class.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

    The method RenderAsLink is not named in camelCase.
    Open

            public function RenderAsLink($strLabel, $strActionParameter = null, $attributes = [], $strTag = 'a', $blnHtmlEntities = true) {
            if (!$attributes) {
                $attributes = [];
            }
            if (!$strTag) {
    Severity: Minor
    Found in includes/base_controls/QControlProxy.class.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

    The method ParsePostData is not named in camelCase.
    Open

            public function ParsePostData() {}
    Severity: Minor
    Found in includes/base_controls/QControlProxy.class.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

    The method Validate is not named in camelCase.
    Open

            public function Validate() {return true;}
    Severity: Minor
    Found in includes/base_controls/QControlProxy.class.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