Completed
Push — master ( 849cd8...301702 )
by Hamish
18s
created

CMSMain::archive()   B

Complexity

Conditions 4
Paths 3

Size

Total Lines 22
Code Lines 12

Duplication

Lines 22
Ratio 100 %

Importance

Changes 1
Bugs 0 Features 0
Metric Value
c 1
b 0
f 0
dl 22
loc 22
rs 8.9197
cc 4
eloc 12
nc 3
nop 2
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
	public function init() {
62
		// set reading lang
63
		if(SiteTree::has_extension('Translatable') && !$this->getRequest()->isAjax()) {
64
			Translatable::choose_site_locale(array_keys(Translatable::get_existing_content_languages('SiteTree')));
65
		}
66
67
		parent::init();
68
69
		Requirements::css(CMS_DIR . '/css/screen.css');
70
		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...
71
		Requirements::add_i18n_javascript(CMS_DIR . '/javascript/lang', false, true);
72
		Requirements::javascript(CMS_DIR . '/javascript/dist/bundle-lib.js', [
73
			'provides' => [
74
				CMS_DIR . '/javascript/dist/CMSMain.AddForm.js',
75
				CMS_DIR . '/javascript/dist/CMSMain.EditForm.js',
76
				CMS_DIR . '/javascript/dist/CMSMain.js',
77
				CMS_DIR . '/javascript/dist/CMSMain.Tree.js',
78
				CMS_DIR . '/javascript/dist/CMSPageHistoryController.js',
79
				CMS_DIR . '/javascript/dist/RedirectorPage.js',
80
				CMS_DIR . '/javascript/dist/SilverStripeNavigator.js',
81
				CMS_DIR . '/javascript/dist/SiteTreeURLSegmentField.js'
82
			]
83
		]);
84
85
		CMSBatchActionHandler::register('publish', 'CMSBatchAction_Publish');
86
		CMSBatchActionHandler::register('unpublish', 'CMSBatchAction_Unpublish');
87
		CMSBatchActionHandler::register('delete', 'CMSBatchAction_Delete');
88
		CMSBatchActionHandler::register('archive', 'CMSBatchAction_Archive');
89
		CMSBatchActionHandler::register('restore', 'CMSBatchAction_Restore');
90
	}
91
92
	public function index($request) {
93
		// In case we're not showing a specific record, explicitly remove any session state,
94
		// to avoid it being highlighted in the tree, and causing an edit form to show.
95
		if(!$request->param('Action')) $this->setCurrentPageId(null);
96
97
		return parent::index($request);
98
	}
99
100
	public function getResponseNegotiator() {
101
		$negotiator = parent::getResponseNegotiator();
102
		$controller = $this;
103
		$negotiator->setCallback('ListViewForm', function() use(&$controller) {
104
			return $controller->ListViewForm()->forTemplate();
105
		});
106
		return $negotiator;
107
	}
108
109
	/**
110
	 * If this is set to true, the "switchView" context in the
111
	 * template is shown, with links to the staging and publish site.
112
	 *
113
	 * @return boolean
114
	 */
115
	public function ShowSwitchView() {
116
		return true;
117
	}
118
119
	/**
120
	 * Overloads the LeftAndMain::ShowView. Allows to pass a page as a parameter, so we are able
121
	 * to switch view also for archived versions.
122
	 */
123
	public function SwitchView($page = null) {
124
		if(!$page) {
125
			$page = $this->currentPage();
126
		}
127
128
		if($page) {
129
			$nav = SilverStripeNavigator::get_for_record($page);
130
			return $nav['items'];
131
		}
132
	}
133
134
	//------------------------------------------------------------------------------------------//
135
	// Main controllers
136
137
	//------------------------------------------------------------------------------------------//
138
	// Main UI components
139
140
	/**
141
	 * Override {@link LeftAndMain} Link to allow blank URL segment for CMSMain.
142
	 *
143
	 * @param string|null $action Action to link to.
144
	 * @return string
145
	 */
146
	public function Link($action = null) {
147
		$link = Controller::join_links(
148
			$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...
149
			$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...
150
			'/', // trailing slash needed if $action is null!
151
			"$action"
152
		);
153
		$this->extend('updateLink', $link);
154
		return $link;
155
	}
156
157
	public function LinkPages() {
158
		return singleton('CMSPagesController')->Link();
159
	}
160
161
	public function LinkPagesWithSearch() {
162
		return $this->LinkWithSearch($this->LinkPages());
163
	}
164
165
	public function LinkTreeView() {
166
		return $this->LinkWithSearch(singleton('CMSMain')->Link('treeview'));
167
	}
168
169
	public function LinkListView() {
170
		return $this->LinkWithSearch(singleton('CMSMain')->Link('listview'));
171
	}
172
173
	public function LinkGalleryView() {
174
		return $this->LinkWithSearch(singleton('CMSMain')->Link('galleryview'));
175
	}
176
177
	public function LinkPageEdit($id = null) {
178
		if(!$id) $id = $this->currentPageID();
179
		return $this->LinkWithSearch(
180
			Controller::join_links(singleton('CMSPageEditController')->Link('show'), $id)
181
		);
182
	}
183
184 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...
185
		if($id = $this->currentPageID()) {
186
			return $this->LinkWithSearch(
187
				Controller::join_links(singleton('CMSPageSettingsController')->Link('show'), $id)
188
			);
189
		}
190
	}
191
192 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...
193
		if($id = $this->currentPageID()) {
194
			return $this->LinkWithSearch(
195
				Controller::join_links(singleton('CMSPageHistoryController')->Link('show'), $id)
196
			);
197
		}
198
	}
199
200
	public function LinkWithSearch($link) {
201
		// Whitelist to avoid side effects
202
		$params = array(
203
			'q' => (array)$this->getRequest()->getVar('q'),
204
			'ParentID' => $this->getRequest()->getVar('ParentID')
205
		);
206
		$link = Controller::join_links(
207
			$link,
208
			array_filter(array_values($params)) ? '?' . http_build_query($params) : null
209
		);
210
		$this->extend('updateLinkWithSearch', $link);
211
		return $link;
212
	}
213
214
	public function LinkPageAdd($extra = null, $placeholders = null) {
215
		$link = singleton("CMSPageAddController")->Link();
216
		$this->extend('updateLinkPageAdd', $link);
217
218
		if($extra) {
219
			$link = Controller::join_links ($link, $extra);
220
		}
221
222
		if($placeholders) {
223
			$link .= (strpos($link, '?') === false ? "?$placeholders" : "&amp;$placeholders");
224
		}
225
226
		return $link;
227
	}
228
229
	/**
230
	 * @return string
231
	 */
232
	public function LinkPreview() {
233
		$record = $this->getRecord($this->currentPageID());
234
		$baseLink = Director::absoluteBaseURL();
235
		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...
236
			// if we are an external redirector don't show a link
237
			if ($record instanceof RedirectorPage && $record->RedirectionType == 'External') {
238
				$baseLink = false;
239
			}
240
			else {
241
				$baseLink = $record->Link('?stage=Stage');
242
			}
243
		}
