From 9521dd795c61a9cbaa86032c33bb93552ffb62dc Mon Sep 17 00:00:00 2001 From: Dan Harrin Date: Thu, 15 Aug 2019 16:14:54 +0100 Subject: [PATCH] Minor Formatting Corrections in Usage Comments (#4541) Credit to @DanHarrin --- modules/backend/classes/AuthManager.php | 2 +- modules/backend/classes/Controller.php | 2 +- modules/backend/classes/NavigationManager.php | 2 +- modules/backend/classes/WidgetManager.php | 12 +++++------- modules/backend/widgets/Filter.php | 6 +++--- modules/backend/widgets/Form.php | 10 +++++----- modules/backend/widgets/Lists.php | 16 ++++++++-------- modules/backend/widgets/MediaManager.php | 16 ++++++++-------- modules/cms/classes/CmsObject.php | 2 +- modules/cms/classes/ComponentBase.php | 4 ++-- modules/cms/classes/ComponentManager.php | 5 ++--- modules/cms/classes/Controller.php | 2 +- modules/cms/classes/Theme.php | 8 +++++--- modules/system/classes/CombineAssets.php | 2 +- modules/system/classes/MailManager.php | 2 +- modules/system/classes/MarkupManager.php | 5 ++--- modules/system/classes/SettingsManager.php | 5 ++--- modules/system/console/OctoberMirror.php | 2 +- 18 files changed, 50 insertions(+), 53 deletions(-) diff --git a/modules/backend/classes/AuthManager.php b/modules/backend/classes/AuthManager.php index f78e33c6d..3eadb5633 100644 --- a/modules/backend/classes/AuthManager.php +++ b/modules/backend/classes/AuthManager.php @@ -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([...]); * }); * diff --git a/modules/backend/classes/Controller.php b/modules/backend/classes/Controller.php index f6916b4ef..b27d7b678 100644 --- a/modules/backend/classes/Controller.php +++ b/modules/backend/classes/Controller.php @@ -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()) { diff --git a/modules/backend/classes/NavigationManager.php b/modules/backend/classes/NavigationManager.php index 0566922e0..d91915a40 100644 --- a/modules/backend/classes/NavigationManager.php +++ b/modules/backend/classes/NavigationManager.php @@ -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([...]); * }); * diff --git a/modules/backend/classes/WidgetManager.php b/modules/backend/classes/WidgetManager.php index ea39becff..e2b663dda 100644 --- a/modules/backend/classes/WidgetManager.php +++ b/modules/backend/classes/WidgetManager.php @@ -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' diff --git a/modules/backend/widgets/Filter.php b/modules/backend/widgets/Filter.php index fa47aaaa6..54789b9a3 100644 --- a/modules/backend/widgets/Filter.php +++ b/modules/backend/widgets/Filter.php @@ -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' diff --git a/modules/backend/widgets/Form.php b/modules/backend/widgets/Form.php index 5d5fbfca1..17e630b96 100644 --- a/modules/backend/widgets/Form.php +++ b/modules/backend/widgets/Form.php @@ -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; diff --git a/modules/backend/widgets/Lists.php b/modules/backend/widgets/Lists.php index acf13db95..6fddd5ca3 100644 --- a/modules/backend/widgets/Lists.php +++ b/modules/backend/widgets/Lists.php @@ -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'; * }); * diff --git a/modules/backend/widgets/MediaManager.php b/modules/backend/widgets/MediaManager.php index acca60f42..f1e5e2c4c 100644 --- a/modules/backend/widgets/MediaManager.php +++ b/modules/backend/widgets/MediaManager.php @@ -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."); * }); * diff --git a/modules/cms/classes/CmsObject.php b/modules/cms/classes/CmsObject.php index 483a10f1d..798a065a0 100644 --- a/modules/cms/classes/CmsObject.php +++ b/modules/cms/classes/CmsObject.php @@ -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 diff --git a/modules/cms/classes/ComponentBase.php b/modules/cms/classes/ComponentBase.php index 5014ab1d8..230a32c1e 100644 --- a/modules/cms/classes/ComponentBase.php +++ b/modules/cms/classes/ComponentBase.php @@ -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); * } diff --git a/modules/cms/classes/ComponentManager.php b/modules/cms/classes/ComponentManager.php index 2b3583517..fe220c1b1 100644 --- a/modules/cms/classes/ComponentManager.php +++ b/modules/cms/classes/ComponentManager.php @@ -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'); * }); * diff --git a/modules/cms/classes/Controller.php b/modules/cms/classes/Controller.php index 1d97031fa..1bb899373 100644 --- a/modules/cms/classes/Controller.php +++ b/modules/cms/classes/Controller.php @@ -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()) { diff --git a/modules/cms/classes/Theme.php b/modules/cms/classes/Theme.php index 24f05eafe..ca97b1100 100644 --- a/modules/cms/classes/Theme.php +++ b/modules/cms/classes/Theme.php @@ -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"; * }); * diff --git a/modules/system/classes/CombineAssets.php b/modules/system/classes/CombineAssets.php index 8b4dacd4d..3e593a075 100644 --- a/modules/system/classes/CombineAssets.php +++ b/modules/system/classes/CombineAssets.php @@ -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'); * }); * diff --git a/modules/system/classes/MailManager.php b/modules/system/classes/MailManager.php index 33e9dc003..ab76bd516 100644 --- a/modules/system/classes/MailManager.php +++ b/modules/system/classes/MailManager.php @@ -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([...]); * }); * diff --git a/modules/system/classes/MarkupManager.php b/modules/system/classes/MarkupManager.php index c621b66ca..d86af6364 100644 --- a/modules/system/classes/MarkupManager.php +++ b/modules/system/classes/MarkupManager.php @@ -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([...]); diff --git a/modules/system/classes/SettingsManager.php b/modules/system/classes/SettingsManager.php index 82bb0f731..c4622ba44 100644 --- a/modules/system/classes/SettingsManager.php +++ b/modules/system/classes/SettingsManager.php @@ -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([...]); * }); * diff --git a/modules/system/console/OctoberMirror.php b/modules/system/console/OctoberMirror.php index a9f5220eb..4fb0689bc 100644 --- a/modules/system/console/OctoberMirror.php +++ b/modules/system/console/OctoberMirror.php @@ -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']); * }); *