RightsSyncCommand Class Reference

Immutable request describing one permissions sync to perform on a module descriptor. More...

Collaboration diagram for RightsSyncCommand:

Static Public Member Functions
static	forObjectCreation (string $module, string $descriptorFile, array $permissions, string $objectName)
	Declare the three CRUD rights of a newly generated object.
static	forObjectDeletion (string $module, string $descriptorFile, array $permissions, string $objectName)
	Drop every right attached to an object being deleted.
static	forRightAddition (string $module, string $descriptorFile, array $permissions, string $objectName, string $label, string $crud)
	Append one right to the descriptor.
static	forRightUpdate (string $module, string $descriptorFile, array $permissions, int $rightKey, string $objectName, string $label, string $crud)
	Replace one right, addressed by its index in the rights array.
static	forRightDeletion (string $module, string $descriptorFile, array $permissions, int $rightKey)
	Remove one right, addressed by its index in the rights array.

Private Member Functions
	__construct (string $module, string $descriptorFile, array $permissions, string $objectName, string $scope, string $actionType, ?int $rightKey=null, ?string $rightLabel=null, ?string $rightCrud=null)

Detailed Description

Immutable request describing one permissions sync to perform on a module descriptor.

ModuleBuilder triggers project onto two axes, not one: a scope (the three CRUD rights of an object, or a single right) and an action. The five real triggers are the five named factories below; there is no object-scoped update.

The command deliberately carries the current rights array along with the intent. That keeps RightsSyncService free of $db, dol_include_once() and globals, so it stays unit-testable against a throwaway fixture file.

Definition at line 35 of file RightsSyncCommand.class.php.

Constructor & Destructor Documentation

__construct()

RightsSyncCommand::__construct ( string $module, string $descriptorFile, array $permissions, string $objectName, string $scope, string $actionType, ?int $rightKey = null, ?string $rightLabel = null, ?string $rightCrud = null )

private

Parameters

string	$module	Module name
string	$descriptorFile	Path to the descriptor to patch
	array<int,array<int,string>>	$permissions Current rights array
string	$objectName	Target object, may be empty for right deletion
string	$scope	One of SCOPE_*
string	$actionType	One of ACTION_*
int | null	$rightKey	Index in $permissions
string | null	$rightLabel	Permission label
string | null	$rightCrud	Permission crud code

Exceptions

InvalidArgumentException When the command is incomplete for its scope and action

Definition at line 83 of file RightsSyncCommand.class.php.

Member Function Documentation

forObjectCreation()

static RightsSyncCommand::forObjectCreation ( string $module, string $descriptorFile, array $permissions, string $objectName )

static

Declare the three CRUD rights of a newly generated object.

Parameters

string	$module	Module name
string	$descriptorFile	Path to the descriptor to patch
	array<int,array<int,string>>	$permissions Current rights array
string	$objectName	Object being generated

Returns

self

Definition at line 141 of file RightsSyncCommand.class.php.

Referenced by reWriteAllPermissions().

forObjectDeletion()

static RightsSyncCommand::forObjectDeletion ( string $module, string $descriptorFile, array $permissions, string $objectName )

static

Drop every right attached to an object being deleted.

Parameters

string	$module	Module name
string	$descriptorFile	Path to the descriptor to patch
	array<int,array<int,string>>	$permissions Current rights array
string	$objectName	Object being deleted

Returns

self

Definition at line 155 of file RightsSyncCommand.class.php.

Referenced by reWriteAllPermissions().

forRightAddition()

static RightsSyncCommand::forRightAddition ( string $module, string $descriptorFile, array $permissions, string $objectName, string $label, string $crud )

static

Append one right to the descriptor.

Parameters

string	$module	Module name
string	$descriptorFile	Path to the descriptor to patch
	array<int,array<int,string>>	$permissions Current rights array
string	$objectName	Object the right belongs to
string	$label	Permission label
string	$crud	Permission crud code

Returns

self

Definition at line 171 of file RightsSyncCommand.class.php.

Referenced by reWriteAllPermissions().

forRightDeletion()

static RightsSyncCommand::forRightDeletion ( string $module, string $descriptorFile, array $permissions, int $rightKey )

static

Remove one right, addressed by its index in the rights array.

Parameters

string	$module	Module name
string	$descriptorFile	Path to the descriptor to patch
	array<int,array<int,string>>	$permissions Current rights array
int	$rightKey	Index of the right to remove

Returns

self

Definition at line 202 of file RightsSyncCommand.class.php.

Referenced by reWriteAllPermissions().

forRightUpdate()

static RightsSyncCommand::forRightUpdate ( string $module, string $descriptorFile, array $permissions, int $rightKey, string $objectName, string $label, string $crud )

static

Replace one right, addressed by its index in the rights array.

Parameters

string	$module	Module name
string	$descriptorFile	Path to the descriptor to patch
	array<int,array<int,string>>	$permissions Current rights array
int	$rightKey	Index of the right to replace
string	$objectName	Object the right belongs to
string	$label	New permission label
string	$crud	New permission crud code

Returns

self

Definition at line 188 of file RightsSyncCommand.class.php.

Referenced by reWriteAllPermissions().

---

The documentation for this class was generated from the following file:

• dolibarr_dev/htdocs/modulebuilder/class/RightsSyncCommand.class.php