DashboardContainer
class DashboardContainer extends BaseWidget
Traits
Widget Maker Trait Class
Adds event related features to any class.
Extendable Trait Allows for "Private traits"
Properties
protected array | $extensionData | from ExtendableTrait | |
static protected array | $extendableCallbacks | from ExtendableTrait | |
static protected array | $extendableStaticMethods | from ExtendableTrait | |
static protected bool | $extendableGuardProperties | from ExtendableTrait | |
static protected ClassLoader | $extendableClassLoader | from ExtendableTrait | |
$implement | from Extendable | ||
array | $vars | from ViewMaker | |
array | $viewPath | from ViewMaker | |
array | $layoutPath | from ViewMaker | |
array | $partialPath | from ViewMaker | |
string | $layout | from ViewMaker | |
bool | $suppressLayout | from ViewMaker | |
protected | $viewFileExtension | from ViewMaker | |
array | $assetPath | from AssetMaker | |
string | $configPath | from ConfigMaker | |
protected | $configFileExtension | from ConfigMaker | |
protected array | $emitterSingleEvents | from EventEmitter | |
protected array | $emitterEvents | from EventEmitter | |
protected array | $emitterEventSorted | from EventEmitter | |
protected AdminController | $controller | from BaseWidget | |
object | $config | from BaseWidget | |
string | $alias | from BaseWidget | |
protected | $defaultAlias | {@inheritdoc} | |
protected | $validateAfterCallback | from ValidatesForm | |
string | $context | ||
string | $canManage | ||
string | $canSetDefault | ||
$dateRangeFormat | |||
$startDate | |||
$endDate | |||
array | $defaultWidgets | ||
protected array | $dashboardWidgets | ||
protected bool | $widgetsDefined |
Methods
Helper method for ::extend() static method
Clear the list of extended classes so they will be re-extended.
Normalizes the provided extension name allowing for the ClassLoader to inject aliased classes
Dynamically extend a class with a specified behavior
Extracts the available methods from a behavior and adds it to the list of callable methods.
Programmatically adds a method to the extendable class
Programatically adds a property to the extendable class
Check if extendable class is extended with a behavior object
Returns a behavior object from an extendable class, example:
Short hand for getClassExtension() method, except takes the short extension name, example:
Checks if a method exists, extension equivalent of method_exists()
Get a list of class methods, extension equivalent of get_class_methods()
Checks if a property exists, extension equivalent of property_exists()
Checks if a property is accessible, property equivalent of is_callabe()
Magic method for __call()
Magic method for __callStatic()
Constructor.
Makes a widget object with the supplied configuration ex. model config
Makes a form widget object with the supplied form field and widget configuration.
Retrieves key/value pair from session data.
Saves key/value pair in to session data.
Retrieves key/value pair from session temporary data.
Saves key/value pair in to session temporary data.
Guess the package path from a specified class.
Render a layout.
Render a partial file contents located in the views or partial folder.
Includes a file path using output buffering.
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.
Reads the contents of the supplied file and applies it to this object.
Reads the contents of the supplied file and applies it to this object.
Merges two configuration sources, either prepared or not, and returns them as a single configuration object.
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.
Guess the package path for the called class.
Guess the package path from a specified class.
Create a new event binding.
Create a new event binding that fires once only
Sort the listeners for a given event by priority.
Fire an event and call the listeners.
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.
Renders this widget along with its collection of dashboard widgets.
Ensure dashboard widgets are registered so they can also be bound to the controller this allows their AJAX features to operate.
Transfers config values stored inside the $config property directly on to the root object properties.
Returns a unique ID for this widget. Useful in creating HTML markup.
Returns a fully qualified event handler name for this widget.
Get the widget configuration values.
Adds widget specific asset files.
Validate the given request with the given rules.
Validate the given request with the given rules.
No description
Get the request input based on the given validation rules.
No description
No description
No description
No description
No description
No description
No description
No description
No description
No description
No description
No description
Registers the dashboard widgets that will be included in this container.
No description
No description
No description
No description
No description
No description
No description
No description
No description
No description
No description
No description
No description
No description
No description
No description
Details
in
ExtendableTrait at line 55
extendableConstruct()
Constructor.
in
ExtendableTrait at line 103
static void
extendableExtendCallback(callable $callback)
Helper method for ::extend() static method
in
ExtendableTrait at line 120
static void
clearExtendedClasses()
Clear the list of extended classes so they will be re-extended.
in
ExtendableTrait at line 131
protected string
extensionNormalizeClassName(string $name)
Normalizes the provided extension name allowing for the ClassLoader to inject aliased classes
in
ExtendableTrait at line 149
void|ExtendableTrait
extendClassWith(string $extensionName)
Dynamically extend a class with a specified behavior
in
ExtendableTrait at line 178
protected void
extensionExtractMethods(string $extensionName, object $extensionObject)
Extracts the available methods from a behavior and adds it to the list of callable methods.
in
ExtendableTrait at line 206
addDynamicMethod(string $dynamicName, callable $method, string $extension = null)
Programmatically adds a method to the extendable class
in
ExtendableTrait at line 225
addDynamicProperty(string $dynamicName, string $value = null)
Programatically adds a property to the extendable class
in
ExtendableTrait at line 249
bool
isClassExtendedWith(string $name)
Check if extendable class is extended with a behavior object
in
ExtendableTrait at line 265
mixed
getClassExtension(string $name)
Returns a behavior object from an extendable class, example:
$this->getClassExtension('Admin.Actions.FormController')
in
ExtendableTrait at line 280
mixed
asExtension(string $shortName)
Short hand for getClassExtension() method, except takes the short extension name, example:
$this->asExtension('FormController')
in
ExtendableTrait at line 301
bool
methodExists(string $name)
Checks if a method exists, extension equivalent of method_exists()
in
ExtendableTrait at line 313
array
getClassMethods()
Get a list of class methods, extension equivalent of get_class_methods()
in
ExtendableTrait at line 326
array
getDynamicProperties()
Returns all dynamic properties and their values
in
ExtendableTrait at line 344
bool
propertyExists(string $name)
Checks if a property exists, extension equivalent of property_exists()
in
ExtendableTrait at line 370
protected bool
extendableIsAccessible(mixed $class, string $propertyName)
Checks if a property is accessible, property equivalent of is_callabe()
in
ExtendableTrait at line 385
string
extendableGet(string $name)
Magic method for __get()
in
ExtendableTrait at line 410
string
extendableSet(string $name, string $value)
Magic method for __set()
in
ExtendableTrait at line 444
mixed
extendableCall(string $name, array $params = null)
Magic method for __call()
in
ExtendableTrait at line 483
static mixed
extendableCallStatic(string $name, array $params = null)
Magic method for __callStatic()
in
ExtendableTrait at line 552
protected ClassLoader|null
extensionGetClassLoader()
Gets the class loader
at line 84
__construct(Controller $controller, array $config = [])
Constructor.
in
Extendable at line 30
__get($name)
No description
in
Extendable at line 35
__set($name, $value)
No description
in
Extendable at line 40
__call($name, $params)
No description
in
Extendable at line 45
static
__callStatic($name, $params)
No description
in
Extendable at line 50
static
extend(callable $callback)
No description
in
WidgetMaker at line 24
BaseWidget
makeWidget(string $class, array $widgetConfig = [])
Makes a widget object with the supplied configuration ex. model config
in
WidgetMaker at line 47
BaseFormWidget
makeFormWidget(string $class, mixed $fieldConfig = [], array $widgetConfig = [])
Makes a form widget object with the supplied form field and widget configuration.
in
SessionMaker at line 17
mixed
getSession(string $key = null, string $default = null)
Retrieves key/value pair from session data.
in
SessionMaker at line 37
void
putSession(string $key, mixed $value)
Saves key/value pair in to session data.
in
SessionMaker at line 47
hasSession($key)
No description
in
SessionMaker at line 62
mixed
getTempSession(string $key = null, string $default = null)
Retrieves key/value pair from session temporary data.
in
SessionMaker at line 82
void
putTempSession(string $key, mixed $value)
Saves key/value pair in to session temporary data.
in
SessionMaker at line 92
forgetSession($key)
No description
in
SessionMaker at line 101
resetSession()
No description
in
SessionMaker at line 111
protected string
makeSessionKey()
Returns a unique session identifier for this location.
in
SessionMaker at line 119
protected
encodeSessionData($data)
No description
in
SessionMaker at line 130
protected
decodeSessionData($data)
No description
in
ViewMaker at line 50
getViewPath($view, $viewPath = null)
No description
in
ViewMaker at line 78
guessViewFileExtension($path)
No description
in
ViewMaker at line 98
string
guessViewPath(string $suffix = '', bool $isPublic = false)
Guess the package path from a specified class.
in
ViewMaker at line 119
mixed
makeLayout(string $name = null, array $vars = [], bool $throwException = true)
Render a layout.
in
ViewMaker at line 147
string
makeView(string $view)
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" or "php".
in
ViewMaker at line 171
mixed
makePartial(string $partial, array $vars = [], bool $throwException = true)
Render a partial file contents located in the views or partial folder.
in
ViewMaker at line 199
string
makeFileContent(string $filePath, array $extraParams = [])
Includes a file path using output buffering.
Ensures that vars are available.
in
ViewMaker at line 235
compileFileContent($filePath)
No description
in
ViewMaker at line 256
protected void
handleViewException(Exception $e, int $obLevel)
Handle a view exception.
in
ViewMaker at line 271
protected array
gatherViewData($data)
Get the data bound to the view instance.
in
AssetMaker at line 15
flushAssets()
No description
in
AssetMaker at line 30
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.
in
AssetMaker at line 55
addMeta($meta)
No description
in
AssetMaker at line 60
addJs($href, $attributes = null)
No description
in
AssetMaker at line 65
addCss($href, $attributes = null)
No description
in
ConfigMaker at line 27
array
loadConfig(array $configFile = [], array $requiredConfig = [], null $index = null)
Reads the contents of the supplied file and applies it to this object.
in
ConfigMaker at line 46
array
makeConfig(string|array $configFile, array $requiredConfig = [])
Reads the contents of the supplied file and applies it to this object.
in
ConfigMaker at line 97
array
mergeConfig($configLeft, $configRight)
Merges two configuration sources, either prepared or not, and returns them as a single configuration object.
in
ConfigMaker at line 116
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.
in
ConfigMaker at line 154
string
guessConfigPath(string $suffix = '')
Guess the package path for the called class.
in
ConfigMaker at line 169
string
guessConfigPathFrom(string $class, string $suffix = '')
Guess the package path from a specified class.
in
EventEmitter at line 36
EventEmitter
bindEvent(string $event, callable $callback, int $priority = 0)
Create a new event binding.
in
EventEmitter at line 52
EventEmitter
bindEventOnce(string $event, callable $callback)
Create a new event binding that fires once only
in
EventEmitter at line 66
protected void
emitterEventSortEvents(string $eventName)
Sort the listeners for a given event by priority.
in
EventEmitter at line 84
EventEmitter
unbindEvent(string $event = null)
Destroys an event binding.
in
EventEmitter at line 124
string|array
fireEvent(string $event, array $params = [], bool $halt = false)
Fire an event and call the listeners.
in
EventEmitter at line 178
mixed
fireSystemEvent(string $event, array $params = [], bool $halt = true)
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('admin.form.myEvent', ['my value']);
Is equivalent to:
$this->fireEvent('form.myEvent', ['myvalue'], true);
Event::fire('admin.form.myEvent', [$this, 'myvalue'], true);
in
LocationAwareWidget at line 10
protected
isLocationAware($config)
No description
in
LocationAwareWidget at line 20
protected
locationApplyScope($query)
Apply location scope where required
in
BaseWidget at line 91
void
initialize()
Initialize the widget called by the constructor.
at line 105
string
render()
Renders this widget along with its collection of dashboard widgets.
at line 96
void
bindToController()
Ensure dashboard widgets are registered so they can also be bound to the controller this allows their AJAX features to operate.
in
BaseWidget at line 120
protected void
fillFromConfig(array $properties = null)
Transfers config values stored inside the $config property directly on to the root object properties.
in
BaseWidget at line 140
string
getId(string $suffix = null)
Returns a unique ID for this widget. Useful in creating HTML markup.
in
BaseWidget at line 162
string
getEventHandler(string $name)
Returns a fully qualified event handler name for this widget.
in
BaseWidget at line 170
getController()
Returns the controller using this widget.
in
BaseWidget at line 181
setConfig(array $config, array $required = [])
Sets the widget configuration values
in
BaseWidget at line 194
mixed
getConfig(string $name = null, mixed $default = null)
Get the widget configuration values.
at line 114
void
loadAssets()
Adds widget specific asset files.
use $this->addCss or $this->addJs
in
ValidatesForm at line 29
array|bool
validatePasses($request, array $rules, array $messages = [], array $customAttributes = [])
Validate the given request with the given rules.
in
ValidatesForm at line 52
array
validate($request, array $rules, array $messages = [], array $customAttributes = [])
Validate the given request with the given rules.
in
ValidatesForm at line 64
makeValidator($request, array $rules, array $messages = [], array $customAttributes = [])
No description
in
ValidatesForm at line 80
parseRules(array $rules)
No description
in
ValidatesForm at line 93
parseAttributes(array $rules)
No description
in
ValidatesForm at line 114
protected array
extractInputFromRules(Request $request, array $rules)
Get the request input based on the given validation rules.
in
ValidatesForm at line 127
protected Factory
getValidationFactory()
Get a validation factory instance.
in
ValidatesForm at line 132
validateAfter(Closure $callback)
No description
in
ValidatesForm at line 137
protected
flashValidationErrors($errors)
No description
in
ValidatesForm at line 147
protected
validateFormWidget($form, $saveData)
No description
at line 131
onRenderWidgets()
No description
at line 140
onLoadAddPopup()
No description
at line 148
onLoadUpdatePopup()
No description
at line 162
onAddWidget()
No description
at line 191
onResetWidgets()
No description
at line 206
onSetAsDefault()
No description
at line 219
onUpdateWidget()
No description
at line 245
onRemoveWidget()
No description
at line 259
array
addWidget($widgetAlias, BaseDashboardWidget $widget, $size)
No description
at line 277
onSetWidgetPriorities()
No description
at line 298
onSetDateRange()
No description
at line 327
getStartDate()
No description
at line 332
getEndDate()
No description
at line 341
protected
defineDashboardWidgets()
Registers the dashboard widgets that will be included in this container.
The chosen widgets are based on the user preferences.
at line 368
protected
makeDashboardWidget($alias, $widgetConfig)
No description
at line 381
protected
resetWidgets()
No description
at line 390
protected
removeWidget($alias)
No description
at line 405
protected
getFormWidget($alias, $widget)
No description
at line 421
protected
findWidgetByAlias($alias)
No description
at line 433
protected
getWidgetClassName($widget)
No description
at line 438
protected
getWidgetPropertyConfigTitle($widget)
No description
at line 450
protected array
getWidgetPropertyConfig(BaseDashboardWidget $widget)
No description
at line 494
protected array
getWidgetPropertyValues(BaseDashboardWidget $widget)
No description
at line 508
protected
getWidgetPropertyWidthOptions()
No description
at line 518
protected
checkWidgetPropertyType($type)
No description
at line 536
protected
getWidgetsFromUserPreferences()
No description
at line 550
protected
setWidgetsToUserPreferences($widgets)
No description
at line 555
protected
resetWidgetsUserPreferences()
No description
at line 560
protected
saveWidgetProperties($alias, $properties)
No description
at line 571
protected
getUserPreferencesKey()
No description
at line 576
protected
getSystemParametersKey()
No description
at line 581
protected
getUniqueAlias($widgets)
No description