accounts/common/behaviors/PrimaryKeyValueBehavior.php

68 lines
1.9 KiB
PHP

<?php
namespace common\behaviors;
use yii\base\Behavior;
use yii\base\InvalidConfigException;
use yii\db\ActiveRecord;
/**
* @property ActiveRecord $owner
*/
class PrimaryKeyValueBehavior extends Behavior {
/**
* @var callable The function that will be called to generate the key.
* Must return a random value suitable for model logic.
* The function will be called in the do-while loop to avoid duplicate strings by the primary key,
* so if the function returns a static value, the program will loop forever and something will die.
* Don't do so.
*/
public $value;
public function events(): array {
return [
ActiveRecord::EVENT_BEFORE_INSERT => 'setPrimaryKeyValue',
];
}
public function setPrimaryKeyValue(): bool {
if ($this->owner->getPrimaryKey() === null) {
$this->refreshPrimaryKeyValue();
}
return true;
}
public function refreshPrimaryKeyValue(): void {
do {
$key = $this->generateValue();
} while ($this->isValueExists($key));
$this->owner->{$this->getPrimaryKeyName()} = $key;
}
protected function generateValue(): string {
return (string)call_user_func($this->value);
}
protected function isValueExists(string $key): bool {
$owner = $this->owner;
return $owner::find()->andWhere([$this->getPrimaryKeyName() => $key])->exists();
}
protected function getPrimaryKeyName(): string {
$owner = $this->owner;
$primaryKeys = $owner::primaryKey();
if (!isset($primaryKeys[0])) {
throw new InvalidConfigException('"' . get_class($owner) . '" must have a primary key.');
}
if (count($primaryKeys) > 1) {
throw new InvalidConfigException('Current behavior don\'t support models with more then one primary key.');
}
return $primaryKeys[0];
}
}