ReportContainer
Report Container Widget
Creates an area hosting report widgets.
class Backend\Widgets\ReportContainer
extends Backend\Classes\WidgetBaseTraits
| Trait | Description |
|---|---|
AssetMaker
|
Asset Maker Trait Adds asset based methods to a class |
ConfigMaker
|
Config Maker Trait Adds configuration based methods to a class |
ErrorMaker
|
Error Maker Trait
Adds exception based methods to a class, goes well with |
EventEmitter
|
Adds system event related features to any class. |
ExtendableTrait
|
This extension trait is used when access to the underlying base class is not available, such as classes that belong to the foundation framework (Laravel). It is currently used by the Controller and Model classes. |
SessionMaker
|
Session Maker Trait |
ViewMaker
|
View Maker Trait Adds view based methods to a class |
WidgetMaker
|
Widget Maker Trait |
Properties
public
$canAddAndDelete
:
string
= true
Determines whether widgets could be added and deleted.
public
$context
:
string
= "dashboard"
The unique report context name Defines the context where the container is used. Widget settings are saved in a specific context. This allows to have multiple report containers on different pages that have different widgets and widget settings. Context names can contain only Latin letters.
public
$defaultWidgets
:
array
= []
A list of default widgets to load. This structure could be defined in the widget configuration file (for example config_report_container.yaml). Example YAML structure:
defaultWidgets: trafficOverview: class: Winter\GoogleAnalytics\ReportWidgets\TrafficOverview sortOrder: 1 configuration: title: 'Traffic overview' ocWidgetWidth: 12
protected
$defaultAlias
:
mixed
= "reportContainer"
A unique alias to identify this widget.
protected
$reportWidgets
:
array
= []
Collection of all report widgets used by this container.
protected
$reportsDefined
:
bool
= false
Determines if report widgets have been created.
public $alias : string
Defined alias used for this widget.
public $assetPath : string
Specifies a path to the asset directory.
public $config : object
Supplied configuration.
public
$implement
:
string
|
array
|
null
= null
Extensions implemented by this class.
public $layout : string
Layout to use for the view.
public
$suppressLayout
:
bool
= false
Prevents the use of a layout.
public
$vars
:
array
= []
A list of variables to pass to the page.
protected
$assets
:
array
= {"js":[],"css":[],"rss":[]}
Collection of assets to display in the layout.
protected $configPath : string
Specifies a path to the config directory.
protected $controller : Backend\Classes\Controller
Backend controller object.
protected
static
$extendableCallbacks
:
array
= []
Used to extend the constructor of an extendable class. Eg:
Class::extend(function($obj) { })
protected
static
$extendableClassLoader
:
ClassLoader
|
null
= null
Class loader instance.
protected
static
$extendableGuardProperties
:
bool
= true
Indicates if dynamic properties can be created.
protected
static
$extendableStaticMethods
:
array
= []
Collection of static methods used by behaviors.
protected
$extensionData
:
array
= {"extensions":[],"methods":[],"dynamicMethods":[],"dynamicProperties":[]}
Class reflection information, including behaviors.
protected $fatalError : string
Object used for storing a fatal error.
protected $layoutPath : string
Specifies a path to the layout directory.
protected $viewPath : string | array
Specifies a path to the views directory.
Methods
public
__construct ($controller, $configuration = null)
Constructor.
| Property | Type | Description |
|---|---|---|
| $controller | mixed |
mixed
|
| $configuration | mixed |
mixed
|
public addWidget ($widget, $size)
| Property | Type | Description |
|---|---|---|
| $widget | mixed |
mixed
|
| $size | mixed |
mixed
|
public bindToController () : void
Ensure report widgets are registered so they can also be bound to the controller this allows their AJAX features to operate.
public onAddWidget ()
public onLoadAddPopup ()
public onMakeLayoutDefault ()
public onRemoveWidget ()
public onResetWidgets ()
public onSetWidgetOrders ()
public onUpdateWidget ()
public render ()
Renders this widget along with its collection of report widgets.
protected defineReportWidgets ()
Registers the report widgets that will be included in this container.
The chosen widgets are based on the user preferences.
protected findWidgetByAlias ($alias)
| Property | Type | Description |
|---|---|---|
| $alias | mixed |
mixed
|
protected getSystemParametersKey ()
protected getUserPreferencesKey ()
protected getWidgetPropertyConfig ($widget)
| Property | Type | Description |
|---|---|---|
| $widget | mixed |
mixed
|
protected getWidgetPropertyValues ($widget)
| Property | Type | Description |
|---|---|---|
| $widget | mixed |
mixed
|
protected getWidgetsFromUserPreferences ()
protected loadAssets ()
Adds widget specific asset files. Use $this->addJs() and $this->addCss() to register new assets to include on the page.
protected makeReportWidget (string $alias, array $widgetInfo) : array
Makes a single report widget object, returned array index:
- widget: The widget object (Backend\Classes\ReportWidgetBase)
- sortOrder: The current sort order
| Property | Type | Description |
|---|---|---|
| $alias | string |
string
|
| $widgetInfo | array |
array
|
protected removeWidget ($alias)
| Property | Type | Description |
|---|---|---|
| $alias | mixed |
mixed
|
protected resetWidgets ()
protected resetWidgetsUserPreferences ()
protected saveWidgetProperties ($alias, $properties)
| Property | Type | Description |
|---|---|---|
| $alias | mixed |
mixed
|
| $properties | mixed |
mixed
|
protected setWidgetsToUserPreferences ($widgets)
| Property | Type | Description |
|---|---|---|
| $widgets | mixed |
mixed
|
public __call ($name, $params)
| Property | Type | Description |
|---|---|---|
| $name | mixed |
mixed
|
| $params | mixed |
mixed
|
public static __callStatic ($name, $params)
| Property | Type | Description |
|---|---|---|
| $name | mixed |
mixed
|
| $params | mixed |
mixed
|
public __get ($name)
| Property | Type | Description |
|---|---|---|
| $name | mixed |
mixed
|
public __set ($name, $value)
| Property | Type | Description |
|---|---|---|
| $name | mixed |
mixed
|
| $value | mixed |
mixed
|
public
addCss (array | string $name, array $attributes = [])
: void
Adds StyleSheet asset to the asset list. Call $this->makeAssets() in a view to output corresponding markup.
| Property | Type | Description |
|---|---|---|
| $name | array | string |
array | string
Specifies a path (URL) or an array of paths to the stylesheet(s). |
| $attributes | array |
array
Adds extra HTML attributes to the asset link. |
public
addDynamicMethod (string $dynamicName, callable $method, string $extension = null)
Programmatically adds a method to the extendable class
| Property | Type | Description |
|---|---|---|
| $dynamicName | string |
string
|
| $method | callable |
callable
|
| $extension | string |
string
|
public
addDynamicProperty (string $dynamicName, mixed $value = null)
: void
Programmatically adds a property to the extendable class
| Property | Type | Description |
|---|---|---|
| $dynamicName | string |
string
The name of the property to add |
| $value | mixed |
mixed
The value of the property |
public
addJs (array | string $name, array $attributes = [])
: void
Adds JavaScript asset to the asset list. Call $this->makeAssets() in a view to output corresponding markup.
| Property | Type | Description |
|---|---|---|
| $name | array | string |
array | string
Specifies a path (URL) or an array of paths to the script(s). |
| $attributes | array |
array
Adds extra HTML attributes to the asset link. |
public
addRss (string $name, array $attributes = [])
: void
Adds an RSS link asset to the asset list. Call $this->makeAssets() in a view to output corresponding markup.
| Property | Type | Description |
|---|---|---|
| $name | string |
string
Specifies a path (URL) to the RSS channel |
| $attributes | array |
array
Adds extra HTML attributes to the asset link. |
public addViewPath (string | array $path) : void
Prepends a path on the available view path locations.
| Property | Type | Description |
|---|---|---|
| $path | string | array |
string | array
|
public asExtension (string $shortName) : mixed
Short hand for getClassExtension() method, except takes the short
extension name, example:
$this->asExtension('FormController')
| Property | Type | Description |
|---|---|---|
| $shortName | string |
string
|
public static clearExtendedClasses () : void
Clear the list of extended classes so they will be re-extended.
public
combineAssets (array $assets, string $localPath = "")
: string
Run the provided assets through the Asset Combiner
| Property | Type | Description |
|---|---|---|
| $assets | array |
array
Collection of assets |
| $localPath | string |
string
Prefix all assets with this path (optional) |
public extendClassWith (string $extensionName) : void
Dynamically extend a class with a specified behavior
| Property | Type | Description |
|---|---|---|
| $extensionName | string |
string
|
public
static
extendableAddExtension (callable $callback, boolean $scoped = false, $outerScope = null)
: void
Extends the class using a closure.
The closure will be provided a single parameter which is the instance of the extended class, by default.
You may optionally specify the callback as a scoped callback, which inherits the scope of the extended class and
provides access to protected and private methods and properties. This makes any call using $this act on the
extended class, not the class providing the extension.
If you use a scoped callback, you can provide the "outer" scope - or the scope of the class providing the extension, with the third parameter. The outer scope object will then be passed as the single parameter to the closure.
| Property | Type | Description |
|---|---|---|
| $callback | callable |
callable
|
| $scoped | boolean |
boolean
|
| $outerScope | mixed |
mixed
|
public
extendableCall (string $name, array $params = null)
: mixed
Magic method for __call().
Callback priority is as follows:
- "Dynamic Methods" added locally to the object via addDynamicMethod($name, $callable)
- Methods available on Behaviors that have been implemented by the object
- Pass it to the parent's __call() method if it defines one
| Property | Type | Description |
|---|---|---|
| $name | string |
string
|
| $params | array |
array
|
public
static
extendableCallStatic (string $name, array $params = null)
: mixed
Magic method for __callStatic()
| Property | Type | Description |
|---|---|---|
| $name | string |
string
|
| $params | array |
array
|
public extendableConstruct ()
This method should be called as part of the constructor.
public
static
extendableExtendCallback (callable $callback, boolean $scoped = false, $outerScope = null)
: void
Helper method for ::extend() static method.
| Property | Type | Description |
|---|---|---|
| $callback | callable |
callable
|
| $scoped | boolean |
boolean
|
| $outerScope | mixed |
mixed
|
public extendableGet (string $name) : mixed | null
Magic method for __get()
| Property | Type | Description |
|---|---|---|
| $name | string |
string
|
public extendableSet (string $name, mixed $value) : void
Magic method for __set()
| Property | Type | Description |
|---|---|---|
| $name | string |
string
|
| $value | mixed |
mixed
|
public
fireSystemEvent (string $event, array $params = [], boolean $halt = true)
: mixed
Fires a combination of local and global events. The first segment is removed from the event name locally and the local object is passed as the first argument to the event globally. Halting is also enabled by default.
For example:
$this->fireSystemEvent('backend.list.myEvent', ['my value']);
Is equivalent to:
$this->fireEvent('list.myEvent', ['myvalue'], true);
Event::fire('backend.list.myEvent', [$this, 'myvalue'], true);
| Property | Type | Description |
|---|---|---|
| $event | string |
string
Event name |
| $params | array |
array
Event parameters |
| $halt | boolean |
boolean
Halt after first non-null result |
public
fireViewEvent (string $event, array $params = [])
: string
Special event function used for extending within view files, allowing HTML to be injected multiple times.
For example:
= $this->fireViewEvent('backend.auth.extendSigninView') ?>| Property | Type | Description |
|---|---|---|
| $event | string |
string
Event name |
| $params | array |
array
Event parameters |
public flushAssets () : void
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
getAssetPath (string $fileName, string $assetPath = null)
: string
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.
| Property | Type | Description |
|---|---|---|
| $fileName | string |
string
File to load. |
| $assetPath | string |
string
Explicitly define an asset path. |
Relative path to the asset file.
public getAssetPaths () : array
Returns an array of all registered asset paths.
public getClassExtension (string $name) : mixed
Returns a behavior object from an extendable class, example:
$this->getClassExtension('Backend.Behaviors.FormController')
| Property | Type | Description |
|---|---|---|
| $name | string |
string
Fully qualified behavior name |
public getClassMethods () : array
Get a list of class methods, extension equivalent of get_class_methods()
public
getConfig (string $name, string $default = null)
: string
Safe accessor for configuration values.
| Property | Type | Description |
|---|---|---|
| $name | string |
string
Config name, supports array names like "field[key]" |
| $default | string |
string
Default value if nothing is found |
public
getConfigPath (string $fileName, mixed $configPath = null)
: string
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.
| Property | Type | Description |
|---|---|---|
| $fileName | string |
string
File to load. |
| $configPath | mixed |
mixed
Explicitly define a config path. |
Full path to the config file.
public getController ()
Returns the controller using this widget.
public getDynamicProperties () : array
Returns all dynamic properties and their values
['property' => 'value']
public getEventHandler (string $name) : string
Returns a fully qualified event handler name for this widget.
| Property | Type | Description |
|---|---|---|
| $name | string |
string
The ajax event handler name. |
public getFatalError () : string
The fatal error message
public
getId (string $suffix = null)
: string
Returns a unique ID for this widget. Useful in creating HTML markup.
| Property | Type | Description |
|---|---|---|
| $suffix | string |
string
An extra string to append to the ID. |
A unique identifier.
public
getViewPath (string $fileName, $viewPaths = null)
: string
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.
If the fileName cannot be found it will be returned unmodified.
| Property | Type | Description |
|---|---|---|
| $fileName | string |
string
|
| $viewPaths | mixed |
mixed
|
public getViewPaths () : array
Returns the active view path locations.
public
guessConfigPath (string $suffix = "")
: string
Guess the package path for the called class.
| Property | Type | Description |
|---|---|---|
| $suffix | string |
string
An extra path to attach to the end |
public
guessConfigPathFrom (string $class, string $suffix = "")
: string
Guess the package path from a specified class.
| Property | Type | Description |
|---|---|---|
| $class | string |
string
Class to guess path from. |
| $suffix | string |
string
An extra path to attach to the end |
public
guessViewPath (string $suffix = "", boolean $isPublic = false)
: string | null
Guess the package path for the called class.
| Property | Type | Description |
|---|---|---|
| $suffix | string |
string
An extra path to attach to the end |
| $isPublic | boolean |
boolean
Returns public path instead of an absolute one |
public
guessViewPathFrom (string $class, string $suffix = "", boolean $isPublic = false)
: string | null
Guess the package path from a specified class.
| Property | Type | Description |
|---|---|---|
| $class | string |
string
Class to guess path from. |
| $suffix | string |
string
An extra path to attach to the end |
| $isPublic | boolean |
boolean
Returns public path instead of an absolute one |
public handleError ($exception)
Sets standard page variables in the case of a controller error.
| Property | Type | Description |
|---|---|---|
| $exception | mixed |
mixed
|
public hasAssetsDefined () : bool
Returns true if assets any have been added.
public hasFatalError () : bool
Whether a fatal error has been set or not.
public init () : void
Initialize the widget, called by the constructor and free from its parameters.
public isClassExtendedWith (string $name) : bool
Check if extendable class is extended with a behavior object
| Property | Type | Description |
|---|---|---|
| $name | string |
string
Fully qualified behavior name |
public
makeAssets ($type = null)
: string | null
Outputs <link> and <script> tags to load assets previously added
with addJs, addCss, & addRss method calls depending on the provided $type
| Property | Type | Description |
|---|---|---|
| $type | mixed |
mixed
|
public
makeConfig (array $configFile = [], array $requiredConfig = [])
: array | stdClass
Reads the contents of the supplied file and applies it to this object.
| Property | Type | Description |
|---|---|---|
| $configFile | array |
array
|
| $requiredConfig | array |
array
|
public
makeConfigFromArray (array $configArray = [])
: stdClass
Makes a config object from an array, making the first level keys properties of a new object.
| Property | Type | Description |
|---|---|---|
| $configArray | array |
array
Config array. |
The config object
public
makeFileContents (string $filePath, array $extraParams = [])
: string
Includes a file path using output buffering, making the provided vars available.
| Property | Type | Description |
|---|---|---|
| $filePath | string |
string
|
| $extraParams | array |
array
|
public
makeFormWidget (string $class, array $fieldConfig = [], array $widgetConfig = [])
: Backend\Classes\FormWidgetBase
Makes a form widget object with the supplied form field and widget configuration.
| Property | Type | Description |
|---|---|---|
| $class | string |
string
Widget class name |
| $fieldConfig | array |
array
A field name, an array of config or a FormField object. |
| $widgetConfig | array |
array
An array of config. |
The widget object
public
makeLayout ($name = null, array $params = [], boolean $throwException = true)
: string | bool
Render a layout, defaulting to the layout propery specified on the class
| Property | Type | Description |
|---|---|---|
| $name | mixed |
mixed
|
| $params | array |
array
|
| $throwException | boolean |
boolean
|
The layout contents, or false.
public
makeLayoutPartial (string $partial, array $params = [])
: string
Renders a layout partial
| Property | Type | Description |
|---|---|---|
| $partial | string |
string
|
| $params | array |
array
|
public
makePartial (string $partial, array $params = [], boolean $throwException = true)
: mixed
Render a partial file contents located in the views folder.
| Property | Type | Description |
|---|---|---|
| $partial | string |
string
|
| $params | array |
array
|
| $throwException | boolean |
boolean
|
Partial contents or false if not throwing an exception.
public makeView (string $view) : string
Loads the specified view. Applies the layout if one is set.
The view file must have the .php extension (or ".htm" for historical reasons) and be located in the views directory
| Property | Type | Description |
|---|---|---|
| $view | string |
string
|
public
makeViewContent (string $contents, $layout = null)
: string
Renders supplied contents inside a layout.
| Property | Type | Description |
|---|---|---|
| $contents | string |
string
|
| $layout | mixed |
mixed
|
public
makeWidget (string $class, array $widgetConfig = [])
: mixed | Backend\Classes\WidgetBase
Makes a widget object with the supplied configuration file.
| Property | Type | Description |
|---|---|---|
| $class | string |
string
Widget class name |
| $widgetConfig | array |
array
An array of config. |
The widget object
public mergeConfig (mixed $configA, mixed $configB) : stdClass
Merges two configuration sources, either prepared or not, and returns them as a single configuration object.
| Property | Type | Description |
|---|---|---|
| $configA | mixed |
mixed
|
| $configB | mixed |
mixed
|
The config object
public methodExists (string $name) : bool
Checks if a method exists, extension equivalent of method_exists()
| Property | Type | Description |
|---|---|---|
| $name | string |
string
|
public propertyExists (string $name) : bool
Checks if a property exists, extension equivalent of property_exists()
| Property | Type | Description |
|---|---|---|
| $name | string |
string
|
public resetSession () : void
Resets all session data related to this widget.
protected addAsset (string $type, string $path, array $attributes)
Adds the provided asset to the internal asset collections
| Property | Type | Description |
|---|---|---|
| $type | string |
string
The type of the asset: 'js' || 'css' || 'rss' |
| $path | string |
string
The path to the asset |
| $attributes | array |
array
The attributes for the asset |
protected
extendableAddLocalExtension (Closure $callback, $outerScope = null)
Adds local extensibility to the current instance.
This rebinds a given closure to the current instance, making it able to access protected and private methods. This
makes any call using $this within the closure act on the extended class, not the class providing the extension.
An outer scope may be provided by providing a second parameter, which will then be passed through to the closure as its first parameter. If this is not given, the current instance will be provided as the first parameter.
| Property | Type | Description |
|---|---|---|
| $callback | Closure |
Closure
|
| $outerScope | mixed |
mixed
|
protected extendableIsAccessible (mixed $class, string $propertyName) : bool
Checks if a property is accessible, property equivalent of is_callable()
| Property | Type | Description |
|---|---|---|
| $class | mixed |
mixed
|
| $propertyName | string |
string
|
protected extensionExtractMethods (string $extensionName, object $extensionObject) : void
Extracts the available methods from a behavior and adds it to the list of callable methods.
| Property | Type | Description |
|---|---|---|
| $extensionName | string |
string
|
| $extensionObject | object |
object
|
protected extensionGetClassLoader () : Winter\Storm\Support\ClassLoader | null
Gets the class loader
protected extensionNormalizeClassName (string $name) : string
Normalizes the provided extension name allowing for the ClassLoader to inject aliased classes
| Property | Type | Description |
|---|---|---|
| $name | string |
string
|
protected
fillFromConfig (array $properties = null)
: void
Transfers config values stored inside the $config property directly on to the root object properties. If no properties are defined all config will be transferred if it finds a matching property.
| Property | Type | Description |
|---|---|---|
| $properties | array |
array
|
protected getAssetEntryBuildPath (array $asset) : string
Internal helper, attaches a build code to an asset path
| Property | Type | Description |
|---|---|---|
| $asset | array |
array
Stored asset array |
protected getAssetScheme (string $asset) : string
Internal helper, get asset scheme
| Property | Type | Description |
|---|---|---|
| $asset | string |
string
Specifies a path (URL) to the asset. |
protected getLocalPath (string | null $relativePath)
| Property | Type | Description |
|---|---|---|
| $relativePath | string | null |
string | null
|
protected
getSession (string $key = null, string $default = null)
: string
Retrieves a widget related key/value pair from session data.
| Property | Type | Description |
|---|---|---|
| $key | string |
string
Unique key for the data store. |
| $default | string |
string
A default value to use when value is not found. |
protected handleViewException (Throwable $e, integer $obLevel) : void
Handle a view exception.
| Property | Type | Description |
|---|---|---|
| $e | Throwable |
Throwable
|
| $obLevel | integer |
integer
|
protected makeSessionId () : string
Returns a unique session identifier for this widget and controller action.
protected putSession (string $key, mixed $value) : void
Saves a widget related key/value pair in to session data.
| Property | Type | Description |
|---|---|---|
| $key | string |
string
Unique key for the data store. |
| $value | mixed |
mixed
The value to store. |
protected removeDuplicates () : void
Removes duplicate assets from the entire collection.