Completed
Push — master ( b4c4c6...a737f9 )
by Damian
9s
created

CMSMain::ListViewForm()   C

Complexity

Conditions 7
Paths 4

Size

Total Lines 92
Code Lines 64

Duplication

Lines 13
Ratio 14.13 %

Importance

Changes 1
Bugs 0 Features 0
Metric Value
c 1
b 0
f 0
dl 13
loc 92
rs 6.4983
cc 7
eloc 64
nc 4
nop 0

How to fix   Long Method   

Long Method

Small methods make your code easier to understand, in particular if combined with a good name. Besides, if your method is small, finding a good name is usually much easier.

For example, if you find yourself adding comments to a method's body, this is usually a good sign to extract the commented part to a new method, and use the comment as a starting point when coming up with a good name for this new method.

Commonly applied refactorings include:

1
<?php
2
/**
3
 * The main "content" area of the CMS.
4
 *
5
 * This class creates a 2-frame layout - left-tree and right-form - to sit beneath the main
6
 * admin menu.
7
 *
8
 * @package cms
9
 * @subpackage controller
10
 * @todo Create some base classes to contain the generic functionality that will be replicated.
11
 */
12
class CMSMain extends LeftAndMain implements CurrentPageIdentifier, PermissionProvider {
13
14
	private static $url_segment = 'pages';
0 ignored issues
show
Comprehensibility introduced by
Consider using a different property name as you override a private property of the parent class.
Loading history...
15
16
	private static $url_rule = '/$Action/$ID/$OtherID';
0 ignored issues
show
Comprehensibility introduced by
Consider using a different property name as you override a private property of the parent class.
Loading history...
17
18
	// Maintain a lower priority than other administration sections
19
	// so that Director does not think they are actions of CMSMain
20
	private static $url_priority = 39;
0 ignored issues
show
Comprehensibility introduced by
Consider using a different property name as you override a private property of the parent class.
Loading history...
21
22
	private static $menu_title = 'Edit Page';
0 ignored issues
show
Comprehensibility introduced by
Consider using a different property name as you override a private property of the parent class.
Loading history...
23
24
	private static $menu_priority = 10;
0 ignored issues
show
Comprehensibility introduced by
Consider using a different property name as you override a private property of the parent class.
Loading history...
25
26
	private static $tree_class = "SiteTree";
0 ignored issues
show
Comprehensibility introduced by
Consider using a different property name as you override a private property of the parent class.
Loading history...
27
28
	private static $subitem_class = "Member";
29
30
	/**
31
	 * Amount of results showing on a single page.
32
	 *
33
	 * @config
34
	 * @var int
35
	 */
36
	private static $page_length = 15;
37
38
	private static $allowed_actions = array(
0 ignored issues
show
Comprehensibility introduced by
Consider using a different property name as you override a private property of the parent class.
Loading history...
39
		'archive',
40
		'buildbrokenlinks',
41
		'deleteitems',
42
		'DeleteItemsForm',
43
		'dialog',
44
		'duplicate',
45
		'duplicatewithchildren',
46
		'publishall',
47
		'publishitems',
48
		'PublishItemsForm',
49
		'submit',
50
		'EditForm',
51
		'SearchForm',
52
		'SiteTreeAsUL',
53
		'getshowdeletedsubtree',
54
		'batchactions',
55
		'treeview',
56
		'listview',
57
		'ListViewForm',
58
		'childfilter',
59
	);
60
61
	/**
62
	 * Enable legacy batch actions.
63
	 * @deprecated since version 4.0
64
	 * @var array
65
	 * @config
66
	 */
67
	private static $enabled_legacy_actions = array();
68
69
	public function init() {
70
		// set reading lang
71
		if(SiteTree::has_extension('Translatable') && !$this->getRequest()->isAjax()) {
72
			Translatable::choose_site_locale(array_keys(Translatable::get_existing_content_languages('SiteTree')));
73
		}
74
75
		parent::init();
76
77
		Requirements::css(CMS_DIR . '/css/screen.css');
78
		Requirements::customCSS($this->generatePageIconsCss());
0 ignored issues
show
Documentation Bug introduced by
The method generatePageIconsCss does not exist on object<CMSMain>? Since you implemented __call, maybe consider adding a @method annotation.

If you implement __call and you know which methods are available, you can improve IDE auto-completion and static analysis by adding a @method annotation to the class.

This is often the case, when __call is implemented by a parent class and only the child class knows which methods exist:

class ParentClass {
    private $data = array();

    public function __call($method, array $args) {
        if (0 === strpos($method, 'get')) {
            return $this->data[strtolower(substr($method, 3))];
        }

        throw new \LogicException(sprintf('Unsupported method: %s', $method));
    }
}

/**
 * If this class knows which fields exist, you can specify the methods here:
 *
 * @method string getName()
 */
class SomeClass extends ParentClass { }
Loading history...
79
		Requirements::add_i18n_javascript(CMS_DIR . '/javascript/lang', false, true);
80
		Requirements::javascript(CMS_DIR . '/javascript/dist/bundle-lib.js', [
81
			'provides' => [
82
				CMS_DIR . '/javascript/dist/CMSMain.AddForm.js',
83
				CMS_DIR . '/javascript/dist/CMSMain.EditForm.js',
84
				CMS_DIR . '/javascript/dist/CMSMain.js',
85
				CMS_DIR . '/javascript/dist/CMSMain.Tree.js',
86
				CMS_DIR . '/javascript/dist/CMSPageHistoryController.js',
87
				CMS_DIR . '/javascript/dist/RedirectorPage.js',
88
				CMS_DIR . '/javascript/dist/SilverStripeNavigator.js',
89
				CMS_DIR . '/javascript/dist/SiteTreeURLSegmentField.js'
90
			]
91
		]);
92
93
		CMSBatchActionHandler::register('publish', 'CMSBatchAction_Publish');
94
		CMSBatchActionHandler::register('unpublish', 'CMSBatchAction_Unpublish');
95
96
97
		// Check legacy actions
98
		$legacy = $this->config()->enabled_legacy_actions;
99
100
		// Delete from live is unnecessary since we have unpublish which does the same thing
101
		if(in_array('CMSBatchAction_DeleteFromLive', $legacy)) {
102
			Deprecation::notice('4.0', 'Delete From Live is deprecated. Use Un-publish instead');
103
			CMSBatchActionHandler::register('deletefromlive', 'CMSBatchAction_DeleteFromLive');
104
		}
105
106
		// Delete action
107
		if(in_array('CMSBatchAction_Delete', $legacy)) {
108
			Deprecation::notice('4.0', 'Delete from Stage is deprecated. Use Archive instead.');
109
			CMSBatchActionHandler::register('delete', 'CMSBatchAction_Delete');
110
		} else {
111
			CMSBatchActionHandler::register('archive', 'CMSBatchAction_Archive');
112
			CMSBatchActionHandler::register('restore', 'CMSBatchAction_Restore');
113
		}
114
	}
115
116
	public function index($request) {
117
		// In case we're not showing a specific record, explicitly remove any session state,
118
		// to avoid it being highlighted in the tree, and causing an edit form to show.
119
		if(!$request->param('Action')) $this->setCurrentPageId(null);
120
121
		return parent::index($request);
122
	}
123
124
	public function getResponseNegotiator() {
125
		$negotiator = parent::getResponseNegotiator();
126
		$controller = $this;
127
		$negotiator->setCallback('ListViewForm', function() use(&$controller) {
128
			return $controller->ListViewForm()->forTemplate();
129
		});
130
		return $negotiator;
131
	}
132
133
	/**
134
	 * If this is set to true, the "switchView" context in the
135
	 * template is shown, with links to the staging and publish site.
136
	 *
137
	 * @return boolean
138
	 */
139
	public function ShowSwitchView() {
140
		return true;
141
	}
142
143
	/**
144
	 * Overloads the LeftAndMain::ShowView. Allows to pass a page as a parameter, so we are able
145
	 * to switch view also for archived versions.
146
	 */
147
	public function SwitchView($page = null) {
148
		if(!$page) {
149
			$page = $this->currentPage();
150
		}
151
152
		if($page) {
153
			$nav = SilverStripeNavigator::get_for_record($page);
154
			return $nav['items'];
155
		}
156
	}
157
158
	//------------------------------------------------------------------------------------------//
159
	// Main controllers
160
161
	//------------------------------------------------------------------------------------------//
162
	// Main UI components
163
164
	/**
165
	 * Override {@link LeftAndMain} Link to allow blank URL segment for CMSMain.
166
	 *
167
	 * @param string|null $action Action to link to.
168
	 * @return string
169
	 */
170
	public function Link($action = null) {
171
		$link = Controller::join_links(
172
			$this->stat('url_base', true),
0 ignored issues
show
Unused Code introduced by
The call to CMSMain::stat() has too many arguments starting with true.

This check compares calls to functions or methods with their respective definitions. If the call has more arguments than are defined, it raises an issue.

If a function is defined several times with a different number of parameters, the check may pick up the wrong definition and report false positives. One codebase where this has been known to happen is Wordpress.

In this case you can add the @ignore PhpDoc annotation to the duplicate definition and it will be ignored.

Loading history...
173
			$this->stat('url_segment', true), // in case we want to change the segment
0 ignored issues
show
Unused Code introduced by
The call to CMSMain::stat() has too many arguments starting with true.

This check compares calls to functions or methods with their respective definitions. If the call has more arguments than are defined, it raises an issue.

If a function is defined several times with a different number of parameters, the check may pick up the wrong definition and report false positives. One codebase where this has been known to happen is Wordpress.

In this case you can add the @ignore PhpDoc annotation to the duplicate definition and it will be ignored.

Loading history...
174
			'/', // trailing slash needed if $action is null!
175
			"$action"
176
		);
177
		$this->extend('updateLink', $link);
178
		return $link;
179
	}
180
181
	public function LinkPages() {
182
		return singleton('CMSPagesController')->Link();
183
	}
184
185
	public function LinkPagesWithSearch() {
186
		return $this->LinkWithSearch($this->LinkPages());
187
	}
188
189
	public function LinkTreeView() {
190
		return $this->LinkWithSearch(singleton('CMSMain')->Link('treeview'));
191
	}
192
193
	public function LinkListView() {
194
		return $this->LinkWithSearch(singleton('CMSMain')->Link('listview'));
195
	}
196
197
	public function LinkGalleryView() {
198
		return $this->LinkWithSearch(singleton('CMSMain')->Link('galleryview'));
199
	}
200
201
	public function LinkPageEdit($id = null) {
202
		if(!$id) $id = $this->currentPageID();
203
		return $this->LinkWithSearch(
204
			Controller::join_links(singleton('CMSPageEditController')->Link('show'), $id)
205
		);
206
	}
207
208 View Code Duplication
	public function LinkPageSettings() {
0 ignored issues
show
Duplication introduced by
This method seems to be duplicated in your project.

Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation.

You can also find more detailed suggestions in the “Code” section of your repository.

Loading history...
209
		if($id = $this->currentPageID()) {
210
			return $this->LinkWithSearch(
211
				Controller::join_links(singleton('CMSPageSettingsController')->Link('show'), $id)
212
			);
213
		}
214
	}
215
216 View Code Duplication
	public function LinkPageHistory() {
0 ignored issues
show
Duplication introduced by
This method seems to be duplicated in your project.

Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation.

You can also find more detailed suggestions in the “Code” section of your repository.

Loading history...
217
		if($id = $this->currentPageID()) {
218
			return $this->LinkWithSearch(
219
				Controller::join_links(singleton('CMSPageHistoryController')->Link('show'), $id)
220
			);
221
		}
222
	}
223
224
	public function LinkWithSearch($link) {
225
		// Whitelist to avoid side effects
226
		$params = array(
227
			'q' => (array)$this->getRequest()->getVar('q'),
228
			'ParentID' => $this->getRequest()->getVar('ParentID')
229
		);
230
		$link = Controller::join_links(
231
			$link,
232
			array_filter(array_values($params)) ? '?' . http_build_query($params) : null
233
		);
234
		$this->extend('updateLinkWithSearch', $link);
235
		return $link;
236
	}
237
238
	public function LinkPageAdd($extra = null, $placeholders = null) {
239
		$link = singleton("CMSPageAddController")->Link();
240
		$this->extend('updateLinkPageAdd', $link);
241
242
		if($extra) {
243
			$link = Controller::join_links ($link, $extra);
244
		}
245
246
		if($placeholders) {
247
			$link .= (strpos($link, '?') === false ? "?$placeholders" : "&amp;$placeholders");
248
		}
249
250
		return $link;
251
	}
252
253
	/**
254
	 * @return string
255
	 */
256
	public function LinkPreview() {
257
		$record = $this->getRecord($this->currentPageID());
258
		$baseLink = Director::absoluteBaseURL();
259
		if ($record && $record instanceof Page) {
0 ignored issues
show
Bug introduced by
The class Page does not exist. Did you forget a USE statement, or did you not list all dependencies?

This error could be the result of:

1. Missing dependencies

PHP Analyzer uses your composer.json file (if available) to determine the dependencies of your project and to determine all the available classes and functions. It expects the composer.json to be in the root folder of your repository.

Are you sure this class is defined by one of your dependencies, or did you maybe not list a dependency in either the require or require-dev section?

2. Missing use statement

PHP does not complain about undefined classes in ìnstanceof checks. For example, the following PHP code will work perfectly fine:

if ($x instanceof DoesNotExist) {
    // Do something.
}

If you have not tested against this specific condition, such errors might go unnoticed.

Loading history...
260
			// if we are an external redirector don't show a link
261
			if ($record instanceof RedirectorPage && $record->RedirectionType == 'External') {
262
				$baseLink = false;
263
			}
264
			else {
265
				$baseLink = $record->Link('?stage=Stage');
266
			}
267
		}
268
		return $baseLink;
269
	}
270
271
	/**
272
	 * Return the entire site tree as a nested set of ULs
273
	 */
274
	public function SiteTreeAsUL() {
275
		// Pre-cache sitetree version numbers for querying efficiency
276
		Versioned::prepopulate_versionnumber_cache("SiteTree", "Stage");
277
		Versioned::prepopulate_versionnumber_cache("SiteTree", "Live");
278
		$html = $this->getSiteTreeFor($this->stat('tree_class'));
279
280
		$this->extend('updateSiteTreeAsUL', $html);
281
282
		return $html;
283
	}
284
285
	/**
286
	 * @return boolean
287
	 */
288
	public function TreeIsFiltered() {
289
		$query = $this->getRequest()->getVar('q');
290
291
		if (!$query || (count($query) === 1 && isset($query['FilterClass']) && $query['FilterClass'] === 'CMSSiteTreeFilter_Search')) {
292
			return false;
293
		}
294
295
		return true;
296
	}
297
298
	public function ExtraTreeTools() {
299
		$html = '';
300
		$this->extend('updateExtraTreeTools', $html);
301
		return $html;
302
	}
303
304
	/**
305
	 * Returns a Form for page searching for use in templates.
306
	 *
307
	 * Can be modified from a decorator by a 'updateSearchForm' method
308
	 *
309
	 * @return Form
310
	 */
311
	public function SearchForm() {
312
		// Create the fields
313
		$content = new TextField('q[Term]', _t('CMSSearch.FILTERLABELTEXT', 'Search'));
314
		$dateHeader = new HeaderField('q[Date]', _t('CMSSearch.PAGEFILTERDATEHEADING', 'Last edited'), 4);
315
		$dateFrom = new DateField(
316
			'q[LastEditedFrom]',
317
			_t('CMSSearch.FILTERDATEFROM', 'From')
318
		);
319
		$dateFrom->setConfig('showcalendar', true);
320
		$dateTo = new DateField(
321
			'q[LastEditedTo]',
322
			_t('CMSSearch.FILTERDATETO', 'To')
323
		);
324
		$dateTo->setConfig('showcalendar', true);
325
		$pageFilter = new DropdownField(
326
			'q[FilterClass]',
327
			_t('CMSMain.PAGES', 'Page status'),
328
			CMSSiteTreeFilter::get_all_filters()
329
		);
330
		$pageClasses = new DropdownField(
331
			'q[ClassName]',
332
			_t('CMSMain.PAGETYPEOPT', 'Page type', 'Dropdown for limiting search to a page type'),
333
			$this->getPageTypes()
334
		);
335
		$pageClasses->setEmptyString(_t('CMSMain.PAGETYPEANYOPT','Any'));
336
337
		// Group the Datefields
338
		$dateGroup = new FieldGroup(
339
			$dateHeader,
340
			$dateFrom,
341
			$dateTo
342
		);
343
		$dateGroup->setFieldHolderTemplate('FieldGroup_DefaultFieldHolder')->addExtraClass('stacked');
344
345
		// Create the Field list
346
		$fields = new FieldList(
347
			$content,
348
			$dateGroup,
349
			$pageFilter,
350
			$pageClasses
351
		);
352
353
		// Create the Search and Reset action
354
		$actions = new FieldList(
355
			FormAction::create('doSearch',  _t('CMSMain_left_ss.APPLY_FILTER', 'Search'))
356
				->addExtraClass('ss-ui-action-constructive'),
357
			Object::create('ResetFormAction', 'clear', _t('CMSMain_left_ss.CLEAR_FILTER', 'Clear'))
358
		);
359
360
		// Use <button> to allow full jQuery UI styling on the all of the Actions
361
		foreach($actions->dataFields() as $action) {
362
			$action->setUseButtonTag(true);
363
		}
364
365
		// Create the form
366
		$form = Form::create($this, 'SearchForm', $fields, $actions)
367
			->addExtraClass('cms-search-form')
368
			->setFormMethod('GET')
369
			->setFormAction($this->Link())
370
			->disableSecurityToken()
371
			->unsetValidator();
372
373
		// Load the form with previously sent search data
374
		$form->loadDataFrom($this->getRequest()->getVars());
375
376
		// Allow decorators to modify the form
377
		$this->extend('updateSearchForm', $form);
378
379
		return $form;
380
	}
381
382
	/**
383
	 * Returns a sorted array suitable for a dropdown with pagetypes and their translated name
384
	 *
385
	 * @return array
386
	 */
387
	protected function getPageTypes() {
388
		$pageTypes = array();
389
		foreach(SiteTree::page_type_classes() as $pageTypeClass) {
390
			$pageTypes[$pageTypeClass] = _t($pageTypeClass.'.SINGULARNAME', $pageTypeClass);
391
		}
392
		asort($pageTypes);
393
		return $pageTypes;
394
	}
395
396
	public function doSearch($data, $form) {
0 ignored issues
show
Unused Code introduced by
The parameter $data is not used and could be removed.

This check looks from parameters that have been defined for a function or method, but which are not used in the method body.

Loading history...
Unused Code introduced by
The parameter $form is not used and could be removed.

This check looks from parameters that have been defined for a function or method, but which are not used in the method body.

Loading history...
397
		return $this->getsubtree($this->getRequest());
398
	}
399
400
	/**
401
	 * @param bool $unlinked
402
	 * @return ArrayList
403
	 */
404
	public function Breadcrumbs($unlinked = false) {
405
		$items = parent::Breadcrumbs($unlinked);
406
407
		if($items->count() > 1) {
408
			// Specific to the SiteTree admin section, we never show the cms section and current
409
			// page in the same breadcrumbs block.
410
			$items->shift();
411
		}
412
413
		return $items;
414
	}
415
416
	/**
417
	 * Create serialized JSON string with site tree hints data to be injected into
418
	 * 'data-hints' attribute of root node of jsTree.
419
	 *
420
	 * @return string Serialized JSON
421
	 */
422
	public function SiteTreeHints() {
423
		$json = '';
0 ignored issues
show
Unused Code introduced by
$json is not used, you could remove the assignment.

This check looks for variable assignements that are either overwritten by other assignments or where the variable is not used subsequently.

$myVar = 'Value';
$higher = false;

if (rand(1, 6) > 3) {
    $higher = true;
} else {
    $higher = false;
}

Both the $myVar assignment in line 1 and the $higher assignment in line 2 are dead. The first because $myVar is never used and the second because $higher is always overwritten for every possible time line.

Loading history...
424
		$classes = SiteTree::page_type_classes();
425
426
	 	$cacheCanCreate = array();
427
	 	foreach($classes as $class) $cacheCanCreate[$class] = singleton($class)->canCreate();
428
429
	 	// Generate basic cache key. Too complex to encompass all variations
430
	 	$cache = SS_Cache::factory('CMSMain_SiteTreeHints');
431
	 	$cacheKey = md5(implode('_', array(Member::currentUserID(), implode(',', $cacheCanCreate), implode(',', $classes))));
432
	 	if($this->getRequest()->getVar('flush')) $cache->clean(Zend_Cache::CLEANING_MODE_ALL);
433
	 	$json = $cache->load($cacheKey);
434
	 	if(!$json) {
435
			$def['Root'] = array();
0 ignored issues
show
Coding Style Comprehensibility introduced by
$def was never initialized. Although not strictly required by PHP, it is generally a good practice to add $def = array(); before regardless.

Adding an explicit array definition is generally preferable to implicit array definition as it guarantees a stable state of the code.

Let’s take a look at an example:

foreach ($collection as $item) {
    $myArray['foo'] = $item->getFoo();

    if ($item->hasBar()) {
        $myArray['bar'] = $item->getBar();
    }

    // do something with $myArray
}

As you can see in this example, the array $myArray is initialized the first time when the foreach loop is entered. You can also see that the value of the bar key is only written conditionally; thus, its value might result from a previous iteration.

This might or might not be intended. To make your intention clear, your code more readible and to avoid accidental bugs, we recommend to add an explicit initialization $myArray = array() either outside or inside the foreach loop.

Loading history...
436
			$def['Root']['disallowedChildren'] = array();
437
438
			// Contains all possible classes to support UI controls listing them all,
439
			// such as the "add page here" context menu.
440
			$def['All'] = array();
441
442
			// Identify disallows and set globals
443
			foreach($classes as $class) {
444
				$obj = singleton($class);
445
				if($obj instanceof HiddenClass) continue;
446
447
				// Name item
448
				$def['All'][$class] = array(
449
					'title' => $obj->i18n_singular_name()
450
				);
451
452
				// Check if can be created at the root
453
				$needsPerm = $obj->stat('need_permission');
454
				if(
455
					!$obj->stat('can_be_root')
456
					|| (!array_key_exists($class, $cacheCanCreate) || !$cacheCanCreate[$class])
457
					|| ($needsPerm && !$this->can($needsPerm))
458
				) {
459
					$def['Root']['disallowedChildren'][] = $class;
460
				}
461
462
				// Hint data specific to the class
463
				$def[$class] = array();
464
465
				$defaultChild = $obj->defaultChild();
466
				if($defaultChild !== 'Page' && $defaultChild !== null) {
467
					$def[$class]['defaultChild'] = $defaultChild;
468
				}
469
470
				$defaultParent = $obj->defaultParent();
471
				if ($defaultParent !== 1 && $defaultParent !== null) {
472
					$def[$class]['defaultParent'] = $defaultParent;
473
				}
474
			}
475
476
			$this->extend('updateSiteTreeHints', $def);
477
478
			$json = Convert::raw2json($def);
479
			$cache->save($json, $cacheKey);
480
		}
481
		return $json;
482
	}
483
484
	/**
485
	 * Populates an array of classes in the CMS
486
	 * which allows the user to change the page type.
487
	 *
488
	 * @return SS_List
489
	 */
490
	public function PageTypes() {
491
		$classes = SiteTree::page_type_classes();
492
493
		$result = new ArrayList();
494
495
		foreach($classes as $class) {
496
			$instance = singleton($class);
497
498
			if($instance instanceof HiddenClass) continue;
499
500
			// skip this type if it is restricted
501
			if($instance->stat('need_permission') && !$this->can(singleton($class)->stat('need_permission'))) continue;
502
503
			$addAction = $instance->i18n_singular_name();
504
505
			// Get description (convert 'Page' to 'SiteTree' for correct localization lookups)
506
			$description = _t((($class == 'Page') ? 'SiteTree' : $class) . '.DESCRIPTION');
507
508
			if(!$description) {
509
				$description = $instance->uninherited('description');
510
			}
511
512
			if($class == 'Page' && !$description) {
513
				$description = singleton('SiteTree')->uninherited('description');
514
			}
515
516
			$result->push(new ArrayData(array(
517
				'ClassName' => $class,
518
				'AddAction' => $addAction,
519
				'Description' => $description,
520
				// TODO Sprite support
521
				'IconURL' => $instance->stat('icon'),
522
				'Title' => singleton($class)->i18n_singular_name(),
523
			)));
524
		}
525
526
		$result = $result->sort('AddAction');
527
528
		return $result;
529
	}
530
531
	/**
532
	 * Get a database record to be managed by the CMS.
533
	 *
534
	 * @param int $id Record ID
535
	 * @param int $versionID optional Version id of the given record
536
	 * @return SiteTree
537
	 */
538
 	public function getRecord($id, $versionID = null) {
539
		$treeClass = $this->stat('tree_class');
540
541
		if($id instanceof $treeClass) {
542
			return $id;
543
		}
544
		else if($id && is_numeric($id)) {
545
			if($this->getRequest()->getVar('Version')) {
546
				$versionID = (int) $this->getRequest()->getVar('Version');
547
			}
548
549
			if($versionID) {
0 ignored issues
show
Bug Best Practice introduced by
The expression $versionID of type integer|null is loosely compared to true; this is ambiguous if the integer can be zero. You might want to explicitly use !== null instead.

In PHP, under loose comparison (like ==, or !=, or switch conditions), values of different types might be equal.

For integer values, zero is a special case, in particular the following results might be unexpected:

0   == false // true
0   == null  // true
123 == false // false
123 == null  // false

// It is often better to use strict comparison
0 === false // false
0 === null  // false
Loading history...
550
				$record = Versioned::get_version($treeClass, $id, $versionID);
551
			} else {
552
				$record = DataObject::get_by_id($treeClass, $id);
553
			}
554
555
			// Then, try getting a record from the live site
556
			if(!$record) {
557
				// $record = Versioned::get_one_by_stage($treeClass, "Live", "\"$treeClass\".\"ID\" = $id");
558
				Versioned::reading_stage('Live');
559
				singleton($treeClass)->flushCache();
560
561
				$record = DataObject::get_by_id($treeClass, $id);
562
				if($record) Versioned::set_reading_mode('');
563
			}
564
565
			// Then, try getting a deleted record
566
			if(!$record) {
567
				$record = Versioned::get_latest_version($treeClass, $id);
568
			}
569
570
			// Don't open a page from a different locale
571
			/** The record's Locale is saved in database in 2.4, and not related with Session,
572
			 *  we should not check their locale matches the Translatable::get_current_locale,
573
			 * 	here as long as we all the HTTPRequest is init with right locale.
574
			 *	This bit breaks the all FileIFrameField functions if the field is used in CMS
575
			 *  and its relevent ajax calles, like loading the tree dropdown for TreeSelectorField.
576
			 */
577
			/* if($record && SiteTree::has_extension('Translatable') && $record->Locale && $record->Locale != Translatable::get_current_locale()) {
578
				$record = null;
579
			}*/
580
581
			return $record;
582
583
		} else if(substr($id,0,3) == 'new') {
584
			return $this->getNewItem($id);
585
		}
586
	}
587
588
	/**
589
	 * @param int $id
590
	 * @param FieldList $fields
591
	 * @return Form
592
	 */
593
	public function getEditForm($id = null, $fields = null) {
594
		if(!$id) $id = $this->currentPageID();
0 ignored issues
show
Bug Best Practice introduced by
The expression $id of type integer|null is loosely compared to false; this is ambiguous if the integer can be zero. You might want to explicitly use === null instead.

In PHP, under loose comparison (like ==, or !=, or switch conditions), values of different types might be equal.

For integer values, zero is a special case, in particular the following results might be unexpected:

0   == false // true
0   == null  // true
123 == false // false
123 == null  // false

// It is often better to use strict comparison
0 === false // false
0 === null  // false
Loading history...
595
		$form = parent::getEditForm($id);
596
597
		// TODO Duplicate record fetching (see parent implementation)
598
		$record = $this->getRecord($id);
599
		if($record && !$record->canView()) return Security::permissionFailure($this);
0 ignored issues
show
Bug Compatibility introduced by
The expression \Security::permissionFailure($this); of type SS_HTTPResponse|null adds the type SS_HTTPResponse to the return on line 599 which is incompatible with the return type documented by CMSMain::getEditForm of type Form.
Loading history...
600
601
		if(!$fields) $fields = $form->Fields();
602
		$actions = $form->Actions();
0 ignored issues
show
Unused Code introduced by
$actions is not used, you could remove the assignment.

This check looks for variable assignements that are either overwritten by other assignments or where the variable is not used subsequently.

$myVar = 'Value';
$higher = false;

if (rand(1, 6) > 3) {
    $higher = true;
} else {
    $higher = false;
}

Both the $myVar assignment in line 1 and the $higher assignment in line 2 are dead. The first because $myVar is never used and the second because $higher is always overwritten for every possible time line.

Loading history...
603
604
		if($record) {
605
			$deletedFromStage = $record->getIsDeletedFromStage();
606
607
			$fields->push($idField = new HiddenField("ID", false, $id));
0 ignored issues
show
Documentation introduced by
false is of type boolean, but the function expects a null|string.

It seems like the type of the argument is not accepted by the function/method which you are calling.

In some cases, in particular if PHP’s automatic type-juggling kicks in this might be fine. In other cases, however this might be a bug.

We suggest to add an explicit type cast like in the following example:

function acceptsInteger($int) { }

$x = '123'; // string "123"

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
Loading history...
608
			// Necessary for different subsites
609
			$fields->push($liveLinkField = new HiddenField("AbsoluteLink", false, $record->AbsoluteLink()));
0 ignored issues
show
Documentation introduced by
false is of type boolean, but the function expects a null|string.

It seems like the type of the argument is not accepted by the function/method which you are calling.

In some cases, in particular if PHP’s automatic type-juggling kicks in this might be fine. In other cases, however this might be a bug.

We suggest to add an explicit type cast like in the following example:

function acceptsInteger($int) { }

$x = '123'; // string "123"

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
Loading history...
610
			$fields->push($liveLinkField = new HiddenField("LiveLink"));
611
			$fields->push($stageLinkField = new HiddenField("StageLink"));
612
			$fields->push(new HiddenField("TreeTitle", false, $record->TreeTitle));
0 ignored issues
show
Documentation introduced by
The property TreeTitle does not exist on object<SiteTree>. Since you implemented __get, maybe consider adding a @property annotation.

Since your code implements the magic getter _get, this function will be called for any read access on an undefined variable. You can add the @property annotation to your class or interface to document the existence of this variable.

<?php

/**
 * @property int $x
 * @property int $y
 * @property string $text
 */
class MyLabel
{
    private $properties;

    private $allowedProperties = array('x', 'y', 'text');

    public function __get($name)
    {
        if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) {
            return $properties[$name];
        } else {
            return null;
        }
    }

    public function __set($name, $value)
    {
        if (in_array($name, $this->allowedProperties)) {
            $properties[$name] = $value;
        } else {
            throw new \LogicException("Property $name is not defined.");
        }
    }

}

If the property has read access only, you can use the @property-read annotation instead.

Of course, you may also just have mistyped another name, in which case you should fix the error.

See also the PhpDoc documentation for @property.

Loading history...
Documentation introduced by
false is of type boolean, but the function expects a null|string.

It seems like the type of the argument is not accepted by the function/method which you are calling.

In some cases, in particular if PHP’s automatic type-juggling kicks in this might be fine. In other cases, however this might be a bug.

We suggest to add an explicit type cast like in the following example:

function acceptsInteger($int) { }

$x = '123'; // string "123"

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
Loading history...
613
614
			if($record->ID && is_numeric( $record->ID ) ) {
615
				$liveLink = $record->getAbsoluteLiveLink();
616
				if($liveLink) $liveLinkField->setValue($liveLink);
617
				if(!$deletedFromStage) {
618
					$stageLink = Controller::join_links($record->AbsoluteLink(), '?stage=Stage');
619
					if($stageLink) $stageLinkField->setValue($stageLink);
620
				}
621
			}
622
623
			// Added in-line to the form, but plucked into different view by LeftAndMain.Preview.js upon load
624
			if(in_array('CMSPreviewable', class_implements($record)) && !$fields->fieldByName('SilverStripeNavigator')) {
625
				$navField = new LiteralField('SilverStripeNavigator', $this->getSilverStripeNavigator());
626
				$navField->setAllowHTML(true);
627
				$fields->push($navField);
628
			}
629
630
			// getAllCMSActions can be used to completely redefine the action list
631
			if($record->hasMethod('getAllCMSActions')) {
632
				$actions = $record->getAllCMSActions();
0 ignored issues
show
Documentation Bug introduced by
The method getAllCMSActions does not exist on object<SiteTree>? Since you implemented __call, maybe consider adding a @method annotation.

If you implement __call and you know which methods are available, you can improve IDE auto-completion and static analysis by adding a @method annotation to the class.

This is often the case, when __call is implemented by a parent class and only the child class knows which methods exist:

class ParentClass {
    private $data = array();

    public function __call($method, array $args) {
        if (0 === strpos($method, 'get')) {
            return $this->data[strtolower(substr($method, 3))];
        }

        throw new \LogicException(sprintf('Unsupported method: %s', $method));
    }
}

/**
 * If this class knows which fields exist, you can specify the methods here:
 *
 * @method string getName()
 */
class SomeClass extends ParentClass { }
Loading history...
633
			} else {
634
				$actions = $record->getCMSActions();
635
636
				// Find and remove action menus that have no actions.
637
				if ($actions && $actions->Count()) {
638
					$tabset = $actions->fieldByName('ActionMenus');
639
					if ($tabset) {
640
						foreach ($tabset->getChildren() as $tab) {
641
							if (!$tab->getChildren()->count()) {
642
								$tabset->removeByName($tab->getName());
643
							}
644
						}
645
					}
646
				}
647
			}
648
649
			// Use <button> to allow full jQuery UI styling
650
			$actionsFlattened = $actions->dataFields();
651
			if($actionsFlattened) foreach($actionsFlattened as $action) $action->setUseButtonTag(true);
652
653
			if($record->hasMethod('getCMSValidator')) {
654
				$validator = $record->getCMSValidator();
0 ignored issues
show
Documentation Bug introduced by
The method getCMSValidator does not exist on object<SiteTree>? Since you implemented __call, maybe consider adding a @method annotation.

If you implement __call and you know which methods are available, you can improve IDE auto-completion and static analysis by adding a @method annotation to the class.

This is often the case, when __call is implemented by a parent class and only the child class knows which methods exist:

class ParentClass {
    private $data = array();

    public function __call($method, array $args) {
        if (0 === strpos($method, 'get')) {
            return $this->data[strtolower(substr($method, 3))];
        }

        throw new \LogicException(sprintf('Unsupported method: %s', $method));
    }
}

/**
 * If this class knows which fields exist, you can specify the methods here:
 *
 * @method string getName()
 */
class SomeClass extends ParentClass { }
Loading history...
Unused Code introduced by
$validator is not used, you could remove the assignment.

This check looks for variable assignements that are either overwritten by other assignments or where the variable is not used subsequently.

$myVar = 'Value';
$higher = false;

if (rand(1, 6) > 3) {
    $higher = true;
} else {
    $higher = false;
}

Both the $myVar assignment in line 1 and the $higher assignment in line 2 are dead. The first because $myVar is never used and the second because $higher is always overwritten for every possible time line.

Loading history...
655
			} else {
656
				$validator = new RequiredFields();
0 ignored issues
show
Unused Code introduced by
$validator is not used, you could remove the assignment.

This check looks for variable assignements that are either overwritten by other assignments or where the variable is not used subsequently.

$myVar = 'Value';
$higher = false;

if (rand(1, 6) > 3) {
    $higher = true;
} else {
    $higher = false;
}

Both the $myVar assignment in line 1 and the $higher assignment in line 2 are dead. The first because $myVar is never used and the second because $higher is always overwritten for every possible time line.

Loading history...
657
			}
658
659
			// TODO Can't merge $FormAttributes in template at the moment
660
			$form->addExtraClass('center ' . $this->BaseCSSClasses());
661
			// Set validation exemptions for specific actions
662
			$form->setValidationExemptActions(array('restore', 'revert', 'deletefromlive', 'delete', 'unpublish', 'rollback', 'doRollback'));
663
664
			// Announce the capability so the frontend can decide whether to allow preview or not.
665
			if(in_array('CMSPreviewable', class_implements($record))) {
666
				$form->addExtraClass('cms-previewable');
667
			}
668
669
			if(!$record->canEdit() || $deletedFromStage) {
670
				$readonlyFields = $form->Fields()->makeReadonly();
671
				$form->setFields($readonlyFields);
672
			}
673
674
			$this->extend('updateEditForm', $form);
675
			return $form;
676
		} else if($id) {
677
			$form = Form::create( $this, "EditForm", new FieldList(
678
				new LabelField('PageDoesntExistLabel',_t('CMSMain.PAGENOTEXISTS',"This page doesn't exist"))), new FieldList()
679
			)->setHTMLID('Form_EditForm');
680
			return $form;
681
		}
682
	}
