TonisOrmisson / yii2-myabstract

src/MyAssignModel.php

<?php
namespace andmemasin\myabstract;

use Yii;

/**
 * This is a base class for models that bind/assign child models to
 * parent models. Typically named as ParentHasChild pattern
 * @property bool $isAlreadyAssigned whether there is already a model with this parent-child relation
 */
class MyAssignModel extends MyActiveRecord
{

    /* @var $parentIdColumnName string Column name containing parent id FK */

The doc comment $parentIdColumnName at position 0 could not be parsed: Unknown type name '$parentIdColumnName' at position 0 in $parentIdColumnName.

    public $parentIdColumnName;

    /* @var $childIdColumnName string Column name containing child id FK */

The doc comment $childIdColumnName at position 0 could not be parsed: Unknown type name '$childIdColumnName' at position 0 in $childIdColumnName.

    public $childIdColumnName;

    public function rules()
    {
        return array_merge(parent::rules(), [
            [[$this->parentIdColumnName, $this->childIdColumnName], 'required'],
            [$this->childIdColumnName, function($attribute) {
                if ($this->isAlreadyAssigned) {
                    $this->addError($attribute, Yii::t('app', "Can only be used once!"));
                }
            }],
        ]);
    }

    /**
     * @param MyActiveRecord $parent
     * @param MyActiveRecord $child
     * @return void
     */
    public function assign($parent, $child)
    {
        $this->{$this->parentIdColumnName} = $parent->primaryKey;
        $this->{$this->childIdColumnName} = $child->primaryKey;
        return null;
    }

    /**
     * @return bool
     */
    public function getIsAlreadyAssigned() {
        if ($this->isNewRecord) {
            $model = static::find()
                ->andWhere([$this->parentIdColumnName => $this->{$this->parentIdColumnName}])
                ->andWhere([$this->childIdColumnName => $this->{$this->childIdColumnName}])
                ->all();
            return !empty($model);
        }
        return false;
    }

}