BlockLoader
in package
Content block plugin manager
Tags
Table of Contents
- $blockManager : PluginManager
- Block manager.
- $configManager : PluginManager
- Config manager.
- $optionsManager : PluginManager
- Options manager.
- __construct() : mixed
- Constructor
- getFromConfig() : array<string|int, mixed>
- Fetch blocks using a configuration name
- getFromConfigObject() : array<string|int, mixed>
- Fetch blocks using Config object.
- getFromOptions() : array<string|int, mixed>
- Fetch blocks using an Options object.
- getFromSearchClassId() : array<string|int, mixed>
- Fetch blocks using a search class ID.
Properties
$blockManager
Block manager.
protected
PluginManager
$blockManager
$configManager
Config manager.
protected
PluginManager
$configManager
$optionsManager
Options manager.
protected
PluginManager
$optionsManager
Methods
__construct()
Constructor
public
__construct(PluginManager $om, PluginManager $cm, PluginManager $bm) : mixed
Parameters
- $om : PluginManager
-
Options manager
- $cm : PluginManager
-
Config manager
- $bm : PluginManager
-
Block manager
Return values
mixed —getFromConfig()
Fetch blocks using a configuration name
public
getFromConfig(string $name[, string $section = 'HomePage' ][, string $setting = 'content' ]) : array<string|int, mixed>
Parameters
- $name : string
-
Configuration name
- $section : string = 'HomePage'
-
Section to load from object
- $setting : string = 'content'
-
Setting to load from section
Return values
array<string|int, mixed> —getFromConfigObject()
Fetch blocks using Config object.
public
getFromConfigObject(Config $config[, string $section = 'HomePage' ][, string $setting = 'content' ]) : array<string|int, mixed>
Parameters
- $config : Config
-
Configuration object
- $section : string = 'HomePage'
-
Section to load from object
- $setting : string = 'content'
-
Setting to load from section
Return values
array<string|int, mixed> —getFromOptions()
Fetch blocks using an Options object.
public
getFromOptions(Options $options) : array<string|int, mixed>
Parameters
- $options : Options
-
Options object
Return values
array<string|int, mixed> —getFromSearchClassId()
Fetch blocks using a search class ID.
public
getFromSearchClassId(string $searchClassId) : array<string|int, mixed>
Parameters
- $searchClassId : string
-
Search class ID