683
684
	/**
685
	 * @param SS_HTTPRequest $request
686
	 * @return string HTML
687
	 */
688
	public function treeview($request) {
0 ignored issues
show
Unused Code introduced by
The parameter $request is not used and could be removed.

This check looks from parameters that have been defined for a function or method, but which are not used in the method body.

Loading history...
689
		return $this->renderWith($this->getTemplatesWithSuffix('_TreeView'));
690
	}
691
692
	/**
693
	 * @param SS_HTTPRequest $request
694
	 * @return string HTML
695
	 */
696
	public function listview($request) {
0 ignored issues
show
Unused Code introduced by
The parameter $request is not used and could be removed.

This check looks from parameters that have been defined for a function or method, but which are not used in the method body.

Loading history...
697
		return $this->renderWith($this->getTemplatesWithSuffix('_ListView'));
698
	}
699
700
	/**
701
	 * Callback to request the list of page types allowed under a given page instance.
702
	 * Provides a slower but more precise response over SiteTreeHints
703
	 *
704
	 * @param SS_HTTPRequest $request
705
	 * @return SS_HTTPResponse
706
	 */
707
	public function childfilter($request) {
708
		// Check valid parent specified
709
		$parentID = $request->requestVar('ParentID');
710
		$parent = SiteTree::get()->byID($parentID);
711
		if(!$parent || !$parent->exists()) return $this->httpError(404);
712
713
		// Build hints specific to this class
714
		// Identify disallows and set globals
715
		$classes = SiteTree::page_type_classes();
716
		$disallowedChildren = array();
717
		foreach($classes as $class) {
718
			$obj = singleton($class);
719
			if($obj instanceof HiddenClass) continue;
720
721
			if(!$obj->canCreate(null, array('Parent' => $parent))) {
722
				$disallowedChildren[] = $class;
723
			}
724
		}
725
726
		$this->extend('updateChildFilter', $disallowedChildren, $parentID);
727
		return $this
728
			->getResponse()
729
			->addHeader('Content-Type', 'application/json; charset=utf-8')
730
			->setBody(Convert::raw2json($disallowedChildren));
731
	}
