CategoryTerm::getChildren() - Code Metrics - Inspection of "Merge pull request #9 from traykovn/master" - nkostadinov/yii2-taxonomy - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 73d5a6...9b6902 )

by Nikola

created 2016-11-29 18:26 UTC

CategoryTerm::getChildren() A

↳ Parent: CategoryTerm

Complexity

Conditions	1
Paths	1

Size

Total Lines	4
Code Lines	2

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
c	0
b	0
f	0
dl	0
loc	4
rs	10
cc	1
eloc	2
nc	1
nop	1

<?php

namespace nkostadinov\taxonomy\components\terms;

use nkostadinov\taxonomy\models\TaxonomyDef;
use nkostadinov\taxonomy\models\TaxonomyTerms;
use Yii;
use yii\base\InvalidParamException;
use yii\db\Query;
use yii\helpers\ArrayHelper;
use yii\web\NotFoundHttpException;

class CategoryTerm extends HierarchicalTerm
{
    public $templateFile = '@nkostadinov/taxonomy/migrations/template/category.php';

    /**
     * Assigns terms to an object.
     *
     * @param integer $object_id
     * @param integer|array $params The ID/IDs of the term/terms that need to be assigned. Can be integer or array of integers.
     * @return An array with the currently assigned TaxonomyTerms.
     */
    public function addTerm($object_id, $params)
    {
        $result = [];

        foreach (TaxonomyTerms::findAll((array) $params) as $term) {
            $data['term_id'] = $term->id;
foreach ($collection as $item) {
    $myArray['foo'] = $item->getFoo();

    if ($item->hasBar()) {
        $myArray['bar'] = $item->getBar();
    }

    // do something with $myArray
}
            $data['object_id'] = $object_id;
function myFunction($a) {
    switch ($a) {
        case 'foo':
            $x = 1;
            break;

        case 'bar':
            $x = 2;
            break;
    }

    // $x is potentially undefined here.
    echo $x;
}

            if (!(new Query())->from($this->table)->where($data)->exists(CategoryTerm::getDb())) {
<?php

/**
 * @property int $x
 * @property int $y
 * @property string $text
 */
class MyLabel
{
    private $properties;

    private $allowedProperties = array('x', 'y', 'text');

    public function __get($name)
    {
        if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) {
            return $properties[$name];
        } else {
            return null;
        }
    }

    public function __set($name, $value)
    {
        if (in_array($name, $this->allowedProperties)) {
            $properties[$name] = $value;
        } else {
            throw new \LogicException("Property $name is not defined.");
        }
    }

}
                Yii::$app->db->transaction(function() use ($data, $term, &$result) {
function myFunction($a) {
    switch ($a) {
        case 'foo':
            $x = 1;
            break;

        case 'bar':
            $x = 2;
            break;
    }

    // $x is potentially undefined here.
    echo $x;
}
                    CategoryTerm::getDb()->createCommand()->insert($this->table, $data)->execute();
<?php

/**
 * @property int $x
 * @property int $y
 * @property string $text
 */
class MyLabel
{
    private $properties;

    private $allowedProperties = array('x', 'y', 'text');

    public function __get($name)
    {
        if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) {
            return $properties[$name];
        } else {
            return null;
        }
    }

    public function __set($name, $value)
    {
        if (in_array($name, $this->allowedProperties)) {
            $properties[$name] = $value;
        } else {
            throw new \LogicException("Property $name is not defined.");
        }
    }

}

                    $term->updateCounters(['total_count' => 1]);
                    TaxonomyDef::updateAllCounters(['total_count' => 1], ['id' => $this->id]);

                    $result[] = $term;
                });
            }
        }

        return $result;
    }

    /**
     * Removes terms from an object.
     *
     * @param integer $object_id The id of the object.
     * @param array|integer $params An array of term IDs or term ID.
     * @return An array with the TaxonomyTerms objects that were removed.
     */
    public function removeTerm($object_id, $params = [])
    {
        $result = [];
        
        foreach(TaxonomyTerms::findAll((array) $params) as $term) {
            $data['term_id'] = $term->id;
foreach ($collection as $item) {
    $myArray['foo'] = $item->getFoo();

    if ($item->hasBar()) {
        $myArray['bar'] = $item->getBar();
    }

    // do something with $myArray
}
            $data['object_id'] = $object_id;
function myFunction($a) {
    switch ($a) {
        case 'foo':
            $x = 1;
            break;

        case 'bar':
            $x = 2;
            break;
    }

    // $x is potentially undefined here.
    echo $x;
}

            $query = new Query();
            if ($query->from($this->table)->where($data)->exists($this->getDb())) {
<?php

/**
 * @property int $x
 * @property int $y
 * @property string $text
 */
class MyLabel
{
    private $properties;

    private $allowedProperties = array('x', 'y', 'text');

    public function __get($name)
    {
        if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) {
            return $properties[$name];
        } else {
            return null;
        }
    }

    public function __set($name, $value)
    {
        if (in_array($name, $this->allowedProperties)) {
            $properties[$name] = $value;
        } else {
            throw new \LogicException("Property $name is not defined.");
        }
    }

}
                Yii::$app->db->transaction(function() use ($data, $term, &$result) {
function myFunction($a) {
    switch ($a) {
        case 'foo':
            $x = 1;
            break;

        case 'bar':
            $x = 2;
            break;
    }

    // $x is potentially undefined here.
    echo $x;
}
                    $this->getDb()->createCommand()->delete($this->table, $data)->execute();
<?php

/**
 * @property int $x
 * @property int $y
 * @property string $text
 */
class MyLabel
{
    private $properties;

    private $allowedProperties = array('x', 'y', 'text');

    public function __get($name)
    {
        if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) {
            return $properties[$name];
        } else {
            return null;
        }
    }

    public function __set($name, $value)
    {
        if (in_array($name, $this->allowedProperties)) {
            $properties[$name] = $value;
        } else {
            throw new \LogicException("Property $name is not defined.");
        }
    }

}

                    $term->updateCounters(['total_count' => -1]);
                    Taxonomydef::updateAllCounters(['total_count' => -1], ['id' => $this->id]);

                    $result[] = $term;
                });
            }
        }

        return $result;
    }

    /**
     * Overwrites the existing terms of the object, but only with the children of the given parents.
     *
     * $params is an array in the form [$parent_id => [$children], $parent_id2 => [$children2]].
     * The children of those parents will replace the existing terms where the given object is assigned.
     *
     * @param integer $object_id The object id whose terms are changed.
     * @param array $params The replacement
     * @return An array with the TaxonomyTerms set
     */
    public function setTerms($object_id, $params = [])
    {
        $result = [];

        foreach (TaxonomyTerms::findAll(array_keys($params)) as $parent) {
            $parentsChildren = $this->getChildren($parent->id);
            $this->removeTerm($object_id, ArrayHelper::getColumn($parentsChildren, 'id'));
            $result = array_merge($result, $this->addTerm($object_id, $params[$parent->id]));
        }

        return $result;
    }

    /**
     * Creates a new category with the following specifics:
     *  - If $parent is string - creates a root category without any children.
     *  - If parent is integer (meaning an id of a term) and:
     *     - $children is string - creates new category and assigns it to that parent;
     *     - $children is array of strings - creates new categories and assigns them to that parent;
     *
     * @param string|integer $parent
     * @param string|array $children
     * @return TaxonomyTerms|array Returns the objects created
     * @throws InvalidParamException If a parameter of a wrong type is given
     * @throws NotFoundHttpException If a parent with a given id is not found
     */
    public function createCategory($parent, $children = [])
    {
        if (is_string($parent)) {
            return $this->getTaxonomyTerm($parent);
        }

        if (!is_int($parent)) {
            throw new InvalidParamException('$parent must be integer!');
        }

        if (!is_string($children) && !is_array($children)) {
            throw new InvalidParamException('$children must be of type string or array!');
        }

        if (!TaxonomyTerms::find()->where(['id' => $parent])->exists()) {
            throw new NotFoundHttpException("Parent with id '$id' does not exist!");
        }

        $children = (array) $children;
        $result = [];
        foreach ($children as $child) {
            Yii::$app->db->transaction(function() use ($parent, $child, &$result) {
                if (!is_string($child)) {
                    throw new InvalidParamException('$children must contain only string values!');
                }

                $term = $this->getTaxonomyTerm($child);
                $term->parent_id = $parent;
<?php

/**
 * @property int $x
 * @property int $y
 * @property string $text
 */
class MyLabel
{
    private $properties;

    private $allowedProperties = array('x', 'y', 'text');

    public function __get($name)
    {
        if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) {
            return $properties[$name];
        } else {
            return null;
        }
    }

    public function __set($name, $value)
    {
        if (in_array($name, $this->allowedProperties)) {
            $properties[$name] = $value;
        } else {
            throw new \LogicException("Property $name is not defined.");
        }
    }

}
                $term->save(false);

                $result[] = $term;
            });
        }

        return $result;
    }

    /**
     * @param integer $termId
     * @return TaxonomyTerms
     */
    public function getParent($termId)
    {
        $childTerm = TaxonomyTerms::findOne($termId);
        if (!$childTerm || is_null($childTerm->parent_id)) {
<?php

/**
 * @property int $x
 * @property int $y
 * @property string $text
 */
class MyLabel
{
    private $properties;

    private $allowedProperties = array('x', 'y', 'text');

    public function __get($name)
    {
        if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) {
            return $properties[$name];
        } else {
            return null;
        }
    }

    public function __set($name, $value)
    {
        if (in_array($name, $this->allowedProperties)) {
            $properties[$name] = $value;
        } else {
            throw new \LogicException("Property $name is not defined.");
        }
    }

}
            return null;
        }

        return TaxonomyTerms::findOne(['id' => $childTerm->parent_id]);
