TPS
/
ORIENT
2
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Minor Formatting Corrections in Usage Comments (#4541) 

Credit to @DanHarrin
This commit is contained in:
Dan Harrin 2019-08-15 16:14:54 +01:00 committed by Luke Towers
parent 35043425a7
commit 9521dd795c
18 changed files with 50 additions and 53 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
modules/backend/classes/AuthManager.php
View File

@ -61,7 +61,7 @@ class AuthManager extends RainAuthManager
* registerPermissions() function. The manager instance is passed to the
* callback function as an argument. Usage:
*
* BackendAuth::registerCallback(function($manager){
* BackendAuth::registerCallback(function ($manager) {
* $manager->registerPermissions([...]);
* });
*

2
modules/backend/classes/Controller.php
View File

@ -553,7 +553,7 @@ class Controller extends ControllerBase
*
* Example usage (forwards AJAX handlers to a backend widget):
*
* Event::listen('backend.ajax.beforeRunHandler', function((\Backend\Classes\Controller) $controller, (string) $handler) {
* Event::listen('backend.ajax.beforeRunHandler', function ((\Backend\Classes\Controller) $controller, (string) $handler) {
* if (strpos($handler, '::')) {
* list($componentAlias, $handlerName) = explode('::', $handler);
* if ($componentAlias === $this->getBackendWidgetAlias()) {

2
modules/backend/classes/NavigationManager.php
View File

@ -154,7 +154,7 @@ class NavigationManager
* `registerMenuItems` method. The manager instance is passed to the callback
* function as an argument. Usage:
*
* BackendMenu::registerCallback(function($manager){
* BackendMenu::registerCallback(function ($manager) {
* $manager->registerMenuItems([...]);
* });
*

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

@ -115,10 +115,9 @@ class WidgetManager
}
/**
* Manually registers form widget for consideration.
* Usage:
* Manually registers form widget for consideration. Usage:
*
* WidgetManager::registerFormWidgets(function($manager){
* WidgetManager::registerFormWidgets(function ($manager) {
* $manager->registerFormWidget('Backend\FormWidgets\CodeEditor', 'codeeditor');
* });
*
@ -200,7 +199,7 @@ class WidgetManager
*
* Example usage:
*
* Event::listen('system.reportwidgets.extendItems', function($manager) {
* Event::listen('system.reportwidgets.extendItems', function ($manager) {
* $manager->removeReportWidget('Acme\ReportWidgets\YourWidget');
* });
*
@ -228,10 +227,9 @@ class WidgetManager
}
/**
* Manually registers report widget for consideration.
* Usage:
* Manually registers report widget for consideration. Usage:
*
* WidgetManager::registerReportWidgets(function($manager){
* WidgetManager::registerReportWidgets(function ($manager) {
* $manager->registerReportWidget('RainLab\GoogleAnalytics\ReportWidgets\TrafficOverview', [
* 'name' => 'Google Analytics traffic overview',
* 'context' => 'dashboard'

6
modules/backend/widgets/Filter.php
View File

@ -377,7 +377,7 @@ class Filter extends WidgetBase
*
* Example usage:
*
* Event::listen('backend.filter.extendQuery', function((\Backend\Widgets\Filter) $filterWidget, $query, (\Backend\Classes\FilterScope) $scope) {
* Event::listen('backend.filter.extendQuery', function ((\Backend\Widgets\Filter) $filterWidget, $query, (\Backend\Classes\FilterScope) $scope) {
* if ($scope->scopeName == 'status') {
* $query->where('status', '<>', 'all');
* }
@ -505,7 +505,7 @@ class Filter extends WidgetBase
*
* Example usage:
*
* Event::listen('backend.filter.extendScopesBefore', function((\Backend\Widgets\Filter) $filterWidget) {
* Event::listen('backend.filter.extendScopesBefore', function ((\Backend\Widgets\Filter) $filterWidget) {
* // Just in case you really had to do something before scopes are defined
* });
*
@ -533,7 +533,7 @@ class Filter extends WidgetBase
*
* Example usage:
*
* Event::listen('backend.filter.extendScopes', function((\Backend\Widgets\Filter) $filterWidget) {
* Event::listen('backend.filter.extendScopes', function ((\Backend\Widgets\Filter) $filterWidget) {
* $filterWidget->addScopes([
* 'my_scope' => [
* 'label' => 'My Filter Scope'

10
modules/backend/widgets/Form.php
View File

@ -364,7 +364,7 @@ class Form extends WidgetBase
*
* Example usage:
*
* Event::listen('backend.form.beforeRefresh', function((\Backend\Widgets\Form) $formWidget, (stdClass) $dataHolder) {
* Event::listen('backend.form.beforeRefresh', function ((\Backend\Widgets\Form) $formWidget, (stdClass) $dataHolder) {
* $dataHolder->data = $arrayOfSaveDataToReplaceExistingDataWith;
* });
*
@ -391,7 +391,7 @@ class Form extends WidgetBase
*
* Example usage:
*
* Event::listen('backend.form.refreshFields', function((\Backend\Widgets\Form) $formWidget, (array) $allFields) {
* Event::listen('backend.form.refreshFields', function ((\Backend\Widgets\Form) $formWidget, (array) $allFields) {
* $allFields['name']->required = false;
* });
*
@ -432,7 +432,7 @@ class Form extends WidgetBase
*
* Example usage:
*
* Event::listen('backend.form.refresh', function((\Backend\Widgets\Form) $formWidget, (array) $result) {
* Event::listen('backend.form.refresh', function ((\Backend\Widgets\Form) $formWidget, (array) $result) {
* $result['#my-partial-id' => $formWidget->makePartial('$/path/to/custom/backend/partial.htm')];
* return $result;
* });
@ -476,7 +476,7 @@ class Form extends WidgetBase
*
* Example usage:
*
* Event::listen('backend.form.extendFieldsBefore', function((\Backend\Widgets\Form) $formWidget) {
* Event::listen('backend.form.extendFieldsBefore', function ((\Backend\Widgets\Form) $formWidget) {
* // You should always check to see if you're extending correct model/controller
* if (!$widget->model instanceof \Foo\Example\Models\Bar) {
* return;
@ -549,7 +549,7 @@ class Form extends WidgetBase
*
* Example usage:
*
* Event::listen('backend.form.extendFields', function((\Backend\Widgets\Form) $formWidget) {
* Event::listen('backend.form.extendFields', function ((\Backend\Widgets\Form) $formWidget) {
* // Only for the User controller
* if (!$widget->getController() instanceof \RainLab\User\Controllers\Users) {
* return;

16
modules/backend/widgets/Lists.php
View File

@ -360,7 +360,7 @@ class Lists extends WidgetBase
*
* Example usage:
*
* Event::listen('backend.list.extendQueryBefore', function($listWidget, $query) {
* Event::listen('backend.list.extendQueryBefore', function ($listWidget, $query) {
* $query->whereNull('deleted_at');
* });
*
@ -557,7 +557,7 @@ class Lists extends WidgetBase
*
* Example usage:
*
* Event::listen('backend.list.extendQuery', function($listWidget, $query) {
* Event::listen('backend.list.extendQuery', function ($listWidget, $query) {
* $newQuery = MyModel::newQuery();
* return $newQuery;
* });
@ -608,7 +608,7 @@ class Lists extends WidgetBase
*
* Example usage:
*
* Event::listen('backend.list.extendRecords', function($listWidget, $records) {
* Event::listen('backend.list.extendRecords', function ($listWidget, $records) {
* $model = MyModel::where('always_include', true)->first();
* $records->prepend($model);
* });
@ -776,7 +776,7 @@ class Lists extends WidgetBase
*
* Example usage:
*
* Event::listen('backend.list.extendColumns', function($listWidget) {
* Event::listen('backend.list.extendColumns', function ($listWidget) {
* // Only for the User controller
* if (!$listWidget->getController() instanceof \Backend\Controllers\Users) {
* return;
@ -953,7 +953,7 @@ class Lists extends WidgetBase
* If a value is returned from this event, it will be used as the value for the provided column.
* `$value` is passed by reference so modifying the variable in place is also supported. Example usage:
*
* Event::listen('backend.list.overrideHeaderValue', function($listWidget, $column, &$value) {
* Event::listen('backend.list.overrideHeaderValue', function ($listWidget, $column, &$value) {
* $value .= '-modified';
* });
*
@ -1029,7 +1029,7 @@ class Lists extends WidgetBase
* If a value is returned from this event, it will be used as the raw value for the provided column.
* `$value` is passed by reference so modifying the variable in place is also supported. Example usage:
*
* Event::listen('backend.list.overrideColumnValueRaw', function($listWidget, $record, $column, &$value) {
* Event::listen('backend.list.overrideColumnValueRaw', function ($listWidget, $record, $column, &$value) {
* $value .= '-modified';
* });
*
@ -1076,7 +1076,7 @@ class Lists extends WidgetBase
* If a value is returned from this event, it will be used as the value for the provided column.
* `$value` is passed by reference so modifying the variable in place is also supported. Example usage:
*
* Event::listen('backend.list.overrideColumnValue', function($listWidget, $record, $column, &$value) {
* Event::listen('backend.list.overrideColumnValue', function ($listWidget, $record, $column, &$value) {
* $value .= '-modified';
* });
*
@ -1110,7 +1110,7 @@ class Lists extends WidgetBase
* If a value is returned from this event, it will be used as the value for the row class.
* `$value` is passed by reference so modifying the variable in place is also supported. Example usage:
*
* Event::listen('backend.list.injectRowClass', function($listWidget, $record, &$value) {
* Event::listen('backend.list.injectRowClass', function ($listWidget, $record, &$value) {
* $value .= '-modified';
* });
*

16
modules/backend/widgets/MediaManager.php
View File

@ -319,7 +319,7 @@ class MediaManager extends WidgetBase
*
* Example usage:
*
* Event::listen('media.folder.delete', function((\Backend\Widgets\MediaManager) $mediaWidget, (string) $path) {
* Event::listen('media.folder.delete', function ((\Backend\Widgets\MediaManager) $mediaWidget, (string) $path) {
* \Log::info($path . " was deleted");
* });
*
@ -350,7 +350,7 @@ class MediaManager extends WidgetBase
*
* Example usage:
*
* Event::listen('media.file.delete', function((\Backend\Widgets\MediaManager) $mediaWidget, (string) $path) {
* Event::listen('media.file.delete', function ((\Backend\Widgets\MediaManager) $mediaWidget, (string) $path) {
* \Log::info($path . " was deleted");
* });
*
@ -433,7 +433,7 @@ class MediaManager extends WidgetBase
*
* Example usage:
*
* Event::listen('media.file.rename', function((\Backend\Widgets\MediaManager) $mediaWidget, (string) $originalPath, (string) $newPath) {
* Event::listen('media.file.rename', function ((\Backend\Widgets\MediaManager) $mediaWidget, (string) $originalPath, (string) $newPath) {
* \Log::info($originalPath . " was moved to " . $path);
* });
*
@ -458,7 +458,7 @@ class MediaManager extends WidgetBase
*
* Example usage:
*
* Event::listen('media.folder.rename', function((\Backend\Widgets\MediaManager) $mediaWidget, (string) $originalPath, (string) $newPath) {
* Event::listen('media.folder.rename', function ((\Backend\Widgets\MediaManager) $mediaWidget, (string) $originalPath, (string) $newPath) {
* \Log::info($originalPath . " was moved to " . $path);
* });
*
@ -516,7 +516,7 @@ class MediaManager extends WidgetBase
*
* Example usage:
*
* Event::listen('media.folder.create', function((\Backend\Widgets\MediaManager) $mediaWidget, (string) $newFolderPath) {
* Event::listen('media.folder.create', function ((\Backend\Widgets\MediaManager) $mediaWidget, (string) $newFolderPath) {
* \Log::info($newFolderPath . " was created");
* });
*
@ -616,7 +616,7 @@ class MediaManager extends WidgetBase
*
* Example usage:
*
* Event::listen('media.file.move', function((\Backend\Widgets\MediaManager) $mediaWidget, (string) $path, (string) $dest) {
* Event::listen('media.file.move', function ((\Backend\Widgets\MediaManager) $mediaWidget, (string) $path, (string) $dest) {
* \Log::info($path . " was moved to " . $dest);
* });
*
@ -642,7 +642,7 @@ class MediaManager extends WidgetBase
*
* Example usage:
*
* Event::listen('media.folder.move', function((\Backend\Widgets\MediaManager) $mediaWidget, (string) $path, (string) $dest) {
* Event::listen('media.folder.move', function ((\Backend\Widgets\MediaManager) $mediaWidget, (string) $path, (string) $dest) {
* \Log::info($path . " was moved to " . $dest);
* });
*
@ -1576,7 +1576,7 @@ class MediaManager extends WidgetBase
*
* Example usage:
*
* Event::listen('media.file.upload', function((\Backend\Widgets\MediaManager) $mediaWidget, (string) $path, (\Symfony\Component\HttpFoundation\File\UploadedFile) $uploadedFile) {
* Event::listen('media.file.upload', function ((\Backend\Widgets\MediaManager) $mediaWidget, (string) $path, (\Symfony\Component\HttpFoundation\File\UploadedFile) $uploadedFile) {
* \Log::info($path . " was upoaded.");
* });
*

2
modules/cms/classes/CmsObject.php
View File

@ -146,7 +146,7 @@ class CmsObject extends HalcyonModel implements CmsObjectContract
* Example usage (filters all pages except for the 404 page on the CMS Maintenance mode settings page):
*
* // Extend only the Settings Controller
* \System\Controllers\Settings::extend(function($controller) {
* \System\Controllers\Settings::extend(function ($controller) {
* // Listen for the cms.object.listInTheme event
* \Event::listen('cms.object.listInTheme', function ($cmsObject, $objectList) {
* // Get the current context of the Settings Manager to ensure we only affect what we need to affect

4
modules/cms/classes/ComponentBase.php
View File

@ -159,7 +159,7 @@ abstract class ComponentBase extends Extendable
*
* Example usage (forwards AJAX handlers to a backend widget):
*
* Event::listen('cms.component.beforeRunAjaxHandler', function((\Cms\Classes\ComponentBase) $component, (string) $handler) {
* Event::listen('cms.component.beforeRunAjaxHandler', function ((\Cms\Classes\ComponentBase) $component, (string) $handler) {
* if (strpos($handler, '::')) {
* list($componentAlias, $handlerName) = explode('::', $handler);
* if ($componentAlias === $this->getBackendWidgetAlias()) {
@ -194,7 +194,7 @@ abstract class ComponentBase extends Extendable
*
* Example usage (Logs requests and their response):
*
* Event::listen('cms.component.beforeRunHandler', function((\Cms\Classes\ComponentBase) $component, (string) $handler, (mixed) $result) {
* Event::listen('cms.component.beforeRunHandler', function ((\Cms\Classes\ComponentBase) $component, (string) $handler, (mixed) $result) {
* if (in_array($handler, $interceptHandlers)) {
* return 'request has been intercepted, original response: ' . json_encode($result);
* }

5
modules/cms/classes/ComponentManager.php
View File

@ -72,10 +72,9 @@ class ComponentManager
}
/**
* Manually registers a component for consideration.
* Usage:
* Manually registers a component for consideration. Usage:
*
* ComponentManager::registerComponents(function($manager){
* ComponentManager::registerComponents(function ($manager) {
* $manager->registerComponent('October\Demo\Components\Test', 'testComponent');
* });
*

2
modules/cms/classes/Controller.php
View File

@ -812,7 +812,7 @@ class Controller
*
* Example usage (forwards AJAX handlers to a backend widget):
*
* Event::listen('cms.ajax.beforeRunHandler', function((\Cms\Classes\Controller) $controller, (string) $handler) {
* Event::listen('cms.ajax.beforeRunHandler', function ((\Cms\Classes\Controller) $controller, (string) $handler) {
* if (strpos($handler, '::')) {
* list($componentAlias, $handlerName) = explode('::', $handler);
* if ($componentAlias === $this->getBackendWidgetAlias()) {

8
modules/cms/classes/Theme.php
View File

@ -181,7 +181,9 @@ class Theme
* If a value is returned from this halting event, it will be used as the active
* theme code. Example usage:
*
* Event::listen('cms.theme.getActiveTheme', function() { return 'mytheme'; });
* Event::listen('cms.theme.getActiveTheme', function () {
* return 'mytheme';
* });
*
*/
$apiResult = Event::fire('cms.theme.getActiveTheme', [], true);
@ -235,7 +237,7 @@ class Theme
* If a value is returned from this halting event, it will be used as the active
* theme code. Example usage:
*
* Event::listen('cms.theme.setActiveTheme', function($code) {
* Event::listen('cms.theme.setActiveTheme', function ($code) {
* \Log::info("Theme has been changed to $code");
* });
*
@ -265,7 +267,7 @@ class Theme
* If a value is returned from this halting event, it will be used as the edit
* theme code. Example usage:
*
* Event::listen('cms.theme.getEditTheme', function() {
* Event::listen('cms.theme.getEditTheme', function () {
* return "the-edit-theme-code";
* });
*

2
modules/system/classes/CombineAssets.php
View File

@ -542,7 +542,7 @@ class CombineAssets
* `registerBundle` method. This instance is passed to the callback
* function as an argument. Usage:
*
* CombineAssets::registerCallback(function($combiner){
* CombineAssets::registerCallback(function ($combiner) {
* $combiner->registerBundle('~/modules/backend/assets/less/october.less');
* });
*

2
modules/system/classes/MailManager.php
View File

@ -401,7 +401,7 @@ class MailManager
* registerMailTemplates() function. Thi instance is passed to the
* callback function as an argument. Usage:
*
* MailManager::registerCallback(function($manager) {
* MailManager::registerCallback(function ($manager) {
* $manager->registerMailTemplates([...]);
* });
*

5
modules/system/classes/MarkupManager.php
View File

@ -87,10 +87,9 @@ class MarkupManager
* Registers a callback function that defines simple Twig extensions.
* The callback function should register menu items by calling the manager's
* `registerFunctions`, `registerFilters`, `registerTokenParsers` function.
* The manager instance is passed to the callback function as an argument.
* Usage:
* The manager instance is passed to the callback function as an argument. Usage:
*
* MarkupManager::registerCallback(function($manager){
* MarkupManager::registerCallback(function ($manager) {
* $manager->registerFilters([...]);
* $manager->registerFunctions([...]);
* $manager->registerTokenParsers([...]);

5
modules/system/classes/SettingsManager.php
View File

@ -191,10 +191,9 @@ class SettingsManager
* Registers a callback function that defines setting items.
* The callback function should register setting items by calling the manager's
* registerSettingItems() function. The manager instance is passed to the
* callback function as an argument.
* Usage:
* callback function as an argument. Usage:
*
* SettingsManager::registerCallback(function($manager){
* SettingsManager::registerCallback(function ($manager) {
* $manager->registerSettingItems([...]);
* });
*

2
modules/system/console/OctoberMirror.php
View File

@ -93,7 +93,7 @@ class OctoberMirror extends Command
*
* Example usage:
*
* Event::listen('system.console.mirror.extendPaths', function($paths) {
* Event::listen('system.console.mirror.extendPaths', function ($paths) {
* $paths->directories = array_merge($paths->directories, ['plugins/myauthor/myplugin/public']);
* });
*