732
733
	/**
734
	 * Safely reconstruct a selected filter from a given set of query parameters
735
	 *
736
	 * @param array $params Query parameters to use
737
	 * @return CMSSiteTreeFilter The filter class, or null if none present
738
	 * @throws InvalidArgumentException if invalid filter class is passed.
739
	 */
740
	protected function getQueryFilter($params) {
741
		if(empty($params['FilterClass'])) return null;
742
		$filterClass = $params['FilterClass'];
743
		if(!is_subclass_of($filterClass, 'CMSSiteTreeFilter')) {
744
			throw new InvalidArgumentException("Invalid filter class passed: {$filterClass}");
745
		}
746
		return $filterClass::create($params);
747
	}
748
749
	/**
750
	 * Returns the pages meet a certain criteria as {@see CMSSiteTreeFilter} or the subpages of a parent page
751
	 * defaulting to no filter and show all pages in first level.
752
	 * Doubles as search results, if any search parameters are set through {@link SearchForm()}.
753
	 *
754
	 * @param array $params Search filter criteria
755
	 * @param int $parentID Optional parent node to filter on (can't be combined with other search criteria)
756
	 * @return SS_List
757
	 * @throws InvalidArgumentException if invalid filter class is passed.
758
	 */
759
	public function getList($params = array(), $parentID = 0) {
760
		if($filter = $this->getQueryFilter($params)) {
761
			return $filter->getFilteredPages();
762
		} else {
763
			$list = DataList::create($this->stat('tree_class'));
764
			$parentID = is_numeric($parentID) ? $parentID : 0;
765
			return $list->filter("ParentID", $parentID);
766
		}
767
	}
