-
Backend
-
Behaviors
-
Classes
-
Controllers
-
Database
-
Seeds
-
-
Facades
-
FormWidgets
-
Helpers
-
Models
-
ReportWidgets
-
Skins
-
Traits
-
VueComponents
-
Widgets
- ServiceProvider
-
-
Cms
-
Classes
- Asset
- CmsCompoundObject
- CmsController
- CmsException
- CmsObject
- CmsObjectCollection
- CodeBase
- CodeParser
- ComponentBase
- ComponentHelpers
- ComponentManager
- ComponentPartial
- Content
- Controller
- EditorExtension
- Layout
- LayoutCode
- MediaLibrary
- MediaLibraryItem
- MediaViewHelper
- Meta
- ObjectMemoryCache
- Page
- PageCode
- Partial
- PartialCode
- PartialStack
- Router
- Theme
- ThemeManager
-
Components
-
Controllers
-
Facades
-
FormWidgets
-
Helpers
-
Models
-
ReportWidgets
-
Traits
-
Twig
- ComponentNode
- ComponentTokenParser
- ContentNode
- ContentTokenParser
- DebugExtension
- DefaultNode
- DefaultTokenParser
- Extension
- FlashNode
- FlashTokenParser
- FrameworkNode
- FrameworkTokenParser
- Loader
- PageNode
- PageTokenParser
- PartialNode
- PartialTokenParser
- PlaceholderNode
- PlaceholderTokenParser
- PutNode
- PutTokenParser
- ScriptsNode
- ScriptsTokenParser
- StylesNode
- StylesTokenParser
-
VueComponents
-
Widgets
- ServiceProvider
-
-
Editor
-
Behaviors
-
Classes
-
Controllers
-
VueComponents
- ServiceProvider
-
-
Media
-
Classes
-
Controllers
-
FormWidgets
-
Twig
-
Widgets
- ServiceProvider
-
-
System
-
Behaviors
-
Classes
-
Console
-
OctoberUtil
- ComposerScript
- OctoberDown
- OctoberFresh
- OctoberMigrate
- OctoberMirror
- OctoberPasswd
- OctoberUp
- OctoberUpdate
- OctoberUtil
- PluginCheck
- PluginDisable
- PluginEnable
- PluginInstall
- PluginList
- PluginRefresh
- PluginRemove
- ProjectSet
- ProjectSync
- ThemeCheck
- ThemeInstall
- ThemeList
- ThemeRemove
- ThemeSync
- ThemeUse
-
-
Controllers
-
Database
-
Facades
-
Helpers
-
Models
-
ReportWidgets
-
Traits
-
Twig
-
Widgets
- ServiceProvider
-
-
Events
-
backend
-
ajax
-
filter
-
form
-
list
-
menu
-
page
-
user
-
-
cms
-
ajax
-
block
-
combiner
-
component
-
object
-
page
-
resizer
-
router
-
template
-
theme
-
-
exception
-
halcyon
-
datasource
-
-
mailer
-
media
-
model
-
auth
-
form
-
relation
-
/docs/api/model/relation/add
-
/docs/api/model/relation/associate
- attach
-
/docs/api/model/relation/beforeadd
-
/docs/api/model/relation/beforeassociate
- beforeAttach
- beforeDetach
-
/docs/api/model/relation/beforedissociate
-
/docs/api/model/relation/beforeremove
- detach
-
/docs/api/model/relation/dissociate
-
/docs/api/model/relation/remove
-
- afterBoot
- afterCreate
- afterDelete
- afterFetch
- afterRestore
- afterSave
- afterUpdate
- afterValidate
- beforeCreate
- beforeDelete
- beforeFetch
- beforeGetAttribute
- beforeRestore
- beforeSave
- beforeSetAttribute
- beforeUpdate
- beforeValidate
- getAttribute
- saveInternal
- setAttribute
-
-
system
-
assets
-
console
-
mirror
-
theme
-
-
reportwidgets
-
resizer
-
settings
- extendConfigFile
-
-
translator
-
-
Library
-
Argon
-
Assetic
-
Asset
-
Cache
-
Exception
-
Factory
-
Filter
- BaseCssFilter
- CallablesFilter
- CssCacheBustingFilter
- CssImportFilter
- CssMinFilter
- CssRewriteFilter
- FilterCollection
- JavascriptImporter
- JSMinFilter
- JSMinPlusFilter
- JSqueezeFilter
- LessCompiler
- LessphpFilter
- MinifyCssCompressorFilter
- PackagerFilter
- PackerFilter
- ScssCompiler
- ScssphpFilter
- StylesheetMinify
-
Util
- README
- AssetManager
- AssetWriter
- FilterManager
-
-
Auth
-
Models
- AuthException
- Manager
-
-
Config
-
Database
-
Attach
-
Behaviors
-
Concerns
-
Connections
-
Connectors
-
Models
-
Relations
-
Schema
-
Traits
-
Updates
- README
- Builder
- Collection
- DatabaseServiceProvider
- DataFeed
- Dongle
- MemoryCache
- MigrationServiceProvider
- Model
- ModelBehavior
- ModelException
- MorphPivot
- NestedTreeScope
- Pivot
- QueryBuilder
- SortableScope
- TreeCollection
- Updater
-
-
Events
-
Exception
-
Extension
-
Filesystem
-
Flash
-
Foundation
-
Bootstrap
-
Console
-
Exception
-
Http
-
Middleware
- Kernel
-
-
Providers
- Application
- Maker
-
-
Halcyon
-
Datasource
-
Exception
-
Processors
-
Traits
- README
- Builder
- Collection
- HalcyonServiceProvider
- MemoryCacheManager
- MemoryRepository
- Model
-
-
Html
-
Mail
-
Network
-
Parse
-
Parsedown
-
Syntax
- Bracket
- Ini
- Markdown
- MarkdownData
- ParseServiceProvider
- Twig
- Yaml
-
-
Process
-
Resize
-
Router
-
Scaffold
-
Support
-
Translation
-
- Documentation
- API
- Cms
- Classes
- 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
- protected array $emitterSingleEventCollection - defined in Editor\Classes\ExtensionBase. Collection of registered events to be fired once only.
- protected array $emitterEventCollection - defined in Editor\Classes\ExtensionBase. Collection of registered events.
- protected array $emitterEventSorted - defined in Editor\Classes\ExtensionBase. Sorted collection of events.
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.
Inherited public methods
- public self bindEvent($event, $callback, $priority=0) - defined in Editor\Classes\ExtensionBase. Create a new event binding.
- public self bindEventOnce($event, $callback) - defined in Editor\Classes\ExtensionBase. Create a new event binding that fires once only.
- public array fireEvent(string $event, array $params=array(), boolean $halt=false) - defined in Editor\Classes\ExtensionBase. Fire an event and call the listeners.
- public mixed fireSystemEvent(string $event, array $params=array(), boolean $halt=true) - defined in Editor\Classes\ExtensionBase. Fires a combination of local and global events. The first segment is removed.
- public string fireViewEvent(string $event, array $params=array()) - defined in Editor\Classes\ExtensionBase. Special event function used for extending within view files,
- public void getNamespaceNormalized() - defined in Editor\Classes\ExtensionBase.
- public void runCommand($command) - defined in Editor\Classes\ExtensionBase. runCommand handles client-side requests.
- public self unbindEvent(string $event=NULL) - defined in Editor\Classes\ExtensionBase. Destroys an event binding.
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
- protected array emitterEventSortEvents(string $eventName) - defined in Editor\Classes\ExtensionBase. Sort the listeners for a given event by priority.
- protected void loadAndLocalizeJsonFile($path) - defined in Editor\Classes\ExtensionBase. loadAndLocalizeJsonFile.
- protected void loadSettingsFile($rootPath, $documentDirectoryName) - defined in Editor\Classes\ExtensionBase. loadSettingsFile.