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

Cms\Classes\EditorExtension

Extends:

EditorExtension adds CMS objects to October Editor IDE

Protected properties

There are no protected properties in the class.

Show inherited protected properties

Inherited protected properties

Public methods

public void getAssetsPath($theme=NULL)
Parameters
  • $theme

public array getClientSideLangStrings()

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

public void getCustomData()

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

public void getNamespace()

getNamespace returns unique extension namespace

public void getNewDocumentsData()

getNewDocumentsData returns a list of new document descriptions, allowing creating documents on the client side.

public void getSettingsForms()

getSettingsForms returns a list of settings form configurations for document types supported by the extension.

public static void hasAccessToDocType($user, $documentType)
Parameters
  • $user
  • $documentType

public void listInspectorConfigurations()

listInspectorConfigurations returns a list of Inspector configurations that must be available on the client side.

public array listJsFiles()

Returns a list of JavaScript files required for the extension.

public void listNavigatorSections($sectionList, $documentType=NULL)

Initializes extension's sidebar Navigator sections.

Parameters
  • $sectionList
  • $documentType

public array listVueComponents()

Returns a list of Vue components required for the extension.

Show inherited public methods

Inherited public methods

Protected methods

protected void addAssetsNavigatorNodes($theme, $rootNode)

addAssetsNavigatorNodes

Parameters
  • $theme
  • $rootNode

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

addDirectoryAssetsNodes

Parameters
  • $path
  • $parentNode
  • $theme

protected void assertCmsThemeExists($themeDir)

assertCmsThemeExists ensures a theme directory exists

Parameters
  • $themeDir

protected void canResetFromTemplateFile($template)

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.

Parameters
  • $template

protected void canUpdateTemplateFile($template)

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.

Parameters
  • $template

protected void command_onAssetCreateDirectory()

protected void command_onAssetDelete()

protected void command_onAssetMove()

protected void command_onAssetRename()

protected void command_onAssetUpload()

protected void command_onDeleteDocument()

protected void command_onExpandCmsComponent()

protected void command_onOpenDocument()

protected void command_onSaveDocument()

protected void command_onSetEditTheme()

command_onSetEditTheme sets the editing theme for the user

protected void getAssetExtensionListInitialState()

getAssetExtensionListInitialState

protected void getCmsAssetNewDocumentData()

getCmsAssetNewDocumentData

protected void getTheme()

getTheme returns the theme object to use for the editor

protected void getThemeDatasource()

getThemeDatasource returns a theme datasource object

protected void intellisenseLoadOctoberTags()

protected void intellisenseLoadTwigFilters()

protected void loadAssetsForUiLists($theme, $user)

loadAssetsForUiLists

Parameters
  • $theme
  • $user

protected void makeMetadataForNewTemplate($documentType)

makeMetadataForNewTemplate builds meta data for new templates

Parameters
  • $documentType

protected void resetFromTemplateFile($documentType, $templatePath)

resetFromTemplateFile

Parameters
  • $documentType
  • $templatePath

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

updateTemplateFile

Parameters
  • $template
  • $documentType
  • $templatePath

Show inherited protected methods

Inherited protected methods