768
769
	public function ListViewForm() {
770
		$params = $this->getRequest()->requestVar('q');
771
		$list = $this->getList($params, $parentID = $this->getRequest()->requestVar('ParentID'));
772
		$gridFieldConfig = GridFieldConfig::create()->addComponents(
773
			new GridFieldSortableHeader(),
774
			new GridFieldDataColumns(),
775
			new GridFieldPaginator(self::config()->page_length)
776
		);
777
		if($parentID){
778
			$gridFieldConfig->addComponent(
779
				GridFieldLevelup::create($parentID)
780
					->setLinkSpec('?ParentID=%d&view=list')
781
					->setAttributes(array('data-pjax' => 'ListViewForm,Breadcrumbs'))
782
			);
783
		}
784
		$gridField = new GridField('Page','Pages', $list, $gridFieldConfig);
785
		$columns = $gridField->getConfig()->getComponentByType('GridFieldDataColumns');
786
787
		// Don't allow navigating into children nodes on filtered lists
788
		$fields = array(
789
			'getTreeTitle' => _t('SiteTree.PAGETITLE', 'Page Title'),
790
			'singular_name' => _t('SiteTree.PAGETYPE'),
791
			'LastEdited' => _t('SiteTree.LASTUPDATED', 'Last Updated'),
792
		);
793
		$gridField->getConfig()->getComponentByType('GridFieldSortableHeader')->setFieldSorting(array('getTreeTitle' => 'Title'));
0 ignored issues
show
Bug introduced by
It seems like you code against a concrete implementation and not the interface GridFieldComponent as the method setFieldSorting() does only exist in the following implementations of said interface: GridFieldSortableHeader.

Let’s take a look at an example:

interface User
{
    /** @return string */
    public function getPassword();
}

class MyUser implements User
{
    public function getPassword()
    {
        // return something
    }

    public function getDisplayName()
    {
        // return some name.
    }
}

class AuthSystem
{
    public function authenticate(User $user)
    {
        $this->logger->info(sprintf('Authenticating %s.', $user->getDisplayName()));
        // do something.
    }
}

In the above example, the authenticate() method works fine as long as you just pass instances of MyUser. However, if you now also want to pass a different implementation of User which does not have a getDisplayName() method, the code will break.

Available Fixes

  1. Change the type-hint for the parameter:

    class AuthSystem
    {
        public function authenticate(MyUser $user) { /* ... */ }
    }
    
  2. Add an additional type-check:

    class AuthSystem
    {
        public function authenticate(User $user)
        {
            if ($user instanceof MyUser) {
                $this->logger->info(/** ... */);
            }
    
            // or alternatively
            if ( ! $user instanceof MyUser) {
                throw new \LogicException(
                    '$user must be an instance of MyUser, '
                   .'other instances are not supported.'
                );
            }
    
        }
    }
    
Note: PHP Analyzer uses reverse abstract interpretation to narrow down the types inside the if block in such a case.
  1. Add the method to the interface:

    interface User
    {
        /** @return string */
        public function getPassword();
    
        /** @return string */
        public function getDisplayName();
    }
    
Loading history...
794
		$gridField->getState()->ParentID = $parentID;
795
796
		if(!$params) {
797
			$fields = array_merge(array('listChildrenLink' => ''), $fields);
798
		}
799
800
		$columns->setDisplayFields($fields);
801
		$columns->setFieldCasting(array(
802
			'Created' => 'SS_Datetime->Ago',
803
			'LastEdited' => 'SS_Datetime->FormatFromSettings',
804
			'getTreeTitle' => 'HTMLText'
805
		));
806
807
		$controller = $this;
808
		$columns->setFieldFormatting(array(
809
			'listChildrenLink' => function($value, &$item) use($controller) {
810
				$num = $item ? $item->numChildren() : null;
811
				if($num) {
812
					return sprintf(
813
						'<a class="cms-panel-link list-children-link" data-pjax-target="ListViewForm,Breadcrumbs" href="%s">%s</a>',
814
						Controller::join_links(
815
							$controller->Link(),
816
							sprintf("?ParentID=%d&view=list", (int)$item->ID)
817
						),
818
						$num
819
					);
820
				}
821
			},
822
			'getTreeTitle' => function($value, &$item) use($controller) {
823
				return sprintf(
824
					'<a class="action-detail" href="%s">%s</a>',
825
					Controller::join_links(
826
						singleton('CMSPageEditController')->Link('show'),
827
						(int)$item->ID
828
					),
829
					$item->TreeTitle // returns HTML, does its own escaping
830
				);
831
			}
832
		));
833
834
		$negotiator = $this->getResponseNegotiator();
835
		$listview = Form::create(
836
			$this,
837
			'ListViewForm',
838
			new FieldList($gridField),
839
			new FieldList()
840
		)->setHTMLID('Form_ListViewForm');
841
		$listview->setAttribute('data-pjax-fragment', 'ListViewForm');
842 View Code Duplication
		$listview->setValidationResponseCallback(function() use ($negotiator, $listview) {
0 ignored issues
show
Duplication introduced by
This code seems to be duplicated across your project.

Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation.

You can also find more detailed suggestions in the “Code” section of your repository.

Loading history...
843
			$request = $this->getRequest();
844
			if($request->isAjax() && $negotiator) {
845
				$listview->setupFormErrors();
846
				$result = $listview->forTemplate();
847
848
				return $negotiator->respond($request, array(
849
					'CurrentForm' => function() use($result) {
850
						return $result;
851
					}
852
				));
853
			}
854
		});
855
856
		$this->extend('updateListView', $listview);
857
858
		$listview->disableSecurityToken();
859
		return $listview;
860
	}