244
		return $baseLink;
245
	}
246
247
	/**
248
	 * Return the entire site tree as a nested set of ULs
249
	 */
250
	public function SiteTreeAsUL() {
251
		// Pre-cache sitetree version numbers for querying efficiency
252
		Versioned::prepopulate_versionnumber_cache("SiteTree", "Stage");
253
		Versioned::prepopulate_versionnumber_cache("SiteTree", "Live");
254
		$html = $this->getSiteTreeFor($this->stat('tree_class'));
255
256
		$this->extend('updateSiteTreeAsUL', $html);
257
258
		return $html;
259
	}
260
261
	/**
262
	 * @return boolean
263
	 */
264
	public function TreeIsFiltered() {
265
		$query = $this->getRequest()->getVar('q');
266
267
		if (!$query || (count($query) === 1 && isset($query['FilterClass']) && $query['FilterClass'] === 'CMSSiteTreeFilter_Search')) {
268
			return false;
269
		}
270
271
		return true;
272
	}
273
274
	public function ExtraTreeTools() {
275
		$html = '';
276
		$this->extend('updateExtraTreeTools', $html);
277
		return $html;
278
	}
279
280
	/**
281
	 * Returns a Form for page searching for use in templates.
282
	 *
283
	 * Can be modified from a decorator by a 'updateSearchForm' method
284
	 *
285
	 * @return Form
286
	 */
287
	public function SearchForm() {
288
		// Create the fields
289
		$content = new TextField('q[Term]', _t('CMSSearch.FILTERLABELTEXT', 'Search'));
290
		$dateHeader = new HeaderField('q[Date]', _t('CMSSearch.PAGEFILTERDATEHEADING', 'Last edited'), 4);
291
		$dateFrom = new DateField(
292
			'q[LastEditedFrom]',
293
			_t('CMSSearch.FILTERDATEFROM', 'From')
294
		);
295
		$dateFrom->setConfig('showcalendar', true);
296
		$dateTo = new DateField(
297
			'q[LastEditedTo]',
298
			_t('CMSSearch.FILTERDATETO', 'To')
299
		);
300
		$dateTo->setConfig('showcalendar', true);
301
		$pageFilter = new DropdownField(
302
			'q[FilterClass]',
303
			_t('CMSMain.PAGES', 'Page status'),
304
			CMSSiteTreeFilter::get_all_filters()
305
		);
306
		$pageClasses = new DropdownField(
307
			'q[ClassName]',
308
			_t('CMSMain.PAGETYPEOPT', 'Page type', 'Dropdown for limiting search to a page type'),
309
			$this->getPageTypes()
310
		);
311
		$pageClasses->setEmptyString(_t('CMSMain.PAGETYPEANYOPT','Any'));
312
313
		// Group the Datefields
314
		$dateGroup = new FieldGroup(
315
			$dateHeader,
316
			$dateFrom,
317
			$dateTo
318
		);
319
		$dateGroup->setFieldHolderTemplate('FieldGroup_DefaultFieldHolder')->addExtraClass('stacked');
320
321
		// Create the Field list
322
		$fields = new FieldList(
323
			$content,
324
			$dateGroup,
325
			$pageFilter,
326
			$pageClasses
327
		);
328
329
		// Create the Search and Reset action
330
		$actions = new FieldList(
331
			FormAction::create('doSearch',  _t('CMSMain_left_ss.APPLY_FILTER', 'Search'))
332
				->addExtraClass('ss-ui-action-constructive'),
333
			Object::create('ResetFormAction', 'clear', _t('CMSMain_left_ss.CLEAR_FILTER', 'Clear'))
334
		);
335
336
		// Use <button> to allow full jQuery UI styling on the all of the Actions
337
		foreach($actions->dataFields() as $action) {
338
			$action->setUseButtonTag(true);
339
		}
340
341
		// Create the form
342
		$form = Form::create($this, 'SearchForm', $fields, $actions)
343
			->addExtraClass('cms-search-form')
344
			->setFormMethod('GET')
345
			->setFormAction($this->Link())
346
			->disableSecurityToken()
347
			->unsetValidator();
348
349
		// Load the form with previously sent search data
350
		$form->loadDataFrom($this->getRequest()->getVars());
351
352
		// Allow decorators to modify the form
353
		$this->extend('updateSearchForm', $form);
354
355
		return $form;
356
	}
357
358
	/**
359
	 * Returns a sorted array suitable for a dropdown with pagetypes and their translated name
360
	 *
361
	 * @return array
362
	 */
363
	protected function getPageTypes() {
364
		$pageTypes = array();
365
		foreach(SiteTree::page_type_classes() as $pageTypeClass) {
366
			$pageTypes[$pageTypeClass] = _t($pageTypeClass.'.SINGULARNAME', $pageTypeClass);
367
		}
368
		asort($pageTypes);
369
		return $pageTypes;
370
	}
371
372
	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...
373
		return $this->getsubtree($this->getRequest());
374
	}
375
376
	/**
377
	 * @param bool $unlinked
378
	 * @return ArrayList
379
	 */
380
	public function Breadcrumbs($unlinked = false) {
381
		$items = parent::Breadcrumbs($unlinked);
382
383
		if($items->count() > 1) {
384
			// Specific to the SiteTree admin section, we never show the cms section and current
385
			// page in the same breadcrumbs block.
386
			$items->shift();
387
		}
388
389
		return $items;
390
	}
391
392
	/**
393
	 * Create serialized JSON string with site tree hints data to be injected into
394
	 * 'data-hints' attribute of root node of jsTree.
395
	 *
396
	 * @return string Serialized JSON
397
	 */
