Skip to content

Commit 332b0e4

Browse files
committed
Apply Winter Coding Standards
Rel: wintercms/winter#1188
1 parent 46a1eb9 commit 332b0e4

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

48 files changed

+426
-390
lines changed

Plugin.php

Lines changed: 26 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -1,18 +1,19 @@
1-
<?php namespace Winter\Pages;
1+
<?php
22

3-
use Backend;
3+
namespace Winter\Pages;
4+
5+
use Backend\Facades\Backend;
46
use Backend\Models\UserRole;
57
use Cms\Classes\Controller as CmsController;
68
use Cms\Classes\Theme;
7-
use Config;
8-
use Event;
99
use System\Classes\PluginBase;
1010
use Winter\Pages\Classes\Controller;
1111
use Winter\Pages\Classes\Page as StaticPage;
1212
use Winter\Pages\Classes\Router;
1313
use Winter\Pages\Classes\Snippet;
1414
use Winter\Pages\Classes\SnippetManager;
1515
use Winter\Pages\Controllers\Index;
16+
use Winter\Storm\Support\Facades\Event;
1617

1718
class Plugin extends PluginBase
1819
{
@@ -37,7 +38,7 @@ public function registerComponents(): array
3738
\Winter\Pages\Components\ChildPages::class => 'childPages',
3839
\Winter\Pages\Components\StaticPage::class => 'staticPage',
3940
\Winter\Pages\Components\StaticMenu::class => 'staticMenu',
40-
\Winter\Pages\Components\StaticBreadcrumbs::class => 'staticBreadcrumbs'
41+
\Winter\Pages\Components\StaticBreadcrumbs::class => 'staticBreadcrumbs',
4142
];
4243
}
4344

@@ -58,7 +59,7 @@ public function registerPermissions(): array
5859
'order' => 200,
5960
'roles' => [UserRole::CODE_DEVELOPER, UserRole::CODE_PUBLISHER],
6061
'label' => 'winter.pages::lang.page.manage_menus',
61-
],
62+
],
6263
'winter.pages.manage_content' => [
6364
'tab' => 'winter.pages::lang.page.tab',
6465
'order' => 200,
@@ -99,28 +100,28 @@ public function registerNavigation(): array
99100
'label' => 'winter.pages::lang.page.menu_label',
100101
'icon' => 'icon-files-o',
101102
'url' => 'javascript:;',
102-
'attributes' => ['data-menu-item'=>'pages'],
103+
'attributes' => ['data-menu-item' => 'pages'],
103104
'permissions' => ['winter.pages.manage_pages'],
104105
],
105106
'menus' => [
106107
'label' => 'winter.pages::lang.menu.menu_label',
107108
'icon' => 'icon-sitemap',
108109
'url' => 'javascript:;',
109-
'attributes' => ['data-menu-item'=>'menus'],
110+
'attributes' => ['data-menu-item' => 'menus'],
110111
'permissions' => ['winter.pages.manage_menus'],
111112
],
112113
'content' => [
113114
'label' => 'winter.pages::lang.content.menu_label',
114115
'icon' => 'icon-file-text-o',
115116
'url' => 'javascript:;',
116-
'attributes' => ['data-menu-item'=>'content'],
117+
'attributes' => ['data-menu-item' => 'content'],
117118
'permissions' => ['winter.pages.manage_content'],
118119
],
119120
'snippets' => [
120121
'label' => 'winter.pages::lang.snippet.menu_label',
121122
'icon' => 'icon-newspaper-o',
122123
'url' => 'javascript:;',
123-
'attributes' => ['data-menu-item'=>'snippets'],
124+
'attributes' => ['data-menu-item' => 'snippets'],
124125
'permissions' => ['winter.pages.access_snippets'],
125126
],
126127
],
@@ -146,8 +147,8 @@ public function registerMarkupTags(): array
146147
{
147148
return [
148149
'filters' => [
149-
'staticPage' => ['Winter\Pages\Classes\Page', 'url']
150-
]
150+
'staticPage' => ['Winter\Pages\Classes\Page', 'url'],
151+
],
151152
];
152153
}
153154

