mirror_php/winter
1
0
Fork 0
mirror of https://github.com/wintercms/winter.git synced 2024-06-28 05:33:29 +02:00
Code Issues Projects Releases Wiki Activity

Updating base widget inline documentation

Browse Source
This commit is contained in:
Luke Towers 2017-11-22 14:10:04 -06:00
parent dfd629ee75
commit 15314bbe94
2 changed files with 11 additions and 11 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
modules/backend/classes/WidgetBase.php
View File

@ -55,7 +55,7 @@ abstract class WidgetBase extends Extendable
/*
* Apply configuration values to a new config object, if a parent
* consutrctor hasn't done it already.
* constructor hasn't done it already.
*/
if ($this->config === null) {
$this->config = $this->makeConfig($configuration);
@ -92,7 +92,7 @@ abstract class WidgetBase extends Extendable
}
/**
* Renders the widgets primary contents.
* Renders the widget's primary contents.
* @return string HTML markup supplied by this widget.
*/
public function render()

18
modules/backend/classes/WidgetManager.php
View File

@ -15,17 +15,17 @@ class WidgetManager
use \October\Rain\Support\Traits\Singleton;
/**
* @var array An array of report widgets.
* @var array An array of form widgets. Stored in the form of ['FormWidgetClass' => $formWidgetInfo].
*/
protected $formWidgets;
/**
* @var array Cache of report widget registration callbacks.
* @var array Cache of form widget registration callbacks.
*/
protected $formWidgetCallbacks = [];
/**
* @var array An array of report widgets.
* @var array An array of form widgets keyed by their code. Stored in the form of ['formwidgetcode' => 'FormWidgetClass'].
*/
protected $formWidgetHints;
@ -92,7 +92,7 @@ class WidgetManager
}
/**
* Registers a single form form widget.
* Registers a single form widget.
* @param string $className Widget class name.
* @param array $widgetInfo Registration information, can contain a `code` key.
* @return void
@ -129,7 +129,7 @@ class WidgetManager
/**
* Returns a class name from a form widget code
* Normalizes a class name or converts an code to it's class name.
* Normalizes a class name or converts an code to its class name.
* @param string $name Class name or form widget code.
* @return string The class name resolved, or the original name.
*/
@ -191,9 +191,9 @@ class WidgetManager
/**
* @event system.reportwidgets.extendItems
* Allows to append or remove a report widget.
* Enables adding or removing report widgets.
*
* You will have access to the WidgetManager instance and be able to call the appropiated methods
* You will have access to the WidgetManager instance and be able to call the appropiate methods
* $manager->registerReportWidget();
* $manager->removeReportWidget();
*
@ -223,8 +223,8 @@ class WidgetManager
*
* WidgetManager::registerReportWidgets(function($manager){
* $manager->registerReportWidget('RainLab\GoogleAnalytics\ReportWidgets\TrafficOverview', [
* 'name'=>'Google Analytics traffic overview',
* 'context'=>'dashboard'
* 'name' => 'Google Analytics traffic overview',
* 'context' => 'dashboard'
* ]);
* });
*