398
	public function SiteTreeHints() {
399
		$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...
400
		$classes = SiteTree::page_type_classes();
401
402
	 	$cacheCanCreate = array();
403
	 	foreach($classes as $class) $cacheCanCreate[$class] = singleton($class)->canCreate();
404
405
	 	// Generate basic cache key. Too complex to encompass all variations
406
	 	$cache = SS_Cache::factory('CMSMain_SiteTreeHints');
407
	 	$cacheKey = md5(implode('_', array(Member::currentUserID(), implode(',', $cacheCanCreate), implode(',', $classes))));
408
	 	if($this->getRequest()->getVar('flush')) $cache->clean(Zend_Cache::CLEANING_MODE_ALL);
409
	 	$json = $cache->load($cacheKey);
410
	 	if(!$json) {
411
			$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...
412
			$def['Root']['disallowedChildren'] = array();
413
414
			// Contains all possible classes to support UI controls listing them all,
415
			// such as the "add page here" context menu.
416
			$def['All'] = array();
417
418
			// Identify disallows and set globals
419
			foreach($classes as $class) {
420
				$obj = singleton($class);
421
				if($obj instanceof HiddenClass) continue;
422
423
				// Name item
424
				$def['All'][$class] = array(
425
					'title' => $obj->i18n_singular_name()
426
				);
427
428
				// Check if can be created at the root
429
				$needsPerm = $obj->stat('need_permission');
430
				if(
431
					!$obj->stat('can_be_root')
432
					|| (!array_key_exists($class, $cacheCanCreate) || !$cacheCanCreate[$class])
433
					|| ($needsPerm && !$this->can($needsPerm))
434
				) {
435
					$def['Root']['disallowedChildren'][] = $class;
436
				}
437
438
				// Hint data specific to the class
439
				$def[$class] = array();
440
441
				$defaultChild = $obj->defaultChild();
442
				if($defaultChild !== 'Page' && $defaultChild !== null) {
443
					$def[$class]['defaultChild'] = $defaultChild;
444
				}
445
446
				$defaultParent = $obj->defaultParent();
447
				if ($defaultParent !== 1 && $defaultParent !== null) {
448
					$def[$class]['defaultParent'] = $defaultParent;
449
				}
450
			}
451
452
			$this->extend('updateSiteTreeHints', $def);
453
454
			$json = Convert::raw2json($def);
455
			$cache->save($json, $cacheKey);
456
		}
457
		return $json;
458
	}
459
460
	/**
461
	 * Populates an array of classes in the CMS
462
	 * which allows the user to change the page type.
463
	 *
464
	 * @return SS_List
465
	 */
466
	public function PageTypes() {
467
		$classes = SiteTree::page_type_classes();
468
469
		$result = new ArrayList();
470
471
		foreach($classes as $class) {
472
			$instance = singleton($class);
473
474
			if($instance instanceof HiddenClass) continue;
475
476
			// skip this type if it is restricted
477
			if($instance->stat('need_permission') && !$this->can(singleton($class)->stat('need_permission'))) continue;
478
479
			$addAction = $instance->i18n_singular_name();
480
481
			// Get description (convert 'Page' to 'SiteTree' for correct localization lookups)
482
			$description = _t((($class == 'Page') ? 'SiteTree' : $class) . '.DESCRIPTION');
483
484
			if(!$description) {
485
				$description = $instance->uninherited('description');
486
			}
487
488
			if($class == 'Page' && !$description) {
489
				$description = singleton('SiteTree')->uninherited('description');
490
			}
491
492
			$result->push(new ArrayData(array(
493
				'ClassName' => $class,
494
				'AddAction' => $addAction,
495
				'Description' => $description,
496
				// TODO Sprite support
497
				'IconURL' => $instance->stat('icon'),
498
				'Title' => singleton($class)->i18n_singular_name(),
499
			)));
500
		}
501
502
		$result = $result->sort('AddAction');
503
504
		return $result;
505
	}
506
507
	/**
508
	 * Get a database record to be managed by the CMS.
509
	 *
510
	 * @param int $id Record ID
511
	 * @param int $versionID optional Version id of the given record
512
	 * @return SiteTree
513
	 */
514
 	public function getRecord($id, $versionID = null) {
515
		$treeClass = $this->stat('tree_class');
516
517
		if($id instanceof $treeClass) {
518
			return $id;
519
		}
520
		else if($id && is_numeric($id)) {
521
			if($this->getRequest()->getVar('Version')) {
522
				$versionID = (int) $this->getRequest()->getVar('Version');
523
			}
524
525
			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...
526
				$record = Versioned::get_version($treeClass, $id, $versionID);
527
			} else {
528
				$record = DataObject::get_by_id($treeClass, $id);
529
			}
530
531
			// Then, try getting a record from the live site
532
			if(!$record) {
533
				// $record = Versioned::get_one_by_stage($treeClass, "Live", "\"$treeClass\".\"ID\" = $id");
534
				Versioned::set_stage(Versioned::LIVE);
0 ignored issues
show
Bug introduced by
The method set_stage() does not seem to exist on object<Versioned>.

This check looks for calls to methods that do not seem to exist on a given type. It looks for the method on the type itself as well as in inherited classes or implemented interfaces.

This is most likely a typographical error or the method has been renamed.

Loading history...
535
				singleton($treeClass)->flushCache();
536
537
				$record = DataObject::get_by_id($treeClass, $id);
538
				if($record) Versioned::set_reading_mode('');
539
			}
540
541
			// Then, try getting a deleted record
542
			if(!$record) {
543
				$record = Versioned::get_latest_version($treeClass, $id);
544
			}
545
546
			// Don't open a page from a different locale
547
			/** The record's Locale is saved in database in 2.4, and not related with Session,
548
			 *  we should not check their locale matches the Translatable::get_current_locale,
549
			 * 	here as long as we all the HTTPRequest is init with right locale.
550
			 *	This bit breaks the all FileIFrameField functions if the field is used in CMS
551
			 *  and its relevent ajax calles, like loading the tree dropdown for TreeSelectorField.
552
			 */
553
			/* if($record && SiteTree::has_extension('Translatable') && $record->Locale && $record->Locale != Translatable::get_current_locale()) {
554
				$record = null;
555
			}*/
556
557
			return $record;
558
559
		} else if(substr($id,0,3) == 'new') {
560
			return $this->getNewItem($id);
561
		}
562
	}
563
564
	/**
565
	 * @param int $id
566
	 * @param FieldList $fields
567
	 * @return Form
568
	 */