<?php

/**
 * @property int $x
 * @property int $y
 * @property string $text
 */
class MyLabel
{
    private $properties;

    private $allowedProperties = array('x', 'y', 'text');

    public function __get($name)
    {
        if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) {
            return $properties[$name];
        } else {
            return null;
        }
    }

    public function __set($name, $value)
    {
        if (in_array($name, $this->allowedProperties)) {
            $properties[$name] = $value;
        } else {
            throw new \LogicException("Property $name is not defined.");
        }
    }

}
    }

    /**
     * @param integer $termId
     * @return boolean
     */
    public function hasParent($termId)
    {
        return $this->getParent($termId) != null;
    }

    /**
     * @param integer $termId
     * @return array An array of TaxonomyTerms
     */
    public function getChildren($termId)
    {
        return TaxonomyTerms::findAll(['parent_id' => $termId]);
    }

    /**
     * @param integer $termId
     * @return boolean
     */
    public function hasChildren($termId)
    {
        return TaxonomyTerms::find()
            ->where("parent_id = $termId")
            ->exists(self::getDb());
    }
}


Push — master ( 73d5a6...9b6902 )

CategoryTerm::getChildren() A

Complexity

Size

Duplication

Importance

Available Fixes

Available Fixes

Available Fixes

Available Fixes

