System\Classes\PresetManager

Overview

PresetManager class manages preset lists

Protected Properties

protected array $presets

presets collection of presets

protected array $extenders

extenders collection of preset extender callbacks

Public Methods

public __construct()

public __construct(): void

public extendPreset()

public extendPreset($alias, $callback): void

extendPreset registers a callback that modifies a preset after it is resolved. The callback receives the preset items array and should return the modified array.

Usage to add items:

PresetManager::instance()->extendPreset('icons', function($items) {
    $items['bi-custom'] = ['custom', 'bi bi-custom'];
    return $items;
});

Usage to remove items:

PresetManager::instance()->extendPreset('icons', function($items) {
    unset($items['oc-icon-trash']);
    return $items;
});

public getPreset()

public getPreset($alias): array 

getPreset returns the resolved preset items for a given alias

public hasPreset()

public hasPreset($alias): bool 

hasPreset checks if a preset exists by alias

public static instance()

public static instance(): static 

instance creates a new instance of this singleton

public registerPreset()

public registerPreset($alias, $callback): void

registerPreset registers a new preset with a callback that returns the items

public replacePreset()

public replacePreset($alias, $callback): void

replacePreset completely replaces an existing preset with a new callback