569
	public function getEditForm($id = null, $fields = null) {
570
		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...
571
		$form = parent::getEditForm($id);
572
573
		// TODO Duplicate record fetching (see parent implementation)
574
		$record = $this->getRecord($id);
575
		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 575 which is incompatible with the return type documented by CMSMain::getEditForm of type Form.
Loading history...
576
577
		if(!$fields) $fields = $form->Fields();
578
		$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...
579
580
		if($record) {
581
			$deletedFromStage = $record->getIsDeletedFromStage();
582
583
			$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...
584
			// Necessary for different subsites
585
			$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...
586
			$fields->push($liveLinkField = new HiddenField("LiveLink"));
587
			$fields->push($stageLinkField = new HiddenField("StageLink"));
588
			$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...
589
590
			if($record->ID && is_numeric( $record->ID ) ) {
591
				$liveLink = $record->getAbsoluteLiveLink();
592
				if($liveLink) $liveLinkField->setValue($liveLink);
593
				if(!$deletedFromStage) {
594
					$stageLink = Controller::join_links($record->AbsoluteLink(), '?stage=Stage');
595
					if($stageLink) $stageLinkField->setValue($stageLink);
596
				}
597
			}
598
599
			// Added in-line to the form, but plucked into different view by LeftAndMain.Preview.js upon load
600
			if(in_array('CMSPreviewable', class_implements($record)) && !$fields->fieldByName('SilverStripeNavigator')) {
601
				$navField = new LiteralField('SilverStripeNavigator', $this->getSilverStripeNavigator());
602
				$navField->setAllowHTML(true);
603
				$fields->push($navField);
604
			}
605
606
			// getAllCMSActions can be used to completely redefine the action list
607
			if($record->hasMethod('getAllCMSActions')) {
608
				$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...
609
			} else {
610
				$actions = $record->getCMSActions();
611
612
				// Find and remove action menus that have no actions.
613
				if ($actions && $actions->Count()) {
614
					$tabset = $actions->fieldByName('ActionMenus');
615
					if ($tabset) {
616
						foreach ($tabset->getChildren() as $tab) {
617
							if (!$tab->getChildren()->count()) {
618
								$tabset->removeByName($tab->getName());
619
							}
620
						}
621
					}
622
				}
623
			}
624
625
			// Use <button> to allow full jQuery UI styling
626
			$actionsFlattened = $actions->dataFields();
627
			if($actionsFlattened) foreach($actionsFlattened as $action) $action->setUseButtonTag(true);
628
629
			if($record->hasMethod('getCMSValidator')) {
630
				$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...
631
			} else {
632
				$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...
633
			}
634
635
			// TODO Can't merge $FormAttributes in template at the moment
636
			$form->addExtraClass('center ' . $this->BaseCSSClasses());
637
			// Set validation exemptions for specific actions
638
			$form->setValidationExemptActions(array('restore', 'revert', 'deletefromlive', 'delete', 'unpublish', 'rollback', 'doRollback'));
639
640
			// Announce the capability so the frontend can decide whether to allow preview or not.
641
			if(in_array('CMSPreviewable', class_implements($record))) {
642
				$form->addExtraClass('cms-previewable');
643
			}
644
645
			if(!$record->canEdit() || $deletedFromStage) {
646
				$readonlyFields = $form->Fields()->makeReadonly();
647
				$form->setFields($readonlyFields);
648
			}
649
650
			$this->extend('updateEditForm', $form);
651
			return $form;
652
		} else if($id) {
653
			$form = Form::create( $this, "EditForm", new FieldList(
654
				new LabelField('PageDoesntExistLabel',_t('CMSMain.PAGENOTEXISTS',"This page doesn't exist"))), new FieldList()
655
			)->setHTMLID('Form_EditForm');
656
			return $form;
657
		}
658
	}
659
660
	/**
661
	 * @param SS_HTTPRequest $request
662
	 * @return string HTML
663
	 */
664
	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...
665
		return $this->renderWith($this->getTemplatesWithSuffix('_TreeView'));
666
	}
667
668
	/**
669
	 * @param SS_HTTPRequest $request
670
	 * @return string HTML
671
	 */
672
	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...
673
		return $this->renderWith($this->getTemplatesWithSuffix('_ListView'));
674
	}
675
676
	/**
677
	 * Callback to request the list of page types allowed under a given page instance.
678
	 * Provides a slower but more precise response over SiteTreeHints
679
	 *
680
	 * @param SS_HTTPRequest $request
681
	 * @return SS_HTTPResponse
682
	 */
683
	public function childfilter($request) {
684
		// Check valid parent specified
685
		$parentID = $request->requestVar('ParentID');
686
		$parent = SiteTree::get()->byID($parentID);
687
		if(!$parent || !$parent->exists()) return $this->httpError(404);
688
689
		// Build hints specific to this class
690
		// Identify disallows and set globals
691
		$classes = SiteTree::page_type_classes();
692
		$disallowedChildren = array();
693
		foreach($classes as $class) {
694
			$obj = singleton($class);
695
			if($obj instanceof HiddenClass) continue;
696
697
			if(!$obj->canCreate(null, array('Parent' => $parent))) {
698
				$disallowedChildren[] = $class;
699
			}
700
		}
701
702
		$this->extend('updateChildFilter', $disallowedChildren, $parentID);
703
		return $this
704
			->getResponse()
705
			->addHeader('Content-Type', 'application/json; charset=utf-8')
706
			->setBody(Convert::raw2json($disallowedChildren));
707
	}
708
709
	/**
710
	 * Safely reconstruct a selected filter from a given set of query parameters
711
	 *
712
	 * @param array $params Query parameters to use
713
	 * @return CMSSiteTreeFilter The filter class, or null if none present
714
	 * @throws InvalidArgumentException if invalid filter class is passed.
715
	 */
716
	protected function getQueryFilter($params) {
717
		if(empty($params['FilterClass'])) return null;
718
		$filterClass = $params['FilterClass'];
719
		if(!is_subclass_of($filterClass, 'CMSSiteTreeFilter')) {
720
			throw new InvalidArgumentException("Invalid filter class passed: {$filterClass}");
721
		}
722
		return $filterClass::create($params);
723
	}
724
725
	/**
726
	 * Returns the pages meet a certain criteria as {@see CMSSiteTreeFilter} or the subpages of a parent page
727
	 * defaulting to no filter and show all pages in first level.
728
	 * Doubles as search results, if any search parameters are set through {@link SearchForm()}.
729
	 *
730
	 * @param array $params Search filter criteria
731
	 * @param int $parentID Optional parent node to filter on (can't be combined with other search criteria)
732
	 * @return SS_List
733
	 * @throws InvalidArgumentException if invalid filter class is passed.
734
	 */
735
	public function getList($params = array(), $parentID = 0) {
736
		if($filter = $this->getQueryFilter($params)) {
737
			return $filter->getFilteredPages();
738
		} else {
739
			$list = DataList::create($this->stat('tree_class'));
740
			$parentID = is_numeric($parentID) ? $parentID : 0;
741
			return $list->filter("ParentID", $parentID);
742
		}
743
	}
