ThemeController
extends BaseController
in package
Tags
Table of Contents
- DEVICE_CODE_COOKIE = 'JinyaDeviceCode'
- $body : array<string, mixed>
- $logger : LoggerInterface
- $themeSyncer : ThemeSyncer
- __construct() : mixed
- activateTheme() : ResponseInterface
- Activates the given theme
- compileTheme() : ResponseInterface
- Compiles all theme assets
- entityNotFound() : ResponseInterface
- formatIteratorPlain() : array<string|int, array<string, mixed>>
- getConfigurationStructure() : ResponseInterface
- Gets the structure of the configuration for the given theme
- getDefaultConfiguration() : ResponseInterface
- Gets the default configuration values by theme ID
- getPreviewImage() : ResponseInterface
- Gets the theme preview image, if no preview image is configured a 204 is returned
- getStyleVariables() : ResponseInterface
- Gets the SCSS variables from the given theme
- getThemeBlogCategories() : ResponseInterface
- getThemeClassicPages() : ResponseInterface
- getThemeFiles() : ResponseInterface
- getThemeForms() : ResponseInterface
- getThemeGalleries() : ResponseInterface
- getThemeMenus() : ResponseInterface
- getThemeModernPages() : ResponseInterface
- jsonIterator() : ResponseInterface
- jsonIteratorPlain() : ResponseInterface
- updateConfiguration() : ResponseInterface
- Updates the theme configuration for the given theme. Before an update is made, the themes will be synced to have the latest state
- updateStyleVariables() : ResponseInterface
- Updates the SCSS variable for the given theme from the body
- updateTheme() : ResponseInterface
- Updates the given theme, from the zip file in the body
- updateThemeBlogCategory() : ResponseInterface
- updateThemeClassicPage() : ResponseInterface
- updateThemeFile() : ResponseInterface
- updateThemeForm() : ResponseInterface
- updateThemeGallery() : ResponseInterface
- updateThemeMenu() : ResponseInterface
- updateThemeModernPage() : ResponseInterface
- uploadTheme() : ResponseInterface
- Uploads a new theme, unzips the posted body and syncs all themes
- formatThemeLinks() : ResponseInterface
Constants
DEVICE_CODE_COOKIE
public
mixed
DEVICE_CODE_COOKIE
= 'JinyaDeviceCode'
Tags
Properties
$body
public
array<string, mixed>
$body
$logger read-only
private
LoggerInterface
$logger
Tags
$themeSyncer read-only
private
ThemeSyncer
$themeSyncer
= new ThemeSyncer()
Tags
Methods
__construct()
public
__construct([ThemeSyncer $themeSyncer = new ThemeSyncer() ]) : mixed
Parameters
- $themeSyncer : ThemeSyncer = new ThemeSyncer()
Tags
Return values
mixed —activateTheme()
Activates the given theme
public
activateTheme(int $id) : ResponseInterface
Parameters
- $id : int
Tags
Return values
ResponseInterface —compileTheme()
Compiles all theme assets
public
compileTheme(int $id) : ResponseInterface
Parameters
- $id : int
Tags
Return values
ResponseInterface —entityNotFound()
public
entityNotFound(string $message) : ResponseInterface
Parameters
- $message : string
Tags
Return values
ResponseInterface —formatIteratorPlain()
public
formatIteratorPlain(Iterator<string|int, T> $iterator) : array<string|int, array<string, mixed>>
Parameters
- $iterator : Iterator<string|int, T>
Tags
Return values
array<string|int, array<string, mixed>> —getConfigurationStructure()
Gets the structure of the configuration for the given theme
public
getConfigurationStructure(int $id) : ResponseInterface
Parameters
- $id : int
Tags
Return values
ResponseInterface —getDefaultConfiguration()
Gets the default configuration values by theme ID
public
getDefaultConfiguration(int $id) : ResponseInterface
Parameters
- $id : int
Tags
Return values
ResponseInterface —getPreviewImage()
Gets the theme preview image, if no preview image is configured a 204 is returned
public
getPreviewImage(int $id) : ResponseInterface
Parameters
- $id : int
Tags
Return values
ResponseInterface —getStyleVariables()
Gets the SCSS variables from the given theme
public
getStyleVariables(int $id) : ResponseInterface
Parameters
- $id : int
Tags
Return values
ResponseInterface —getThemeBlogCategories()
public
getThemeBlogCategories(int $id) : ResponseInterface
Parameters
- $id : int
Tags
Return values
ResponseInterface —getThemeClassicPages()
public
getThemeClassicPages(int $id) : ResponseInterface
Parameters
- $id : int
Tags
Return values
ResponseInterface —getThemeFiles()
public
getThemeFiles(int $id) : ResponseInterface
Parameters
- $id : int
Tags
Return values
ResponseInterface —getThemeForms()
public
getThemeForms(int $id) : ResponseInterface
Parameters
- $id : int
Tags
Return values
ResponseInterface —getThemeGalleries()
public
getThemeGalleries(int $id) : ResponseInterface
Parameters
- $id : int
Tags
Return values
ResponseInterface —getThemeMenus()
public
getThemeMenus(int $id) : ResponseInterface
Parameters
- $id : int
Tags
Return values
ResponseInterface —getThemeModernPages()
public
getThemeModernPages(int $id) : ResponseInterface
Parameters
- $id : int
Tags
Return values
ResponseInterface —jsonIterator()
public
jsonIterator(Iterator $iterator) : ResponseInterface
Parameters
- $iterator : Iterator
Tags
Return values
ResponseInterface —jsonIteratorPlain()
public
jsonIteratorPlain(Iterator $iterator) : ResponseInterface
Parameters
- $iterator : Iterator
Tags
Return values
ResponseInterface —updateConfiguration()
Updates the theme configuration for the given theme. Before an update is made, the themes will be synced to have the latest state
public
updateConfiguration(int $id) : ResponseInterface
Parameters
- $id : int
Tags
Return values
ResponseInterface —updateStyleVariables()
Updates the SCSS variable for the given theme from the body
public
updateStyleVariables(int $id) : ResponseInterface
Parameters
- $id : int
Tags
Return values
ResponseInterface —updateTheme()
Updates the given theme, from the zip file in the body
public
updateTheme(int $id) : ResponseInterface
Parameters
- $id : int
Tags
Return values
ResponseInterface —updateThemeBlogCategory()
public
updateThemeBlogCategory(int $id, string $name) : ResponseInterface
Parameters
- $id : int
- $name : string
Tags
Return values
ResponseInterface —updateThemeClassicPage()
public
updateThemeClassicPage(int $id, string $name) : ResponseInterface
Parameters
- $id : int
- $name : string
Tags
Return values
ResponseInterface —updateThemeFile()
public
updateThemeFile(int $id, string $name) : ResponseInterface
Parameters
- $id : int
- $name : string
Tags
Return values
ResponseInterface —updateThemeForm()
public
updateThemeForm(int $id, string $name) : ResponseInterface
Parameters
- $id : int
- $name : string
Tags
Return values
ResponseInterface —updateThemeGallery()
public
updateThemeGallery(int $id, string $name) : ResponseInterface
Parameters
- $id : int
- $name : string
Tags
Return values
ResponseInterface —updateThemeMenu()
public
updateThemeMenu(int $id, string $name) : ResponseInterface
Parameters
- $id : int
- $name : string
Tags
Return values
ResponseInterface —updateThemeModernPage()
public
updateThemeModernPage(int $id, string $name) : ResponseInterface
Parameters
- $id : int
- $name : string
Tags
Return values
ResponseInterface —uploadTheme()
Uploads a new theme, unzips the posted body and syncs all themes
public
uploadTheme() : ResponseInterface
Tags
Return values
ResponseInterface —formatThemeLinks()
private
formatThemeLinks(array<string, BlogCategory|ClassicPage|File|Form|Gallery|Menu|ModernPage> $links) : ResponseInterface
Parameters
- $links : array<string, BlogCategory|ClassicPage|File|Form|Gallery|Menu|ModernPage>