CreatorService
extends Service
in package
Table of Contents
- createBlock() : array<string|int, mixed>
- Create a new block class for a theme
- createBlockProvider() : array<string|int, mixed>
- Create a new block displayer for a theme
- createFieldDisplayer() : array<string|int, mixed>
- Create a new field displayer class for a theme
- createFileDisplayer() : array<string|int, mixed>
- Create a new file displayer class for a theme
- createTheme() : array<string|int, mixed>
- Create a new theme
- blockCacheService() : BlockCacheService
- Get the block cache service
- blockProviderService() : BlockProvidersService
- Get the block providers service
- blocksService() : BlockService
- Get the blocks service
- displayService() : DisplayService
- Get the display service
- eagerLoadingService() : EagerLoadingService
- Get the eager loading service
- fieldDisplayersService() : FieldDisplayerService
- Get the field displayers service
- fieldsService() : FieldsService
- Get the fields service
- fileDisplayerService() : FileDisplayerService
- Get the file displayers service
- getNamespace() : string
- Get the namespace of a theme
- getTheme() : ThemeInterface
- Ensure a theme exists
- groupsService() : GroupsService
- Get the groups service
- layoutService() : LayoutService
- Get the layout service
- matrixService() : MatrixService
- Get the matrix service
- sanitizeClassName() : string
- Make up a class name from a name and validates it
- themesRegistry() : ThemesRegistry
- Get the themes registry
- triggerEvent() : mixed
- Triggers an event
- validateHandle() : mixed
- Validate a handle
- viewModesService() : ViewModeService
- Get the view mode service
- viewService() : ViewService
- Get the view service
Methods
createBlock()
Create a new block class for a theme
public
createBlock(string $theme, string $name[, string $handle = '' ][, string $description = '' ][, string $className = '' ]) : array<string|int, mixed>
Parameters
- $theme : string
- $name : string
- $handle : string = ''
- $description : string = ''
- $className : string = ''
Return values
array<string|int, mixed> —createBlockProvider()
Create a new block displayer for a theme
public
createBlockProvider(string $theme, string $name[, string $handle = '' ][, string $className = '' ]) : array<string|int, mixed>
Parameters
- $theme : string
- $name : string
- $handle : string = ''
- $className : string = ''
Return values
array<string|int, mixed> —createFieldDisplayer()
Create a new field displayer class for a theme
public
createFieldDisplayer(string $theme, string $name[, string $handle = '' ][, string $className = '' ]) : array<string|int, mixed>
Parameters
- $theme : string
- $name : string
- $handle : string = ''
- $className : string = ''
Return values
array<string|int, mixed> —createFileDisplayer()
Create a new file displayer class for a theme
public
createFileDisplayer(string $theme, string $name[, string $handle = '' ][, string $className = '' ]) : array<string|int, mixed>
Parameters
- $theme : string
- $name : string
- $handle : string = ''
- $className : string = ''
Return values
array<string|int, mixed> —createTheme()
Create a new theme
public
createTheme(string $name[, string $handle = '' ][, string $namespace = '' ][, string $className = '' ][, string $folder = 'themes' ]) : array<string|int, mixed>
Parameters
- $name : string
- $handle : string = ''
- $namespace : string = ''
- $className : string = ''
- $folder : string = 'themes'
Tags
Return values
array<string|int, mixed> —blockCacheService()
Get the block cache service
protected
blockCacheService() : BlockCacheService
Return values
BlockCacheService —blockProviderService()
Get the block providers service
protected
blockProviderService() : BlockProvidersService
Return values
BlockProvidersService —blocksService()
Get the blocks service
protected
blocksService() : BlockService
Return values
BlockService —displayService()
Get the display service
protected
displayService() : DisplayService
Return values
DisplayService —eagerLoadingService()
Get the eager loading service
protected
eagerLoadingService() : EagerLoadingService
Return values
EagerLoadingService —fieldDisplayersService()
Get the field displayers service
protected
fieldDisplayersService() : FieldDisplayerService
Return values
FieldDisplayerService —fieldsService()
Get the fields service
protected
fieldsService() : FieldsService
Return values
FieldsService —fileDisplayerService()
Get the file displayers service
protected
fileDisplayerService() : FileDisplayerService
Return values
FileDisplayerService —getNamespace()
Get the namespace of a theme
protected
getNamespace(ThemeInterface $theme) : string
Parameters
- $theme : ThemeInterface
Return values
string —getTheme()
Ensure a theme exists
protected
getTheme(string $handle) : ThemeInterface
Parameters
- $handle : string
Tags
Return values
ThemeInterface —groupsService()
Get the groups service
protected
groupsService() : GroupsService
Return values
GroupsService —layoutService()
Get the layout service
protected
layoutService() : LayoutService
Return values
LayoutService —matrixService()
Get the matrix service
protected
matrixService() : MatrixService
Return values
MatrixService —sanitizeClassName()
Make up a class name from a name and validates it
protected
sanitizeClassName(string $className, string $name) : string
Parameters
- $className : string
- $name : string
Tags
Return values
string —themesRegistry()
Get the themes registry
protected
themesRegistry() : ThemesRegistry
Return values
ThemesRegistry —triggerEvent()
Triggers an event
protected
triggerEvent(string $type, Event $event) : mixed
Parameters
- $type : string
- $event : Event
Return values
mixed —validateHandle()
Validate a handle
protected
validateHandle(string $handle) : mixed
Parameters
- $handle : string
Tags
Return values
mixed —viewModesService()
Get the view mode service
protected
viewModesService() : ViewModeService
Return values
ViewModeService —viewService()
Get the view service
protected
viewService() : ViewService