744
745
	public function ListViewForm() {
746
		$params = $this->getRequest()->requestVar('q');
747
		$list = $this->getList($params, $parentID = $this->getRequest()->requestVar('ParentID'));
748
		$gridFieldConfig = GridFieldConfig::create()->addComponents(
749
			new GridFieldSortableHeader(),
750
			new GridFieldDataColumns(),
751
			new GridFieldPaginator(self::config()->page_length)
752
		);
753
		if($parentID){
754
			$gridFieldConfig->addComponent(
755
				GridFieldLevelup::create($parentID)
756
					->setLinkSpec('?ParentID=%d&view=list')
757
					->setAttributes(array('data-pjax' => 'ListViewForm,Breadcrumbs'))
758
			);
759
		}
760
		$gridField = new GridField('Page','Pages', $list, $gridFieldConfig);
761
		$columns = $gridField->getConfig()->getComponentByType('GridFieldDataColumns');
762
763
		// Don't allow navigating into children nodes on filtered lists
764
		$fields = array(
765
			'getTreeTitle' => _t('SiteTree.PAGETITLE', 'Page Title'),
766
			'singular_name' => _t('SiteTree.PAGETYPE'),
767
			'LastEdited' => _t('SiteTree.LASTUPDATED', 'Last Updated'),
768
		);
769
		$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...
770
		$gridField->getState()->ParentID = $parentID;
771
772
		if(!$params) {
773
			$fields = array_merge(array('listChildrenLink' => ''), $fields);
774
		}
775
776
		$columns->setDisplayFields($fields);
777
		$columns->setFieldCasting(array(
778
			'Created' => 'SS_Datetime->Ago',
779
			'LastEdited' => 'SS_Datetime->FormatFromSettings',
780
			'getTreeTitle' => 'HTMLText'
781
		));
782
783
		$controller = $this;
784
		$columns->setFieldFormatting(array(
785
			'listChildrenLink' => function($value, &$item) use($controller) {
786
				$num = $item ? $item->numChildren() : null;
787
				if($num) {
788
					return sprintf(
789
						'<a class="cms-panel-link list-children-link" data-pjax-target="ListViewForm,Breadcrumbs" href="%s">%s</a>',
790
						Controller::join_links(
791
							$controller->Link(),
792
							sprintf("?ParentID=%d&view=list", (int)$item->ID)
793
						),
794
						$num
795
					);
796
				}
797
			},
798
			'getTreeTitle' => function($value, &$item) use($controller) {
799
				return sprintf(
800
					'<a class="action-detail" href="%s">%s</a>',
801
					Controller::join_links(
802
						singleton('CMSPageEditController')->Link('show'),
803
						(int)$item->ID
804
					),
805
					$item->TreeTitle // returns HTML, does its own escaping
806
				);
807
			}
808
		));
809
810
		$negotiator = $this->getResponseNegotiator();
811
		$listview = Form::create(
812
			$this,
813
			'ListViewForm',
814
			new FieldList($gridField),
815
			new FieldList()
816
		)->setHTMLID('Form_ListViewForm');
817
		$listview->setAttribute('data-pjax-fragment', 'ListViewForm');
818 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...
819
			$request = $this->getRequest();
820
			if($request->isAjax() && $negotiator) {
821
				$listview->setupFormErrors();
822
				$result = $listview->forTemplate();
823
824
				return $negotiator->respond($request, array(
825
					'CurrentForm' => function() use($result) {
826
						return $result;
827
					}
828
				));
829
			}
830
		});
831
832
		$this->extend('updateListView', $listview);
833
834
		$listview->disableSecurityToken();
835
		return $listview;
836
	}
837
838
	public function currentPageID() {
839
		$id = parent::currentPageID();
840
841
		$this->extend('updateCurrentPageID', $id);
842
843
		return $id;
844
	}
845
846
	//------------------------------------------------------------------------------------------//
847
	// Data saving handlers
848
849
	/**
850
	 * Save and Publish page handler
851
	 *
852
	 * @param array $data
853
	 * @param Form $form
854
	 * @return SS_HTTPResponse
855
	 * @throws SS_HTTPResponse_Exception
856
	 */
857
	public function save($data, $form) {
858
		$className = $this->stat('tree_class');
859
860
		// Existing or new record?
861
		$id = $data['ID'];
862
		if(substr($id,0,3) != 'new') {
863
			/** @var SiteTree $record */
864
			$record = DataObject::get_by_id($className, $id);
865
			// Check edit permissions
866
			if($record && !$record->canEdit()) {
867
				return Security::permissionFailure($this);
868
			}
869
			if(!$record || !$record->ID) {
870
				throw new SS_HTTPResponse_Exception("Bad record ID #$id", 404);
871
			}
872
		} else {
873
			if(!$className::singleton()->canCreate()) {
874
				return Security::permissionFailure($this);
875
			}
876
			$record = $this->getNewItem($id, false);
877
		}
878
879
		// Check publishing permissions
880
		$doPublish = !empty($data['publish']);
881
		if($record && $doPublish && !$record->canPublish()) {
882
			return Security::permissionFailure($this);
883
		}
884
885
		// TODO Coupling to SiteTree
886
		$record->HasBrokenLink = 0;
887
		$record->HasBrokenFile = 0;
888
889
		if (!$record->ObsoleteClassName) {
890
			$record->writeWithoutVersion();
891
		}
892
893
		// Update the class instance if necessary
894
		if(isset($data['ClassName']) && $data['ClassName'] != $record->ClassName) {
895
			$newClassName = $record->ClassName;
896
			// The records originally saved attribute was overwritten by $form->saveInto($record) before.
897
			// This is necessary for newClassInstance() to work as expected, and trigger change detection
898
			// on the ClassName attribute
899
			$record->setClassName($data['ClassName']);
900
			// Replace $record with a new instance
901
			$record = $record->newClassInstance($newClassName);
902
		}
903
904
		// save form data into record
905
		$form->saveInto($record);
906
		$record->write();
907
908
		// If the 'Save & Publish' button was clicked, also publish the page
909
		if ($doPublish) {
910
			$record->doPublish();
911
			$message = _t(
912
				'CMSMain.PUBLISHED',
913
				"Published '{title}' successfully.",
914
				['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...
915
			);
916
		} else {
917
			$message = _t(
918
				'CMSMain.SAVED',
919
				"Saved '{title}' successfully.",
920
				['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...
921
			);
922
		}
923
924
		$this->getResponse()->addHeader('X-Status', rawurlencode($message));
925
		return $this->getResponseNegotiator()->respond($this->getRequest());
926
	}
927
928
	/**
929
	 * @uses LeftAndMainExtension->augmentNewSiteTreeItem()
930
	 */
931
	public function getNewItem($id, $setID = true) {
932
		$parentClass = $this->stat('tree_class');
933
		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...
934
935
		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...
936
			$response = Security::permissionFailure($this);
937
			if (!$response) {
938
				$response = $this->getResponse();
939
			}
940
			throw new SS_HTTPResponse_Exception($response);
941
		}
942
943
		$newItem = new $className();
944
945
		if( !$suffix ) {
946
			$sessionTag = "NewItems." . $parentID . "." . $className;
947
			if(Session::get($sessionTag)) {
948
				$suffix = '-' . Session::get($sessionTag);
949
				Session::set($sessionTag, Session::get($sessionTag) + 1);
950
			}
951
			else
952
				Session::set($sessionTag, 1);
953
954
				$id = $id . $suffix;
955
		}
956
957
		$newItem->Title = _t(
958
			'CMSMain.NEWPAGE',
959
			"New {pagetype}",'followed by a page type title',
960
			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...
961
		);
962
		$newItem->ClassName = $className;
963
		$newItem->ParentID = $parentID;
964
965
		// DataObject::fieldExists only checks the current class, not the hierarchy
966
		// This allows the CMS to set the correct sort value
967
		if($newItem->castingHelper('Sort')) {
968
			$newItem->Sort = DB::prepared_query('SELECT MAX("Sort") FROM "SiteTree" WHERE "ParentID" = ?', array($parentID))->value() + 1;
969
		}
970
971
		if($setID) $newItem->ID = $id;
972
973
		# Some modules like subsites add extra fields that need to be set when the new item is created
974
		$this->extend('augmentNewSiteTreeItem', $newItem);
975
976
		return $newItem;
977
	}
978
979
	/**
980
	 * Actually perform the publication step
981
	 *
982
	 * @param Versioned|DataObject $record
983
	 * @return mixed
984
	 */
985
	public function performPublish($record) {
986
		if($record && !$record->canPublish()) {
0 ignored issues
show
Bug introduced by
The method canPublish does only exist in Versioned, but not in DataObject.

It seems like the method you are trying to call exists only in some of the possible types.

Let’s take a look at an example:

class A
{
    public function foo() { }
}

class B extends A
{
    public function bar() { }
}

/**
 * @param A|B $x
 */
function someFunction($x)
{
    $x->foo(); // This call is fine as the method exists in A and B.
    $x->bar(); // This method only exists in B and might cause an error.
}

Available Fixes

  1. Add an additional type-check:

    /**
     * @param A|B $x
     */
    function someFunction($x)
    {
        $x->foo();
    
        if ($x instanceof B) {
            $x->bar();
        }
    }
    
  2. Only allow a single type to be passed if the variable comes from a parameter:

    function someFunction(B $x) { /** ... */ }
    
Loading history...
987
			return Security::permissionFailure($this);
988
		}
989
990
		$record->doPublish();
0 ignored issues
show
Bug introduced by
The method doPublish does only exist in Versioned, but not in DataObject.

It seems like the method you are trying to call exists only in some of the possible types.

Let’s take a look at an example:

class A
{
    public function foo() { }
}

class B extends A
{
    public function bar() { }
}

/**
 * @param A|B $x
 */
function someFunction($x)
{
    $x->foo(); // This call is fine as the method exists in A and B.
    $x->bar(); // This method only exists in B and might cause an error.
}

Available Fixes

  1. Add an additional type-check:

    /**
     * @param A|B $x
     */
    function someFunction($x)
    {
        $x->foo();
    
        if ($x instanceof B) {
            $x->bar();
        }
    }
    
  2. Only allow a single type to be passed if the variable comes from a parameter:

    function someFunction(B $x) { /** ... */ }
    
Loading history...
991
	}
992
993
	/**
994
	 * Reverts a page by publishing it to live.
995
	 * Use {@link restorepage()} if you want to restore a page
996
	 * which was deleted from draft without publishing.
997
	 *
998
	 * @uses SiteTree->doRevertToLive()
999
	 *
1000
	 * @param array $data
1001
	 * @param Form $form
1002
	 * @return SS_HTTPResponse
1003
	 * @throws SS_HTTPResponse_Exception
1004
	 */
1005
	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...
1006
		if(!isset($data['ID'])) {
1007
			throw new SS_HTTPResponse_Exception("Please pass an ID in the form content", 400);
1008
		}
1009
1010
		$id = (int) $data['ID'];
1011
		$restoredPage = Versioned::get_latest_version("SiteTree", $id);
1012
		if(!$restoredPage) {
1013
			throw new SS_HTTPResponse_Exception("SiteTree #$id not found", 400);
1014
		}
1015
1016
		/** @var SiteTree $record */
1017
		$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...
1018
			'"SiteTree_Live"."ID"' => $id
1019
		));
