-
Backend
-
Behaviors
-
FormController
-
ImportExportController
-
ListController
-
RelationController
- FormController
- ImportExportController
- ListController
- RelationController
- ReorderController
- UserPreferencesModel
-
-
Classes
-
Dashboard
-
NavigationManager
-
WidgetManager
- AuthManager
- BackendController
- Controller
- ControllerBehavior
- DashboardManager
- DashboardWidgetBase
- FilterScope
- FilterWidgetBase
- FormField
- FormTabs
- FormWidgetBase
- ListColumn
- LoginCustomization
- MainMenuItem
- NavigationManager
- ReportDataSourceBase
- ReportDataSourceManager
- ReportWidgetBase
- RoleManager
- RolePermission
- SettingsController
- SideMenuItem
- Skin
- StaticReportWidgetContainer
- VueComponentBase
- WidgetBase
- WidgetManager
- WildcardController
-
-
Controllers
-
Database
-
Facades
-
FilterWidgets
-
FormWidgets
-
Helpers
-
Models
-
BrandSetting
-
ExportModel
-
ImportModel
- AccessLog
- BrandSetting
- Dashboard
- EditorSetting
- ExportModel
- ImportModel
- Preference
- ReportDataCache
- User
- UserGroup
- UserPreference
- UserPreferenceModel
- UserRole
- UserThrottle
-
-
ReportWidgets
-
Skins
-
Traits
-
VueComponents
-
Widgets
-
Filter
-
Form
-
Lists
-
Table
- Filter
- Form
- Lists
- ListStructure
- ReportContainer
- RoleImpersonator
- Search
- SiteSwitcher
- Table
- Toolbar
-
- ServiceProvider
-
-
Cms
-
Classes
-
Controller
-
EditorExtension
-
Layout
-
Page
-
Partial
-
Theme
- AjaxResponse
- Asset
- CmsCompoundObject
- CmsController
- CmsDemoTrafficDataGenerator
- CmsException
- CmsObject
- CmsObjectCache
- CmsObjectCollection
- CmsReportDataSource
- CmsStatusDataSource
- CodeBase
- CodeParser
- ComponentBase
- ComponentBehavior
- ComponentHelpers
- ComponentManager
- ComponentModuleBase
- ComponentPartial
- Content
- Controller
- EditorExtension
- Layout
- LayoutCode
- Meta
- Page
- PageCode
- PageManager
- Partial
- PartialCode
- PartialStack
- PartialWatcher
- Router
- Snippet
- SnippetManager
- Theme
- ThemeManager
- ThisVariable
- TrafficLogger
-
-
Components
-
Console
-
Controllers
-
Database
-
Facades
-
FormWidgets
-
Helpers
-
Models
-
ReportWidgets
-
Traits
-
Twig
- AjaxPartialTokenParser
- ComponentNode
- ComponentTokenParser
- ContentNode
- ContentTokenParser
- DebugExtension
- DefaultNode
- DefaultTokenParser
- Extension
- FlashNode
- FlashTokenParser
- FrameworkNode
- FrameworkTokenParser
- GetAttrAdjuster
- GetAttrNode
- Loader
- MetaNode
- MetaTokenParser
- PageNode
- PageTokenParser
- PartialNode
- PartialTokenParser
- PlaceholderNode
- PlaceholderTokenParser
- PutNode
- PutTokenParser
- ScriptsNode
- ScriptsTokenParser
- StylesNode
- StylesTokenParser
-
VueComponents
-
Widgets
- ServiceProvider
-
-
Editor
-
Behaviors
-
Classes
-
Controllers
-
Traits
-
VueComponents
- ServiceProvider
-
-
Media
-
Classes
-
Controllers
-
FormWidgets
-
Helpers
-
Twig
-
Widgets
- ServiceProvider
-
-
System
-
Behaviors
-
Classes
-
PresetManager
-
SiteManager
-
UiManager
-
UpdateManager
- AppBase
- CombineAssets
- DependencyResolver
- DriverBehavior
- ErrorHandler
- MailManager
- ManifestCache
- MarkupExtensionItem
- MarkupManager
- ModelBehavior
- PagerElement
- PluginBase
- PluginManager
- PresetManager
- ProductDetail
- RateLimiter
- ResizeImageItem
- ResizeImages
- SettingsManager
- SettingsMenuItem
- SiteManager
- SystemController
- SystemReportDataSource
- UiElement
- UiManager
- UpdateManager
- VersionManager
-
-
Console
- ComposerScript
- OctoberAbout
- OctoberDown
- OctoberFresh
- OctoberMigrate
- OctoberMirror
- OctoberOptimize
- OctoberPasswd
- OctoberUp
- OctoberUpdate
- OctoberUtil
- OctoberUtilCommands
- OctoberUtilPatches
- OctoberUtilRefitLang
- PluginCheck
- PluginDisable
- PluginEnable
- PluginInstall
- PluginList
- PluginRefresh
- PluginRemove
- PluginSeed
- PluginTest
- ProjectSync
-
Controllers
-
Database
-
Facades
-
Helpers
-
Middleware
-
Models
-
ReportWidgets
-
Traits
-
Twig
-
Widgets
- ServiceProvider
-
-
Tailor
-
Behaviors
-
Classes
-
Blueprint
-
BlueprintIndexer
-
EditorExtension
-
Relations
-
SchemaBuilder
-
Scopes
- Blueprint
- BlueprintCollection
- BlueprintErrorData
- BlueprintException
- BlueprintIndexer
- BlueprintModel
- BlueprintVerifier
- ComponentVariable
- ContentFieldBase
- EditorExtension
- FieldManager
- Fieldset
- NavigationItem
- PermissionItem
- RecordIndexer
- SchemaBuilder
- SchemaPruner
-
-
Components
-
Console
-
ContentFields
-
Controllers
-
Models
-
EntryRecord
-
GlobalRecord
-
RecordImport
- ContentSchema
- EntryRecord
- GlobalRecord
- NestedFormItem
- PreviewToken
- RecordExport
- RecordImport
- RepeaterItem
-
-
Traits
-
VueComponents
- ServiceProvider
-
-
Events
-
backend
-
ajax
-
brand
-
files
-
filter
-
form
-
list
-
menu
-
page
-
roles
-
site
-
user
-
-
cms
-
ajax
-
block
-
combiner
-
component
-
internalTrafficStatistics
-
object
-
page
-
pageLookup
-
resizer
-
router
-
sitePicker
-
template
-
theme
- extendTwig
-
-
deferredBinding
-
editor
-
extension
-
-
exception
-
halcyon
-
datasource
-
-
mailer
-
media
-
model
-
auth
-
filter
-
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
-
-
/docs/api/model/afterboot
-
/docs/api/model/aftercreate
-
/docs/api/model/afterdelete
-
/docs/api/model/afterfetch
-
/docs/api/model/afterinit
- afterRelation
- afterRestore
-
/docs/api/model/aftersave
- afterTrash
-
/docs/api/model/afterupdate
- afterValidate
-
/docs/api/model/beforecreate
-
/docs/api/model/beforedelete
-
/docs/api/model/beforefetch
- beforeGetAttribute
- beforeRelation
- beforeReplicate
- beforeRestore
-
/docs/api/model/beforesave
- beforeSetAttribute
-
/docs/api/model/beforeupdate
- beforeValidate
- extendBlueprint
- getAttribute
- newInstance
- saveInternal
- setAttribute
-
-
pages
-
snippet
-
-
site
-
system
-
assets
- beforeAddAsset
-
/docs/api/system/assets/beforebundleasset
-
console
-
mirror
-
-
mail
-
reportwidgets
-
resizer
-
settings
-
site
-
updater
- extendConfigFile
- extendTwig
-
-
tailor
-
user
-
-
Library
-
Argon
-
Assetic
-
Asset
-
Cache
-
Exception
-
Factory
-
Filter
-
Traits
-
Util
- README
- AsseticServiceProvider
- AssetManager
- AssetWriter
- Combiner
- FilterManager
-
-
Auth
-
Combine
-
Composer
-
Config
-
Database
-
Attach
-
Concerns
-
Connections
-
Connectors
-
Factories
-
Models
-
Relations
-
Schema
-
Scopes
-
Traits
-
Updates
- README
- Builder
- Collection
- DatabaseServiceProvider
- Dongle
- ExpandoModel
- MigrationServiceProvider
- Model
- ModelBehavior
- ModelException
- MorphPivot
- NestedTreeScope
- Pivot
- QueryBuilder
- Replicator
- SortableScope
- TreeCollection
- Updater
-
-
Element
-
Filter
-
Form
-
Lists
-
Navigation
- ElementBase
- ElementHolder
-
-
Events
-
Exception
-
Extension
-
Filesystem
-
Flash
-
Foundation
-
Bootstrap
-
Console
-
Exception
-
Http
-
Middleware
- Kernel
-
-
Providers
- Application
-
-
Halcyon
-
Concerns
-
Datasource
-
Exception
-
Processors
-
Traits
- README
- Builder
- Collection
- HalcyonServiceProvider
- Model
-
-
Html
-
Mail
-
Network
-
Parse
-
Resize
-
Router
-
Scaffold
-
Support
-
Debug
-
Facades
-
Traits
- README
- Arr
- ClassLoader
- Collection
- Facade
- ModuleServiceProvider
- SafeCollection
- ServiceProvider
- Singleton
- Str
-
-
Translation
-
Validation
-
- Documentation
- API
- Cms
- Classes
- ComponentModuleBase
Cms\Classes\ComponentModuleBase
Overview
ComponentModuleBase is an internal base class used by module components
Extends
Implements
- Stringable
- October\Contracts\Twig\CallsAnyMethod
Public Properties
There are no public properties in the class.
Show inherited public properties
Inherited Public Properties
- $id - is a unique identifier for this component. (defined in Cms\Classes\ComponentBase)
- $alias - used for this component. (defined in Cms\Classes\ComponentBase)
- $name - as a class name or class alias used in the component declaration in a template. (defined in Cms\Classes\ComponentBase)
- $isHidden - determines whether the component is hidden from the backend UI. (defined in Cms\Classes\ComponentBase)
- $pluginIcon - of the plugin that defines the component. (defined in Cms\Classes\ComponentBase)
- $componentCssClass - name for the backend page/layout component list. (defined in Cms\Classes\ComponentBase)
- $inspectorEnabled - determines whether Inspector can be used with the component. (defined in Cms\Classes\ComponentBase)
- $implement - extensions for this class. (defined in October\Rain\Extension\Extendable)
- $assetPath - specifies the relative path to the asset directory. (defined in Cms\Classes\ComponentBase)
- $assetUrlPath - specifies the public path to the asset directory. (defined in Cms\Classes\ComponentBase)
Protected Properties
There are no protected properties in the class.
Show inherited protected properties
Inherited Protected Properties
- $dirName - specifies the component directory name. (defined in Cms\Classes\ComponentBase)
- $controller - object. (defined in Cms\Classes\ComponentBase)
- $page - object object. (defined in Cms\Classes\ComponentBase)
- $externalPropertyNames - is a collection of external property names used by this component. (defined in Cms\Classes\ComponentBase)
- $componentGetPathCache - (defined in Cms\Classes\ComponentBase)
- $extensionData - contains class reflection information, including behaviors. (defined in October\Rain\Extension\Extendable)
- $extendableStaticMethods - is a collection of static methods used by behaviors. (defined in October\Rain\Extension\Extendable)
- $extendableGuardProperties - indicates if dynamic properties can be created. (defined in October\Rain\Extension\Extendable)
- $assets - Collection of assets to display in the layout. (defined in Cms\Classes\ComponentBase)
- $assetBundles - Collection of combined and prioritized assets. (defined in Cms\Classes\ComponentBase)
- $assetDefaults - is the default attributes for assets. (defined in Cms\Classes\ComponentBase)
- $emitterSingleEventCollection - of events to be fired once only. (defined in Cms\Classes\ComponentBase)
- $emitterEventCollection - of all registered events. (defined in Cms\Classes\ComponentBase)
- $emitterEventSorted - collection. (defined in Cms\Classes\ComponentBase)
- $dependencyResolver - for AJAX handlers and controller actions. (defined in Cms\Classes\ComponentBase)
- $properties - contains the object property values. (defined in Cms\Classes\ComponentBase)
Public Methods
public getPath()
public getPath(): void
getPath returns the absolute component path
Inherited Public Methods
- __call() - dynamically handles calls into the controller instance. (defined in Cms\Classes\ComponentBase)
- __callStatic() - calls an undefined static method. (defined in October\Rain\Extension\Extendable)
- __construct() - the component, which takes in the page or layout code section object. (defined in Cms\Classes\ComponentBase)
- __get() - an undefined property. (defined in October\Rain\Extension\Extendable)
- __set() - an undefined property. (defined in October\Rain\Extension\Extendable)
- __sleep() - prepare the object for serialization. (defined in October\Rain\Extension\Extendable)
- __toString() - returns the component's alias, used by SELF. (defined in Cms\Classes\ComponentBase)
- __wakeup() - when a model is being unserialized, check if it needs to be booted. (defined in October\Rain\Extension\Extendable)
- addCss() - includes a StyleSheet asset to the asset list. (defined in Cms\Classes\ComponentBase)
- addCssBundle() - includes a CSS asset to the bundled combiner pipeline. (defined in Cms\Classes\ComponentBase)
- addDynamicMethod() - programmatically adds a method to the extendable class. (defined in October\Rain\Extension\Extendable)
- addDynamicProperty() - programmatically adds a property to the extendable class. (defined in October\Rain\Extension\Extendable)
- addJs() - includes a JavaScript asset to the asset list. (defined in Cms\Classes\ComponentBase)
- addJsBundle() - includes a JS asset to the bundled combiner pipeline. (defined in Cms\Classes\ComponentBase)
- addRss() - adds an RSS link asset to the asset list. Call $this->makeAssets(). (defined in Cms\Classes\ComponentBase)
- asExtension() - is short hand for
getClassExtension()method, except takes the short. (defined in October\Rain\Extension\Extendable) - bindEvent() - creates a new event binding. (defined in Cms\Classes\ComponentBase)
- bindEventOnce() - creates a new event binding that fires once only. (defined in Cms\Classes\ComponentBase)
- clearExtendedClasses() - (defined in October\Rain\Extension\Extendable)
- combineAssets() - runs asset paths through the Asset Combiner. (defined in Cms\Classes\ComponentBase)
- componentDetails() - returns information about this component, including name and description. (defined in Cms\Classes\ComponentBase)
- defineProperties() - used by this class. (defined in Cms\Classes\ComponentBase)
- extend() - this class with a closure. (defined in October\Rain\Extension\Extendable)
- extendClassWith() - dynamically extends a class with a specified behavior. (defined in October\Rain\Extension\Extendable)
- extendableCall() - magic method for
__call(). (defined in October\Rain\Extension\Extendable) - extendableCallStatic() - magic method for
__callStatic(). (defined in October\Rain\Extension\Extendable) - extendableConstruct() - should be called as part of the constructor. (defined in October\Rain\Extension\Extendable)
- extendableDestruct() - should be called when serializing the object. (defined in October\Rain\Extension\Extendable)
- extendableExtendCallback() - is a helper method for
::extend()static method. (defined in October\Rain\Extension\Extendable) - extendableGet() - magic method for
__get(). (defined in October\Rain\Extension\Extendable) - extendableSet() - magic method for
__set(). (defined in October\Rain\Extension\Extendable) - fireEvent() - and call the listeners. (defined in Cms\Classes\ComponentBase)
- fireSystemEvent() - fires a combination of local and global events. The first segment is removed. (defined in Cms\Classes\ComponentBase)
- fireViewEvent() - is a special event function used for extending within view files, (defined in Cms\Classes\ComponentBase)
- flushAssets() - disables the use, and subsequent broadcast, of assets. This is useful. (defined in Cms\Classes\ComponentBase)
- getAssetPath() - locates a file based on it's definition. If the file starts with. (defined in Cms\Classes\ComponentBase)
- getAssetPaths() - returns an array of all registered asset paths. (defined in Cms\Classes\ComponentBase)
- getClassExtension() - returns a behavior object from an extendable class, example:. (defined in October\Rain\Extension\Extendable)
- getClassMethodAsReflector() - (defined in October\Rain\Extension\Extendable)
- getClassMethods() - gets a list of class methods, extension equivalent of get_class_methods(). (defined in October\Rain\Extension\Extendable)
- getController() - returns the controller using this component. (defined in Cms\Classes\ComponentBase)
- getDynamicProperties() - returns all dynamic properties and their values. (defined in October\Rain\Extension\Extendable)
- getProperties() - returns all properties. (defined in Cms\Classes\ComponentBase)
- getPropertyOptions() - returns options for multi-option properties (drop-downs, etc.). (defined in Cms\Classes\ComponentBase)
- hasAssetsDefined() - returns true if assets any have been added. (defined in Cms\Classes\ComponentBase)
- implementClassWith() - will implement an extension using non-interference and should. (defined in October\Rain\Extension\Extendable)
- init() - is executed when this component is first initialized, before AJAX requests. (defined in Cms\Classes\ComponentBase)
- isClassExtendedWith() - checks if extendable class is extended with a behavior object. (defined in October\Rain\Extension\Extendable)
- isClassInstanceOf() - checks if the class implements the supplied interface methods. (defined in October\Rain\Extension\Extendable)
- makeAssets() - outputs
<link>and<script>tags to load assets previously added with addJs and addCss method calls. (defined in Cms\Classes\ComponentBase) - makePrimaryAccessor() - returns the PHP object variable for the Twig view layer. (defined in Cms\Classes\ComponentBase)
- methodExists() - checks if a method exists, extension equivalent of method_exists(). (defined in October\Rain\Extension\Extendable)
- onRender() - is executed when this component is rendered on a page or layout. (defined in Cms\Classes\ComponentBase)
- onRun() - is executed when this component is bound to a page or layout, part of. (defined in Cms\Classes\ComponentBase)
- paramName() - returns the external property name when the property value is a routing. (defined in Cms\Classes\ComponentBase)
- property() - returns a defined property value or default if one is not set. (defined in Cms\Classes\ComponentBase)
- propertyExists() - checks if a property exists, extension equivalent of
property_exists(). (defined in October\Rain\Extension\Extendable) - propertyName() - returns the external property name when the property value is an external. (defined in Cms\Classes\ComponentBase)
- renderPartial() - renders a requested partial in context of this component, (defined in Cms\Classes\ComponentBase)
- runAjaxHandler() - executes the event cycle when running an AJAX handler. (defined in Cms\Classes\ComponentBase)
- runLifeCycle() - executes the life cycle for the component. (defined in Cms\Classes\ComponentBase)
- setExternalPropertyName() - sets an external property name. (defined in Cms\Classes\ComponentBase)
- setExternalPropertyNames() - sets names used by external properties. (defined in Cms\Classes\ComponentBase)
- setProperties() - for multiple values. (defined in Cms\Classes\ComponentBase)
- setProperty() - for a single value. (defined in Cms\Classes\ComponentBase)
- unbindEvent() - destroys an event binding. (defined in Cms\Classes\ComponentBase)
- validateProperties() - against the defined properties of the class. (defined in Cms\Classes\ComponentBase)
Protected Methods
protected getComponentAssetUrlPath()
protected getComponentAssetUrlPath(): string
getComponentAssetUrlPath returns the public directory for the component assets
Show inherited protected methods
Inherited Protected Methods
- combineBundledAssets() - spins over every bundle definition and combines them to an asset. (defined in Cms\Classes\ComponentBase)
- emitterEventSortEvents() - sorts the listeners for a given event by priority. (defined in Cms\Classes\ComponentBase)
- extendableIsAccessible() - checks if a property is accessible, property equivalent. (defined in October\Rain\Extension\Extendable)
- extendableIsSettingDynamicProperty() - returns true if a dynamic. (defined in October\Rain\Extension\Extendable)
- extensionExtractImplements() - will return classes to implement. (defined in October\Rain\Extension\Extendable)
- extensionExtractMethods() - extracts the available methods from a behavior and adds it. (defined in October\Rain\Extension\Extendable)
- getAssetEntryBuildPath() - Internal helper, attaches a build code to an asset path. (defined in Cms\Classes\ComponentBase)
- getAssetScheme() - is an internal helper to get the asset scheme. (defined in Cms\Classes\ComponentBase)
- getComponentAssetRelativePath() - (defined in Cms\Classes\ComponentBase)
- getExtendableMethodFromDynamicMethods() - (defined in October\Rain\Extension\Extendable)
- getExtendableMethodFromExtensions() - (defined in October\Rain\Extension\Extendable)
- getLocalPath() - converts a relative path to a local path. (defined in Cms\Classes\ComponentBase)
- makeCallMethod() - will prepare method args with DI and call the method. (defined in Cms\Classes\ComponentBase)
- processAssetAttributes() - (defined in Cms\Classes\ComponentBase)
- removeDuplicateAssets() - removes duplicate and global assets from the entire collection. (defined in Cms\Classes\ComponentBase)
- renderAssetAttributes() - takes an asset definition and returns the necessary HTML output. (defined in Cms\Classes\ComponentBase)