MatthewMi11er/wordpress-plugin-mi11er-utility

View on GitHub
includes/mi11er-utility/class-ap-style.php

Summary

Maintainability
A
35 mins
Test Coverage

Function _format_time has a Cognitive Complexity of 7 (exceeds 5 allowed). Consider refactoring.
Open

    protected function _format_time( $the_time ) {

        $time_parts = explode( '|', $the_time );

        // Reformat to noon and midnight.
Severity: Minor
Found in includes/mi11er-utility/class-ap-style.php - About 35 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 '$date_parts' which will lead to PHP notices.
Open

            return $date_parts[1] . ' ' . $meridian;

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 '$date_parts' which will lead to PHP notices.
Open

        if ( '00' === $date_parts[2] ) {

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 _format_time uses an else expression. Else clauses are basically not necessary and you can simplify the code by not using them.
Open

        } else {
            $meridian = 'p.m.';
        }

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

The parameter $the_time is not named in camelCase.
Open

    protected function _format_time( $the_time ) {

        $time_parts = explode( '|', $the_time );

        // Reformat to noon and midnight.

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 $the_date is not named in camelCase.
Open

    public function get_the_date_filter( $the_date, $d = '', $post = null ) {

        if ( self::AP_STYLE !== $d ) {
            return $the_date;
        }

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 $the_date is not named in camelCase.
Open

    function get_the_modified_date_filter( $the_date, $d = '' ) {

        if ( self::AP_STYLE !== $d ) {
            return $the_date;
        }

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 $the_time is not named in camelCase.
Open

    public function get_the_time_filter( $the_time, $d = '', $post = null ) {

        if ( self::AP_STYLE !== $d ) {
            return $the_time;
        }

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 $the_time is not named in camelCase.
Open

    function get_the_modified_time_filter( $the_time, $d = '' ) {

        if ( self::AP_STYLE !== $d ) {
            return $the_time;
        }

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 $d. Configured minimum length is 3.
Open

    function get_the_modified_time_filter( $the_time, $d = '' ) {

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 class Ap_Style is not named in CamelCase.
Open

class Ap_Style implements Plugin_Interface
{

    /**
     * Format Strings

CamelCaseClassName

Since: 0.2

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

Example

class class_name {
}

Source

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

    protected function _year_string( $y ) {

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

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

    public function get_the_time_filter( $the_time, $d = '', $post = null ) {

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

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

    function get_the_modified_date_filter( $the_date, $d = '' ) {

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 parameter $the_value is not named in camelCase.
Open

    protected function _capitalization( $the_value ) {

        if ( ( ( 'noon' === $the_value || 'midnight' === $the_value ) && self::CAPITALIZE_NOON ) || ( 'today' === $the_value && self::CAPITALIZE_TODAY ) ) {
            return ucfirst( $the_value );
        }

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 $m. Configured minimum length is 3.
Open

    protected function _month_string( $m ) {

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

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

    public function get_the_date_filter( $the_date, $d = '', $post = null ) {

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 parameter $the_date is not named in camelCase.
Open

    protected function _format_date( $the_date ) {

        $date_parts = explode( '|', $the_date );

        $month = $this->_month_string( $date_parts[1] );

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 method get_the_time_filter is not named in camelCase.
Open

    public function get_the_time_filter( $the_time, $d = '', $post = null ) {

        if ( self::AP_STYLE !== $d ) {
            return $the_time;
        }

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 get_the_date_filter is not named in camelCase.
Open

    public function get_the_date_filter( $the_date, $d = '', $post = null ) {

        if ( self::AP_STYLE !== $d ) {
            return $the_date;
        }

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 _capitalization is not named in camelCase.
Open

    protected function _capitalization( $the_value ) {

        if ( ( ( 'noon' === $the_value || 'midnight' === $the_value ) && self::CAPITALIZE_NOON ) || ( 'today' === $the_value && self::CAPITALIZE_TODAY ) ) {
            return ucfirst( $the_value );
        }

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 _format_date is not named in camelCase.
Open

    protected function _format_date( $the_date ) {

        $date_parts = explode( '|', $the_date );

        $month = $this->_month_string( $date_parts[1] );

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 get_the_modified_date_filter is not named in camelCase.
Open

    function get_the_modified_date_filter( $the_date, $d = '' ) {

        if ( self::AP_STYLE !== $d ) {
            return $the_date;
        }

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 _month_string is not named in camelCase.
Open

    protected function _month_string( $m ) {
        $ap_months = [
            '01' => 'Jan.',
            '02' => 'Feb.',
            '03' => 'March',

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 get_the_modified_time_filter is not named in camelCase.
Open

    function get_the_modified_time_filter( $the_time, $d = '' ) {

        if ( self::AP_STYLE !== $d ) {
            return $the_time;
        }

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 _year_string is not named in camelCase.
Open

    protected function _year_string( $y ) {

        if ( date( 'Y' ) !== $y || self::USE_YEAR ) {
            return $y;
        }

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 _format_time is not named in camelCase.
Open

    protected function _format_time( $the_time ) {

        $time_parts = explode( '|', $the_time );

        // Reformat to noon and midnight.

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