861
862
	public function currentPageID() {
863
		$id = parent::currentPageID();
864
865
		$this->extend('updateCurrentPageID', $id);
866
867
		return $id;
868
	}
869
870
	//------------------------------------------------------------------------------------------//
871
	// Data saving handlers
872
873
	/**
874
	 * Save and Publish page handler
875
	 */
876
	public function save($data, $form) {
877
		$className = $this->stat('tree_class');
878
879
		// Existing or new record?
880
		$id = $data['ID'];
881
		if(substr($id,0,3) != 'new') {
882
			$record = DataObject::get_by_id($className, $id);
883
			if($record && !$record->canEdit()) return Security::permissionFailure($this);
884
			if(!$record || !$record->ID) throw new SS_HTTPResponse_Exception("Bad record ID #$id", 404);
885
		} else {
886
			if(!singleton($this->stat('tree_class'))->canCreate()) return Security::permissionFailure($this);
887
			$record = $this->getNewItem($id, false);
888
		}
889
890
		// TODO Coupling to SiteTree
891
		$record->HasBrokenLink = 0;
892
		$record->HasBrokenFile = 0;
893
894
		if (!$record->ObsoleteClassName) $record->writeWithoutVersion();
895
896
		// Update the class instance if necessary
897
		if(isset($data['ClassName']) && $data['ClassName'] != $record->ClassName) {
898
			$newClassName = $record->ClassName;
899
			// The records originally saved attribute was overwritten by $form->saveInto($record) before.
900
			// This is necessary for newClassInstance() to work as expected, and trigger change detection
901
			// on the ClassName attribute
902
			$record->setClassName($data['ClassName']);
903
			// Replace $record with a new instance
904
			$record = $record->newClassInstance($newClassName);
905
		}
906
907
		// save form data into record
908
		$form->saveInto($record);
909
		$record->write();
910
911
		// If the 'Save & Publish' button was clicked, also publish the page
912
		if (isset($data['publish']) && $data['publish'] == 1) {
913
			$record->doPublish();
914
		}
915
916
		return $this->getResponseNegotiator()->respond($this->getRequest());
917
	}
918
919
	/**
920
	 * @uses LeftAndMainExtension->augmentNewSiteTreeItem()
921
	 */
922
	public function getNewItem($id, $setID = true) {
923
		$parentClass = $this->stat('tree_class');
924
		list($dummy, $className, $parentID, $suffix) = array_pad(explode('-',$id),4,null);
0 ignored issues
show
Unused Code introduced by
The assignment to $dummy is unused. Consider omitting it like so list($first,,$third).

This checks looks for assignemnts to variables using the list(...) function, where not all assigned variables are subsequently used.

Consider the following code example.

<?php

function returnThreeValues() {
    return array('a', 'b', 'c');
}

list($a, $b, $c) = returnThreeValues();

print $a . " - " . $c;

Only the variables $a and $c are used. There was no need to assign $b.

Instead, the list call could have been.

list($a,, $c) = returnThreeValues();
Loading history...
925
926
		if(!is_subclass_of($className, $parentClass) && strcasecmp($className, $parentClass) != 0) {
0 ignored issues
show
Bug introduced by
Due to PHP Bug #53727, is_subclass_of might return inconsistent results on some PHP versions if $parentClass can be an interface. If so, you could instead use ReflectionClass::implementsInterface.
Loading history...
927
			$response = Security::permissionFailure($this);
928
			if (!$response) {
929
				$response = $this->getResponse();
930
			}
931
			throw new SS_HTTPResponse_Exception($response);
932
		}
933
934
		$newItem = new $className();
935
936
		if( !$suffix ) {
937
			$sessionTag = "NewItems." . $parentID . "." . $className;
938
			if(Session::get($sessionTag)) {
939
				$suffix = '-' . Session::get($sessionTag);
940
				Session::set($sessionTag, Session::get($sessionTag) + 1);
941
			}
942
			else
943
				Session::set($sessionTag, 1);
944
945
				$id = $id . $suffix;
946
		}
947
948
		$newItem->Title = _t(
949
			'CMSMain.NEWPAGE',
950
			"New {pagetype}",'followed by a page type title',
951
			array('pagetype' => singleton($className)->i18n_singular_name())
0 ignored issues
show
Documentation introduced by
array('pagetype' => sing...->i18n_singular_name()) is of type array<string,?,{"pagetype":"?"}>, but the function expects a string.

It seems like the type of the argument is not accepted by the function/method which you are calling.

In some cases, in particular if PHP’s automatic type-juggling kicks in this might be fine. In other cases, however this might be a bug.

We suggest to add an explicit type cast like in the following example:

function acceptsInteger($int) { }

$x = '123'; // string "123"

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
Loading history...
952
		);
953
		$newItem->ClassName = $className;
954
		$newItem->ParentID = $parentID;
955
956
		// DataObject::fieldExists only checks the current class, not the hierarchy
957
		// This allows the CMS to set the correct sort value
958
		if($newItem->castingHelper('Sort')) {
959
			$newItem->Sort = DB::prepared_query('SELECT MAX("Sort") FROM "SiteTree" WHERE "ParentID" = ?', array($parentID))->value() + 1;
960
		}
961
962
		if($setID) $newItem->ID = $id;
963
964
		# Some modules like subsites add extra fields that need to be set when the new item is created
965
		$this->extend('augmentNewSiteTreeItem', $newItem);
966
967
		return $newItem;
968
	}
969
970
	/**
971
	 * Delete the page from live. This means a page in draft mode might still exist.
972
	 *
973
	 * @see delete()
974
	 */
