-
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
- Classes
- ControllerBehavior
Backend\Classes\ControllerBehavior
Extends:
Controller Behavior base class
Public properties
public string $assetPath
Specifies a path to the asset directory.
public array $vars
vars is a list of variables to pass to the page
public string $layout
layout to use for the view
public bool $suppressLayout
suppressLayout prevents the use of a layout
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.
Protected properties
protected object $config
Supplied configuration.
protected Backend\Classes\Controller $controller
Reference to the back end controller.
protected array $requiredProperties
Properties that must exist in the controller using this behavior.
protected array $actions
Visible actions in context of the controller. Only takes effect if it is an array
protected array $assets
Collection of assets to display in the layout.
protected array $assetBundles
Collection of combined and prioritized assets.
protected string $configPath
Specifies a path to the config directory.
protected string|array $viewPath
viewPath specifies a path to the views directory
protected string $layoutPath
layoutPath specifies a path to the layout directory
Show inherited protected properties
Inherited protected properties
- 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.
Public methods
public void __construct($controller)
Constructor.
Parameters
- $controller
public void addCss($name, $attributes=array())
addCss includes a StyleSheet asset to the asset list
Parameters
- $name
- $attributes
public void addCssBundle($name, $attributes=array())
addCssBundle includes a CSS asset to the bundled combiner stream
Parameters
- $name
- $attributes
public void addJs($name, $attributes=array())
addJs includes a JavaScript asset to the asset list
Parameters
- $name
- $attributes
public void addJsBundle($name, $attributes=array())
addJsBundle includes a JS asset to the bundled combiner stream
Parameters
- $name
- $attributes
public void addRss($name, $attributes=array())
addRss adds an RSS link asset to the asset list. Call $this->makeAssets() in a view to output corresponding markup.
Parameters
- $name
- $attributes
public void addViewPath(string|array $path)
addViewPath prepends a path on the available view path locations
Parameters
- string|array $path
public void combineAssets($assets, $localPath='')
combineAssets runs asset paths through the Asset Combiner
Parameters
- $assets
- $localPath
public void flushAssets()
Disables the use, and subequent broadcast, of assets. This is useful to call during an AJAX request to speed things up. This method works by specifically targeting the hasAssetsDefined method.
public string getAssetPath(string $fileName, string $assetPath=NULL)
Locates a file based on it's definition. If the file starts with a forward slash, it will be returned in context of the application public path, otherwise it will be returned in context of the asset path.
Parameters
- string $fileName - File to load.
- string $assetPath - Explicitly define an asset path.
public array getAssetPaths()
Returns an array of all registered asset paths.
public string getConfig(string $name=NULL, mixed $default=NULL)
Safe accessor for configuration values.
Parameters
- string $name - Config name, supports array names like "field[key]"
- mixed $default - Default value if nothing is found
public string getConfigPath(string $fileName, mixed $configPath=NULL)
Locates a file based on it's definition. If the file starts with the ~ symbol it will be returned in context of the application base path, otherwise it will be returned in context of the config path.
Parameters
- string $fileName - File to load.
- mixed $configPath - Explicitly define a config path.
public string getViewPath(string $fileName, mixed $viewPath=NULL)
getViewPath locates a file based on its definition. The file name can be prefixed with a symbol (~|$) to return in context of the application or plugin base path, otherwise it will be returned in context of this object view path.
Parameters
- string $fileName - File to load.
- mixed $viewPath - Explicitly define a view path.
public array getViewPaths()
getViewPaths returns the active view path locations
public string guessConfigPath(string $suffix='')
Guess the package path for the called class.
Parameters
- string $suffix - An extra path to attach to the end
public string guessConfigPathFrom(string $class, string $suffix='')
Guess the package path from a specified class.
Parameters
- string $class - Class to guess path from.
- string $suffix - An extra path to attach to the end
public string guessViewPath(string $suffix='', bool $isPublic=false)
guessViewPath guesses the package path for the called class
Parameters
- string $suffix - An extra path to attach to the end
- bool $isPublic - Returns public path instead of an absolute one
public string guessViewPathFrom(string $class, string $suffix='', bool $isPublic=false)
guessViewPathFrom guesses the package path from a specified class
Parameters
- string $class - Class to guess path from.
- string $suffix - An extra path to attach to the end
- bool $isPublic - Returns public path instead of an absolute one
public void hasAssetsDefined()
hasAssetsDefined returns true if assets any have been added
public string localMakeFileContents(string $filePath, array $extraParams=array())
makeFileContents includes a file path using output buffering
Parameters
- string $filePath - Absolute path to the view file.
- array $extraParams - Parameters that should be available to the view.
public string makeAssets(string $type=NULL)
Outputs <link>
and <script>
tags to load assets previously added with addJs and addCss method calls
Parameters
- string $type - Return an asset collection of a given type (css, rss, js) or null for all.
public object makeConfig(array $configFile=array(), array $requiredConfig=array())
Reads the contents of the supplied file and applies it to this object.
Parameters
- array $configFile
- array $requiredConfig
public stdClass makeConfigFromArray(array $configArray=array())
Makes a config object from an array, making the first level keys properties of a new object.
Parameters
- array $configArray - Config array.
public string makeFileContents(string $filePath, array $extraParams=array())
Makes all views in context of the controller, not the behavior.
Parameters
- string $filePath - Absolute path to the view file.
- array $extraParams - Parameters that should be available to the view.
public Backend\Classes\FormWidgetBase makeFormWidget(string $class, mixed $fieldConfig=array(), array $widgetConfig=array())
Makes a form widget object with the supplied form field and widget configuration.
Parameters
- string $class - Widget class name
- mixed $fieldConfig - A field name, an array of config or a FormField object.
- array $widgetConfig - An array of config.
public mixed makeLayout(string $name=NULL, array $params=array(), bool $throwException=true)
makeLayout renders a layout
Parameters
- string $name - Specifies the layout name. If this parameter is omitted, the $layout property will be used.
- array $params - Parameter variables to pass to the view.
- bool $throwException - Throw an exception if the layout is not found
public string makeLayoutPartial(string $partial, array $params=array())
makeLayoutPartial renders a layout partial
Parameters
- string $partial - The view to load.
- array $params - Parameter variables to pass to the view.
public mixed makePartial(string $partial, array $params=array(), bool $throwException=true)
makePartial renders a partial file contents located in the views folder
Parameters
- string $partial - The view to load.
- array $params - Parameter variables to pass to the view.
- bool $throwException - Throw an exception if the partial is not found.
public string makeView(string $view)
makeView loads a view with the name specified. Applies layout if its name is provided by the parent object. The view file must be situated in the views directory, and has the extension "htm"
Parameters
- string $view - Specifies the view name, without extension. Eg: "index".
public string makeViewContent(string $contents, string $layout=NULL)
makeViewContent renders supplied contents inside a layout
Parameters
- string $contents - The inner contents as a string.
- string $layout - Specifies the layout name.
public Backend\Classes\WidgetBase makeWidget(string $class, array $widgetConfig=array())
Makes a widget object with the supplied configuration file.
Parameters
- string $class - Widget class name
- array $widgetConfig - An array of config.
public stdClass mergeConfig(mixed $configA, mixed $configB)
Merges two configuration sources, either prepared or not, and returns them as a single configuration object.
Parameters
- mixed $configA
- mixed $configB
public void resetSession()
Resets all session data related to this widget.
public void setConfig(mixed $config, array $required=array())
Sets the configuration values
Parameters
- mixed $config - Config object or array
- array $required - Required config items
Inherited public methods
- 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 static void getCalledExtensionClass() - defined in October\Rain\Extension\ExtensionBase.
Protected methods
protected void combineBundledAssets($type)
combineBundledAssets spins over every bundle definition and combines them to an asset
Parameters
- $type
protected bool controllerMethodExists(string $methodName)
Returns true in case if a specified method exists in the extended controller.
Parameters
- string $methodName - Specifies the method name
protected string getAssetEntryBuildPath(array $asset)
Internal helper, attaches a build code to an asset path
Parameters
- array $asset - Stored asset array
protected string getAssetScheme(string $asset)
Internal helper, get asset scheme
Parameters
- string $asset - Specifies a path (URL) to the asset.
protected void getLocalPath($relativePath)
getLocalPath converts a relative path to a local path
Parameters
- $relativePath
protected string getSession(string $key=NULL, string $default=NULL)
Retrieves a widget related key/value pair from session data.
Parameters
- string $key - Unique key for the data store.
- string $default - A default value to use when value is not found.
protected void handleViewException($e, $obLevel)
handleViewException handles a view exception
Parameters
- $e
- $obLevel
protected void hideAction(mixed $methodName)
Protects a public method from being available as an controller action. These methods could be defined in a controller to override a behavior default action. Such methods should be defined as public, to allow the behavior object to access it. By default public methods of a controller are considered as actions. To prevent this occurrence, methods should be hidden by using this method.
Parameters
- mixed $methodName - Specifies a method name.
protected string makeSessionId()
Returns a unique session identifier for this widget and controller action.
protected void putSession(string $key, string $value)
Saves a widget related key/value pair in to session data.
Parameters
- string $key - Unique key for the data store.
- string $value - The value to store.
protected void removeDuplicates()
Removes duplicate assets from the entire collection.
protected void renderAssetAttributes($type, $asset)
renderAssetAttributes takes an asset definition and returns the necessary HTML output
Parameters
- $type
- $asset
Show inherited protected methods
Inherited protected methods
- protected void extensionHideField($name) - defined in October\Rain\Extension\ExtensionBase.
- protected void extensionHideMethod($name) - defined in October\Rain\Extension\ExtensionBase.