RightsSyncCommand.class.php

Go to the documentation of this file.

<?php
/* Copyright (C) 2026 ATM Consulting <support@atm-consulting.fr>
 * Copyright (C) 2026   MDW       <mdeweerd@users.noreply.github.com>
 *
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program. If not, see <https://www.gnu.org/licenses/>.
 */
 
final class RightsSyncCommand
{
  const ACTION_ADD = 'add';
  const ACTION_UPDATE = 'update';
  const ACTION_DELETE = 'delete';
 
  const SCOPE_OBJECT = 'object';
  const SCOPE_RIGHT = 'right';
 
  public $module;
 
  public $descriptorFile;
 
  public $permissions;
 
  public $objectName;
 
  public $scope;
 
  public $actionType;
 
  public $rightKey;
 
  public $rightLabel;
 
  public $rightCrud;
 
  private function __construct(
    string $module,
    string $descriptorFile,
    array $permissions,
    string $objectName,
    string $scope,
    string $actionType,
    ?int $rightKey = null,
    ?string $rightLabel = null,
    ?string $rightCrud = null
  ) {
    if ($module === '') {
      throw new \InvalidArgumentException('RightsSyncCommand requires a module name');
    }
    if ($descriptorFile === '') {
      throw new \InvalidArgumentException('RightsSyncCommand requires a descriptor file path');
    }
    if (!in_array($scope, array(self::SCOPE_OBJECT, self::SCOPE_RIGHT), true)) {
      throw new \InvalidArgumentException('RightsSyncCommand got an unknown scope: '.$scope);
    }
    if (!in_array($actionType, array(self::ACTION_ADD, self::ACTION_UPDATE, self::ACTION_DELETE), true)) {
      throw new \InvalidArgumentException('RightsSyncCommand got an unknown action: '.$actionType);
    }
    if ($scope === self::SCOPE_OBJECT) {
      if ($objectName === '') {
        throw new \InvalidArgumentException('An object-scoped RightsSyncCommand requires an object name');
      }
      if ($actionType === self::ACTION_UPDATE) {
        throw new \InvalidArgumentException('There is no object-scoped update in ModuleBuilder');
      }
    }
    if ($scope === self::SCOPE_RIGHT && $actionType !== self::ACTION_ADD && $rightKey === null) {
      throw new \InvalidArgumentException('A right-scoped '.$actionType.' requires a right key');
    }
    if ($scope === self::SCOPE_RIGHT && $actionType !== self::ACTION_DELETE && ($rightLabel === null || $rightCrud === null)) {
      throw new \InvalidArgumentException('A right-scoped '.$actionType.' requires a label and a crud code');
    }
 
    $this->module = $module;
    $this->descriptorFile = $descriptorFile;
    $this->permissions = $permissions;
    $this->objectName = $objectName;
    $this->scope = $scope;
    $this->actionType = $actionType;
    $this->rightKey = $rightKey;
    $this->rightLabel = $rightLabel;
    $this->rightCrud = $rightCrud;
  }
 
  public static function forObjectCreation(string $module, string $descriptorFile, array $permissions, string $objectName): self
  {
    return new self($module, $descriptorFile, $permissions, $objectName, self::SCOPE_OBJECT, self::ACTION_ADD);
  }
 
  public static function forObjectDeletion(string $module, string $descriptorFile, array $permissions, string $objectName): self
  {
    return new self($module, $descriptorFile, $permissions, $objectName, self::SCOPE_OBJECT, self::ACTION_DELETE);
  }
 
  public static function forRightAddition(string $module, string $descriptorFile, array $permissions, string $objectName, string $label, string $crud): self
  {
    return new self($module, $descriptorFile, $permissions, $objectName, self::SCOPE_RIGHT, self::ACTION_ADD, null, $label, $crud);
  }
 
  public static function forRightUpdate(string $module, string $descriptorFile, array $permissions, int $rightKey, string $objectName, string $label, string $crud): self
  {
    return new self($module, $descriptorFile, $permissions, $objectName, self::SCOPE_RIGHT, self::ACTION_UPDATE, $rightKey, $label, $crud);
  }
 
  public static function forRightDeletion(string $module, string $descriptorFile, array $permissions, int $rightKey): self
  {
    return new self($module, $descriptorFile, $permissions, '', self::SCOPE_RIGHT, self::ACTION_DELETE, $rightKey);
  }
}