ACLService

Table of contents

  1. Overview
  2. Public Methods
  3. Notes


1. Overview Table of Contents

The ACLService class provides a collection of static methods for managing Access Control Lists (ACLs) associated with users. ACLs define role-based permissions and are stored as a JSON-encoded array in each user’s acl field.

This service helps enforce permission rules across the application while maintaining clean separation from controller logic.


Setup

use Core\Services\AclService;


Common Use Cases

  • Assign or remove ACLs from users
  • Determine which ACLs are in use
  • Prevent deletion of ACLs assigned to users
  • Set default ACLs at registration


2. Public Methods Table of Contents

A. aclsForUser()

Returns an array containing access control list information. When the $acl instance variable is empty an empty array is returned.

Parameter:

  • Users $user - The user whose ACLs we want to use.

Return:

  • array - The array containing access control list information.
$acls = ACLService::aclsForUser($user);


B. aclToArray()

Ensures that we are always dealing with an array of ACLs.

Parameter:

  • mixed $acls - An array or any type that we want to add to an array.

Returns:

  • array - An array of acls.
$normalized = ACLService::aclToArray(['Admin', 'Manager']);


C. addAcl()

Add ACL to user’s acl field as an element of an array.

Parameters:

  • int $user_id - The id of the user whose acl field we want to modify.
  • string $acl - The name of the new ACL.

Returns:

  • bool - True or false depending on success of operation.
ACLService::addAcl(3, 'Manager');


D. removeAcl()

Removes ACL from user’s acl field array.

Parameters:

  • int $user_id - The id of the user whose acl field we want to modify.
  • string $acl - The name of the ACL to be removed.

Returns:

  • bool - True if user is found, otherwise we return false.
ACLService::removeAcl(3, 'Viewer');


E. checkACL()

Redirects with a flash message if:

  • The ACL does not exist, or
  • The ACL is already assigned to users and cannot be modified.

Parameter:

  • ACL $acl The ACL to verify.
ACLService::checkACL($acl);


F. deleteIfAllowed()

Deletes an ACL only if it is not assigned to any users.

Parameter:

  • int $id - The id for the ACL.

Returns:

  • bool - True if deleted, otherwise false. 
    ACLService::deleteIfAllowed($aclId);


G. manageAcls()

Adds or removes ACLs from a user based on the differences between the new ACLs and existing ACLs.

Used internally by updateUserACLs().

Parameters:

  • array $acls - ACLs stored in acl table.
  • Users $user - The user we want to modify.
  • array $newAcls - The new ACLs for the user.
  • array $userAcls - The user’s existing ACLs.


H. updateUserACLs()

Central method for updating a user’s ACLs. Compares current ACLs with selected ones and saves the result.

Parameters:

  • Users $user - The user whose ACLs we want to update.
  • array $userAcls - Existing user’s ACLs.
  • array $acls - All available ACLs.
  • array|null $postAcls - ACLs from post that are selected.
ACLService::updateUserACLs($user, $existing, $all, $posted);


I. setAclAtRegistration()

Returns the default ACL value for a new user:

  • “Admin” if no users exist yet
  • ”” (blank string) otherwise

Returns:

  • string - The value of the ACL we are setting upon registration of a user.
ACLService::saveACL($acl, $request);


J. saveACL()

Assigns data to an ACL and saves it, using a blacklist if the ACL already exists.

Parameters:

  • ACL $acl - The ACL to be Saves
  • Input $request - The request.

Returns:

  • bool - True if update is successful, otherwise false.
ACLService::saveACL($acl, $request);


K. usedACLs()

Returns array of used ACLs.

Returns:

  • array $usedACLs - An array of used ACLs.
$used = ACLService::usedACLs();


L. unUsedACLs(): array

Returns array of unused ACLs.

Returns:

  • array $unUsedAcls - An array of unused ACLs. 
    $unused = ACLService::unUsedACLs();


3. Notes Table of Contents

  • User ACLs are stored as JSON in the acl column of the users table.
  • The service ensures consistent encoding and decoding of ACL data.
  • Methods like checkACL() and deleteIfAllowed() are designed for use in admin-facing ACL management interfaces.
  • This service should be used instead of direct access to $user->acl.