Azmog
1e6557729f
- Introduced a new trait `HasCompositePrimaryKey` to enable Eloquent models to handle composite primary keys, which are not supported natively by Eloquent. The trait requires models to implement a method to define the composite key columns and manages key retrieval for save and select queries. chore: add GrumPHP configuration for pre-commit checks - Added a `grumphp.yml` configuration file to enforce code style and static analysis checks before commits. This setup includes Laravel Pint for code style and Larastan for static analysis, ensuring code quality and consistency. chore: create PHPStan configuration file - Created a `phpstan.neon` file to configure PHPStan with Larastan for static analysis. The configuration specifies the paths to analyze and sets the analysis level to 5 for a balance between catching bugs and avoiding excessive strictness.
102 lines
2.7 KiB
PHP
102 lines
2.7 KiB
PHP
<?php
|
|
|
|
namespace App\Models\Concerns;
|
|
|
|
use Illuminate\Database\Eloquent\Builder;
|
|
|
|
/**
|
|
* Apprend à un modèle Eloquent à gérer une clé primaire COMPOSITE
|
|
* (plusieurs colonnes), ce qu'Eloquent ne sait pas faire nativement.
|
|
*
|
|
* Eloquent suppose que `$primaryKey` est une seule colonne (chaîne). On garde
|
|
* donc `$primaryKey` sous forme de chaîne (contrat respecté) et on déclare les
|
|
* colonnes de la clé composite via compositeKeyColumns(). Les requêtes de
|
|
* mise à jour / suppression / sélection par clé filtrent alors sur CHAQUE
|
|
* colonne de la clé.
|
|
*
|
|
* Le modèle qui l'utilise doit :
|
|
* - déclarer `public $incrementing = false;`
|
|
* - implémenter compositeKeyColumns() en listant les colonnes de la clé.
|
|
*/
|
|
trait HasCompositePrimaryKey
|
|
{
|
|
/**
|
|
* Colonnes qui composent la clé primaire composite.
|
|
*
|
|
* @return list<string>
|
|
*/
|
|
abstract protected function compositeKeyColumns(): array;
|
|
|
|
/**
|
|
* Valeur de la clé sous forme de tableau « colonne => valeur ».
|
|
*
|
|
* @return array<string, mixed>
|
|
*/
|
|
public function getKey()
|
|
{
|
|
$key = [];
|
|
|
|
foreach ($this->compositeKeyColumns() as $column) {
|
|
$key[$column] = $this->getAttribute($column);
|
|
}
|
|
|
|
return $key;
|
|
}
|
|
|
|
/**
|
|
* Cible chaque colonne de la clé composite lors d'un save / update.
|
|
*
|
|
* @param Builder<static> $query
|
|
* @return Builder<static>
|
|
*/
|
|
protected function setKeysForSaveQuery($query)
|
|
{
|
|
foreach ($this->compositeKeyColumns() as $column) {
|
|
$query->where($column, '=', $this->getKeyForSaveQuery($column));
|
|
}
|
|
|
|
return $query;
|
|
}
|
|
|
|
/**
|
|
* Valeur d'une colonne de la clé pour un save (valeur d'origine si dispo).
|
|
*
|
|
* @param string|null $column
|
|
* @return mixed
|
|
*/
|
|
protected function getKeyForSaveQuery($column = null)
|
|
{
|
|
$column ??= $this->getKeyName();
|
|
|
|
return $this->original[$column] ?? $this->getAttribute($column);
|
|
}
|
|
|
|
/**
|
|
* Cible chaque colonne de la clé composite lors d'une sélection par clé.
|
|
*
|
|
* @param Builder<static> $query
|
|
* @return Builder<static>
|
|
*/
|
|
protected function setKeysForSelectQuery($query)
|
|
{
|
|
foreach ($this->compositeKeyColumns() as $column) {
|
|
$query->where($column, '=', $this->getKeyForSelectQuery($column));
|
|
}
|
|
|
|
return $query;
|
|
}
|
|
|
|
/**
|
|
* Valeur d'une colonne de la clé pour une sélection.
|
|
*
|
|
* @param string|null $column
|
|
* @return mixed
|
|
*/
|
|
protected function getKeyForSelectQuery($column = null)
|
|
{
|
|
$column ??= $this->getKeyName();
|
|
|
|
return $this->original[$column] ?? $this->getAttribute($column);
|
|
}
|
|
}
|