-
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
- Editor
- Behaviors
- StateManager
Editor\Behaviors\StateManager
Extends:
Manages Editor initial state
Public properties
There are no public properties in the class.
Show inherited public properties
Inherited public properties
- public static string $extendableStaticCalledClass - defined in October\Rain\Extension\ExtensionBase. The calling class when using a static method.
- public string $assetPath - defined in Backend\Classes\ControllerBehavior. Specifies a path to the asset directory.
- public array $vars - defined in Backend\Classes\ControllerBehavior. vars is a list of variables to pass to the page.
- public string $layout - defined in Backend\Classes\ControllerBehavior. layout to use for the view.
- public bool $suppressLayout - defined in Backend\Classes\ControllerBehavior. suppressLayout prevents the use of a layout.
Protected properties
There are no protected properties in the class.
Show inherited protected properties
Inherited protected properties
- protected object $config - defined in Backend\Classes\ControllerBehavior. Supplied configuration.
- protected Backend\Classes\Controller $controller - defined in Backend\Classes\ControllerBehavior. Reference to the back end controller.
- protected array $requiredProperties - defined in Backend\Classes\ControllerBehavior. Properties that must exist in the controller using this behavior.
- protected array $actions - defined in Backend\Classes\ControllerBehavior. Visible actions in context of the controller.
- protected static array $extensionCallbacks - defined in October\Rain\Extension\ExtensionBase. Used to extend the constructor of an extension class.
- protected $extensionHidden - defined in October\Rain\Extension\ExtensionBase.
- protected array $assets - defined in Backend\Classes\ControllerBehavior. Collection of assets to display in the layout.
- protected array $assetBundles - defined in Backend\Classes\ControllerBehavior. Collection of combined and prioritized assets.
- protected string $configPath - defined in Backend\Classes\ControllerBehavior. Specifies a path to the config directory.
- protected string|array $viewPath - defined in Backend\Classes\ControllerBehavior. viewPath specifies a path to the views directory.
- protected string $layoutPath - defined in Backend\Classes\ControllerBehavior. layoutPath specifies a path to the layout directory.
Public methods
public void listExtensionNavigatorSections($extension, $namespace, $documentType=NULL)
Parameters
- $extension
- $namespace
- $documentType
public void makeInitialState($params)
Parameters
- $params
Inherited public methods
- public void __construct($controller) - defined in Backend\Classes\ControllerBehavior. Constructor.
- public void addCss($name, $attributes=array()) - defined in Backend\Classes\ControllerBehavior. addCss includes a StyleSheet asset to the asset list.
- public void addCssBundle($name, $attributes=array()) - defined in Backend\Classes\ControllerBehavior. addCssBundle includes a CSS asset to the bundled combiner stream.
- public void addJs($name, $attributes=array()) - defined in Backend\Classes\ControllerBehavior. addJs includes a JavaScript asset to the asset list.
- public void addJsBundle($name, $attributes=array()) - defined in Backend\Classes\ControllerBehavior. addJsBundle includes a JS asset to the bundled combiner stream.
- public void addRss($name, $attributes=array()) - defined in Backend\Classes\ControllerBehavior. addRss adds an RSS link asset to the asset list. Call $this->makeAssets().
- public void addViewPath(string|array $path) - defined in Backend\Classes\ControllerBehavior. addViewPath prepends a path on the available view path locations.
- public void combineAssets($assets, $localPath='') - defined in Backend\Classes\ControllerBehavior. combineAssets runs asset paths through the Asset Combiner.
- public static void extend($callback) - defined in October\Rain\Extension\ExtensionBase.
- public void extensionApplyInitCallbacks() - defined in October\Rain\Extension\ExtensionBase.
- public static void extensionExtendCallback(callable $callback) - defined in October\Rain\Extension\ExtensionBase. Helper method for
::extend()static method. - public void extensionIsHiddenField($name) - defined in October\Rain\Extension\ExtensionBase.
- public void extensionIsHiddenMethod($name) - defined in October\Rain\Extension\ExtensionBase.
- public void flushAssets() - defined in Backend\Classes\ControllerBehavior. Disables the use, and subequent broadcast, of assets. This is useful.
- public string getAssetPath(string $fileName, string $assetPath=NULL) - defined in Backend\Classes\ControllerBehavior. Locates a file based on it's definition. If the file starts with.
- public array getAssetPaths() - defined in Backend\Classes\ControllerBehavior. Returns an array of all registered asset paths.
- public static void getCalledExtensionClass() - defined in October\Rain\Extension\ExtensionBase.
- public string getConfig(string $name=NULL, mixed $default=NULL) - defined in Backend\Classes\ControllerBehavior. Safe accessor for configuration values.
- public string getConfigPath(string $fileName, mixed $configPath=NULL) - defined in Backend\Classes\ControllerBehavior. Locates a file based on it's definition. If the file starts with.
- public string getViewPath(string $fileName, mixed $viewPath=NULL) - defined in Backend\Classes\ControllerBehavior. getViewPath locates a file based on its definition. The file name can be prefixed.
- public array getViewPaths() - defined in Backend\Classes\ControllerBehavior. getViewPaths returns the active view path locations.
- public string guessConfigPath(string $suffix='') - defined in Backend\Classes\ControllerBehavior. Guess the package path for the called class.
- public string guessConfigPathFrom(string $class, string $suffix='') - defined in Backend\Classes\ControllerBehavior. Guess the package path from a specified class.
- public string guessViewPath(string $suffix='', bool $isPublic=false) - defined in Backend\Classes\ControllerBehavior. guessViewPath guesses the package path for the called class.
- public string guessViewPathFrom(string $class, string $suffix='', bool $isPublic=false) - defined in Backend\Classes\ControllerBehavior. guessViewPathFrom guesses the package path from a specified class.
- public void hasAssetsDefined() - defined in Backend\Classes\ControllerBehavior. hasAssetsDefined returns true if assets any have been added.
- public string localMakeFileContents(string $filePath, array $extraParams=array()) - defined in Backend\Classes\ControllerBehavior. makeFileContents includes a file path using output buffering.
- public string makeAssets(string $type=NULL) - defined in Backend\Classes\ControllerBehavior. Outputs
<link>and<script>tags to load assets previously added with addJs and addCss method calls. - public object makeConfig(array $configFile=array(), array $requiredConfig=array()) - defined in Backend\Classes\ControllerBehavior. Reads the contents of the supplied file and applies it to this object.
- public stdClass makeConfigFromArray(array $configArray=array()) - defined in Backend\Classes\ControllerBehavior. Makes a config object from an array, making the first level keys properties of a new object.
- public string makeFileContents(string $filePath, array $extraParams=array()) - defined in Backend\Classes\ControllerBehavior. Makes all views in context of the controller, not the behavior.
- public Backend\Classes\FormWidgetBase makeFormWidget(string $class, mixed $fieldConfig=array(), array $widgetConfig=array()) - defined in Backend\Classes\ControllerBehavior. Makes a form widget object with the supplied form field and widget configuration.
- public mixed makeLayout(string $name=NULL, array $params=array(), bool $throwException=true) - defined in Backend\Classes\ControllerBehavior. makeLayout renders a layout.
- public string makeLayoutPartial(string $partial, array $params=array()) - defined in Backend\Classes\ControllerBehavior. makeLayoutPartial renders a layout partial.
- public mixed makePartial(string $partial, array $params=array(), bool $throwException=true) - defined in Backend\Classes\ControllerBehavior. makePartial renders a partial file contents located in the views folder.
- public string makeView(string $view) - defined in Backend\Classes\ControllerBehavior. makeView loads a view with the name specified. Applies layout if its name is provided.
- public string makeViewContent(string $contents, string $layout=NULL) - defined in Backend\Classes\ControllerBehavior. makeViewContent renders supplied contents inside a layout.
- public Backend\Classes\WidgetBase makeWidget(string $class, array $widgetConfig=array()) - defined in Backend\Classes\ControllerBehavior. Makes a widget object with the supplied configuration file.
- public stdClass mergeConfig(mixed $configA, mixed $configB) - defined in Backend\Classes\ControllerBehavior. Merges two configuration sources, either prepared or not, and returns.
- public void resetSession() - defined in Backend\Classes\ControllerBehavior. Resets all session data related to this widget.
- public void setConfig(mixed $config, array $required=array()) - defined in Backend\Classes\ControllerBehavior. Sets the configuration values.
Protected methods
Show inherited protected methods
Inherited protected methods
- protected void combineBundledAssets($type) - defined in Backend\Classes\ControllerBehavior. combineBundledAssets spins over every bundle definition and combines them to an asset.
- protected bool controllerMethodExists(string $methodName) - defined in Backend\Classes\ControllerBehavior. Returns true in case if a specified method exists in the extended controller.
- protected void extensionHideField($name) - defined in October\Rain\Extension\ExtensionBase.
- protected void extensionHideMethod($name) - defined in October\Rain\Extension\ExtensionBase.
- protected string getAssetEntryBuildPath(array $asset) - defined in Backend\Classes\ControllerBehavior. Internal helper, attaches a build code to an asset path.
- protected string getAssetScheme(string $asset) - defined in Backend\Classes\ControllerBehavior. Internal helper, get asset scheme.
- protected void getLocalPath($relativePath) - defined in Backend\Classes\ControllerBehavior. getLocalPath converts a relative path to a local path.
- protected string getSession(string $key=NULL, string $default=NULL) - defined in Backend\Classes\ControllerBehavior. Retrieves a widget related key/value pair from session data.
- protected void handleViewException($e, $obLevel) - defined in Backend\Classes\ControllerBehavior. handleViewException handles a view exception.
- protected void hideAction(mixed $methodName) - defined in Backend\Classes\ControllerBehavior. Protects a public method from being available as an controller action.
- protected string makeSessionId() - defined in Backend\Classes\ControllerBehavior. Returns a unique session identifier for this widget and controller action.
- protected void putSession(string $key, string $value) - defined in Backend\Classes\ControllerBehavior. Saves a widget related key/value pair in to session data.
- protected void removeDuplicates() - defined in Backend\Classes\ControllerBehavior. Removes duplicate assets from the entire collection.
- protected void renderAssetAttributes($type, $asset) - defined in Backend\Classes\ControllerBehavior. renderAssetAttributes takes an asset definition and returns the necessary HTML output.