Tailor\Classes\EditorExtension
Overview
EditorExtension adds Tailor objects to October Editor IDE
Extends
Protected Properties
There are no protected properties in the class.
Show inherited protected properties
Inherited Protected Properties
- $emitterSingleEventCollection - of events to be fired once only. (defined in Editor\Classes\ExtensionBase)
- $emitterEventCollection - of all registered events. (defined in Editor\Classes\ExtensionBase)
- $emitterEventSorted - collection. (defined in Editor\Classes\ExtensionBase)
Public Methods
public getClientSideLangStrings()
public getClientSideLangStrings(): array
getClientSideLangStrings 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 getExtensionSortOrder()
public getExtensionSortOrder(): void
getExtensionSortOrder affects the extension position in the Editor Navigator
public getNamespace()
public getNamespace(): string
getNamespace returns unique extension namespace
public getNewDocumentsData()
public getNewDocumentsData(): void
public static hasAccessToDocType()
public static hasAccessToDocType($user, $documentType): void
public listJsFiles()
public listJsFiles(): array
Returns a list of JavaScript files required for the extension.
public listNavigatorSections()
public listNavigatorSections($sectionList, $documentType = null): void
listNavigatorSections initializes extension's sidebar Navigator sections.
public listVueComponents()
public listVueComponents(): array
Returns a list of Vue components required for the extension.
Inherited Public Methods
- bindEvent() - creates a new event binding. (defined in Editor\Classes\ExtensionBase)
- bindEventOnce() - creates a new event binding that fires once only. (defined in Editor\Classes\ExtensionBase)
- fireEvent() - and call the listeners. (defined in Editor\Classes\ExtensionBase)
- fireSystemEvent() - fires a combination of local and global events. The first segment is removed. (defined in Editor\Classes\ExtensionBase)
- fireViewEvent() - is a special event function used for extending within view files, (defined in Editor\Classes\ExtensionBase)
- getEditorContext() - returns the editor context this extension appears in. (defined in Editor\Classes\ExtensionBase)
- getNamespaceNormalized() - (defined in Editor\Classes\ExtensionBase)
- getSettingsForms() - returns a list of settings form configurations for document types. (defined in Editor\Classes\ExtensionBase)
- listInspectorConfigurations() - returns a list of Inspector configurations that must. (defined in Editor\Classes\ExtensionBase)
- runCommand() - handles client-side requests. (defined in Editor\Classes\ExtensionBase)
- unbindEvent() - destroys an event binding. (defined in Editor\Classes\ExtensionBase)
Protected Methods
protected addBlueprintsNavigatorNodes()
protected addBlueprintsNavigatorNodes($rootNode): void
protected addDirectoryBlueprintNodes()
protected addDirectoryBlueprintNodes($path, $parentNode, $isTheme = false): void
protected addSectionMenuItems()
protected addSectionMenuItems($section): void
protected addThemeBlueprintsNavigatorNodes()
protected addThemeBlueprintsNavigatorNodes($rootNode): void
addBlueprintsNavigatorNodes
protected command_onBlueprintCreateDirectory()
protected command_onBlueprintCreateDirectory(): void
protected command_onBlueprintDelete()
protected command_onBlueprintDelete(): void
protected command_onBlueprintMove()
protected command_onBlueprintMove(): void
command_onBlueprintDelete
protected command_onBlueprintRename()
protected command_onBlueprintRename(): void
protected command_onBlueprintUpload()
protected command_onBlueprintUpload(): void
protected command_onDeleteDocument()
protected command_onDeleteDocument(): void
protected command_onMigrateBlueprint()
protected command_onMigrateBlueprint($controller): void
protected command_onOpenDocument()
protected command_onOpenDocument(): void
protected command_onSaveDocument()
protected command_onSaveDocument(): void
protected getBlueprintTemplate()
protected getBlueprintTemplate($type): void
protected makeMetadataForNewTemplate()
protected makeMetadataForNewTemplate($documentType): array
makeMetadataForNewTemplate builds meta data for new templates
Show inherited protected methods
Inherited Protected Methods
- editorCreateDirectory() - (defined in Editor\Classes\ExtensionBase)
- editorDeleteFileOrDirectory() - (defined in Editor\Classes\ExtensionBase)
- editorMoveFilesOrDirectories() - (defined in Editor\Classes\ExtensionBase)
- editorRenameFileOrDirectory() - (defined in Editor\Classes\ExtensionBase)
- editorUploadFiles() - (defined in Editor\Classes\ExtensionBase)
- emitterEventSortEvents() - sorts the listeners for a given event by priority. (defined in Editor\Classes\ExtensionBase)
- loadAndLocalizeJsonFile() - (defined in Editor\Classes\ExtensionBase)
- loadSettingsFields() - (defined in Editor\Classes\ExtensionBase)