1020
1021
		// a user can restore a page without publication rights, as it just adds a new draft state
1022
		// (this action should just be available when page has been "deleted from draft")
1023
		if($record && !$record->canEdit()) {
1024
			return Security::permissionFailure($this);
1025
		}
1026
		if(!$record || !$record->ID) {
1027
			throw new SS_HTTPResponse_Exception("Bad record ID #$id", 404);
1028
		}
1029
1030
		$record->doRevertToLive();
0 ignored issues
show
Documentation Bug introduced by
The method doRevertToLive 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...
1031
1032
		$this->getResponse()->addHeader(
1033
			'X-Status',
1034
			rawurlencode(_t(
1035
				'CMSMain.RESTORED',
1036
				"Restored '{title}' successfully",
1037
				'Param %s is a title',
1038
				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...
1039
			))
1040
		);
1041
1042
		return $this->getResponseNegotiator()->respond($this->getRequest());
1043
	}
1044
1045
	/**
1046
	 * Delete the current page from draft stage.
1047
	 *
1048
	 * @see deletefromlive()
1049
	 *
1050
	 * @param array $data
1051
	 * @param Form $form
1052
	 * @return SS_HTTPResponse
1053
	 * @throws SS_HTTPResponse_Exception
1054
	 */
1055 View Code Duplication
	public function delete($data, $form) {
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...
1056
		$id = $data['ID'];
1057
		$record = DataObject::get_by_id("SiteTree", $id);
1058
		if($record && !$record->canDelete()) {
1059
			return Security::permissionFailure();
1060
		}
1061
		if(!$record || !$record->ID) {
1062
			throw new SS_HTTPResponse_Exception("Bad record ID #$id", 404);
1063
		}
1064
1065
		// Delete record
1066
		$record->delete();
1067
1068
		$this->getResponse()->addHeader(
1069
			'X-Status',
1070
			rawurlencode(sprintf(_t('CMSMain.REMOVEDPAGEFROMDRAFT',"Removed '%s' from the draft site"), $record->Title))
1071
		);
1072
1073
		// Even if the record has been deleted from stage and live, it can be viewed in "archive mode"
1074
		return $this->getResponseNegotiator()->respond($this->getRequest());
1075
	}
1076
1077
	/**
1078
	 * Delete this page from both live and stage
1079
	 *
1080
	 * @param array $data
1081
	 * @param Form $form
1082
	 * @return SS_HTTPResponse
1083
	 * @throws SS_HTTPResponse_Exception
1084
	 */
1085 View Code Duplication
	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...
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...
1086
		$id = $data['ID'];
1087
		/** @var SiteTree $record */
1088
		$record = DataObject::get_by_id("SiteTree", $id);
1089
		if(!$record || !$record->exists()) {
1090
			throw new SS_HTTPResponse_Exception("Bad record ID #$id", 404);
1091
		}
1092
		if(!$record->canArchive()) {
0 ignored issues
show
Documentation Bug introduced by
The method canArchive 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...
1093
			return Security::permissionFailure();
1094
		}
1095
1096
		// Archive record
1097
		$record->doArchive();
0 ignored issues
show
Documentation Bug introduced by
The method doArchive 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...
1098
1099
		$this->getResponse()->addHeader(
1100
			'X-Status',
1101
			rawurlencode(sprintf(_t('CMSMain.ARCHIVEDPAGE',"Archived page '%s'"), $record->Title))
1102
		);
1103
1104
		// Even if the record has been deleted from stage and live, it can be viewed in "archive mode"
1105
		return $this->getResponseNegotiator()->respond($this->getRequest());
1106
	}
1107
1108
	public function publish($data, $form) {
1109
		$data['publish'] = '1';
1110
1111
		return $this->save($data, $form);
1112
	}