@@ -239,19 +240,19 @@ protected function extendBackendForms(): void
239240
*/
240241
protected function extendCmsTemplates(): void
241242
{
242-
Event::listen('cms.template.save', function($controller, $template, $type) {
243+
Event::listen('cms.template.save', function ($controller, $template, $type) {
243244
Plugin::clearCache();
244245
});
245246

246-
Event::listen('cms.template.processSettingsBeforeSave', function($controller, $dataHolder) {
247+
Event::listen('cms.template.processSettingsBeforeSave', function ($controller, $dataHolder) {
247248
$dataHolder->settings = Snippet::processTemplateSettingsArray($dataHolder->settings);
248249
});
249250

250-
Event::listen('cms.template.processSettingsAfterLoad', function($controller, $template) {
251+
Event::listen('cms.template.processSettingsAfterLoad', function ($controller, $template) {
251252
Snippet::processTemplateSettings($template);
252253
});
253254

254-
Event::listen('cms.template.processTwigContent', function($template, $dataHolder) {
255+
Event::listen('cms.template.processTwigContent', function ($template, $dataHolder) {
255256
if ($template instanceof \Cms\Classes\Layout) {
256257
$dataHolder->content = Controller::instance()->parseSyntaxFields($dataHolder->content);
257258
}
@@ -263,7 +264,7 @@ protected function extendCmsTemplates(): void
263264
*/
264265
protected function extendCmsRouter(): void
265266
{
266-
Event::listen('cms.router.beforeRoute', function($url) {
267+
Event::listen('cms.router.beforeRoute', function ($url) {
267268
return Controller::instance()->initCmsPage($url);
268269
});
269270
}
@@ -273,7 +274,7 @@ protected function extendCmsRouter(): void
273274
*/
274275
protected function extendCmsRenderer(): void
275276
{
276-
Event::listen('cms.page.beforeRenderPage', function($controller, $page) {
277+
Event::listen('cms.page.beforeRenderPage', function ($controller, $page) {
277278
/*
278279
* Before twig renders
279280
*/
@@ -290,11 +291,11 @@ protected function extendCmsRenderer(): void
290291
}
291292
});
292293

293-
Event::listen('cms.page.initComponents', function($controller, $page) {
294+
Event::listen('cms.page.initComponents', function ($controller, $page) {
294295
Controller::instance()->initPageComponents($controller, $page);
295296
});
296297

297-
Event::listen('cms.block.render', function($blockName, $blockContents) {
298+
Event::listen('cms.block.render', function ($blockName, $blockContents) {
298299
$page = CmsController::getController()->getPage();
299300

300301
if (!isset($page->apiBag['staticPage'])) {
@@ -313,24 +314,24 @@ protected function extendCmsRenderer(): void
313314
*/
314315
protected function registerMenuItemTypes(): void
315316
{
316-
Event::listen('pages.menuitem.listTypes', function() {
317+
Event::listen('pages.menuitem.listTypes', function () {
317318
return [
318319
'static-page' => 'winter.pages::lang.menuitem.static_page',
319-
'all-static-pages' => 'winter.pages::lang.menuitem.all_static_pages'
320+
'all-static-pages' => 'winter.pages::lang.menuitem.all_static_pages',
320321
];
321322
});
322323

323-
Event::listen('pages.menuitem.getTypeInfo', function($type) {
324+
Event::listen('pages.menuitem.getTypeInfo', function ($type) {
324325
if ($type == 'url') {
325326
return [];
326327
}
327328

328-
if ($type == 'static-page'|| $type == 'all-static-pages') {
329+
if ($type == 'static-page' || $type == 'all-static-pages') {
329330
return StaticPage::getMenuTypeInfo($type);
330331
}
331332
});
332333

333-
Event::listen('pages.menuitem.resolveItem', function($type, $item, $url, $theme) {
334+
Event::listen('pages.menuitem.resolveItem', function ($type, $item, $url, $theme) {
334335
if ($type == 'static-page' || $type == 'all-static-pages') {
335336
return StaticPage::resolveMenuItem($item, $url, $theme);
336337
}

assets/js/page-preview.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -63,7 +63,7 @@
6363
* @param {Event} event
6464
*/
6565
PagePreview.prototype.onDeviceClick = function (event) {
66-
const $clicked = $(event.currentTarget)
66+
public const $clicked = $(event.currentTarget)
6767

6868
// Remove active class from other options
6969
this.$deviceSelector.find('a').removeClass('active')

classes/Content.php

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,6 @@
1-
<?php namespace Winter\Pages\Classes;
1+
<?php
2+
3+
namespace Winter\Pages\Classes;
24

35
use Cms\Classes\Content as ContentBase;
46

@@ -16,7 +18,7 @@ class Content extends ContentBase
1618
* @var array Attributes that support translation, if available.
1719
*/
1820
public $translatable = [
19-
'markup'
21+
'markup',
2022
];
2123

2224
public $translatableModel = 'Winter\Translate\Classes\MLContent';

classes/Controller.php

Lines changed: 8 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,14 @@
1-
<?php namespace Winter\Pages\Classes;
1+
<?php
2+
3+
namespace Winter\Pages\Classes;
24

3-
use Cache;
45
use Cms\Classes\CmsException;
56
use Cms\Classes\Page as CmsPage;
67
use Cms\Classes\Theme;
78
use Exception;
8-
use Lang;
9-
use Log;
9+
use Illuminate\Support\Facades\Cache;
10+
use Illuminate\Support\Facades\Lang;
11+
use Illuminate\Support\Facades\Log;
1012
use Winter\Storm\Parse\Syntax\Parser as SyntaxParser;
1113
use Winter\Storm\Support\Str;
1214

@@ -139,10 +141,9 @@ public function parseSyntaxFields($content)
139141
try {
140142
return SyntaxParser::parse($content, [
141143
'varPrefix' => 'extraData.',
142-
'tagPrefix' => 'page:'
144+
'tagPrefix' => 'page:',
143145
])->toTwig();
144-
}
145-
catch (Exception $ex) {
146+
} catch (Exception $ex) {
146147
return $content;
147148
}
148149
}

classes/Menu.php

Lines changed: 16 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,12 @@
1-
<?php namespace Winter\Pages\Classes;
1+
<?php
2+
3+
namespace Winter\Pages\Classes;
24

35
use Cms\Classes\Meta;
4-
use Event;
5-
use Request;
6-
use SystemException;
7-
use Url;
6+
use Illuminate\Support\Facades\Request;
7+
use Winter\Storm\Exception\SystemException;
8+
use Winter\Storm\Support\Facades\Event;
9+
use Winter\Storm\Support\Facades\URL;
810
use Winter\Storm\Support\Str;
911

1012
/**
@@ -71,7 +73,7 @@ public function setCodeAttribute($code)
7173
$code = trim($code);
7274

7375
if (strlen($code)) {
74-
$this->fileName = $code.'.yaml';
76+
$this->fileName = $code . '.yaml';
7577
$this->attributes = array_merge($this->attributes, ['code' => $code]);
7678
}
7779

@@ -148,11 +150,11 @@ public function generateReferences($page)
148150
$currentUrl = Str::lower(Url::to($currentUrl));
149151

150152
$activeMenuItem = $page->activeMenuItem ?: false;
151-
$iterator = function($items) use ($currentUrl, &$iterator, $activeMenuItem) {
153+
$iterator = function ($items) use ($currentUrl, &$iterator, $activeMenuItem) {
152154
$result = [];
153155

154156
foreach ($items as $item) {
155-
$parentReference = new MenuItemReference;
157+
$parentReference = new MenuItemReference();
156158
$parentReference->type = $item->type;
157159
$parentReference->title = $item->title;
158160
$parentReference->code = $item->code;
@@ -165,8 +167,7 @@ public function generateReferences($page)
165167
if ($item->type == 'url') {
166168
$parentReference->url = $item->url;
167169
$parentReference->isActive = $currentUrl == Str::lower(Url::to($item->url)) || $activeMenuItem === $item->code;
168-
}
169-
else {
170+
} else {
170171
/*
171172
* If the item type is not URL, use the API to request the item type's provider to
172173
* return the item URL, subitems and determine whether the item is active.
@@ -179,11 +180,11 @@ public function generateReferences($page)
179180
}
180181

181182
if (isset($itemInfo['items'])) {
182-
$itemIterator = function($items) use (&$itemIterator, $parentReference) {
183+
$itemIterator = function ($items) use (&$itemIterator, $parentReference) {
183184
$result = [];
184185

185186
foreach ($items as $item) {
186-
$reference = new MenuItemReference;
187+
$reference = new MenuItemReference();
187188
$reference->type = isset($item['type']) ? $item['type'] : null;
188189
$reference->title = isset($item['title']) ? $item['title'] : '--no title--';
189190
$reference->url = isset($item['url']) ? $item['url'] : '#';
@@ -216,8 +217,7 @@ public function generateReferences($page)
216217

217218
if (!$item->replace) {
218219
$result[] = $parentReference;
219-
}
220-
else {
220+
} else {
221221
foreach ($parentReference->items as $subItem) {
222222
$result[] = $subItem;
223223
}
@@ -232,7 +232,7 @@ public function generateReferences($page)
232232
/*
233233
* Populate the isChildActive property
234234
*/
235-
$hasActiveChild = function($items) use (&$hasActiveChild) {
235+
$hasActiveChild = function ($items) use (&$hasActiveChild) {
236236
foreach ($items as $item) {
237237
if ($item->isActive) {
238238
return true;
@@ -245,7 +245,7 @@ public function generateReferences($page)
245245
}
246246
};
247247

248-
$iterator = function($items) use (&$iterator, &$hasActiveChild) {
248+
$iterator = function ($items) use (&$iterator, &$hasActiveChild) {
249249
foreach ($items as $item) {
250250
$item->isChildActive = $hasActiveChild($item->items);
251251

classes/MenuItem.php

Lines changed: 9 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,8 @@
1-
<?php namespace Winter\Pages\Classes;
1+
<?php
22

3-
use Event;
3+
namespace Winter\Pages\Classes;
4+
5+
use Winter\Storm\Support\Facades\Event;
46

57
/**
68
* Represents a menu item.
@@ -78,7 +80,7 @@ class MenuItem
7880
'reference',
7981
'cmsPage',
8082
'replace',
81-
'viewBag'
83+
'viewBag',
8284
];
8385

8486
/**
@@ -96,15 +98,14 @@ public static function initFromArray(array $items): array
9698
$result = [];
9799

98100
foreach ($items as $itemData) {
99-
$obj = new self;
101+
$obj = new self();
100102

101103
foreach ($itemData as $name => $value) {
102104
if ($name != 'items') {
103105
if (property_exists($obj, $name)) {
104106
$obj->$name = $value;
105107
}
106-
}
107-
else {
108+
} else {
108109
$obj->items = self::initFromArray($value);
109110
}
110111
}
@@ -174,9 +175,9 @@ public static function getTypeInfo($type): array
174175
$baseName = $page->getBaseFileName();
175176
$pos = strrpos($baseName, '/');
176177

177-
$dir = $pos !== false ? substr($baseName, 0, $pos).' / ' : null;
178+
$dir = $pos !== false ? substr($baseName, 0, $pos) . ' / ' : null;
178179
$cmsPages[$baseName] = strlen($page->title)
179-
? $dir.$page->title
180+
? $dir . $page->title
180181
: $baseName;
181182
}
182183

classes/MenuItemReference.php

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,6 @@
1-
<?php namespace Winter\Pages\Classes;
1+
<?php
2+
3+
namespace Winter\Pages\Classes;
24

35
/**
46
* Represents a front-end menu item.

0 commit comments

Comments
 (0)