1		<?php
2
3		namespace nkostadinov\taxonomy\components\terms;
4
5		use nkostadinov\taxonomy\models\TaxonomyDef;
6		use nkostadinov\taxonomy\models\TaxonomyTerms;
7		use Yii;
8		use yii\base\InvalidParamException;
9		use yii\db\Query;
10		use yii\helpers\ArrayHelper;
11		use yii\web\NotFoundHttpException;
12
13		class CategoryTerm extends HierarchicalTerm
14		{
15		public $templateFile = '@nkostadinov/taxonomy/migrations/template/category.php';
16
17		/**
18		* Assigns terms to an object.
19		*
20		* @param integer $object_id
21		* @param integer\|array $params The ID/IDs of the term/terms that need to be assigned. Can be integer or array of integers.
22		* @return An array with the currently assigned TaxonomyTerms.
23		*/
24		public function addTerm($object_id, $params)
25		{
26		$result = [];
27
28		foreach (TaxonomyTerms::findAll((array) $params) as $term) {
29		$data['term_id'] = $term->id;
		0 ignored issues – show Coding Style Comprehensibility introduced 2016-10-21 11:13 UTC by Report Bug Copy Issue Report `$data` was never initialized. Although not strictly required by PHP, it is generally a good practice to add `$data = array();` before regardless. Adding an explicit array definition is generally preferable to implicit array definition as it guarantees a stable state of the code. Let’s take a look at an example: foreach ($collection as $item) { $myArray['foo'] = $item->getFoo(); if ($item->hasBar()) { $myArray['bar'] = $item->getBar(); } // do something with $myArray } As you can see in this example, the array `$myArray` is initialized the first time when the foreach loop is entered. You can also see that the value of the `bar` key is only written conditionally; thus, its value might result from a previous iteration. This might or might not be intended. To make your intention clear, your code more readible and to avoid accidental bugs, we recommend to add an explicit initialization `$myArray = array()` either outside or inside the foreach loop. Loading history...
30		$data['object_id'] = $object_id;
		0 ignored issues – show Bug introduced 2016-11-29 18:42 UTC by Report Bug Copy Issue Report The variable `$data` does not seem to be defined for all execution paths leading up to this point. If you define a variable conditionally, it can happen that it is not defined for all execution paths. Let’s take a look at an example: function myFunction($a) { switch ($a) { case 'foo': $x = 1; break; case 'bar': $x = 2; break; } // $x is potentially undefined here. echo $x; } In the above example, the variable `$x` is defined if you pass “foo” or “bar” as argument for `$a`. However, since the `switch` statement has no default case statement, if you pass any other value, the variable `$x` would be undefined. Available Fixes Check for existence of the variable explicitly: function myFunction($a) { switch ($a) { case 'foo': $x = 1; break; case 'bar': $x = 2; break; } if (isset($x)) { // Make sure it's always set. echo $x; } } Define a default value for the variable: function myFunction($a) { $x = ''; // Set a default which gets overridden for certain paths. switch ($a) { case 'foo': $x = 1; break; case 'bar': $x = 2; break; } echo $x; } Add a value for the missing path: function myFunction($a) { switch ($a) { case 'foo': $x = 1; break; case 'bar': $x = 2; break; // We add support for the missing case. default: $x = ''; break; } echo $x; } Loading history...
31
32		if (!(new Query())->from($this->table)->where($data)->exists(CategoryTerm::getDb())) {
		0 ignored issues – show Documentation introduced 2016-10-21 11:13 UTC by Report Bug Copy Issue Report The property `table` does not exist on `object<nkostadinov\taxon...nts\terms\CategoryTerm>`. Since you implemented `__get`, maybe consider adding a @property annotation. Since your code implements the magic getter `_get`, this function will be called for any read access on an undefined variable. You can add the `@property` annotation to your class or interface to document the existence of this variable. <?php /** * @property int $x * @property int $y * @property string $text */ class MyLabel { private $properties; private $allowedProperties = array('x', 'y', 'text'); public function __get($name) { if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) { return $properties[$name]; } else { return null; } } public function __set($name, $value) { if (in_array($name, $this->allowedProperties)) { $properties[$name] = $value; } else { throw new \LogicException("Property $name is not defined."); } } } If the property has read access only, you can use the @property-read annotation instead. Of course, you may also just have mistyped another name, in which case you should fix the error. See also the PhpDoc documentation for @property. Loading history...
33	View Code Duplication	Yii::$app->db->transaction(function() use ($data, $term, &$result) {
		0 ignored issues – show Bug introduced 2016-11-29 18:42 UTC by Report Bug Copy Issue Report The variable `$data` does not seem to be defined for all execution paths leading up to this point. If you define a variable conditionally, it can happen that it is not defined for all execution paths. Let’s take a look at an example: function myFunction($a) { switch ($a) { case 'foo': $x = 1; break; case 'bar': $x = 2; break; } // $x is potentially undefined here. echo $x; } In the above example, the variable `$x` is defined if you pass “foo” or “bar” as argument for `$a`. However, since the `switch` statement has no default case statement, if you pass any other value, the variable `$x` would be undefined. Available Fixes Check for existence of the variable explicitly: function myFunction($a) { switch ($a) { case 'foo': $x = 1; break; case 'bar': $x = 2; break; } if (isset($x)) { // Make sure it's always set. echo $x; } } Define a default value for the variable: function myFunction($a) { $x = ''; // Set a default which gets overridden for certain paths. switch ($a) { case 'foo': $x = 1; break; case 'bar': $x = 2; break; } echo $x; } Add a value for the missing path: function myFunction($a) { switch ($a) { case 'foo': $x = 1; break; case 'bar': $x = 2; break; // We add support for the missing case. default: $x = ''; break; } echo $x; } Loading history... Duplication introduced 2016-11-29 18:42 UTC by Report Bug Copy Issue Report This code seems to be duplicated across your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
34		CategoryTerm::getDb()->createCommand()->insert($this->table, $data)->execute();
		0 ignored issues – show Documentation introduced 2016-10-21 11:13 UTC by Report Bug Copy Issue Report The property `table` does not exist on `object<nkostadinov\taxon...nts\terms\CategoryTerm>`. Since you implemented `__get`, maybe consider adding a @property annotation. Since your code implements the magic getter `_get`, this function will be called for any read access on an undefined variable. You can add the `@property` annotation to your class or interface to document the existence of this variable. <?php /** * @property int $x * @property int $y * @property string $text */ class MyLabel { private $properties; private $allowedProperties = array('x', 'y', 'text'); public function __get($name) { if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) { return $properties[$name]; } else { return null; } } public function __set($name, $value) { if (in_array($name, $this->allowedProperties)) { $properties[$name] = $value; } else { throw new \LogicException("Property $name is not defined."); } } } If the property has read access only, you can use the @property-read annotation instead. Of course, you may also just have mistyped another name, in which case you should fix the error. See also the PhpDoc documentation for @property. Loading history...
35

nkostadinov / yii2-taxonomy

Push — master ( 73d5a6...9b6902 )

CategoryTerm::getChildren() A

Complexity

Size

Duplication

Importance

Available Fixes

Available Fixes

Available Fixes

Available Fixes

Duplication Side-by-Side

Filter issues like