1113
1114
	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...
1115
		$className = $this->stat('tree_class');
1116
		/** @var SiteTree $record */
1117
		$record = DataObject::get_by_id($className, $data['ID']);
1118
1119
		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...
1120
			return Security::permissionFailure($this);
1121
		}
1122 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...
1123
			throw new SS_HTTPResponse_Exception("Bad record ID #" . (int)$data['ID'], 404);
1124
		}
1125
1126
		$record->doUnpublish();
0 ignored issues
show
Documentation Bug introduced by
The method doUnpublish 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...
1127
1128
		$this->getResponse()->addHeader(
1129
			'X-Status',
1130
			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...
1131
		);
1132
1133
		return $this->getResponseNegotiator()->respond($this->getRequest());
1134
	}
1135
1136
	/**
1137
	 * @return array
1138
	 */
1139
	public function rollback() {
1140
		return $this->doRollback(array(
1141
			'ID' => $this->currentPageID(),
1142
			'Version' => $this->getRequest()->param('VersionID')
1143
		), null);
0 ignored issues
show
Documentation introduced by
null is of type null, but the function expects a object<Form>.

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...
1144
	}
1145
1146
	/**
1147
	 * Rolls a site back to a given version ID
1148
	 *
1149
	 * @param array $data
1150
	 * @param Form $form
1151
	 * @return SS_HTTPResponse
1152
	 */
1153
	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...
1154
		$this->extend('onBeforeRollback', $data['ID']);
1155
1156
		$id = (isset($data['ID'])) ? (int) $data['ID'] : null;
1157
		$version = (isset($data['Version'])) ? (int) $data['Version'] : null;
1158
1159
		/** @var DataObject|Versioned $record */
1160
		$record = DataObject::get_by_id($this->stat('tree_class'), $id);
1161
		if($record && !$record->canEdit()) {
0 ignored issues
show
Bug introduced by
The call to canEdit() misses a required argument $member.

This check looks for function calls that miss required arguments.

Loading history...
1162
			return Security::permissionFailure($this);
1163
		}
1164
1165
		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...
1166
			$record->doRollbackTo($version);
0 ignored issues
show
Bug introduced by
The method doRollbackTo does only exist in Versioned, but not in DataObject.

It seems like the method you are trying to call exists only in some of the possible types.

Let’s take a look at an example:

class A
{
    public function foo() { }
}

class B extends A
{
    public function bar() { }
}

/**
 * @param A|B $x
 */
function someFunction($x)
{
    $x->foo(); // This call is fine as the method exists in A and B.
    $x->bar(); // This method only exists in B and might cause an error.
}

Available Fixes

  1. Add an additional type-check:

    /**
     * @param A|B $x
     */
    function someFunction($x)
    {
        $x->foo();
    
        if ($x instanceof B) {
            $x->bar();
        }
    }
    
  2. Only allow a single type to be passed if the variable comes from a parameter:

    function someFunction(B $x) { /** ... */ }
    
Loading history...
1167
			$message = _t(
1168
				'CMSMain.ROLLEDBACKVERSIONv2',
1169
				"Rolled back to version #%d.",
1170
				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...
1171
			);
1172
		} else {
1173
			$record->doRollbackTo('Live');
1174
			$message = _t(
1175
				'CMSMain.ROLLEDBACKPUBv2',"Rolled back to published version."
1176
			);
1177
		}
1178
1179
		$this->getResponse()->addHeader('X-Status', rawurlencode($message));
1180
1181
		// Can be used in different contexts: In normal page edit view, in which case the redirect won't have any effect.
1182
		// Or in history view, in which case a revert causes the CMS to re-load the edit view.
1183
		// The X-Pjax header forces a "full" content refresh on redirect.
1184
		$url = Controller::join_links(singleton('CMSPageEditController')->Link('show'), $record->ID);
1185
		$this->getResponse()->addHeader('X-ControllerURL', $url);
1186
		$this->getRequest()->addHeader('X-Pjax', 'Content');
1187
		$this->getResponse()->addHeader('X-Pjax', 'Content');
1188
1189
		return $this->getResponseNegotiator()->respond($this->getRequest());
1190
	}
1191
1192
	/**
1193
	 * Batch Actions Handler
1194
	 */
1195
	public function batchactions() {
1196
		return new CMSBatchActionHandler($this, 'batchactions');
1197
	}
1198
1199
	public function BatchActionParameters() {
1200
		$batchActions = CMSBatchActionHandler::config()->batch_actions;
1201
1202
		$forms = array();
1203
		foreach($batchActions as $urlSegment => $batchAction) {
1204
			$SNG_action = singleton($batchAction);
1205
			if ($SNG_action->canView() && $fieldset = $SNG_action->getParameterFields()) {
1206
				$formHtml = '';
1207
				foreach($fieldset as $field) {
1208
					$formHtml .= $field->Field();
1209
				}
1210
				$forms[$urlSegment] = $formHtml;
1211
			}
1212
		}
1213
		$pageHtml = '';
1214
		foreach($forms as $urlSegment => $html) {
1215
			$pageHtml .= "<div class=\"params\" id=\"BatchActionParameters_$urlSegment\">$html</div>\n\n";
1216
		}
1217
		return new LiteralField("BatchActionParameters", '<div id="BatchActionParameters" style="display:none">'.$pageHtml.'</div>');
1218
	}
1219
	/**
1220
	 * Returns a list of batch actions
1221
	 */
1222
	public function BatchActionList() {
1223
		return $this->batchactions()->batchActionList();
1224
	}
1225
1226
	public function buildbrokenlinks($request) {
1227
		// Protect against CSRF on destructive action
1228
		if(!SecurityToken::inst()->checkRequest($request)) return $this->httpError(400);
1229
1230
		increase_time_limit_to();
1231
		increase_memory_limit_to();
1232
1233
		if($this->urlParams['ID']) {
1234
			$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...
1235
		} else {
1236
			$pages = DataObject::get("Page");
1237
			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...
1238
			$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...
1239
		}
1240
1241
		$content = new HtmlEditorField('Content');
1242
		$download = new HtmlEditorField('Download');
1243
1244
		foreach($newPageSet as $i => $page) {
1245
			$page->HasBrokenLink = 0;
1246
			$page->HasBrokenFile = 0;
1247
1248
			$content->setValue($page->Content);
1249
			$content->saveInto($page);
1250
1251
			$download->setValue($page->Download);
1252
			$download->saveInto($page);
1253
1254
			echo "<li>$page->Title (link:$page->HasBrokenLink, file:$page->HasBrokenFile)";
1255
1256
			$page->writeWithoutVersion();
1257
			$page->destroy();
1258
			$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...
1259
		}
1260
	}
