AppSettingsTable
extends BaseTable
in package
AppSettings Model
Table of Contents
Constants
- CACHE_GROUPS_TO_CLEAR = []
- CACHES_TO_CLEAR = []
- ID_CACHES_TO_CLEAR = []
- PASSWORD_VALUE_PREFIX = 'enc:v1:'
Methods
- addBranchScopeQuery() : SelectQuery
- Add branch-based data scoping to a query.
- afterDelete() : void
- After delete hook to capture impersonation audit trail entries.
- afterSave() : void
- After-save handler for automatic cache invalidation.
- buildRules() : RulesChecker
- Define application-level rules.
- delete() : bool
- Delete.
- deleteAppSetting() : bool
- Delete app setting.
- deleteMany() : iterable<string|int, AppSetting>|ResultSetInterface<string|int, AppSetting>|false
- deleteManyOrFail() : iterable<string|int, AppSetting>|ResultSetInterface<string|int, AppSetting>
- deleteSetting() : bool
- Update an app setting and cache the new value.
- findOrCreate() : AppSetting
- get() : AppSetting
- getAllAppSettingsStartWith() : array<string|int, mixed>
- Get all app settings start with.
- getAppSetting() : mixed
- Get app setting.
- getSetting() : mixed
- Get an app setting by name, using cache.
- initialize() : void
- Initialize method
- newEmptyEntity() : AppSetting
- newEntities() : array<string|int, AppSetting>
- newEntity() : AppSetting
- patchEntities() : array<string|int, AppSetting>
- patchEntity() : AppSetting
- save() : EntityInterface|false
- Save.
- saveMany() : iterable<string|int, AppSetting>|ResultSetInterface<string|int, AppSetting>|false
- saveManyOrFail() : iterable<string|int, AppSetting>|ResultSetInterface<string|int, AppSetting>
- saveOrFail() : AppSetting
- setAppSetting() : bool
- Set app setting.
- updateSetting() : bool
- Update an app setting and cache the new value.
- validationDefault() : Validator
- Default validation rules.
- logImpersonationAction() : void
- Record impersonated writes to audit log table.
- getPasswordEncryptionKey() : string
- Get password encryption key.
- isSensitiveSetting() : bool
- Check if sensitive setting.
- resolveValueForRead() : mixed
- Resolve value for read.
- resolveValueForWrite() : mixed
- Resolve value for write.
Constants
CACHE_GROUPS_TO_CLEAR
protected
array<string|int, string>
CACHE_GROUPS_TO_CLEAR
= []
Cache groups to clear entirely on save
CACHES_TO_CLEAR
protected
array<string|int, array{string, string}>
CACHES_TO_CLEAR
= []
Static cache entries to clear on save
ID_CACHES_TO_CLEAR
protected
array<string|int, array{string, string}>
ID_CACHES_TO_CLEAR
= []
Entity-ID cache prefixes to clear on save
PASSWORD_VALUE_PREFIX
private
mixed
PASSWORD_VALUE_PREFIX
= 'enc:v1:'
Methods
addBranchScopeQuery()
Add branch-based data scoping to a query.
public
addBranchScopeQuery(SelectQuery $query, array<string|int, int> $branchIDs) : SelectQuery
Child tables should override for custom branch relationships.
Parameters
- $query : SelectQuery
-
The query to modify
- $branchIDs : array<string|int, int>
-
Authorized branch IDs
Return values
SelectQuery —Query with branch filtering
afterDelete()
After delete hook to capture impersonation audit trail entries.
public
afterDelete(EventInterface $event, EntityInterface $entity, ArrayObject $options) : void
Parameters
- $event : EventInterface
-
Delete event
- $entity : EntityInterface
-
Entity being deleted
- $options : ArrayObject
-
Delete options
afterSave()
After-save handler for automatic cache invalidation.
public
afterSave(EventInterface $event, EntityInterface $entity, ArrayObject $options) : void
Parameters
- $event : EventInterface
-
The afterSave event
- $entity : EntityInterface
-
The saved entity
- $options : ArrayObject
-
Save options
buildRules()
Define application-level rules.
public
buildRules(RulesChecker $rules) : RulesChecker
Parameters
- $rules : RulesChecker
Return values
RulesCheckerdelete()
Delete.
public
delete(EntityInterface $entity[, array<string|int, mixed> $options = [] ]) : bool
Parameters
- $entity : EntityInterface
- $options : array<string|int, mixed> = []
Return values
booldeleteAppSetting()
Delete app setting.
public
deleteAppSetting(mixed $key[, bool $forceDelete = false ]) : bool
Parameters
- $key : mixed
- $forceDelete : bool = false
Return values
booldeleteMany()
public
deleteMany(iterable<string|int, mixed> $entities[, array<string|int, mixed> $options = = '[]' ]) : iterable<string|int, AppSetting>|ResultSetInterface<string|int, AppSetting>|false
Parameters
- $entities : iterable<string|int, mixed>
- $options : array<string|int, mixed> = = '[]'
Return values
iterable<string|int, AppSetting>|ResultSetInterface<string|int, AppSetting>|falsedeleteManyOrFail()
public
deleteManyOrFail(iterable<string|int, mixed> $entities[, array<string|int, mixed> $options = = '[]' ]) : iterable<string|int, AppSetting>|ResultSetInterface<string|int, AppSetting>
Parameters
- $entities : iterable<string|int, mixed>
- $options : array<string|int, mixed> = = '[]'
Return values
iterable<string|int, AppSetting>|ResultSetInterface<string|int, AppSetting>deleteSetting()
Update an app setting and cache the new value.
public
deleteSetting(string $name[, bool $forceDelete = false ]) : bool
Parameters
- $name : string
-
The name of the setting.
- $forceDelete : bool = false
Return values
bool —True on success, false on failure.
findOrCreate()
public
findOrCreate(mixed $search[, callable|null $callback = = 'null' ][, array<string|int, mixed> $options = = '[]' ]) : AppSetting
Parameters
- $search : mixed
- $callback : callable|null = = 'null'
- $options : array<string|int, mixed> = = '[]'
Return values
AppSettingget()
public
get(mixed $primaryKey[, array<string|int, mixed>|string $finder = = '\'all\'' ][, CacheInterface|string|null $cache = = 'null' ][, Closure|string|null $cacheKey = = 'null' ], mixed ...$args) : AppSetting
Parameters
- $primaryKey : mixed
- $finder : array<string|int, mixed>|string = = '\'all\''
- $cache : CacheInterface|string|null = = 'null'
- $cacheKey : Closure|string|null = = 'null'
- $args : mixed
Return values
AppSettinggetAllAppSettingsStartWith()
Get all app settings start with.
public
getAllAppSettingsStartWith(mixed $key) : array<string|int, mixed>
Parameters
- $key : mixed
Return values
array<string|int, mixed>getAppSetting()
Get app setting.
public
getAppSetting(mixed $key[, mixed $default = null ][, mixed $type = null ][, mixed $required = false ]) : mixed
Parameters
- $key : mixed
- $default : mixed = null
- $type : mixed = null
- $required : mixed = false
getSetting()
Get an app setting by name, using cache.
public
getSetting(string $name) : mixed
Parameters
- $name : string
-
The name of the setting.
Return values
mixed —The value of the setting.
initialize()
Initialize method
public
initialize(array<string, mixed> $config) : void
Parameters
- $config : array<string, mixed>
-
The configuration for the Table.
newEmptyEntity()
public
newEmptyEntity() : AppSetting
Return values
AppSettingnewEntities()
public
newEntities(array<string|int, mixed> $data[, array<string|int, mixed> $options = = '[]' ]) : array<string|int, AppSetting>
Parameters
- $data : array<string|int, mixed>
- $options : array<string|int, mixed> = = '[]'
Return values
array<string|int, AppSetting>newEntity()
public
newEntity(array<string|int, mixed> $data[, array<string|int, mixed> $options = = '[]' ]) : AppSetting
Parameters
- $data : array<string|int, mixed>
- $options : array<string|int, mixed> = = '[]'
Return values
AppSettingpatchEntities()
public
patchEntities(iterable<string|int, mixed> $entities, array<string|int, mixed> $data[, array<string|int, mixed> $options = = '[]' ]) : array<string|int, AppSetting>
Parameters
- $entities : iterable<string|int, mixed>
- $data : array<string|int, mixed>
- $options : array<string|int, mixed> = = '[]'
Return values
array<string|int, AppSetting>patchEntity()
public
patchEntity(EntityInterface $entity, array<string|int, mixed> $data[, array<string|int, mixed> $options = = '[]' ]) : AppSetting
Parameters
- $entity : EntityInterface
- $data : array<string|int, mixed>
- $options : array<string|int, mixed> = = '[]'
Return values
AppSettingsave()
Save.
public
save(EntityInterface $entity[, array<string|int, mixed> $options = [] ]) : EntityInterface|false
Parameters
- $entity : EntityInterface
- $options : array<string|int, mixed> = []
Return values
EntityInterface|falsesaveMany()
public
saveMany(iterable<string|int, mixed> $entities[, array<string|int, mixed> $options = = '[]' ]) : iterable<string|int, AppSetting>|ResultSetInterface<string|int, AppSetting>|false
Parameters
- $entities : iterable<string|int, mixed>
- $options : array<string|int, mixed> = = '[]'
Return values
iterable<string|int, AppSetting>|ResultSetInterface<string|int, AppSetting>|falsesaveManyOrFail()
public
saveManyOrFail(iterable<string|int, mixed> $entities[, array<string|int, mixed> $options = = '[]' ]) : iterable<string|int, AppSetting>|ResultSetInterface<string|int, AppSetting>
Parameters
- $entities : iterable<string|int, mixed>
- $options : array<string|int, mixed> = = '[]'
Return values
iterable<string|int, AppSetting>|ResultSetInterface<string|int, AppSetting>saveOrFail()
public
saveOrFail(EntityInterface $entity[, array<string|int, mixed> $options = = '[]' ]) : AppSetting
Parameters
- $entity : EntityInterface
- $options : array<string|int, mixed> = = '[]'
Return values
AppSettingsetAppSetting()
Set app setting.
public
setAppSetting(mixed $key, mixed $value[, mixed $type = null ][, mixed $required = false ]) : bool
Parameters
- $key : mixed
- $value : mixed
- $type : mixed = null
- $required : mixed = false
Return values
boolupdateSetting()
Update an app setting and cache the new value.
public
updateSetting(string $name, string|null $type, mixed $value[, mixed $required = false ]) : bool
Parameters
- $name : string
-
The name of the setting.
- $type : string|null
-
The new value of the setting.
- $value : mixed
-
The new value of the setting.
- $required : mixed = false
Return values
bool —True on success, false on failure.
validationDefault()
Default validation rules.
public
validationDefault(Validator $validator) : Validator
Parameters
- $validator : Validator
-
Validator instance.
Return values
ValidatorlogImpersonationAction()
Record impersonated writes to audit log table.
protected
logImpersonationAction(string $defaultOperation, EntityInterface $entity) : void
Parameters
- $defaultOperation : string
-
Operation fallback (save/delete)
- $entity : EntityInterface
-
Affected entity
getPasswordEncryptionKey()
Get password encryption key.
private
getPasswordEncryptionKey() : string
Return values
stringisSensitiveSetting()
Check if sensitive setting.
private
isSensitiveSetting(string $name) : bool
Parameters
- $name : string
Return values
boolresolveValueForRead()
Resolve value for read.
private
resolveValueForRead(string $type, mixed $value) : mixed
Parameters
- $type : string
- $value : mixed
resolveValueForWrite()
Resolve value for write.
private
resolveValueForWrite(string $type, mixed $value, bool $settingExists) : mixed
Parameters
- $type : string
- $value : mixed
- $settingExists : bool