BristolSU\Support\ModuleInstance\Settings\ModuleSettingsStore Class Reference

Inheritance diagram for BristolSU\Support\ModuleInstance\Settings\ModuleSettingsStore:

Collaboration diagram for BristolSU\Support\ModuleInstance\Settings\ModuleSettingsStore:

Public Member Functions
	register (string $alias, Form $settings)
	get (string $alias)

Private Attributes
	$settings = []

Detailed Description

Store setting schemas for a module

Definition at line 11 of file ModuleSettingsStore.php.

Member Function Documentation

get()

BristolSU\Support\ModuleInstance\Settings\ModuleSettingsStore::get

(

string

$alias

)

Get the settings schema for a given alias

Parameters

string

$alias

Module alias

Returns

Form Settings Schema

Exceptions

Implements BristolSU\Support\ModuleInstance\Contracts\Settings\ModuleSettingsStore.

Definition at line 43 of file ModuleSettingsStore.php.

References function\settings().

register()

BristolSU\Support\ModuleInstance\Settings\ModuleSettingsStore::register	(	string	$alias,
		Form	$settings
	)

Register a new required settings schema

Parameters

string	$alias	Alias of the module
Form	$settings	Settings schema

Returns

void

Implements BristolSU\Support\ModuleInstance\Contracts\Settings\ModuleSettingsStore.

Definition at line 30 of file ModuleSettingsStore.php.

References BristolSU\Support\ModuleInstance\Settings\ModuleSettingsStore\$settings, and function\settings().

Member Data Documentation

$settings

BristolSU\Support\ModuleInstance\Settings\ModuleSettingsStore::$settings = []

private

Definition at line 21 of file ModuleSettingsStore.php.

Referenced by BristolSU\Support\ModuleInstance\Settings\ModuleSettingsStore\register().

---

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

• src/ModuleInstance/Settings/ModuleSettingsStore.php