1261
1262
	public function publishall($request) {
1263
		if(!Permission::check('ADMIN')) return Security::permissionFailure($this);
1264
1265
		increase_time_limit_to();
1266
		increase_memory_limit_to();
1267
1268
		$response = "";
1269
1270
		if(isset($this->requestParams['confirm'])) {
1271
			// Protect against CSRF on destructive action
1272
			if(!SecurityToken::inst()->checkRequest($request)) return $this->httpError(400);
1273
1274
			$start = 0;
1275
			$pages = DataObject::get("SiteTree", "", "", "", "$start,30");
1276
			$count = 0;
1277
			while($pages) {
1278
				foreach($pages as $page) {
1279
					if($page && !$page->canPublish()) return Security::permissionFailure($this);
1280
1281
					$page->doPublish();
1282
					$page->destroy();
1283
					unset($page);
1284
					$count++;
1285
					$response .= "<li>$count</li>";
1286
				}
1287
				if($pages->Count() > 29) {
1288
					$start += 30;
1289
					$pages = DataObject::get("SiteTree", "", "", "", "$start,30");
1290
				} else {
1291
					break;
1292
				}
1293
			}
1294
			$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...
1295
1296
		} else {
1297
			$token = SecurityToken::inst();
1298
			$fields = new FieldList();
1299
			$token->updateFieldSet($fields);
1300
			$tokenField = $fields->First();
1301
			$tokenHtml = ($tokenField) ? $tokenField->FieldHolder() : '';
1302
			$response .= '<h1>' . _t('CMSMain.PUBALLFUN','"Publish All" functionality') . '</h1>
1303
				<p>' . _t('CMSMain.PUBALLFUN2', 'Pressing this button will do the equivalent of going to every page and pressing "publish".  It\'s
1304
				intended to be used after there have been massive edits of the content, such as when the site was
1305
				first built.') . '</p>
1306
				<form method="post" action="publishall">
1307
					<input type="submit" name="confirm" value="'
1308
					. _t('CMSMain.PUBALLCONFIRM',"Please publish every page in the site, copying content stage to live",'Confirmation button') .'" />'
1309
					. $tokenHtml .
1310
				'</form>';
1311
		}
1312
1313
		return $response;
1314
	}
1315
1316
	/**
1317
	 * Restore a completely deleted page from the SiteTree_versions table.
1318
	 */
1319
	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...
1320
		if(!isset($data['ID']) || !is_numeric($data['ID'])) {
1321
			return new SS_HTTPResponse("Please pass an ID in the form content", 400);
1322
		}
1323
1324
		$id = (int)$data['ID'];
1325
		$restoredPage = Versioned::get_latest_version("SiteTree", $id);
1326
		if(!$restoredPage) 	return new SS_HTTPResponse("SiteTree #$id not found", 400);
1327
1328
		$restoredPage = $restoredPage->doRestoreToStage();
1329
1330
		$this->getResponse()->addHeader(
1331
			'X-Status',
1332
			rawurlencode(_t(
1333
				'CMSMain.RESTORED',
1334
				"Restored '{title}' successfully",
1335
				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...
1336
			))
1337
		);
1338
1339
		return $this->getResponseNegotiator()->respond($this->getRequest());
1340
	}
1341
1342
	public function duplicate($request) {
1343
		// Protect against CSRF on destructive action
1344
		if(!SecurityToken::inst()->checkRequest($request)) return $this->httpError(400);
1345
1346
		if(($id = $this->urlParams['ID']) && is_numeric($id)) {
1347
			$page = DataObject::get_by_id("SiteTree", $id);
1348 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...
1349
				return Security::permissionFailure($this);
1350
			}
1351
			if(!$page || !$page->ID) throw new SS_HTTPResponse_Exception("Bad record ID #$id", 404);
1352
1353
			$newPage = $page->duplicate();
1354
1355
			// ParentID can be hard-set in the URL.  This is useful for pages with multiple parents
1356
			if(isset($_GET['parentID']) && is_numeric($_GET['parentID'])) {
1357
				$newPage->ParentID = $_GET['parentID'];
1358
				$newPage->write();
1359
			}
1360
1361
			$this->getResponse()->addHeader(
1362
				'X-Status',
1363
				rawurlencode(_t(
1364
					'CMSMain.DUPLICATED',
1365
					"Duplicated '{title}' successfully",
1366
					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...
1367
				))
1368
			);
1369
			$url = Controller::join_links(singleton('CMSPageEditController')->Link('show'), $newPage->ID);
1370
			$this->getResponse()->addHeader('X-ControllerURL', $url);
1371
			$this->getRequest()->addHeader('X-Pjax', 'Content');
1372
			$this->getResponse()->addHeader('X-Pjax', 'Content');
1373
1374
			return $this->getResponseNegotiator()->respond($this->getRequest());
1375
		} else {
1376
			return new SS_HTTPResponse("CMSMain::duplicate() Bad ID: '$id'", 400);
1377
		}
1378
	}
1379
1380
	public function duplicatewithchildren($request) {
1381
		// Protect against CSRF on destructive action
1382
		if(!SecurityToken::inst()->checkRequest($request)) return $this->httpError(400);
1383
		increase_time_limit_to();
1384
		if(($id = $this->urlParams['ID']) && is_numeric($id)) {
1385
			$page = DataObject::get_by_id("SiteTree", $id);
1386 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...
1387
				return Security::permissionFailure($this);
1388
			}
1389
			if(!$page || !$page->ID) throw new SS_HTTPResponse_Exception("Bad record ID #$id", 404);
1390
1391
			$newPage = $page->duplicateWithChildren();
1392
1393
			$this->getResponse()->addHeader(
1394
				'X-Status',
1395
				rawurlencode(_t(
1396
					'CMSMain.DUPLICATEDWITHCHILDREN',
1397
					"Duplicated '{title}' and children successfully",
1398
					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...
1399
				))
1400
			);
1401
			$url = Controller::join_links(singleton('CMSPageEditController')->Link('show'), $newPage->ID);
1402
			$this->getResponse()->addHeader('X-ControllerURL', $url);
1403
			$this->getRequest()->addHeader('X-Pjax', 'Content');
1404
			$this->getResponse()->addHeader('X-Pjax', 'Content');
1405
1406
			return $this->getResponseNegotiator()->respond($this->getRequest());
1407
		} else {
1408
			return new SS_HTTPResponse("CMSMain::duplicatewithchildren() Bad ID: '$id'", 400);
1409
		}
1410
	}
1411
1412
	public function providePermissions() {
1413
		$title = _t("CMSPagesController.MENUTITLE", LeftAndMain::menu_title_for_class('CMSPagesController'));
1414
		return array(
1415
			"CMS_ACCESS_CMSMain" => array(
1416
				'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...
1417
				'category' => _t('Permission.CMS_ACCESS_CATEGORY', 'CMS Access'),
1418
				'help' => _t(
1419
					'CMSMain.ACCESS_HELP',
1420
					'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".'
1421
				),
1422
				'sort' => -99 // below "CMS_ACCESS_LeftAndMain", but above everything else
1423
			)
1424
		);
1425
	}
1426
1427
}
1428