Dashboard\Classes\VueReportWidgetBase
Overview
VueReportWidgetBase is a base class for Vue-based dashboard widgets
Extends
Public Properties
public string $alias
alias defined for this widget.
Show inherited public properties
Inherited Public Properties
- $implement - extensions for this class. (defined in October\Rain\Extension\Extendable)
- $vars - is a list of variables to pass to the page. (defined in System\Classes\VueComponentBase)
- $layout - to use for the view. (defined in System\Classes\VueComponentBase)
- $suppressLayout - prevents the use of a layout. (defined in System\Classes\VueComponentBase)
- $assetPath - specifies the relative path to the asset directory. (defined in System\Classes\VueComponentBase)
- $assetUrlPath - specifies the public path to the asset directory. (defined in System\Classes\VueComponentBase)
Protected Properties
protected DashReport $dashReport
dashReport object containing general dash report information.
protected string $defaultAlias
defaultAlias to identify this widget.
protected array $properties
properties contains the object property values.
Show inherited protected properties
Inherited Protected Properties
- $controller - object. (defined in System\Classes\VueComponentBase)
- $componentName - is the Vue component tag name. (defined in System\Classes\VueComponentBase)
- $require - Vue component class names for this component. (defined in System\Classes\VueComponentBase)
- $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)
- $viewPath - specifies a path to the views directory. (defined in System\Classes\VueComponentBase)
- $layoutPath - specifies a path to the layout directory. (defined in System\Classes\VueComponentBase)
- $viewPathGuessCache - remembers path guesses for performance. (defined in System\Classes\VueComponentBase)
- $assets - Collection of assets to display in the layout. (defined in System\Classes\VueComponentBase)
- $assetBundles - Collection of combined and prioritized assets. (defined in System\Classes\VueComponentBase)
- $assetDefaults - is the default attributes for assets. (defined in System\Classes\VueComponentBase)
Public Methods
public __construct()
public __construct($controller, $dashReport = null, $properties = []): void
public bindToController()
public bindToController(): void
bindToController binds a widget to the controller for safe use.
public defineProperties()
public defineProperties(): void
defineProperties used by this class. This method should be used as an override in the extended class.
public getData()
public getData($data): mixed
public getProperties()
public getProperties(): array
getProperties returns all properties.
public getPropertyOptions()
public getPropertyOptions(string $property): array
getPropertyOptions returns options for multi-option properties (drop-downs, etc.)
public property()
public property(string $name, ?string $default = null): ?string
property returns a defined property value or default if one is not set.
public runHandler()
public runHandler($widgetConfig, $handlerName, $extraData): mixed
public setProperties()
public setProperties(array $properties): void
setProperties for multiple values
public setProperty()
public setProperty(string $name, mixed $value): void
setProperty for a single value
public validateProperties()
public validateProperties(array $properties): array
validateProperties against the defined properties of the class. This method also sets default properties.
Inherited Public Methods
- __call() - calls an undefined local method. (defined in October\Rain\Extension\Extendable)
- __callStatic() - calls an undefined static method. (defined in October\Rain\Extension\Extendable)
- __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)
- __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 System\Classes\VueComponentBase)
- addCssBundle() - includes a CSS asset to the bundled combiner pipeline. (defined in System\Classes\VueComponentBase)
- 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 System\Classes\VueComponentBase)
- addJsBundle() - includes a JS asset to the bundled combiner pipeline. (defined in System\Classes\VueComponentBase)
- addRss() - adds an RSS link asset to the asset list. Call $this->makeAssets(). (defined in System\Classes\VueComponentBase)
- addViewPath() - prepends a path on the available view path locations. (defined in System\Classes\VueComponentBase)
- asExtension() - is short hand for
getClassExtension()method, except takes the short. (defined in October\Rain\Extension\Extendable) - clearExtendedClasses() - (defined in October\Rain\Extension\Extendable)
- combineAssets() - runs asset paths through the Asset Combiner. (defined in System\Classes\VueComponentBase)
- 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) - flushAssets() - disables the use, and subsequent broadcast, of assets. This is useful. (defined in System\Classes\VueComponentBase)
- getAssetPath() - locates a file based on it's definition. If the file starts with. (defined in System\Classes\VueComponentBase)
- getAssetPaths() - returns an array of all registered asset paths. (defined in System\Classes\VueComponentBase)
- getAssetPathsWithAttributes() - returns an array of all registered asset paths. (defined in System\Classes\VueComponentBase)
- 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)
- getComponentName() - returns the Vue component tag name. (defined in System\Classes\VueComponentBase)
- getDependencies() - (defined in System\Classes\VueComponentBase)
- getDynamicProperties() - returns all dynamic properties and their values. (defined in October\Rain\Extension\Extendable)
- getEsmModulePath() - returns the ESM module path for this component. (defined in System\Classes\VueComponentBase)
- getEsmModules() - returns JS-only ESM modules (no templates). (defined in System\Classes\VueComponentBase)
- getSubcomponentEsmPath() - returns the ESM path for a specific subcomponent. (defined in System\Classes\VueComponentBase)
- getSubcomponentName() - returns the Vue component tag name for a subcomponent. (defined in System\Classes\VueComponentBase)
- getSubcomponents() - (defined in System\Classes\VueComponentBase)
- getViewPath() - locates a file based on its definition. The file name can be prefixed. (defined in System\Classes\VueComponentBase)
- getViewPaths() - returns the active view path locations. (defined in System\Classes\VueComponentBase)
- guessViewPath() - guesses the package path for the called class. (defined in System\Classes\VueComponentBase)
- guessViewPathFrom() - guesses the package path from a specified class, including. (defined in System\Classes\VueComponentBase)
- hasAssetsDefined() - returns true if assets any have been added. (defined in System\Classes\VueComponentBase)
- implementClassWith() - will implement an extension using non-interference and should. (defined in October\Rain\Extension\Extendable)
- 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 System\Classes\VueComponentBase) - makeFileContents() - includes a file path using output buffering. (defined in System\Classes\VueComponentBase)
- makeLayout() - renders a layout. (defined in System\Classes\VueComponentBase)
- makeLayoutPartial() - renders a layout partial. (defined in System\Classes\VueComponentBase)
- makePartial() - renders a partial file contents located in the views folder. (defined in System\Classes\VueComponentBase)
- makeView() - loads a view with the name specified. Applies layout if its name is provided. (defined in System\Classes\VueComponentBase)
- makeViewContent() - renders supplied contents inside a layout. (defined in System\Classes\VueComponentBase)
- methodExists() - checks if a method exists, extension equivalent of method_exists(). (defined in October\Rain\Extension\Extendable)
- propertyExists() - checks if a property exists, extension equivalent of
property_exists(). (defined in October\Rain\Extension\Extendable) - render() - the default component partial. (defined in System\Classes\VueComponentBase)
- renderSubcomponent() - (defined in System\Classes\VueComponentBase)
Protected Methods
Show inherited protected methods
Inherited Protected Methods
- combineBundledAssets() - spins over every bundle definition and combines them to an asset. (defined in System\Classes\VueComponentBase)
- extendableIsAccessible() - checks if a property is accessible, property equivalent. (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() - is an internal marker that returns the asset path. (defined in System\Classes\VueComponentBase)
- getAssetScheme() - is an internal helper to get the asset scheme. (defined in System\Classes\VueComponentBase)
- getComponentBaseName() - (defined in System\Classes\VueComponentBase)
- 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 System\Classes\VueComponentBase)
- handleViewException() - handles a view exception. (defined in System\Classes\VueComponentBase)
- loadAssets() - adds component specific asset files. Use $this->addJs() and. (defined in System\Classes\VueComponentBase)
- loadDefaultAssets() - adds the default CSS file for this component. (defined in System\Classes\VueComponentBase)
- loadDependencyAssets() - adds dependency assets required for the component. (defined in System\Classes\VueComponentBase)
- prepareVars() - required by the component's partials. (defined in System\Classes\VueComponentBase)
- processAssetAttributes() - (defined in System\Classes\VueComponentBase)
- registerEsmModule() - adds a JavaScript-only ESM module (no template). (defined in System\Classes\VueComponentBase)
- registerSubcomponent() - adds a subcomponent. (defined in System\Classes\VueComponentBase)
- registerSubcomponents() - (defined in System\Classes\VueComponentBase)
- removeDuplicateAssets() - removes duplicate and global assets from the entire collection. (defined in System\Classes\VueComponentBase)
- renderAssetAttributes() - takes an asset definition and returns the necessary HTML output. (defined in System\Classes\VueComponentBase)