ldc-legaulois/app/Models/DepartaimantsCollection.php
2021-03-19 10:54:30 +01:00

348 lines
12 KiB
PHP

<?php
namespace App\Models;
use App\Enums\Departaimant;
use App\Enums\DepartaimantCurrent;
use App\Enums\DepartaimantCollectionType;
use App\Enums\DepartaimantStatus;
use App\Enums\DepartaimantVintage;
use Kwaadpepper\Enum\Traits\CastsEnums;
use Exception;
use Illuminate\Database\Eloquent\Builder;
use Illuminate\Database\Eloquent\Model;
/**
* Departaimants Model
* Has functions to store departaimants on multiple statuses
*
* @uses App\Enums\Departaimant
* @uses App\Enums\DepartaimantStatus
* @uses App\Enums\DepartaimantCollectionType
* @author Jérémy Munsch <jeremy.munsch@ldc.fr>
*/
class DepartaimantsCollection extends Model
{
use CastsEnums;
protected $enumCasts = [
'type' => DepartaimantCollectionType::class
];
protected $table = 'departaimants';
private static $columnTableNamePrefix = 'col'; // Le prefix d'un table departaimant
private static $tableFields = 4; // Le nombre de colonnes des departaimants
private static $departementWidth = 2; // La largeur en bits d'un départaimant
public $attributes = [
'type' => 'current' // to be set in construct
];
public $fillable = [
'collection'
];
public static function __callStatic($name, $arguments)
{
if ($name === 'defaultType'){
return DepartaimantCollectionType::current();
}
return parent::__callStatic($name, $arguments);
}
public function __construct(array $attributes = [])
{
$this->type = DepartaimantCollectionType::current();
// Set Default 0 to cols instead of null
for ($i = 1; $i < $this->tableFields; $i++) {
$this->attributes[sprintf('col%d', $i)] = 0;
}
parent::__construct($attributes);
}
public function customer()
{
return $this->belongsTo(Customers::class);
}
/**
* Add a Departaiment to this collection
*
* @param Departaimant $departaimant
* @return void
*/
public function add(Departaimant $departaimant): void
{
$this->set($departaimant, DepartaimantStatus::has());
}
/**
* Removes a Departaime from this collection
*
* @param Departaimant $departaimant
* @return void
*/
public function remove(Departaimant $departaimant): void
{
$this->reset($departaimant);
}
/**
* Checks if this collection has a Departaimant
*
* @param Departaimant $departaimant
* @return bool
*/
public function has(Departaimant $departaimant): bool
{
return $this->status($departaimant, DepartaimantStatus::has());
}
/**
* Set the Departaimant to a specific status
*
* @param Departaimant $departaimant
* @param DepartaimantStatus $status
* @return void
*/
public function set(Departaimant $departaimant, DepartaimantStatus $status): void
{
$depCol = static::depColInTable($departaimant);
$tableName = sprintf('%s%d', static::$columnTableNamePrefix, static::depField($departaimant));
$this->reset($departaimant);
$this->$tableName |= ($status->value << $depCol); // OR
}
/**
* Test the Departaimant status
*
* @param Departaimant $departaimant
* @param DepartaimantStatus $status
* @return bool
*/
public function status(Departaimant $departaimant, DepartaimantStatus $status): bool
{
$depCol = static::depColInTable($departaimant);
$tableName = sprintf('%s%d', static::$columnTableNamePrefix, static::depField($departaimant));
/**
* On créer le masque, puis on le décale vers la gauche de $depCol
* On fait un & binaire pour récupérer la valeur
* Puis on la redécale vers la droite
* Enfin on la compare à l'énum DepartaimantStatus::has()
*/
$mask = bindec(str_replace('0', '1', decbin(static::$departementWidth))) << $depCol;
return ($status->value << $depCol) === ($this->$tableName & $mask);
}
/**
* Get all Customer which has their departaimant with a status
*
* @param Departaimant $departaimant
* @param DepartaimantStatus $status
* @return Illuminate\Database\Eloquent\Builder
*/
public static function getCustomersWithStatusAndDepartaimant(Departaimant $departaimant, DepartaimantStatus $status): Builder
{
$depCol = self::depColInTable($departaimant);
$tableName = sprintf('%s%d', self::$columnTableNamePrefix, self::depField($departaimant));
/**
* On créer le masque, puis on le décale vers la gauche de $depCol
* On fait un & binaire pour récupérer la valeur
* Puis on la redécale vers la droite
* Enfin on la compare à l'énum DepartaimantStatus::has()
*/
$mask = bindec(str_replace('0', '1', decbin(self::$departementWidth))) << $depCol;
return Customers::with('departaimantsCollections')
->whereHas('departaimantsCollections', function ($query) use ($tableName, $mask, $status, $depCol) {
$query->whereRaw(sprintf('((%d << %d) = (%s & %d))', $status->value, $depCol, $tableName, $mask));
});
}
/**
* Get all Customer which has their departaimant with a status
*
* @param array $departaimants
* @param DepartaimantStatus $status
* @param DepartaimantCollectionType $type
* @return Builder
*/
public static function getDepartaimantsCollectionWithStatus(Array $departaimants, DepartaimantStatus $status, DepartaimantCollectionType $type): Builder
{
// TODO : Check if array is array of Departaimant
$req = static::where('type', $type->value);
$whereReq = '';
foreach ($departaimants as $k => $departaimant) {
$depCol = self::depColInTable($departaimant);
$tableName = sprintf('%s%d', self::$columnTableNamePrefix, self::depField($departaimant));
/**
* On créer le masque, puis on le décale vers la gauche de $depCol
* On fait un & binaire pour récupérer la valeur
* Puis on la redécale vers la droite
* Enfin on la compare à l'énum DepartaimantStatus::has()
*/
$mask = bindec(str_replace('0', '1', decbin(self::$departementWidth))) << $depCol;
$whereReq .= sprintf('((%d << %d) = (%s & %d)) ', $status->value, $depCol, $tableName, $mask);
if ($k !== count($departaimants) - 1){
$whereReq .= " OR ";
}
}
$req->whereRaw("($whereReq)");
return $req;
}
/**
* Get the Departaimant status
*
* @param Departaimant $departaimant
* @return DepartaimantStatus
*/
public function getStatus(Departaimant $departaimant): DepartaimantStatus
{
$depCol = static::depColInTable($departaimant);
$tableName = sprintf('%s%d', static::$columnTableNamePrefix, static::depField($departaimant));
/**
* On créer le masque, puis on le décale vers la gauche de $depCol
* On fait un & binaire pour récupérer la valeur
* Puis on la redécale vers la droite
* Enfin on la compare à l'énum DepartaimantStatus::has()
*/
$mask = bindec(str_replace('0', '1', decbin(static::$departementWidth))) << $depCol;
return DepartaimantStatus::make(($this->$tableName & $mask) >> $depCol);
}
/**
* Get a list of all the departaimants and their status
*
* @uses Departaimant
* @uses DepartaimantStatus
* @return array[object] with departaimant: \App\Enums\Departaimant, status:\App\Enums\DepartaimantStatus
*/
public function getAllDepartaimants(): array
{
$deps = [];
/** @var Departaimant */
$type = static::getDepType();
foreach (static::getDepKeys() as $depKey) {
/** @var Departaimant */
$dep = \forward_static_call([\get_class($type), 'make'], $depKey);
$deps[$depKey] = (object)[
'departaimant' => $dep,
'status' => $this->getStatus($dep)
];
}
return $deps;
}
/**
* Set the Departaimant column to 0
*
* @param Departaimant $departaimant
* @return void
*/
private function reset(Departaimant $departaimant): void
{
$depCol = static::depColInTable($departaimant);
$tableName = sprintf('%s%d', static::$columnTableNamePrefix, static::depField($departaimant));
$this->$tableName &= ~(DepartaimantStatus::wants()->value << $depCol); // AND max enum value
}
/**
* Donne la 'table' (colonne SQL) dans laquelle se trouve
* le département
*
* @param Departaimant $dep
* @return int
*/
public static function depField(Departaimant $dep): int
{
$fieldCols = floor(8 * 8 / self::$departementWidth); // bigInt = 8 * 8 octets
$totalFieldCols = self::$tableFields * $fieldCols;
$depsPerField = floor($totalFieldCols / self::$tableFields);
return (int)floor((array_search($dep->value, \array_keys(self::getDeps())) + $depsPerField) / $depsPerField);
}
/**
* Donne la colonne (binaire) dans laquelle se trouve le département
* Dans sa 'table' (colonne SQL)
*
* @param Departaimant $dep
* @return int
*/
public static function depColInTable(Departaimant $dep): int
{
$tableColumnWith = floor(8 * 8 / self::$departementWidth); // bigInt = 8 * 8 octets
$depsKeys = self::getDepKeys();
$size = count($depsKeys);
$i = 0;
for ($a = 0; $a < $size; $a++) {
if ($dep->value == $depsKeys[$a]) {
return $i * 2;
}
$i = $i >= ($tableColumnWith - 1) ? 0 : $i + 1;
}
return -1;
}
/**
* Donne la valeur (masque binaire) d'un département
*
* @param Departaimant $dep
* @return int
*/
public function depVal(Departaimant $dep): int
{
return static::getDeps()[$dep->value];
}
/**
* Genère la liste des departements avec leur masques
*
* @return array
*/
private static function getDeps(): array
{
$tableColumnWith = floor(8 * 8 / self::$departementWidth); // bigInt = 8 * 8 octets
$o = [];
$i = 0;
$depsKeys = self::getDepKeys();
$size = count($depsKeys);
for ($a = 0; $a < $size; $a++) {
$o[$depsKeys[$a]] = 1 << $i * self::$departementWidth;
$i = $i >= ($tableColumnWith - 1) ? 0 : $i + 1;
}
return $o;
}
private static function getDepKeys(): array
{
/** @var Departaimant */
$type = self::getDepType();
return \forward_static_call([\get_class($type), 'toValues']);
}
private static function getDepType(): Departaimant
{
/** @var DepartaimantCollectionType */
$type = self::defaultType();
if (is_null($type)) {
throw new Exception(
'DepartaimantCollection::type class memeber must be set to a DepartaimantCollectionType'
);
}
switch ($type) {
case DepartaimantCollectionType::current():
return new DepartaimantCurrent();
case DepartaimantCollectionType::vintage():
return new DepartaimantVintage();
break;
default:
throw new Exception(sprintf(
'DepartaimantCollection::type %s is not handled in DepartaimantCollection Model'
), $type);
}
}
}