975
	public function deletefromlive($data, $form) {
0 ignored issues
show
Unused Code introduced by
The parameter $form is not used and could be removed.

This check looks from parameters that have been defined for a function or method, but which are not used in the method body.

Loading history...
976
		Versioned::reading_stage('Live');
977
978
		/** @var SiteTree $record */
979
		$record = DataObject::get_by_id("SiteTree", $data['ID']);
980
		if($record && !($record->canDelete() && $record->canUnpublish())) {
0 ignored issues
show
Documentation Bug introduced by
The method canUnpublish does not exist on object<SiteTree>? Since you implemented __call, maybe consider adding a @method annotation.

If you implement __call and you know which methods are available, you can improve IDE auto-completion and static analysis by adding a @method annotation to the class.

This is often the case, when __call is implemented by a parent class and only the child class knows which methods exist:

class ParentClass {
    private $data = array();

    public function __call($method, array $args) {
        if (0 === strpos($method, 'get')) {
            return $this->data[strtolower(substr($method, 3))];
        }

        throw new \LogicException(sprintf('Unsupported method: %s', $method));
    }
}

/**
 * If this class knows which fields exist, you can specify the methods here:
 *
 * @method string getName()
 */
class SomeClass extends ParentClass { }
Loading history...
981
			return Security::permissionFailure($this);
982
		}
983
984
		$descendantsRemoved = 0;
985
		$recordTitle = $record->Title;
986
987
		// before deleting the records, get the descendants of this tree
988
		if($record) {
989
			$descendantIDs = $record->getDescendantIDList();
0 ignored issues
show
Documentation Bug introduced by
The method getDescendantIDList does not exist on object<SiteTree>? Since you implemented __call, maybe consider adding a @method annotation.

If you implement __call and you know which methods are available, you can improve IDE auto-completion and static analysis by adding a @method annotation to the class.

This is often the case, when __call is implemented by a parent class and only the child class knows which methods exist:

class ParentClass {
    private $data = array();

    public function __call($method, array $args) {
        if (0 === strpos($method, 'get')) {
            return $this->data[strtolower(substr($method, 3))];
        }

        throw new \LogicException(sprintf('Unsupported method: %s', $method));
    }
}

/**
 * If this class knows which fields exist, you can specify the methods here:
 *
 * @method string getName()
 */
class SomeClass extends ParentClass { }
Loading history...
990
991
			// then delete them from the live site too
992
			$descendantsRemoved = 0;
993
			foreach( $descendantIDs as $descID )
994
				/** @var SiteTree $descendant */
995
				if( $descendant = DataObject::get_by_id('SiteTree', $descID) ) {
996
					$descendant->doUnpublish();
997
					$descendantsRemoved++;
998
				}
999
1000
			// delete the record
1001
			$record->doUnpublish();
1002
		}
1003
1004
		Versioned::reading_stage('Stage');
1005
1006
		if(isset($descendantsRemoved)) {
1007
			$descRemoved = ' ' . _t(
1008
				'CMSMain.DESCREMOVED',
1009
				'and {count} descendants',
1010
				array('count' => $descendantsRemoved)
0 ignored issues
show
Documentation introduced by
array('count' => $descendantsRemoved) is of type array<string,integer,{"count":"integer"}>, but the function expects a string.

It seems like the type of the argument is not accepted by the function/method which you are calling.

In some cases, in particular if PHP’s automatic type-juggling kicks in this might be fine. In other cases, however this might be a bug.

We suggest to add an explicit type cast like in the following example:

function acceptsInteger($int) { }

$x = '123'; // string "123"

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
Loading history...
1011
			);
1012
		} else {
1013
			$descRemoved = '';
1014
		}
1015
1016
		$this->getResponse()->addHeader(
1017
			'X-Status',
1018
			rawurlencode(
1019
				_t(
1020
					'CMSMain.REMOVED',
1021
					'Deleted \'{title}\'{description} from live site',
1022
					array('title' => $recordTitle, 'description' => $descRemoved)
0 ignored issues
show
Documentation introduced by
array('title' => $record...ption' => $descRemoved) is of type array<string,string,{"ti...description":"string"}>, but the function expects a string.

It seems like the type of the argument is not accepted by the function/method which you are calling.

In some cases, in particular if PHP’s automatic type-juggling kicks in this might be fine. In other cases, however this might be a bug.

We suggest to add an explicit type cast like in the following example:

function acceptsInteger($int) { }

$x = '123'; // string "123"

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
Loading history...
1023
				)
1024
			)
1025
		);
1026
1027
		// Even if the record has been deleted from stage and live, it can be viewed in "archive mode"
1028
		return $this->getResponseNegotiator()->respond($this->getRequest());
1029
	}
1030
1031
	/**
1032
	 * Actually perform the publication step
1033
	 */
1034
	public function performPublish($record) {
1035
		if($record && !$record->canPublish()) return Security::permissionFailure($this);
1036
1037
		$record->doPublish();
1038
	}
1039
1040
	/**
1041
 	 * Reverts a page by publishing it to live.
1042
 	 * Use {@link restorepage()} if you want to restore a page
1043
 	 * which was deleted from draft without publishing.
1044
 	 *
1045
 	 * @uses SiteTree->doRevertToLive()
1046
	 */
1047
	public function revert($data, $form) {
0 ignored issues
show
Unused Code introduced by
The parameter $form is not used and could be removed.

This check looks from parameters that have been defined for a function or method, but which are not used in the method body.

Loading history...
1048
		if(!isset($data['ID'])) return new SS_HTTPResponse("Please pass an ID in the form content", 400);
1049
1050
		$id = (int) $data['ID'];
1051
		$restoredPage = Versioned::get_latest_version("SiteTree", $id);
1052
		if(!$restoredPage) 	return new SS_HTTPResponse("SiteTree #$id not found", 400);
1053
1054
		$record = Versioned::get_one_by_stage('SiteTree', 'Live', array(
0 ignored issues
show
Documentation introduced by
array('"SiteTree_Live"."ID"' => $id) is of type array<string,integer,{"\...e\".\"ID\"":"integer"}>, but the function expects a string.

It seems like the type of the argument is not accepted by the function/method which you are calling.

In some cases, in particular if PHP’s automatic type-juggling kicks in this might be fine. In other cases, however this might be a bug.

We suggest to add an explicit type cast like in the following example:

function acceptsInteger($int) { }

$x = '123'; // string "123"

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
Loading history...
1055
			'"SiteTree_Live"."ID"' => $id
1056
		));
1057
1058
		// a user can restore a page without publication rights, as it just adds a new draft state
1059
		// (this action should just be available when page has been "deleted from draft")
1060
		if($record && !$record->canEdit()) return Security::permissionFailure($this);
1061
		if(!$record || !$record->ID) throw new SS_HTTPResponse_Exception("Bad record ID #$id", 404);
1062
1063
		$record->doRevertToLive();
1064
1065
		$this->getResponse()->addHeader(
1066
			'X-Status',
1067
			rawurlencode(_t(
1068
				'CMSMain.RESTORED',
1069
				"Restored '{title}' successfully",
1070
				'Param %s is a title',
1071
				array('title' => $record->Title)
0 ignored issues
show
Documentation introduced by
array('title' => $record->Title) is of type array<string,?,{"title":"?"}>, but the function expects a string.

It seems like the type of the argument is not accepted by the function/method which you are calling.

In some cases, in particular if PHP’s automatic type-juggling kicks in this might be fine. In other cases, however this might be a bug.

We suggest to add an explicit type cast like in the following example:

function acceptsInteger($int) { }

$x = '123'; // string "123"

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
Loading history...
1072
			))
1073
		);
1074
1075
		return $this->getResponseNegotiator()->respond($this->getRequest());
1076
	}
1077
1078
	/**
1079
	 * Delete the current page from draft stage.
1080
	 * @see deletefromlive()
1081
	 */
1082
	public function delete($data, $form) {
1083
		Deprecation::notice('4.0', 'Delete from stage is deprecated. Use archive instead');
1084
		$id = $data['ID'];
1085
		$record = DataObject::get_by_id("SiteTree", $id);
1086
		if($record && !$record->canDelete()) return Security::permissionFailure();
1087
		if(!$record || !$record->ID) throw new SS_HTTPResponse_Exception("Bad record ID #$id", 404);
1088
1089
		// Delete record
1090
		$record->delete();
1091
1092
		$this->getResponse()->addHeader(
1093
			'X-Status',
1094
			rawurlencode(sprintf(_t('CMSMain.REMOVEDPAGEFROMDRAFT',"Removed '%s' from the draft site"), $record->Title))
1095
		);
1096
1097
		// Even if the record has been deleted from stage and live, it can be viewed in "archive mode"
1098
		return $this->getResponseNegotiator()->respond($this->getRequest());
1099
	}
1100
1101
	/**
1102
	 * Delete this page from both live and stage
1103
	 *
1104
	 * @param array $data
1105
	 * @param Form $form
1106
	 */
1107
	public function archive($data, $form) {
0 ignored issues
show
Unused Code introduced by
The parameter $form is not used and could be removed.

This check looks from parameters that have been defined for a function or method, but which are not used in the method body.

Loading history...
1108
		$id = $data['ID'];
1109
		$record = DataObject::get_by_id("SiteTree", $id);
1110
		if(!$record || !$record->exists()) {
1111
			throw new SS_HTTPResponse_Exception("Bad record ID #$id", 404);
1112
		}
1113
		if(!$record->canArchive()) {
1114
			return Security::permissionFailure();
1115
		}
1116
1117
		// Archive record
1118
		$record->doArchive();
1119
1120
		$this->getResponse()->addHeader(
1121
			'X-Status',
1122
			rawurlencode(sprintf(_t('CMSMain.ARCHIVEDPAGE',"Archived page '%s'"), $record->Title))
1123
		);
1124
1125
		// Even if the record has been deleted from stage and live, it can be viewed in "archive mode"
1126
		return $this->getResponseNegotiator()->respond($this->getRequest());
1127
	}
1128
1129
	public function publish($data, $form) {
1130
		$data['publish'] = '1';
1131
1132
		return $this->save($data, $form);
1133
	}
1134
1135
	public function unpublish($data, $form) {
0 ignored issues
show
Unused Code introduced by
The parameter $form is not used and could be removed.

This check looks from parameters that have been defined for a function or method, but which are not used in the method body.

Loading history...
1136
		$className = $this->stat('tree_class');
1137
		/** @var SiteTree $record */
1138
		$record = DataObject::get_by_id($className, $data['ID']);
1139
1140
		if($record && !$record->canUnpublish()) {
0 ignored issues
show
Documentation Bug introduced by
The method canUnpublish does not exist on object<SiteTree>? Since you implemented __call, maybe consider adding a @method annotation.

If you implement __call and you know which methods are available, you can improve IDE auto-completion and static analysis by adding a @method annotation to the class.

This is often the case, when __call is implemented by a parent class and only the child class knows which methods exist:

class ParentClass {
    private $data = array();

    public function __call($method, array $args) {
        if (0 === strpos($method, 'get')) {
            return $this->data[strtolower(substr($method, 3))];
        }

        throw new \LogicException(sprintf('Unsupported method: %s', $method));
    }
}

/**
 * If this class knows which fields exist, you can specify the methods here:
 *
 * @method string getName()
 */
class SomeClass extends ParentClass { }
Loading history...
1141
			return Security::permissionFailure($this);
1142
		}
1143 View Code Duplication
		if(!$record || !$record->ID) {
0 ignored issues
show
Duplication introduced by
This code seems to be duplicated across your project.

Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation.

You can also find more detailed suggestions in the “Code” section of your repository.

Loading history...
1144
			throw new SS_HTTPResponse_Exception("Bad record ID #" . (int)$data['ID'], 404);
1145
		}
1146
1147
		$record->doUnpublish();
1148
1149
		$this->getResponse()->addHeader(
1150
			'X-Status',
1151
			rawurlencode(_t('CMSMain.REMOVEDPAGE',"Removed '{title}' from the published site", array('title' => $record->Title)))
0 ignored issues
show
Documentation introduced by
array('title' => $record->Title) is of type array<string,string,{"title":"string"}>, but the function expects a string.

It seems like the type of the argument is not accepted by the function/method which you are calling.

In some cases, in particular if PHP’s automatic type-juggling kicks in this might be fine. In other cases, however this might be a bug.

We suggest to add an explicit type cast like in the following example:

function acceptsInteger($int) { }

$x = '123'; // string "123"

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
Loading history...
1152
		);
1153
1154
		return $this->getResponseNegotiator()->respond($this->getRequest());
1155
	}
1156
1157
	/**
1158
	 * @return array
1159
	 */
1160
	public function rollback() {
1161
		return $this->doRollback(array(
1162
			'ID' => $this->currentPageID(),
1163
			'Version' => $this->getRequest()->param('VersionID')
1164
		), null);
1165
	}
1166
1167
	/**
1168
	 * Rolls a site back to a given version ID
1169
	 *
1170
	 * @param array
1171
	 * @param Form
1172
	 *
1173
	 * @return html
1174
	 */
1175
	public function doRollback($data, $form) {
0 ignored issues
show
Unused Code introduced by
The parameter $form is not used and could be removed.

This check looks from parameters that have been defined for a function or method, but which are not used in the method body.

Loading history...
1176
		$this->extend('onBeforeRollback', $data['ID']);
1177
1178
		$id = (isset($data['ID'])) ? (int) $data['ID'] : null;
1179
		$version = (isset($data['Version'])) ? (int) $data['Version'] : null;
1180
1181
		$record = DataObject::get_by_id($this->stat('tree_class'), $id);
1182
		if($record && !$record->canEdit()) return Security::permissionFailure($this);
1183
1184
		if($version) {
0 ignored issues
show
Bug Best Practice introduced by
The expression $version of type integer|null is loosely compared to true; this is ambiguous if the integer can be zero. You might want to explicitly use !== null instead.

In PHP, under loose comparison (like ==, or !=, or switch conditions), values of different types might be equal.

For integer values, zero is a special case, in particular the following results might be unexpected:

0   == false // true
0   == null  // true
123 == false // false
123 == null  // false

// It is often better to use strict comparison
0 === false // false
0 === null  // false
Loading history...
1185
			$record->doRollbackTo($version);
1186
			$message = _t(
1187
				'CMSMain.ROLLEDBACKVERSIONv2',
1188
				"Rolled back to version #%d.",
1189
				array('version' => $data['Version'])
0 ignored issues
show
Documentation introduced by
array('version' => $data['Version']) is of type array<string,?,{"version":"?"}>, but the function expects a string.

It seems like the type of the argument is not accepted by the function/method which you are calling.

In some cases, in particular if PHP’s automatic type-juggling kicks in this might be fine. In other cases, however this might be a bug.

We suggest to add an explicit type cast like in the following example:

function acceptsInteger($int) { }

$x = '123'; // string "123"

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
Loading history...
1190
			);
1191
		} else {
1192
			$record->doRollbackTo('Live');
1193
			$message = _t(
1194
				'CMSMain.ROLLEDBACKPUBv2',"Rolled back to published version."
1195
			);
1196
		}
1197
1198
		$this->getResponse()->addHeader('X-Status', rawurlencode($message));
1199
1200
		// Can be used in different contexts: In normal page edit view, in which case the redirect won't have any effect.
1201
		// Or in history view, in which case a revert causes the CMS to re-load the edit view.
1202
		// The X-Pjax header forces a "full" content refresh on redirect.
1203
		$url = Controller::join_links(singleton('CMSPageEditController')->Link('show'), $record->ID);
1204
		$this->getResponse()->addHeader('X-ControllerURL', $url);
1205
		$this->getRequest()->addHeader('X-Pjax', 'Content');
1206
		$this->getResponse()->addHeader('X-Pjax', 'Content');
1207
1208
		return $this->getResponseNegotiator()->respond($this->getRequest());
1209
	}
1210
1211
	/**
1212
	 * Batch Actions Handler
1213
	 */
1214
	public function batchactions() {
1215
		return new CMSBatchActionHandler($this, 'batchactions');
1216
	}
1217
1218
	public function BatchActionParameters() {
1219
		$batchActions = CMSBatchActionHandler::config()->batch_actions;
1220
1221
		$forms = array();
1222
		foreach($batchActions as $urlSegment => $batchAction) {
1223
			$SNG_action = singleton($batchAction);
1224
			if ($SNG_action->canView() && $fieldset = $SNG_action->getParameterFields()) {
1225
				$formHtml = '';
1226
				foreach($fieldset as $field) {
1227
					$formHtml .= $field->Field();
1228
				}
1229
				$forms[$urlSegment] = $formHtml;
1230
			}
1231
		}
1232
		$pageHtml = '';
1233
		foreach($forms as $urlSegment => $html) {
1234
			$pageHtml .= "<div class=\"params\" id=\"BatchActionParameters_$urlSegment\">$html</div>\n\n";
1235
		}
1236
		return new LiteralField("BatchActionParameters", '<div id="BatchActionParameters" style="display:none">'.$pageHtml.'</div>');
1237
	}
1238
	/**
1239
	 * Returns a list of batch actions
1240
	 */
1241
	public function BatchActionList() {
1242
		return $this->batchactions()->batchActionList();
1243
	}
1244
1245
	public function buildbrokenlinks($request) {
1246
		// Protect against CSRF on destructive action
1247
		if(!SecurityToken::inst()->checkRequest($request)) return $this->httpError(400);
1248
1249
		increase_time_limit_to();
1250
		increase_memory_limit_to();
1251
1252
		if($this->urlParams['ID']) {
1253
			$newPageSet[] = DataObject::get_by_id("Page", $this->urlParams['ID']);
0 ignored issues
show
Coding Style Comprehensibility introduced by
$newPageSet was never initialized. Although not strictly required by PHP, it is generally a good practice to add $newPageSet = array(); before regardless.

Adding an explicit array definition is generally preferable to implicit array definition as it guarantees a stable state of the code.

Let’s take a look at an example:

foreach ($collection as $item) {
    $myArray['foo'] = $item->getFoo();

    if ($item->hasBar()) {
        $myArray['bar'] = $item->getBar();
    }

    // do something with $myArray
}

As you can see in this example, the array $myArray is initialized the first time when the foreach loop is entered. You can also see that the value of the bar key is only written conditionally; thus, its value might result from a previous iteration.

This might or might not be intended. To make your intention clear, your code more readible and to avoid accidental bugs, we recommend to add an explicit initialization $myArray = array() either outside or inside the foreach loop.

Loading history...
1254
		} else {
1255
			$pages = DataObject::get("Page");
1256
			foreach($pages as $page) $newPageSet[] = $page;
0 ignored issues
show
Coding Style Comprehensibility introduced by
$newPageSet was never initialized. Although not strictly required by PHP, it is generally a good practice to add $newPageSet = array(); before regardless.

Adding an explicit array definition is generally preferable to implicit array definition as it guarantees a stable state of the code.

Let’s take a look at an example:

foreach ($collection as $item) {
    $myArray['foo'] = $item->getFoo();

    if ($item->hasBar()) {
        $myArray['bar'] = $item->getBar();
    }

    // do something with $myArray
}

As you can see in this example, the array $myArray is initialized the first time when the foreach loop is entered. You can also see that the value of the bar key is only written conditionally; thus, its value might result from a previous iteration.

This might or might not be intended. To make your intention clear, your code more readible and to avoid accidental bugs, we recommend to add an explicit initialization $myArray = array() either outside or inside the foreach loop.

Loading history...
1257
			$pages = null;
0 ignored issues
show
Unused Code introduced by
$pages is not used, you could remove the assignment.

This check looks for variable assignements that are either overwritten by other assignments or where the variable is not used subsequently.

$myVar = 'Value';
$higher = false;

if (rand(1, 6) > 3) {
    $higher = true;
} else {
    $higher = false;
}

Both the $myVar assignment in line 1 and the $higher assignment in line 2 are dead. The first because $myVar is never used and the second because $higher is always overwritten for every possible time line.

Loading history...
1258
		}
1259
1260
		$content = new HtmlEditorField('Content');
1261
		$download = new HtmlEditorField('Download');
1262
1263
		foreach($newPageSet as $i => $page) {
1264
			$page->HasBrokenLink = 0;
1265
			$page->HasBrokenFile = 0;
1266
1267
			$content->setValue($page->Content);
1268
			$content->saveInto($page);
1269
1270
			$download->setValue($page->Download);
1271
			$download->saveInto($page);
1272
1273
			echo "<li>$page->Title (link:$page->HasBrokenLink, file:$page->HasBrokenFile)";
1274
1275
			$page->writeWithoutVersion();
1276
			$page->destroy();
1277
			$newPageSet[$i] = null;
0 ignored issues
show
Bug introduced by
The variable $newPageSet does not seem to be defined for all execution paths leading up to this point.

If you define a variable conditionally, it can happen that it is not defined for all execution paths.

Let’s take a look at an example:

function myFunction($a) {
    switch ($a) {
        case 'foo':
            $x = 1;
            break;

        case 'bar':
            $x = 2;
            break;
    }

    // $x is potentially undefined here.
    echo $x;
}

In the above example, the variable $x is defined if you pass “foo” or “bar” as argument for $a. However, since the switch statement has no default case statement, if you pass any other value, the variable $x would be undefined.

Available Fixes

  1. Check for existence of the variable explicitly:

    function myFunction($a) {
        switch ($a) {
            case 'foo':
                $x = 1;
                break;
    
            case 'bar':
                $x = 2;
                break;
        }
    
        if (isset($x)) { // Make sure it's always set.
            echo $x;
        }
    }
    
  2. Define a default value for the variable:

    function myFunction($a) {
        $x = ''; // Set a default which gets overridden for certain paths.
        switch ($a) {
            case 'foo':
                $x = 1;
                break;
    
            case 'bar':
                $x = 2;
                break;
        }
    
        echo $x;
    }
    
  3. Add a value for the missing path:

    function myFunction($a) {
        switch ($a) {
            case 'foo':
                $x = 1;
                break;
    
            case 'bar':
                $x = 2;
                break;
    
            // We add support for the missing case.
            default:
                $x = '';
                break;
        }
    
        echo $x;
    }
    
Loading history...
1278
		}
1279
	}
1280
1281
	public function publishall($request) {
1282
		if(!Permission::check('ADMIN')) return Security::permissionFailure($this);
1283
1284
		increase_time_limit_to();
1285
		increase_memory_limit_to();
1286
1287
		$response = "";
1288
1289
		if(isset($this->requestParams['confirm'])) {
1290
			// Protect against CSRF on destructive action
1291
			if(!SecurityToken::inst()->checkRequest($request)) return $this->httpError(400);
1292
1293
			$start = 0;
1294
			$pages = DataObject::get("SiteTree", "", "", "", "$start,30");
1295
			$count = 0;
1296
			while($pages) {
1297
				foreach($pages as $page) {
1298
					if($page && !$page->canPublish()) return Security::permissionFailure($this);
1299
1300
					$page->doPublish();
1301
					$page->destroy();
1302
					unset($page);
1303
					$count++;
1304
					$response .= "<li>$count</li>";
1305
				}
1306
				if($pages->Count() > 29) {
1307
					$start += 30;
1308
					$pages = DataObject::get("SiteTree", "", "", "", "$start,30");
1309
				} else {
1310
					break;
1311
				}
1312
			}
1313
			$response .= _t('CMSMain.PUBPAGES',"Done: Published {count} pages", array('count' => $count));
0 ignored issues
show
Documentation introduced by
array('count' => $count) is of type array<string,integer,{"count":"integer"}>, but the function expects a string.

It seems like the type of the argument is not accepted by the function/method which you are calling.

In some cases, in particular if PHP’s automatic type-juggling kicks in this might be fine. In other cases, however this might be a bug.

We suggest to add an explicit type cast like in the following example:

function acceptsInteger($int) { }

$x = '123'; // string "123"

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
Loading history...
1314
1315
		} else {
1316
			$token = SecurityToken::inst();
1317
			$fields = new FieldList();
1318
			$token->updateFieldSet($fields);
1319
			$tokenField = $fields->First();
1320
			$tokenHtml = ($tokenField) ? $tokenField->FieldHolder() : '';
1321
			$response .= '<h1>' . _t('CMSMain.PUBALLFUN','"Publish All" functionality') . '</h1>
1322
				<p>' . _t('CMSMain.PUBALLFUN2', 'Pressing this button will do the equivalent of going to every page and pressing "publish".  It\'s
1323
				intended to be used after there have been massive edits of the content, such as when the site was
1324
				first built.') . '</p>
1325
				<form method="post" action="publishall">
1326
					<input type="submit" name="confirm" value="'
1327
					. _t('CMSMain.PUBALLCONFIRM',"Please publish every page in the site, copying content stage to live",'Confirmation button') .'" />'
1328
					. $tokenHtml .
1329
				'</form>';
1330
		}
1331
1332
		return $response;
1333
	}
1334
1335
	/**
1336
	 * Restore a completely deleted page from the SiteTree_versions table.
1337
	 */
1338
	public function restore($data, $form) {
0 ignored issues
show
Unused Code introduced by
The parameter $form is not used and could be removed.

This check looks from parameters that have been defined for a function or method, but which are not used in the method body.

Loading history...
1339
		if(!isset($data['ID']) || !is_numeric($data['ID'])) {
1340
			return new SS_HTTPResponse("Please pass an ID in the form content", 400);
1341
		}
1342
1343
		$id = (int)$data['ID'];
1344
		$restoredPage = Versioned::get_latest_version("SiteTree", $id);
1345
		if(!$restoredPage) 	return new SS_HTTPResponse("SiteTree #$id not found", 400);
1346
1347
		$restoredPage = $restoredPage->doRestoreToStage();
1348
1349
		$this->getResponse()->addHeader(
1350
			'X-Status',
1351
			rawurlencode(_t(
1352
				'CMSMain.RESTORED',
1353
				"Restored '{title}' successfully",
1354
				array('title' => $restoredPage->Title)
0 ignored issues
show
Documentation introduced by
array('title' => $restoredPage->Title) is of type array<string,?,{"title":"?"}>, but the function expects a string.

It seems like the type of the argument is not accepted by the function/method which you are calling.

In some cases, in particular if PHP’s automatic type-juggling kicks in this might be fine. In other cases, however this might be a bug.

We suggest to add an explicit type cast like in the following example:

function acceptsInteger($int) { }

$x = '123'; // string "123"

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
Loading history...
1355
			))
1356
		);
1357
1358
		return $this->getResponseNegotiator()->respond($this->getRequest());
1359
	}
1360
1361
	public function duplicate($request) {
1362
		// Protect against CSRF on destructive action
1363
		if(!SecurityToken::inst()->checkRequest($request)) return $this->httpError(400);
1364
1365
		if(($id = $this->urlParams['ID']) && is_numeric($id)) {
1366
			$page = DataObject::get_by_id("SiteTree", $id);
1367 View Code Duplication
			if($page && (!$page->canEdit() || !$page->canCreate(null, array('Parent' => $page->Parent())))) {
0 ignored issues
show
Bug introduced by
The method Parent() does not exist on DataObject. Did you maybe mean parentClass()?

This check marks calls to methods that do not seem to exist on an object.

This is most likely the result of a method being renamed without all references to it being renamed likewise.

Loading history...
Duplication introduced by
This code seems to be duplicated across your project.

Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation.

You can also find more detailed suggestions in the “Code” section of your repository.

Loading history...
1368
				return Security::permissionFailure($this);
1369
			}
1370
			if(!$page || !$page->ID) throw new SS_HTTPResponse_Exception("Bad record ID #$id", 404);
1371
1372
			$newPage = $page->duplicate();
1373
1374
			// ParentID can be hard-set in the URL.  This is useful for pages with multiple parents
1375
			if(isset($_GET['parentID']) && is_numeric($_GET['parentID'])) {
1376
				$newPage->ParentID = $_GET['parentID'];
1377
				$newPage->write();
1378
			}
1379
1380
			$this->getResponse()->addHeader(
1381
				'X-Status',
1382
				rawurlencode(_t(
1383
					'CMSMain.DUPLICATED',
1384
					"Duplicated '{title}' successfully",
1385
					array('title' => $newPage->Title)
0 ignored issues
show
Documentation introduced by
array('title' => $newPage->Title) is of type array<string,?,{"title":"?"}>, but the function expects a string.

It seems like the type of the argument is not accepted by the function/method which you are calling.

In some cases, in particular if PHP’s automatic type-juggling kicks in this might be fine. In other cases, however this might be a bug.

We suggest to add an explicit type cast like in the following example:

function acceptsInteger($int) { }

$x = '123'; // string "123"

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
Loading history...
1386
				))
1387
			);
1388
			$url = Controller::join_links(singleton('CMSPageEditController')->Link('show'), $newPage->ID);
1389
			$this->getResponse()->addHeader('X-ControllerURL', $url);
1390
			$this->getRequest()->addHeader('X-Pjax', 'Content');
1391
			$this->getResponse()->addHeader('X-Pjax', 'Content');
1392
1393
			return $this->getResponseNegotiator()->respond($this->getRequest());
1394
		} else {
1395
			return new SS_HTTPResponse("CMSMain::duplicate() Bad ID: '$id'", 400);
1396
		}
1397
	}
1398
1399
	public function duplicatewithchildren($request) {
1400
		// Protect against CSRF on destructive action
1401
		if(!SecurityToken::inst()->checkRequest($request)) return $this->httpError(400);
1402
		increase_time_limit_to();
1403
		if(($id = $this->urlParams['ID']) && is_numeric($id)) {
1404
			$page = DataObject::get_by_id("SiteTree", $id);
1405 View Code Duplication
			if($page && (!$page->canEdit() || !$page->canCreate(null, array('Parent' => $page->Parent())))) {
0 ignored issues
show
Bug introduced by
The method Parent() does not exist on DataObject. Did you maybe mean parentClass()?

This check marks calls to methods that do not seem to exist on an object.

This is most likely the result of a method being renamed without all references to it being renamed likewise.

Loading history...
Duplication introduced by
This code seems to be duplicated across your project.

Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation.

You can also find more detailed suggestions in the “Code” section of your repository.

Loading history...
1406
				return Security::permissionFailure($this);
1407
			}
1408
			if(!$page || !$page->ID) throw new SS_HTTPResponse_Exception("Bad record ID #$id", 404);
1409
1410
			$newPage = $page->duplicateWithChildren();
1411
1412
			$this->getResponse()->addHeader(
1413
				'X-Status',
1414
				rawurlencode(_t(
1415
					'CMSMain.DUPLICATEDWITHCHILDREN',
1416
					"Duplicated '{title}' and children successfully",
1417
					array('title' => $newPage->Title)
0 ignored issues
show
Documentation introduced by
array('title' => $newPage->Title) is of type array<string,?,{"title":"?"}>, but the function expects a string.

It seems like the type of the argument is not accepted by the function/method which you are calling.

In some cases, in particular if PHP’s automatic type-juggling kicks in this might be fine. In other cases, however this might be a bug.

We suggest to add an explicit type cast like in the following example:

function acceptsInteger($int) { }

$x = '123'; // string "123"

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
Loading history...
1418
				))
1419
			);
1420
			$url = Controller::join_links(singleton('CMSPageEditController')->Link('show'), $newPage->ID);
1421
			$this->getResponse()->addHeader('X-ControllerURL', $url);
1422
			$this->getRequest()->addHeader('X-Pjax', 'Content');
1423
			$this->getResponse()->addHeader('X-Pjax', 'Content');
1424
1425
			return $this->getResponseNegotiator()->respond($this->getRequest());
1426
		} else {
1427
			return new SS_HTTPResponse("CMSMain::duplicatewithchildren() Bad ID: '$id'", 400);
1428
		}
1429
	}
1430
1431
	public function providePermissions() {
1432
		$title = _t("CMSPagesController.MENUTITLE", LeftAndMain::menu_title_for_class('CMSPagesController'));
1433
		return array(
1434
			"CMS_ACCESS_CMSMain" => array(
1435
				'name' => _t('CMSMain.ACCESS', "Access to '{title}' section", array('title' => $title)),
0 ignored issues
show
Documentation introduced by
array('title' => $title) is of type array<string,string,{"title":"string"}>, but the function expects a string.

It seems like the type of the argument is not accepted by the function/method which you are calling.

In some cases, in particular if PHP’s automatic type-juggling kicks in this might be fine. In other cases, however this might be a bug.

We suggest to add an explicit type cast like in the following example:

function acceptsInteger($int) { }

$x = '123'; // string "123"

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
Loading history...
1436
				'category' => _t('Permission.CMS_ACCESS_CATEGORY', 'CMS Access'),
1437
				'help' => _t(
1438
					'CMSMain.ACCESS_HELP',
1439
					'Allow viewing of the section containing page tree and content. View and edit permissions can be handled through page specific dropdowns, as well as the separate "Content permissions".'
1440
				),
1441
				'sort' => -99 // below "CMS_ACCESS_LeftAndMain", but above everything else
1442
			)
1443
		);
1444
	}
1445
1446
}
1447