nkostadinov / yii2-taxonomy

components/terms/CategoryTerm.php

<?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;

$data was never initialized. Although not strictly required by PHP, it is generally a good practice to add $data = array(); before regardless.

            $data['object_id'] = $object_id;

The variable $data does not seem to be defined for all execution paths leading up to this point.

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

The property table does not exist on object<nkostadinov\taxonomy\components\terms\CategoryTerm>. Since you implemented __get, maybe consider adding a @property annotation.

                Yii::$app->db->transaction(function() use ($data, $term, &$result) {

The variable $data does not seem to be defined for all execution paths leading up to this point.

This code seems to be duplicated across your project.

                    CategoryTerm::getDb()->createCommand()->insert($this->table, $data)->execute();

The property table does not exist on object<nkostadinov\taxonomy\components\terms\CategoryTerm>. Since you implemented __get, maybe consider adding a @property annotation.

                    $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;

$data was never initialized. Although not strictly required by PHP, it is generally a good practice to add $data = array(); before regardless.

            $data['object_id'] = $object_id;

The variable $data does not seem to be defined for all execution paths leading up to this point.

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

The property table does not exist on object<nkostadinov\taxonomy\components\terms\CategoryTerm>. Since you implemented __get, maybe consider adding a @property annotation.

                Yii::$app->db->transaction(function() use ($data, $term, &$result) {

The variable $data does not seem to be defined for all execution paths leading up to this point.

This code seems to be duplicated across your project.

                    $this->getDb()->createCommand()->delete($this->table, $data)->execute();

The property table does not exist on object<nkostadinov\taxonomy\components\terms\CategoryTerm>. Since you implemented __get, maybe consider adding a @property annotation.

                    $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!');

The class yii\base\InvalidParamException has been deprecated with message: since 2.0.14. Use [[InvalidArgumentException]] instead.

        }

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

The class yii\base\InvalidParamException has been deprecated with message: since 2.0.14. Use [[InvalidArgumentException]] instead.

        }

        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!');

The class yii\base\InvalidParamException has been deprecated with message: since 2.0.14. Use [[InvalidArgumentException]] instead.

                }

                $term = $this->getTaxonomyTerm($child);
                $term->parent_id = $parent;
                $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)) {
            return null;
        }

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

The expression \nkostadinov\taxonomy\models\TaxonomyTerms::findOne(array('id' => $childTerm->parent_id)); of type yii\db\ActiveRecordInterface|array|null adds the type array to the return on line 162 which is incompatible with the return type documented by nkostadinov\taxonomy\components\terms\CategoryTerm::getParent of type nkostadinov\taxonomy\models\TaxonomyTerms|null.

    }

    /**
     * @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());
    }
}