-
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
- Backend
- VueComponents
- RichEditorDocumentConnector
Backend\VueComponents\RichEditorDocumentConnector
Extends:
Rich Editor Document connector Vue component
Public properties
There are no public properties in the class.
Show inherited public properties
Inherited public properties
- public array $implement - defined in October\Rain\Extension\Extendable. Extensions implemented by this class.
- public array $vars - defined in Backend\Classes\VueComponentBase. vars is a list of variables to pass to the page.
- public string $layout - defined in Backend\Classes\VueComponentBase. layout to use for the view.
- public bool $suppressLayout - defined in Backend\Classes\VueComponentBase. suppressLayout prevents the use of a layout.
- public string $assetPath - defined in Backend\Classes\VueComponentBase. Specifies a path to the asset directory.
Protected properties
protected $require
A list of Vue component class names required for this component.
Show inherited protected properties
Inherited protected properties
- protected Backend\Classes\Controller $controller - defined in Backend\Classes\VueComponentBase. Backend controller object.
- protected array $extensionData - defined in October\Rain\Extension\Extendable. extensionData contains class reflection information, including behaviors.
- protected static array $extendableCallbacks - defined in October\Rain\Extension\Extendable. Used to extend the constructor of an extendable class.
- protected static array $extendableStaticMethods - defined in October\Rain\Extension\Extendable. Collection of static methods used by behaviors.
- protected static bool $extendableGuardProperties - defined in October\Rain\Extension\Extendable. Indicates if dynamic properties can be created.
- protected string|array $viewPath - defined in Backend\Classes\VueComponentBase. viewPath specifies a path to the views directory.
- protected string $layoutPath - defined in Backend\Classes\VueComponentBase. layoutPath specifies a path to the layout directory.
- protected array $assets - defined in Backend\Classes\VueComponentBase. Collection of assets to display in the layout.
- protected array $assetBundles - defined in Backend\Classes\VueComponentBase. Collection of combined and prioritized assets.
Public methods
Inherited public methods
- public void __call($name, $params) - defined in October\Rain\Extension\Extendable.
- public static void __callStatic($name, $params) - defined in October\Rain\Extension\Extendable.
- public void __construct(Backend\Classes\Controller $controller) - defined in Backend\Classes\VueComponentBase. Constructor.
- public void __get($name) - defined in October\Rain\Extension\Extendable.
- public void __set($name, $value) - defined in October\Rain\Extension\Extendable.
- public void addCss($name, $attributes=array()) - defined in Backend\Classes\VueComponentBase. addCss includes a StyleSheet asset to the asset list.
- public void addCssBundle($name, $attributes=array()) - defined in Backend\Classes\VueComponentBase. addCssBundle includes a CSS asset to the bundled combiner stream.
- public void addDynamicMethod(string $dynamicName, callable $method, string $extension=NULL) - defined in October\Rain\Extension\Extendable. Programmatically adds a method to the extendable class.
- public void addDynamicProperty(string $dynamicName, string $value=NULL) - defined in October\Rain\Extension\Extendable. Programmatically adds a property to the extendable class.
- public void addJs($name, $attributes=array()) - defined in Backend\Classes\VueComponentBase. addJs includes a JavaScript asset to the asset list.
- public void addJsBundle($name, $attributes=array()) - defined in Backend\Classes\VueComponentBase. addJsBundle includes a JS asset to the bundled combiner stream.
- public void addRss($name, $attributes=array()) - defined in Backend\Classes\VueComponentBase. addRss adds an RSS link asset to the asset list. Call $this->makeAssets().
- public void addViewPath(string|array $path) - defined in Backend\Classes\VueComponentBase. addViewPath prepends a path on the available view path locations.
- public mixed asExtension(string $shortName) - defined in October\Rain\Extension\Extendable. Short hand for
getClassExtension()method, except takes the short. - public static void clearExtendedClasses() - defined in October\Rain\Extension\Extendable. Clear the list of extended classes so they will be re-extended.
- public void combineAssets($assets, $localPath='') - defined in Backend\Classes\VueComponentBase. combineAssets runs asset paths through the Asset Combiner.
- public static void extend($callback) - defined in October\Rain\Extension\Extendable.
- public void extendClassWith(string $extensionName) - defined in October\Rain\Extension\Extendable. Dynamically extend a class with a specified behavior.
- public mixed extendableCall(string $name, array $params=NULL) - defined in October\Rain\Extension\Extendable. Magic method for
__call(). - public static mixed extendableCallStatic(string $name, array $params=NULL) - defined in October\Rain\Extension\Extendable. Magic method for
__callStatic(). - public void extendableConstruct() - defined in October\Rain\Extension\Extendable. extendableConstruct should be called as part of the constructor.
- public static void extendableExtendCallback(callable $callback) - defined in October\Rain\Extension\Extendable. extendableExtendCallback is a helper method for
::extend()static method. - public string extendableGet(string $name) - defined in October\Rain\Extension\Extendable. Magic method for
__get(). - public string extendableSet(string $name, string $value) - defined in October\Rain\Extension\Extendable. Magic method for
__set(). - public void flushAssets() - defined in Backend\Classes\VueComponentBase. Disables the use, and subequent broadcast, of assets. This is useful.
- public string getAssetPath(string $fileName, string $assetPath=NULL) - defined in Backend\Classes\VueComponentBase. Locates a file based on it's definition. If the file starts with.
- public array getAssetPaths() - defined in Backend\Classes\VueComponentBase. Returns an array of all registered asset paths.
- public mixed getClassExtension(string $name) - defined in October\Rain\Extension\Extendable. Returns a behavior object from an extendable class, example:.
- public array getClassMethods() - defined in October\Rain\Extension\Extendable. Get a list of class methods, extension equivalent of get_class_methods().
- public void getDependencies() - defined in Backend\Classes\VueComponentBase.
- public array getDynamicProperties() - defined in October\Rain\Extension\Extendable. Returns all dynamic properties and their values.
- public void getSubcomponents() - defined in Backend\Classes\VueComponentBase.
- public string getViewPath(string $fileName, mixed $viewPath=NULL) - defined in Backend\Classes\VueComponentBase. getViewPath locates a file based on its definition. The file name can be prefixed.
- public array getViewPaths() - defined in Backend\Classes\VueComponentBase. getViewPaths returns the active view path locations.
- public string guessViewPath(string $suffix='', bool $isPublic=false) - defined in Backend\Classes\VueComponentBase. guessViewPath guesses the package path for the called class.
- public string guessViewPathFrom(string $class, string $suffix='', bool $isPublic=false) - defined in Backend\Classes\VueComponentBase. guessViewPathFrom guesses the package path from a specified class.
- public void hasAssetsDefined() - defined in Backend\Classes\VueComponentBase. hasAssetsDefined returns true if assets any have been added.
- public boolean isClassExtendedWith(string $name) - defined in October\Rain\Extension\Extendable. Check if extendable class is extended with a behavior object.
- public string makeAssets(string $type=NULL) - defined in Backend\Classes\VueComponentBase. Outputs
<link>and<script>tags to load assets previously added with addJs and addCss method calls. - public string makeFileContents(string $filePath, array $extraParams=array()) - defined in Backend\Classes\VueComponentBase. makeFileContents includes a file path using output buffering.
- public mixed makeLayout(string $name=NULL, array $params=array(), bool $throwException=true) - defined in Backend\Classes\VueComponentBase. makeLayout renders a layout.
- public string makeLayoutPartial(string $partial, array $params=array()) - defined in Backend\Classes\VueComponentBase. makeLayoutPartial renders a layout partial.
- public mixed makePartial(string $partial, array $params=array(), bool $throwException=true) - defined in Backend\Classes\VueComponentBase. makePartial renders a partial file contents located in the views folder.
- public string makeView(string $view) - defined in Backend\Classes\VueComponentBase. 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\VueComponentBase. makeViewContent renders supplied contents inside a layout.
- public boolean methodExists(string $name) - defined in October\Rain\Extension\Extendable. Checks if a method exists, extension equivalent of method_exists().
- public boolean propertyExists(string $name) - defined in October\Rain\Extension\Extendable. Checks if a property exists, extension equivalent of
property_exists(). - public void render() - defined in Backend\Classes\VueComponentBase. Renders the default component partial.
- public void renderSubcomponent($name) - defined in Backend\Classes\VueComponentBase.
Protected methods
protected void loadAssets()
Adds component specific asset files. Use $this->addJs() and $this->addCss() to register new assets to include on the page. The default component script and CSS file are loaded automatically.
protected void loadDependencyAssets()
Adds dependency assets required for the component. This method is called before the component's default resources are loaded. Use $this->addJs() and $this->addCss() to register new assets to include on the page.
protected void prepareVars()
Prepares variables required by the component's partials
protected void registerSubcomponents()
Show inherited protected methods
Inherited protected methods
- protected void combineBundledAssets($type) - defined in Backend\Classes\VueComponentBase. combineBundledAssets spins over every bundle definition and combines them to an asset.
- protected boolean extendableIsAccessible(mixed $class, string $propertyName) - defined in October\Rain\Extension\Extendable. Checks if a property is accessible, property equivalent of
is_callable(). - protected void extensionExtractMethods(string $extensionName, object $extensionObject) - defined in October\Rain\Extension\Extendable. Extracts the available methods from a behavior and adds it to the.
- protected string getAssetEntryBuildPath(array $asset) - defined in Backend\Classes\VueComponentBase. Internal helper, attaches a build code to an asset path.
- protected string getAssetScheme(string $asset) - defined in Backend\Classes\VueComponentBase. Internal helper, get asset scheme.
- protected void getComponentBaseName() - defined in Backend\Classes\VueComponentBase.
- protected void getLocalPath($relativePath) - defined in Backend\Classes\VueComponentBase. getLocalPath converts a relative path to a local path.
- protected void handleViewException($e, $obLevel) - defined in Backend\Classes\VueComponentBase. handleViewException handles a view exception.
- protected void loadDefaultAssets() - defined in Backend\Classes\VueComponentBase.
- protected void registerSubcomponent(string $name) - defined in Backend\Classes\VueComponentBase. Adds a subcomponent.
- protected void removeDuplicates() - defined in Backend\Classes\VueComponentBase. Removes duplicate assets from the entire collection.
- protected void renderAssetAttributes($type, $asset) - defined in Backend\Classes\VueComponentBase. renderAssetAttributes takes an asset definition and returns the necessary HTML output.