Sign upLogin

vistart/yii2-models

View on GitHub
Star
traits/UserRelationTrait.php

Summary

Maintainability
B
5 hrs
Test Coverage

File UserRelationTrait.php has 275 lines of code (exceeds 250 allowed). Consider refactoring.
Open

<?php

/**
 *  _   __ __ _____ _____ ___  ____  _____
 * | | / // // ___//_  _//   ||  __||_   _|
Severity: Minor
Found in traits/UserRelationTrait.php - About 2 hrs to fix

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

        protected static function buildRelation($user, $other)
    {
        $relationQuery = static::find()->initiators($user)->recipients($other);
        $noInit = $relationQuery->noInitModel;
        $relation = $relationQuery->one();
    Severity: Minor
    Found in traits/UserRelationTrait.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

    Similar blocks of code found in 2 locations. Consider refactoring.
    Open

        public function onInsertRelation($event)
    {
        $sender = $event->sender;
        if ($sender->relationType == static::$relationMutual) {
            $opposite = static::buildOppositeRelation($sender);
    Severity: Major
    Found in traits/UserRelationTrait.php and 1 other location - About 1 hr to fix
    traits/UserRelationTrait.php on lines 502..513

    Duplicated Code

    Duplicated code can lead to software that is hard to understand and difficult to change. The Don't Repeat Yourself (DRY) principle states:

    Every piece of knowledge must have a single, unambiguous, authoritative representation within a system.

    When you violate DRY, bugs and maintenance problems are sure to follow. Duplicated code has a tendency to both continue to replicate and also to diverge (leaving bugs as two similar implementations differ in subtle ways).

    Tuning

    This issue has a mass of 105.

    We set useful threshold defaults for the languages we support but you may want to adjust these settings based on your project guidelines.

    The threshold configuration represents the minimum mass a code block must have to be analyzed for duplication. The lower the threshold, the more fine-grained the comparison.

    If the engine is too easily reporting duplication, try raising the threshold. If you suspect that the engine isn't catching enough duplication, try lowering the threshold. The best setting tends to differ from language to language.

    See codeclimate-duplication's documentation for more information about tuning the mass threshold in your .codeclimate.yml.

    Refactorings

    Further Reading

    Similar blocks of code found in 2 locations. Consider refactoring.
    Open

        public function onUpdateRelation($event)
    {
        $sender = $event->sender;
        if ($sender->relationType == static::$relationMutual) {
            $opposite = static::buildOppositeRelation($sender);
    Severity: Major
    Found in traits/UserRelationTrait.php and 1 other location - About 1 hr to fix
    traits/UserRelationTrait.php on lines 483..494

    Duplicated Code

    Duplicated code can lead to software that is hard to understand and difficult to change. The Don't Repeat Yourself (DRY) principle states:

    Every piece of knowledge must have a single, unambiguous, authoritative representation within a system.

    When you violate DRY, bugs and maintenance problems are sure to follow. Duplicated code has a tendency to both continue to replicate and also to diverge (leaving bugs as two similar implementations differ in subtle ways).

    Tuning

    This issue has a mass of 105.

    We set useful threshold defaults for the languages we support but you may want to adjust these settings based on your project guidelines.

    The threshold configuration represents the minimum mass a code block must have to be analyzed for duplication. The lower the threshold, the more fine-grained the comparison.

    If the engine is too easily reporting duplication, try raising the threshold. If you suspect that the engine isn't catching enough duplication, try lowering the threshold. The best setting tends to differ from language to language.

    See codeclimate-duplication's documentation for more information about tuning the mass threshold in your .codeclimate.yml.

    Refactorings

    Further Reading

    The 'getIsFavorite()' method which returns a boolean should be named 'is...()' or 'has...()'
    Open

        public function getIsFavorite()
    {
        $favoriteAttribute = $this->favoriteAttribute;
        return is_string($favoriteAttribute) ? (int) $this->$favoriteAttribute > 0 : null;
    }
    Severity: Minor
    Found in traits/UserRelationTrait.php by phpmd

    BooleanGetMethodName

    Since: 0.2

    Looks for methods named 'getX()' with 'boolean' as the return type. The convention is to name these methods 'isX()' or 'hasX()'.

    Example

    class Foo {
    /**
     * @return boolean
     */
    public function getFoo() {} // bad
    /**
     * @return bool
     */
    public function isFoo(); // ok
    /**
     * @return boolean
     */
    public function getFoo($bar); // ok, unless checkParameterizedMethods=true
}

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

    Line exceeds 120 characters; contains 156 characters
    Open

                [[$this->otherGuidAttribute, $this->createdByAttribute], 'unique', 'targetAttribute' => [$this->otherGuidAttribute, $this->createdByAttribute]],
    Severity: Minor
    Found in traits/UserRelationTrait.php by phpcodesniffer

    Line exceeds 120 characters; contains 140 characters
    Open

            return array_merge($rules, $this->getRemarkRules(), $this->getFavoriteRules(), $this->getGroupsRules(), $this->getOtherGuidRules());
    Severity: Minor
    Found in traits/UserRelationTrait.php by phpcodesniffer

    Line exceeds 120 characters; contains 171 characters
    Open

                $inverse = (int) static::find()->recipients($initiator)->initiators($recipient)->andWhere([$model->mutualTypeAttribute => static::$mutualTypeNormal])->count();
    Severity: Minor
    Found in traits/UserRelationTrait.php by phpcodesniffer

    Line exceeds 120 characters; contains 125 characters
    Open

                $relation = new static([$createdByAttribute => $user, $otherGuidAttribute => $other, 'userClass' => $userClass]);
    Severity: Minor
    Found in traits/UserRelationTrait.php by phpcodesniffer

    Line exceeds 120 characters; contains 172 characters
    Open

                $relation = (int) static::find()->initiators($initiator)->recipients($recipient)->andWhere([$model->mutualTypeAttribute => static::$mutualTypeNormal])->count();
    Severity: Minor
    Found in traits/UserRelationTrait.php by phpcodesniffer

    Whitespace found at end of line
    Open

         * @var boolean
    Severity: Minor
    Found in traits/UserRelationTrait.php by phpcodesniffer

    Whitespace found at end of line
    Open

         * The status of mutual relation will be changed to normal if it is not.
    Severity: Minor
    Found in traits/UserRelationTrait.php by phpcodesniffer

    There are no issues that match your filters.

    Category
    Status