ConfigMaker
Config Maker Trait Adds configuration based methods to a class

 trait System\Traits\ConfigMaker

Properties

protected $configPath : string

Specifies a path to the config directory.

Methods

public getConfigPath (string $fileName, mixed $configPath = `null`) : string

Locates a file based on it's definition. If the file starts with the ~ symbol it will be returned in context of the application base path, otherwise it will be returned in context of the config path.

Parameters

Property	Type	Description
$fileName	string	string File to load.
$configPath	mixed	mixed Explicitly define a config path.

Returns

string

Full path to the config file.

public guessConfigPath (string $suffix = `""`) : string

Guess the package path for the called class.

Parameters

Property	Type	Description
$suffix	string	string An extra path to attach to the end

Returns

string

public guessConfigPathFrom (string $class, string $suffix = `""`) : string

Guess the package path from a specified class.

Parameters

Property	Type	Description
$class	string	string Class to guess path from.
$suffix	string	string An extra path to attach to the end

Returns

string

public makeConfig (array $configFile = `[]`, array $requiredConfig = `[]`) : array | stdClass

Reads the contents of the supplied file and applies it to this object.

Parameters

Property	Type	Description
$configFile	array	array
$requiredConfig	array	array

Returns

array | stdClass

public makeConfigFromArray (array $configArray = `[]`) : stdClass

Makes a config object from an array, making the first level keys properties of a new object.

Parameters

Property	Type	Description
$configArray	array	array Config array.

Returns

stdClass

The config object

public mergeConfig (mixed $configA, mixed $configB) : stdClass

Merges two configuration sources, either prepared or not, and returns them as a single configuration object.

Parameters

Property	Type	Description
$configA	mixed	mixed
$configB	mixed	mixed

Returns

stdClass

The config object

Used by

Class	Description
`SettingsModel`	Settings model extension
`EventLogs`	Event Logs controller
`MailBrandSettings`	Mail brand customization controller
`MailLayouts`	Mail layouts controller
`MailPartials`	Mail partials controller
`MailTemplates`	Mail templates controller
`RequestLogs`	Request Logs controller
`Settings`	Settings controller
`Updates`	Updates controller
`Status`	System status report widget.
`FormController`	Adds features for working with backend forms. This behavior will inject CRUD actions to the controller -- including create, update and preview -- along with some relevant AJAX handlers.
`ImportExportController`	Adds features for importing and exporting data.
`ListController`	Adds features for working with backend lists.
`RelationController`	Uses a combination of lists and forms for managing Model relations.
`ReorderController`	Used for reordering and sorting records.
`UserPreferencesModel`	User Preferences model extension, identical to System\Behaviors\SettingsModel except values are set against the logged in user's preferences via Backend\Models\UserPreference
`Controller`	The Backend base controller class, used by Backend controllers.
`ControllerBehavior`	Controller Behavior base class
`FormWidgetBase`	Form Widget base class Widgets used specifically for forms
`ReportWidgetBase`	Report Widget base class Report widgets are used inside the ReportContainer.
`WidgetBase`	Widget base class.
`AccessLogs`	Access Logs controller
`Auth`	Authentication controller
`Files`	Backend files controller
`Index`	Dashboard controller
`Media`	Backend Media Manager
`Preferences`	Editor Settings controller
`UserGroups`	Backend user groups controller
`UserRoles`	Backend user groups controller
`Users`	Backend user controller
`CodeEditor`	Code Editor Renders a code editor field.
`ColorPicker`	Color picker Renders a color picker field.
`DataTable`	Data Table Renders a table field.
`DatePicker`	Date picker Renders a date picker field.
`FileUpload`	File upload field Renders a form file uploader field.
`IconPicker`	Icon picker Renders an icon picker field.
`MarkdownEditor`	Code Editor Renders a code editor field.
`MediaFinder`	Media Finder Renders a record finder field.
`NestedForm`	Nested Form Renders a nested form bound to a jsonable field of a model.
`PermissionEditor`	User/group permission editor This widget is used by the system internally on the System / Administrators pages.
`RecordFinder`	Record Finder Renders a record finder field.
`Relation`	Form Relationship Renders a field prepopulated with a belongsTo and belongsToHasMany relation.
`RelationManager`
`Repeater`	Repeater Form Widget
`RichEditor`	Rich Editor Renders a rich content editor field.
`Sensitive`	Sensitive widget.
`TagList`	Tag List Form Widget
`Welcome`	User welcome report widget.
`Filter`	Filter Widget Renders a container used for filtering things.
`Form`	Form Widget Used for building back end forms and renders a form.
`Lists`	List Widget Used for building back end lists, renders a list of model objects
`MediaManager`	Media Manager widget.
`ReportContainer`	Report Container Widget Creates an area hosting report widgets.
`Search`	Search Widget Used for building a toolbar, Renders a search container.
`Table`	Table Widget.
`Toolbar`	Toolbar Widget Used for building a toolbar, renders a toolbar.
`Index`	CMS index
`Media`	CMS Media Manager
`ThemeLogs`	Request Logs controller
`ThemeOptions`	Theme customization controller
`Themes`	Theme selector controller
`Components`	Component Builder Builds a collection of Cms components and configures them.
`MediaFinder`	Media Finder Renders a record finder field.
`ActiveTheme`	Active theme report widget.
`AssetList`	CMS asset list widget.
`ComponentList`	Component list widget.
`MediaManager`	Media Manager widget.
`TemplateList`	Template list widget.

← Previous page System\Traits\AssetMaker Next page → System\Traits\EventEmitter

ConfigMaker Config Maker Trait Adds configuration based methods to a class

# Properties

# protected $configPath : string

# Methods

# public getConfigPath (string $fileName, mixed $configPath = null) : string

# public guessConfigPath (string $suffix = "") : string

# public guessConfigPathFrom (string $class, string $suffix = "") : string

# public makeConfig (array $configFile = [], array $requiredConfig = []) : array | stdClass

# public makeConfigFromArray (array $configArray = []) : stdClass

# public mergeConfig (mixed $configA, mixed $configB) : stdClass

# Used by

ConfigMaker
Config Maker Trait Adds configuration based methods to a class

Properties

protected $configPath : string

Methods

public getConfigPath (string $fileName, mixed $configPath = `null`) : string

public guessConfigPath (string $suffix = `""`) : string

public guessConfigPathFrom (string $class, string $suffix = `""`) : string

public makeConfig (array $configFile = `[]`, array $requiredConfig = `[]`) : array | stdClass

public makeConfigFromArray (array $configArray = `[]`) : stdClass

public mergeConfig (mixed $configA, mixed $configB) : stdClass

Used by