1. Documentation
  2. API
  3. Cms
  4. Classes
  5. EditorExtension

Cms\Classes\EditorExtension

Overview

EditorExtension adds CMS objects to October Editor IDE

Extends

Protected Properties

protected bool $cachedEditTheme

Show inherited protected properties

Inherited Protected Properties

Public Methods

public getAssetsPath()

public getAssetsPath($theme $theme = null): string

getAssetsPath returns the asset path for a theme

public getClientSideLangStrings()

public getClientSideLangStrings(): array

Returns a list of language strings required by the client-side extension controller.

public getCustomData()

public getCustomData(): array

getCustomData returns custom state data required for the extension client-side controller

public getNamespace()

public getNamespace(): string

getNamespace returns unique extension namespace

public getNewDocumentsData()

public getNewDocumentsData(): array

public getSettingsForms()

public getSettingsForms(): array

public static hasAccessToDocType()

public static hasAccessToDocType($user, $documentType): array

public listJsFiles()

public listJsFiles(): array

Returns a list of JavaScript files required for the extension.

public listNavigatorSections()

public listNavigatorSections($sectionList, $documentType = null): void

Initializes extension's sidebar Navigator sections.

public listVueComponents()

public listVueComponents(): array

Returns a list of Vue components required for the extension.

Show inherited public methods

Inherited Public Methods

Protected Methods

protected addAssetsNavigatorNodes()

protected addAssetsNavigatorNodes($theme, $rootNode): void

protected addDirectoryAssetsNodes()

protected addDirectoryAssetsNodes($path, $parentNode, $theme): void

protected assertCmsThemeExists()

protected assertCmsThemeExists($themeDir): void

assertCmsThemeExists ensures a theme directory exists

protected canResetFromTemplateFile()

protected canResetFromTemplateFile($template): bool

canResetFromTemplateFile returns true if the database template can be reloaded from the template file. Only available when the database templates are enabled, and the template exists in both the database and filesystem.

protected canUpdateTemplateFile()

protected canUpdateTemplateFile($template): bool

canUpdateTemplateFile returns true if the template file can be updated with the database content. Only available in debug mode, the database templates must be enabled, and the template must exist in the database.

protected command_onAssetCreateDirectory()

protected command_onAssetCreateDirectory(): void

protected command_onAssetDelete()

protected command_onAssetDelete(): void

protected command_onAssetMove()

protected command_onAssetMove(): void

protected command_onAssetRename()

protected command_onAssetRename(): void

protected command_onAssetUpload()

protected command_onAssetUpload(): void

protected command_onDeleteDocument()

protected command_onDeleteDocument(): void

protected command_onExpandCmsComponent()

protected command_onExpandCmsComponent(): void

protected command_onOpenDocument()

protected command_onOpenDocument(): void

protected command_onSaveDocument()

protected command_onSaveDocument(): void

protected command_onSetEditTheme()

protected command_onSetEditTheme(): void

command_onSetEditTheme sets the editing theme for the user

protected getAssetExtensionListInitialState()

protected getAssetExtensionListInitialState(): void

protected getAssetFullPath()

protected getAssetFullPath($path $path): string

getAssetFullPath returns the full path for the current theme

protected getCmsAssetNewDocumentData()

protected getCmsAssetNewDocumentData(): void

protected getTemplateToolbarCustomSettingsButtons()

protected getTemplateToolbarCustomSettingsButtons($entityName): void

protected getTheme()

protected getTheme(): void

getTheme returns the theme object to use for the editor

protected getThemeDatasource()

protected getThemeDatasource(): void

getThemeDatasource returns a theme datasource object

protected getToolbarCustomSettingsButtons()

protected getToolbarCustomSettingsButtons(): void

protected handleEmptyValuesOnLoad()

protected handleEmptyValuesOnLoad($template, $templateData): void

protected handleEmptyValuesOnSave()

protected handleEmptyValuesOnSave($template, $templateData): void

protected handleLineEndings()

protected handleLineEndings($templateData): void

protected intellisenseLoadOctoberTags()

protected intellisenseLoadOctoberTags(): void

protected intellisenseLoadTwigFilters()

protected intellisenseLoadTwigFilters(): void

protected loadAndExtendCmsSettingsFields()

protected loadAndExtendCmsSettingsFields($fieldsClass, $entityName): void

protected loadAssetsForUiLists()

protected loadAssetsForUiLists($theme, $user): void

protected loadCustomSettingsButtons()

protected loadCustomSettingsButtons($fieldsClass): array
See Also

protected makeMetadataForNewTemplate()

protected makeMetadataForNewTemplate($documentType): array

makeMetadataForNewTemplate builds meta data for new templates

protected resetFromTemplateFile()

protected resetFromTemplateFile($documentType, $templatePath): void

protected updateTemplateFile()

protected updateTemplateFile($template, $documentType, $templatePath): void

Show inherited protected methods

Inherited Protected Methods