Completed
Pull Request — master (#1381)
by Damian
02:47
created

SiteTree   F

Complexity

Total Complexity 471

Size/Duplication

Total Lines 2965
Duplicated Lines 1.72 %

Coupling/Cohesion

Components 1
Dependencies 49
Metric Value
wmc 471
lcom 1
cbo 49
dl 51
loc 2965
rs 0.5217

96 Methods

Rating   Name   Duplication   Size   Complexity  
C DependentPages() 0 50 10
B VirtualPages() 0 22 4
F getCMSFields() 0 180 22
C getSettingsFields() 0 106 8
B fieldLabels() 0 38 3
D getCMSActions() 17 151 24
C doPublish() 0 42 7
D doUnpublish() 0 38 9
A doRevertToLive() 0 18 2
A isParentArchived() 0 9 4
B doRestoreToStage() 0 36 6
A doDeleteFromLive() 0 4 1
A isNew() 0 11 3
D getClassDropdown() 0 44 10
B allowedChildren() 0 20 8
A defaultChild() 0 9 4
A defaultParent() 0 3 1
A getMenuTitle() 0 7 2
A setMenuTitle() 0 7 2
C getStatusFlags() 0 34 7
C getTreeTitle() 0 29 7
A Level() 0 9 3
A getPageLevel() 0 6 2
C CMSTreeClasses() 0 31 8
A getIsDeletedFromStage() 0 9 3
A getExistsOnLive() 0 3 1
A getIsModifiedOnStage() 0 12 3
A getIsAddedToStage() 0 9 3
A disableCMSFieldsExtensions() 0 3 1
A enableCMSFieldsExtensions() 0 3 1
B providePermissions() 0 34 1
A i18n_singular_name() 0 5 2
A provideI18nEntities() 0 16 3
A getParentType() 0 3 2
A reset() 0 3 1
A on_db_reset() 0 3 1
A set_enforce_strict_hierarchy() 0 4 1
A get_enforce_strict_hierarchy() 0 4 1
A nested_urls() 0 4 1
A enable_nested_urls() 0 4 1
A disable_nested_urls() 0 4 1
A set_create_default_pages() 0 4 1
A get_create_default_pages() 0 4 1
C get_by_link() 6 66 20
B page_type_classes() 0 32 6
B link_shortcode_handler() 0 18 6
A Link() 0 3 1
A AbsoluteLink() 0 7 2
A PreviewLink() 0 7 2
D RelativeLink() 0 25 9
A getAbsoluteLiveLink() 0 16 3
A CMSEditLink() 0 3 1
A ElementName() 0 3 1
A isCurrent() 0 3 2
A isSection() 0 5 3
A isOrphaned() 0 8 4
A LinkOrCurrent() 0 3 2
A LinkOrSection() 0 3 2
A LinkingMode() 0 9 3
A InSection() 0 9 3
A duplicate() 0 15 2
A duplicateWithChildren() 0 16 4
A duplicateAsChild() 0 6 1
A Breadcrumbs() 0 8 1
B getBreadcrumbItems() 0 18 9
A setParent() 0 8 3
A getParent() 0 5 2
A NestedTitle() 0 9 3
B can() 3 17 12
B canAddChildren() 3 18 9
D canView() 3 39 19
B canDelete() 3 20 7
C canCreate() 3 32 11
C canEdit() 3 24 8
A canDeleteFromLive() 0 12 2
A getSiteConfig() 0 9 3
A prepopulate_permission_cache() 0 10 3
D batch_permission_check() 0 123 23
A can_edit_multiple() 0 3 1
B can_delete_multiple() 0 59 8
A collateDescendants() 0 9 4
D MetaTags() 0 33 10
A ContentSource() 0 3 1
C requireDefaultRecords() 0 49 7
C onBeforeWrite() 0 50 11
A syncLinkTracking() 0 3 1
B onAfterWrite() 0 19 5
A onBeforeDelete() 0 10 4
A onAfterDelete() 0 13 3
A flushCache() 0 4 1
C validate() 10 37 8
D validURLSegment() 0 34 15
A generateURLSegment() 0 12 4
A getStageURLSegment() 0 6 2
A getLiveURLSegment() 0 6 2
B rewriteFileLinks() 0 32 6

How to fix   Duplicated Code    Complexity   

Duplicated Code

Duplicate code is one of the most pungent code smells. A rule that is often used is to re-structure code once it is duplicated in three or more places.

Common duplication problems, and corresponding solutions are:

Complex Class

 Tip:   Before tackling complexity, make sure that you eliminate any duplication first. This often can reduce the size of classes significantly.

Complex classes like SiteTree often do a lot of different things. To break such a class down, we need to identify a cohesive component within that class. A common approach to find such a component is to look for fields/methods that share the same prefixes, or suffixes. You can also have a look at the cohesion graph to spot any un-connected, or weakly-connected components.

Once you have determined the fields that belong together, you can apply the Extract Class refactoring. If the component makes sense as a sub-class, Extract Subclass is also a candidate, and is often faster.

While breaking up the class, it is a good idea to analyze how other classes use SiteTree, and based on these observations, apply Extract Interface, too.

1
<?php
2
/**
3
 * Basic data-object representing all pages within the site tree. All page types that live within the hierarchy should
4
 * inherit from this. In addition, it contains a number of static methods for querying the site tree and working with
5
 * draft and published states.
6
 *
7
 * <h2>URLs</h2>
8
 * A page is identified during request handling via its "URLSegment" database column. As pages can be nested, the full
9
 * path of a URL might contain multiple segments. Each segment is stored in its filtered representation (through
10
 * {@link URLSegmentFilter}). The full path is constructed via {@link Link()}, {@link RelativeLink()} and
11
 * {@link AbsoluteLink()}. You can allow these segments to contain multibyte characters through
12
 * {@link URLSegmentFilter::$default_allow_multibyte}.
13
 *
14
 * @property string URLSegment
15
 * @property string Title
16
 * @property string MenuTitle
17
 * @property string Content HTML content of the page.
18
 * @property string MetaDescription
19
 * @property string ExtraMeta
20
 * @property string ShowInMenus
21
 * @property string ShowInSearch
22
 * @property string Sort Integer value denoting the sort order.
23
 * @property string ReportClass
24
 * @property string CanViewType Type of restriction for viewing this object.
25
 * @property string CanEditType Type of restriction for editing this object.
26
 *
27
 * @method ManyManyList ViewerGroups List of groups that can view this object.
28
 * @method ManyManyList EditorGroups List of groups that can edit this object.
29
 *
30
 * @mixin Hierarchy
31
 * @mixin Versioned
32
 * @mixin SiteTreeLinkTracking
33
 *
34
 * @package cms
35
 */
36
class SiteTree extends DataObject implements PermissionProvider,i18nEntityProvider,CMSPreviewable {
37
38
	/**
39
	 * Indicates what kind of children this page type can have.
40
	 * This can be an array of allowed child classes, or the string "none" -
41
	 * indicating that this page type can't have children.
42
	 * If a classname is prefixed by "*", such as "*Page", then only that
43
	 * class is allowed - no subclasses. Otherwise, the class and all its
44
	 * subclasses are allowed.
45
	 * To control allowed children on root level (no parent), use {@link $can_be_root}.
46
	 *
47
	 * Note that this setting is cached when used in the CMS, use the "flush" query parameter to clear it.
48
	 *
49
	 * @config
50
	 * @var array
51
	 */
52
	private static $allowed_children = array("SiteTree");
53
54
	/**
55
	 * The default child class for this page.
56
	 * Note: Value might be cached, see {@link $allowed_chilren}.
57
	 *
58
	 * @config
59
	 * @var string
60
	 */
61
	private static $default_child = "Page";
62
63
	/**
64
	 * Default value for SiteTree.ClassName enum
65
	 * {@see DBClassName::getDefault}
66
	 *
67
	 * @config
68
	 * @var string
69
	 */
70
	private static $default_classname = "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...
71
72
	/**
73
	 * The default parent class for this page.
74
	 * Note: Value might be cached, see {@link $allowed_chilren}.
75
	 *
76
	 * @config
77
	 * @var string
78
	 */
79
	private static $default_parent = null;
80
81
	/**
82
	 * Controls whether a page can be in the root of the site tree.
83
	 * Note: Value might be cached, see {@link $allowed_chilren}.
84
	 *
85
	 * @config
86
	 * @var bool
87
	 */
88
	private static $can_be_root = true;
89
90
	/**
91
	 * List of permission codes a user can have to allow a user to create a page of this type.
92
	 * Note: Value might be cached, see {@link $allowed_chilren}.
93
	 *
94
	 * @config
95
	 * @var array
96
	 */
97
	private static $need_permission = null;
98
99
	/**
100
	 * If you extend a class, and don't want to be able to select the old class
101
	 * in the cms, set this to the old class name. Eg, if you extended Product
102
	 * to make ImprovedProduct, then you would set $hide_ancestor to Product.
103
	 *
104
	 * @config
105
	 * @var string
106
	 */
107
	private static $hide_ancestor = null;
108
109
	private static $db = 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...
110
		"URLSegment" => "Varchar(255)",
111
		"Title" => "Varchar(255)",
112
		"MenuTitle" => "Varchar(100)",
113
		"Content" => "HTMLText",
114
		"MetaDescription" => "Text",
115
		"ExtraMeta" => "HTMLText('meta, link')",
116
		"ShowInMenus" => "Boolean",
117
		"ShowInSearch" => "Boolean",
118
		"Sort" => "Int",
119
		"HasBrokenFile" => "Boolean",
120
		"HasBrokenLink" => "Boolean",
121
		"ReportClass" => "Varchar",
122
		"CanViewType" => "Enum('Anyone, LoggedInUsers, OnlyTheseUsers, Inherit', 'Inherit')",
123
		"CanEditType" => "Enum('LoggedInUsers, OnlyTheseUsers, Inherit', 'Inherit')",
124
	);
125
126
	private static $indexes = 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...
127
		"URLSegment" => true,
128
	);
129
130
	private static $many_many = 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...
131
		"ViewerGroups" => "Group",
132
		"EditorGroups" => "Group",
133
	);
134
135
	private static $casting = 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...
136
		"Breadcrumbs" => "HTMLText",
137
		"LastEdited" => "SS_Datetime",
138
		"Created" => "SS_Datetime",
139
		'Link' => 'Text',
140
		'RelativeLink' => 'Text',
141
		'AbsoluteLink' => 'Text',
142
		'TreeTitle' => 'HTMLText',
143
	);
144
145
	private static $defaults = 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...
146
		"ShowInMenus" => 1,
147
		"ShowInSearch" => 1,
148
		"CanViewType" => "Inherit",
149
		"CanEditType" => "Inherit"
150
	);
151
152
	private static $versioning = array(
153
		"Stage",  "Live"
154
	);
155
156
	private static $default_sort = "\"Sort\"";
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...
157
158
	/**
159
	 * If this is false, the class cannot be created in the CMS by regular content authors, only by ADMINs.
160
	 * @var boolean
161
	 * @config
162
	 */
163
	private static $can_create = true;
164
165
	/**
166
	 * Icon to use in the CMS page tree. This should be the full filename, relative to the webroot.
167
	 * Also supports custom CSS rule contents (applied to the correct selector for the tree UI implementation).
168
	 *
169
	 * @see CMSMain::generateTreeStylingCSS()
170
	 * @config
171
	 * @var string
172
	 */
173
	private static $icon = null;
174
	
175
	/**
176
	 * @config
177
	 * @var string Description of the class functionality, typically shown to a user
178
	 * when selecting which page type to create. Translated through {@link provideI18nEntities()}.
179
	 */
180
	private static $description = 'Generic content page';
181
182
	private static $extensions = 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...
183
		"Hierarchy",
184
		"Versioned('Stage', 'Live')",
185
		"SiteTreeLinkTracking"
186
	);
187
	
188
	private static $searchable_fields = 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...
189
		'Title',
190
		'Content',
191
	);
192
193
	private static $field_labels = 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...
194
		'URLSegment' => 'URL'
195
	);
196
	
197
	/**
198
	 * @config
199
	 */
200
	private static $nested_urls = true;
201
	
202
	/**
203
	 * @config
204
	*/
205
	private static $create_default_pages = true;
206
	
207
	/**
208
	 * This controls whether of not extendCMSFields() is called by getCMSFields.
209
	 */
210
	private static $runCMSFieldsExtensions = true;
211
	
212
	/**
213
	 * Cache for canView/Edit/Publish/Delete permissions.
214
	 * Keyed by permission type (e.g. 'edit'), with an array
215
	 * of IDs mapped to their boolean permission ability (true=allow, false=deny).
216
	 * See {@link batch_permission_check()} for details.
217
	 */
218
	private static $cache_permissions = array();
219
220
	/**
221
	 * @config
222
	 * @var boolean
223
	 */
224
	private static $enforce_strict_hierarchy = true;
225
226
	/**
227
	 * The value used for the meta generator tag. Leave blank to omit the tag.
228
	 *
229
	 * @config
230
	 * @var string
231
	 */
232
	private static $meta_generator = 'SilverStripe - http://silverstripe.org';
233
234
	protected $_cache_statusFlags = null;
235
	
236
	/**
237
	 * Determines if the system should avoid orphaned pages
238
	 * by deleting all children when the their parent is deleted (TRUE),
239
	 * or rather preserve this data even if its not reachable through any navigation path (FALSE).
240
	 *
241
	 * @deprecated 4.0 Use the "SiteTree.enforce_strict_hierarchy" config setting instead
242
	 * @param boolean
243
	 */
244
	static public function set_enforce_strict_hierarchy($to) {
245
		Deprecation::notice('4.0', 'Use the "SiteTree.enforce_strict_hierarchy" config setting instead');
246
		Config::inst()->update('SiteTree', 'enforce_strict_hierarchy', $to);
247
	}
248
	
249
	/**
250
	 * @deprecated 4.0 Use the "SiteTree.enforce_strict_hierarchy" config setting instead
251
	 * @return boolean
252
	 */
253
	static public function get_enforce_strict_hierarchy() {
254
		Deprecation::notice('4.0', 'Use the "SiteTree.enforce_strict_hierarchy" config setting instead');
255
		return Config::inst()->get('SiteTree', 'enforce_strict_hierarchy');
256
	}
257
258
	/**
259
	 * Returns TRUE if nested URLs (e.g. page/sub-page/) are currently enabled on this site.
260
	 *
261
	 * @deprecated 4.0 Use the "SiteTree.nested_urls" config setting instead
262
	 * @return bool
263
	 */
264
	static public function nested_urls() {
265
		Deprecation::notice('4.0', 'Use the "SiteTree.nested_urls" config setting instead');
266
		return Config::inst()->get('SiteTree', 'nested_urls');
267
	}
268
	
269
	/**
270
	 * @deprecated 4.0 Use the "SiteTree.nested_urls" config setting instead
271
	 */
272
	static public function enable_nested_urls() {
273
		Deprecation::notice('4.0', 'Use the "SiteTree.nested_urls" config setting instead');
274
		Config::inst()->update('SiteTree', 'nested_urls', true);
275
	}
276
	
277
	/**
278
	 * @deprecated 4.0 Use the "SiteTree.nested_urls" config setting instead
279
	 */
280
	static public function disable_nested_urls() {
281
		Deprecation::notice('4.0', 'Use the "SiteTree.nested_urls" config setting instead');
282
		Config::inst()->update('SiteTree', 'nested_urls', false);
283
	}
284
	
285
	/**
286
	 * Set the (re)creation of default pages on /dev/build
287
	 *
288
	 * @deprecated 4.0 Use the "SiteTree.create_default_pages" config setting instead
289
	 * @param bool $option
290
	 */
291
	static public function set_create_default_pages($option = true) {
292
		Deprecation::notice('4.0', 'Use the "SiteTree.create_default_pages" config setting instead');
293
		Config::inst()->update('SiteTree', 'create_default_pages', $option);
294
	}
295
296
	/**
297
	 * Return true if default pages should be created on /dev/build.
298
	 *
299
	 * @deprecated 4.0 Use the "SiteTree.create_default_pages" config setting instead
300
	 * @return bool
301
	 */
302
	static public function get_create_default_pages() {
303
		Deprecation::notice('4.0', 'Use the "SiteTree.create_default_pages" config setting instead');
304
		return Config::inst()->get('SiteTree', 'create_default_pages');
305
	}
306
	
307
	/**
308
	 * Fetches the {@link SiteTree} object that maps to a link.
309
	 *
310
	 * If you have enabled {@link SiteTree::config()->nested_urls} on this site, then you can use a nested link such as
311
	 * "about-us/staff/", and this function will traverse down the URL chain and grab the appropriate link.
312
	 *
313
	 * Note that if no model can be found, this method will fall over to a extended alternateGetByLink method provided
314
	 * by a extension attached to {@link SiteTree}
315
	 *
316
	 * @param string $link  The link of the page to search for
317
	 * @param bool   $cache True (default) to use caching, false to force a fresh search from the database
318
	 * @return SiteTree
319
	 */
320
	static public function get_by_link($link, $cache = true) {
321
		if(trim($link, '/')) {
322
			$link = trim(Director::makeRelative($link), '/');
323
		} else {
324
			$link = RootURLController::get_homepage_link();
325
		}
326
		
327
		$parts = preg_split('|/+|', $link);
328
		
329
		// Grab the initial root level page to traverse down from.
330
		$URLSegment = array_shift($parts);
331
		$conditions = array('"SiteTree"."URLSegment"' => rawurlencode($URLSegment));
332
		if(self::config()->nested_urls) {
333
			$conditions[] = array('"SiteTree"."ParentID"' => 0);
334
		}
335
		$sitetree = DataObject::get_one('SiteTree', $conditions, $cache);
336
		
337
		/// Fall back on a unique URLSegment for b/c.
338
		if(	!$sitetree
339
			&& self::config()->nested_urls
340
			&& $page = DataObject::get_one('SiteTree', array(
341
				'"SiteTree"."URLSegment"' => $URLSegment
342
			), $cache)
343
		) {
344
			return $page;
345
		}
346
		
347
		// Attempt to grab an alternative page from extensions.
348
		if(!$sitetree) {
349
			$parentID = self::config()->nested_urls ? 0 : null;
350
			
351 View Code Duplication
			if($alternatives = singleton('SiteTree')->extend('alternateGetByLink', $URLSegment, $parentID)) {
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...
352
				foreach($alternatives as $alternative) if($alternative) $sitetree = $alternative;
353
			}
354
			
355
			if(!$sitetree) return false;
0 ignored issues
show
Bug Best Practice introduced by
The return type of return false; (false) is incompatible with the return type documented by SiteTree::get_by_link of type SiteTree.

If you return a value from a function or method, it should be a sub-type of the type that is given by the parent type f.e. an interface, or abstract method. This is more formally defined by the Lizkov substitution principle, and guarantees that classes that depend on the parent type can use any instance of a child type interchangably. This principle also belongs to the SOLID principles for object oriented design.

Let’s take a look at an example:

class Author {
    private $name;

    public function __construct($name) {
        $this->name = $name;
    }

    public function getName() {
        return $this->name;
    }
}

abstract class Post {
    public function getAuthor() {
        return 'Johannes';
    }
}

class BlogPost extends Post {
    public function getAuthor() {
        return new Author('Johannes');
    }
}

class ForumPost extends Post { /* ... */ }

function my_function(Post $post) {
    echo strtoupper($post->getAuthor());
}

Our function my_function expects a Post object, and outputs the author of the post. The base class Post returns a simple string and outputting a simple string will work just fine. However, the child class BlogPost which is a sub-type of Post instead decided to return an object, and is therefore violating the SOLID principles. If a BlogPost were passed to my_function, PHP would not complain, but ultimately fail when executing the strtoupper call in its body.

Loading history...
356
		}
357
		
358
		// Check if we have any more URL parts to parse.
359
		if(!self::config()->nested_urls || !count($parts)) return $sitetree;
360
		
361
		// Traverse down the remaining URL segments and grab the relevant SiteTree objects.
362
		foreach($parts as $segment) {
363
			$next = DataObject::get_one('SiteTree', array(
364
					'"SiteTree"."URLSegment"' => $segment,
365
					'"SiteTree"."ParentID"' => $sitetree->ID
366
				),
367
				$cache
368
			);
369
			
370
			if(!$next) {
371
				$parentID = (int) $sitetree->ID;
372
				
373 View Code Duplication
				if($alternatives = singleton('SiteTree')->extend('alternateGetByLink', $segment, $parentID)) {
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...
374
					foreach($alternatives as $alternative) if($alternative) $next = $alternative;
375
				}
376
				
377
				if(!$next) return false;
0 ignored issues
show
Bug Best Practice introduced by
The return type of return false; (false) is incompatible with the return type documented by SiteTree::get_by_link of type SiteTree.

If you return a value from a function or method, it should be a sub-type of the type that is given by the parent type f.e. an interface, or abstract method. This is more formally defined by the Lizkov substitution principle, and guarantees that classes that depend on the parent type can use any instance of a child type interchangably. This principle also belongs to the SOLID principles for object oriented design.

Let’s take a look at an example:

class Author {
    private $name;

    public function __construct($name) {
        $this->name = $name;
    }

    public function getName() {
        return $this->name;
    }
}

abstract class Post {
    public function getAuthor() {
        return 'Johannes';
    }
}

class BlogPost extends Post {
    public function getAuthor() {
        return new Author('Johannes');
    }
}

class ForumPost extends Post { /* ... */ }

function my_function(Post $post) {
    echo strtoupper($post->getAuthor());
}

Our function my_function expects a Post object, and outputs the author of the post. The base class Post returns a simple string and outputting a simple string will work just fine. However, the child class BlogPost which is a sub-type of Post instead decided to return an object, and is therefore violating the SOLID principles. If a BlogPost were passed to my_function, PHP would not complain, but ultimately fail when executing the strtoupper call in its body.

Loading history...
378
			}
379
			
380
			$sitetree->destroy();
381
			$sitetree = $next;
382
		}
383
		
384
		return $sitetree;
385
	}
386
	
387
	/**
388
	 * Return a subclass map of SiteTree that shouldn't be hidden through {@link SiteTree::$hide_ancestor}
389
	 *
390
	 * @return array
391
	 */
392
	static public function page_type_classes() {
393
		$classes = ClassInfo::getValidSubClasses();
394
395
		$baseClassIndex = array_search('SiteTree', $classes);
396
		if($baseClassIndex !== FALSE) unset($classes[$baseClassIndex]);
397
398
		$kill_ancestors = array();
399
400
		// figure out if there are any classes we don't want to appear
401
		foreach($classes as $class) {
402
			$instance = singleton($class);
403
404
			// do any of the progeny want to hide an ancestor?
405
			if($ancestor_to_hide = $instance->stat('hide_ancestor')) {
406
				// note for killing later
407
				$kill_ancestors[] = $ancestor_to_hide;
408
			}
409
		}
410
411
		// If any of the descendents don't want any of the elders to show up, cruelly render the elders surplus to
412
		// requirements
413
		if($kill_ancestors) {
0 ignored issues
show
Bug Best Practice introduced by
The expression $kill_ancestors of type array is implicitly converted to a boolean; are you sure this is intended? If so, consider using ! empty($expr) instead to make it clear that you intend to check for an array without elements.

This check marks implicit conversions of arrays to boolean values in a comparison. While in PHP an empty array is considered to be equal (but not identical) to false, this is not always apparent.

Consider making the comparison explicit by using empty(..) or ! empty(...) instead.

Loading history...
414
			$kill_ancestors = array_unique($kill_ancestors);
415
			foreach($kill_ancestors as $mark) {
416
				// unset from $classes
417
				$idx = array_search($mark, $classes);
418
				unset($classes[$idx]);
419
			}
420
		}
421
422
		return $classes;
423
	}
424
	
425
	/**
426
	 * Replace a "[sitetree_link id=n]" shortcode with a link to the page with the corresponding ID.
427
	 *
428
	 * @param array      $arguments
429
	 * @param string     $content
430
	 * @param TextParser $parser
431
	 * @return string
432
	 */
433
	static public function link_shortcode_handler($arguments, $content = null, $parser = null) {
434
		if(!isset($arguments['id']) || !is_numeric($arguments['id'])) return;
435
		
436
		if (
437
			   !($page = DataObject::get_by_id('SiteTree', $arguments['id']))         // Get the current page by ID.
438
			&& !($page = Versioned::get_latest_version('SiteTree', $arguments['id'])) // Attempt link to old version.
439
		) {
440
			 return; // There were no suitable matches at all.
441
		}
442
443
		$link = Convert::raw2att($page->Link());
444
		
445
		if($content) {
0 ignored issues
show
Bug Best Practice introduced by
The expression $content of type string|null is loosely compared to true; this is ambiguous if the string can be empty. 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 string values, the empty string '' is a special case, in particular the following results might be unexpected:

''   == false // true
''   == null  // true
'ab' == false // false
'ab' == null  // false

// It is often better to use strict comparison
'' === false // false
'' === null  // false
Loading history...
446
			return sprintf('<a href="%s">%s</a>', $link, $parser->parse($content));
0 ignored issues
show
Unused Code introduced by
The call to TextParser::parse() has too many arguments starting with $content.

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...
Bug introduced by
It seems like $parser is not always an object, but can also be of type null. Maybe add an additional type check?

If a variable is not always an object, we recommend to add an additional type check to ensure your method call is safe:

function someFunction(A $objectMaybe = null)
{
    if ($objectMaybe instanceof A) {
        $objectMaybe->doSomething();
    }
}
Loading history...
447
		} else {
448
			return $link;
449
		}
450
	}
451
452
	/**
453
	 * Return the link for this {@link SiteTree} object, with the {@link Director::baseURL()} included.
454
	 *
455
	 * @param string $action Optional controller action (method).
456
	 *                       Note: URI encoding of this parameter is applied automatically through template casting,
457
	 *                       don't encode the passed parameter. Please use {@link Controller::join_links()} instead to
458
	 *                       append GET parameters.
459
	 * @return string
460
	 */
461
	public function Link($action = null) {
462
		return Controller::join_links(Director::baseURL(), $this->RelativeLink($action));
463
	}
464
	
465
	/**
466
	 * Get the absolute URL for this page, including protocol and host.
467
	 *
468
	 * @param string $action See {@link Link()}
469
	 * @return string
470
	 */
471
	public function AbsoluteLink($action = null) {
472
		if($this->hasMethod('alternateAbsoluteLink')) {
473
			return $this->alternateAbsoluteLink($action);
0 ignored issues
show
Bug introduced by
The method alternateAbsoluteLink() does not exist on SiteTree. Did you maybe mean AbsoluteLink()?

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...
474
		} else {
475
			return Director::absoluteURL($this->Link($action));
0 ignored issues
show
Comprehensibility Best Practice introduced by
The expression \Director::absoluteURL($this->Link($action)); of type string|false adds false to the return on line 475 which is incompatible with the return type documented by SiteTree::AbsoluteLink of type string. It seems like you forgot to handle an error condition.
Loading history...
476
		}
477
	}
478
	
479
	/**
480
	 * Base link used for previewing. Defaults to absolute URL, in order to account for domain changes, e.g. on multi
481
	 * site setups. Does not contain hints about the stage, see {@link SilverStripeNavigator} for details.
482
	 *
483
	 * @param string $action See {@link Link()}
484
	 * @return string
485
	 */
486
	public function PreviewLink($action = null) {
487
		if($this->hasMethod('alternatePreviewLink')) {
488
			return $this->alternatePreviewLink($action);
0 ignored issues
show
Bug introduced by
The method alternatePreviewLink() does not exist on SiteTree. Did you maybe mean PreviewLink()?

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...
489
		} else {
490
			return $this->AbsoluteLink($action);
491
		}
492
	}
493
	
494
	/**
495
	 * Return the link for this {@link SiteTree} object relative to the SilverStripe root.
496
	 *
497
	 * By default, if this page is the current home page, and there is no action specified then this will return a link
498
	 * to the root of the site. However, if you set the $action parameter to TRUE then the link will not be rewritten
499
	 * and returned in its full form.
500
	 *
501
	 * @uses RootURLController::get_homepage_link()
502
	 *
503
	 * @param string $action See {@link Link()}
504
	 * @return string
505
	 */
506
	public function RelativeLink($action = null) {
507
		if($this->ParentID && self::config()->nested_urls) {
0 ignored issues
show
Documentation introduced by
The property ParentID 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...
508
			$parent = $this->Parent();
0 ignored issues
show
Bug introduced by
The method Parent() does not exist on SiteTree. Did you maybe mean setParent()?

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...
509
			// If page is removed select parent from version history (for archive page view)
510
			if((!$parent || !$parent->exists()) && $this->IsDeletedFromStage) {
0 ignored issues
show
Documentation introduced by
The property IsDeletedFromStage 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...
511
				$parent = Versioned::get_latest_version('SiteTree', $this->ParentID);
0 ignored issues
show
Documentation introduced by
The property ParentID 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...
512
			}
513
			$base = $parent->RelativeLink($this->URLSegment);
514
		} elseif(!$action && $this->URLSegment == RootURLController::get_homepage_link()) {
0 ignored issues
show
Bug Best Practice introduced by
The expression $action of type string|null is loosely compared to false; this is ambiguous if the string can be empty. 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 string values, the empty string '' is a special case, in particular the following results might be unexpected:

''   == false // true
''   == null  // true
'ab' == false // false
'ab' == null  // false

// It is often better to use strict comparison
'' === false // false
'' === null  // false
Loading history...
515
			// Unset base for root-level homepages.
516
			// Note: Homepages with action parameters (or $action === true)
517
			// need to retain their URLSegment.
518
			$base = null;
519
		} else {
520
			$base = $this->URLSegment;
521
		}
522
		
523
		$this->extend('updateRelativeLink', $base, $action);
524
		
525
		// Legacy support: If $action === true, retain URLSegment for homepages,
526
		// but don't append any action
527
		if($action === true) $action = null;
528
529
		return Controller::join_links($base, '/', $action);
530
	}
531
532
	/**
533
	 * Get the absolute URL for this page on the Live site.
534
	 *
535
	 * @param bool $includeStageEqualsLive Whether to append the URL with ?stage=Live to force Live mode
536
	 * @return string
537
	 */
538
	public function getAbsoluteLiveLink($includeStageEqualsLive = true) {
539
		$oldStage = Versioned::current_stage();
540
		Versioned::reading_stage('Live');
541
		$live = Versioned::get_one_by_stage('SiteTree', 'Live', array(
0 ignored issues
show
Documentation introduced by
array('"SiteTree"."ID"' => $this->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...
542
			'"SiteTree"."ID"' => $this->ID
543
		));
544
		if($live) {
545
			$link = $live->AbsoluteLink();
546
			if($includeStageEqualsLive) $link .= '?stage=Live';
547
		} else {
548
			$link = null;
549
		}
550
551
		Versioned::reading_stage($oldStage);
552
		return $link;
553
	}
554
	
555
	/**
556
	 * Generates a link to edit this page in the CMS.
557
	 *
558
	 * @return string
559
	 */
560
	public function CMSEditLink() {
561
		return Controller::join_links(singleton('CMSPageEditController')->Link('show'), $this->ID);
562
	}
563
	
564
		
565
	/**
566
	 * Return a CSS identifier generated from this page's link.
567
	 *
568
	 * @return string The URL segment
569
	 */
570
	public function ElementName() {
571
		return str_replace('/', '-', trim($this->RelativeLink(true), '/'));
0 ignored issues
show
Documentation introduced by
true is of type boolean, but the function expects a string|null.

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...
572
	}
573
	
574
	/**
575
	 * Returns true if this is the currently active page being used to handle this request.
576
	 *
577
	 * @return bool
578
	 */
579
	public function isCurrent() {
580
		return $this->ID ? $this->ID == Director::get_current_page()->ID : $this === Director::get_current_page();
581
	}
582
	
583
	/**
584
	 * Check if this page is in the currently active section (e.g. it is either current or one of its children is
585
	 * currently being viewed).
586
	 *
587
	 * @return bool
588
	 */
589
	public function isSection() {
590
		return $this->isCurrent() || (
591
			Director::get_current_page() instanceof SiteTree && in_array($this->ID, Director::get_current_page()->getAncestors()->column())
0 ignored issues
show
Documentation Bug introduced by
The method getAncestors 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...
592
		);
593
	}
594
	
595
	/**
596
	 * Check if the parent of this page has been removed (or made otherwise unavailable), and is still referenced by
597
	 * this child. Any such orphaned page may still require access via the CMS, but should not be shown as accessible
598
	 * to external users.
599
	 *
600
	 * @return bool
601
	 */
602
	public function isOrphaned() {
603
		// Always false for root pages
604
		if(empty($this->ParentID)) return false;
0 ignored issues
show
Documentation introduced by
The property ParentID 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...
605
		
606
		// Parent must exist and not be an orphan itself
607
		$parent = $this->Parent();
0 ignored issues
show
Bug introduced by
The method Parent() does not exist on SiteTree. Did you maybe mean setParent()?

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...
608
		return !$parent || !$parent->exists() || $parent->isOrphaned();
609
	}
610
	
611
	/**
612
	 * Return "link" or "current" depending on if this is the {@link SiteTree::isCurrent()} current page.
613
	 *
614
	 * @return string
615
	 */
616
	public function LinkOrCurrent() {
617
		return $this->isCurrent() ? 'current' : 'link';
618
	}
619
	
620
	/**
621
	 * Return "link" or "section" depending on if this is the {@link SiteTree::isSeciton()} current section.
622
	 *
623
	 * @return string
624
	 */
625
	public function LinkOrSection() {
626
		return $this->isSection() ? 'section' : 'link';
627
	}
628
	
629
	/**
630
	 * Return "link", "current" or "section" depending on if this page is the current page, or not on the current page
631
	 * but in the current section.
632
	 *
633
	 * @return string
634
	 */
635
	public function LinkingMode() {
636
		if($this->isCurrent()) {
637
			return 'current';
638
		} elseif($this->isSection()) {
639
			return 'section';
640
		} else {
641
			return 'link';
642
		}
643
	}
644
	
645
	/**
646
	 * Check if this page is in the given current section.
647
	 *
648
	 * @param string $sectionName Name of the section to check
649
	 * @return bool True if we are in the given section
650
	 */
651
	public function InSection($sectionName) {
652
		$page = Director::get_current_page();
653
		while($page) {
654
			if($sectionName == $page->URLSegment)
655
				return true;
656
			$page = $page->Parent;
657
		}
658
		return false;
659
	}
660
661
	/**
662
	 * Create a duplicate of this node. Doesn't affect joined data - create a custom overloading of this if you need
663
	 * such behaviour.
664
	 *
665
	 * @param bool $doWrite Whether to write the new object before returning it
666
	 * @return self The duplicated object
667
	 */
668
	 public function duplicate($doWrite = true) {
669
		
670
		$page = parent::duplicate(false);
671
		$page->Sort = 0;
672
		$this->invokeWithExtensions('onBeforeDuplicate', $page);
673
		
674
		if($doWrite) {
675
			$page->write();
676
677
			$page = $this->duplicateManyManyRelations($this, $page);
678
		}
679
		$this->invokeWithExtensions('onAfterDuplicate', $page);
680
		
681
		return $page;
682
	}
683
684
	/**
685
	 * Duplicates each child of this node recursively and returns the top-level duplicate node.
686
	 *
687
	 * @return self The duplicated object
688
	 */
689
	public function duplicateWithChildren() {
690
		$clone = $this->duplicate();
691
		$children = $this->AllChildren();
0 ignored issues
show
Documentation Bug introduced by
The method AllChildren 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...
692
693
		if($children) {
694
			foreach($children as $child) {
695
				$childClone = method_exists($child, 'duplicateWithChildren')
696
					? $child->duplicateWithChildren()
697
					: $child->duplicate();
698
				$childClone->ParentID = $clone->ID;
699
				$childClone->write();
700
			}
701
		}
702
703
		return $clone;
704
	}
705
706
	/**
707
	 * Duplicate this node and its children as a child of the node with the given ID
708
	 *
709
	 * @param int $id ID of the new node's new parent
710
	 */
711
	public function duplicateAsChild($id) {
712
		$newSiteTree = $this->duplicate();
713
		$newSiteTree->ParentID = $id;
0 ignored issues
show
Documentation introduced by
The property ParentID does not exist on object<SiteTree>. Since you implemented __set, maybe consider adding a @property annotation.

Since your code implements the magic setter _set, this function will be called for any write 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.");
        }
    }

}

Since the property has write access only, you can use the @property-write 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...
714
		$newSiteTree->Sort = 0;
715
		$newSiteTree->write();
716
	}
717
	
718
	/**
719
	 * Return a breadcrumb trail to this page. Excludes "hidden" pages (with ShowInMenus=0) by default.
720
	 *
721
	 * @param int $maxDepth The maximum depth to traverse.
722
	 * @param boolean $unlinked Whether to link page titles.
723
	 * @param boolean|string $stopAtPageType ClassName of a page to stop the upwards traversal.
724
	 * @param boolean $showHidden Include pages marked with the attribute ShowInMenus = 0
725
	 * @return HTMLText The breadcrumb trail.
726
	 */
727
	public function Breadcrumbs($maxDepth = 20, $unlinked = false, $stopAtPageType = false, $showHidden = false) {
728
		$pages = $this->getBreadcrumbItems($maxDepth, $stopAtPageType, $showHidden);
729
		$template = new SSViewer('BreadcrumbsTemplate');
730
		return $template->process($this->customise(new ArrayData(array(
731
			"Pages" => $pages,
732
			"Unlinked" => $unlinked
733
		))));
734
	}
735
736
737
	/**
738
	 * Returns a list of breadcrumbs for the current page.
739
	 *
740
	 * @param int $maxDepth The maximum depth to traverse.
741
	 * @param boolean|string $stopAtPageType ClassName of a page to stop the upwards traversal.
742
	 * @param boolean $showHidden Include pages marked with the attribute ShowInMenus = 0
743
	 *
744
	 * @return ArrayList
745
	*/
746
	public function getBreadcrumbItems($maxDepth = 20, $stopAtPageType = false, $showHidden = false) {
747
		$page = $this;
748
		$pages = array();
749
		
750
		while(
751
			$page
752
 			&& (!$maxDepth || count($pages) < $maxDepth)
753
 			&& (!$stopAtPageType || $page->ClassName != $stopAtPageType)
754
 		) {
755
			if($showHidden || $page->ShowInMenus || ($page->ID == $this->ID)) {
756
				$pages[] = $page;
757
			}
758
			
759
			$page = $page->Parent;
760
		}
761
762
		return new ArrayList(array_reverse($pages));
763
	}
764
765
766
	/**
767
	 * Make this page a child of another page.
768
	 *
769
	 * If the parent page does not exist, resolve it to a valid ID before updating this page's reference.
770
	 *
771
	 * @param SiteTree|int $item Either the parent object, or the parent ID
772
	 */
773
	public function setParent($item) {
774
		if(is_object($item)) {
775
			if (!$item->exists()) $item->write();
776
			$this->setField("ParentID", $item->ID);
777
		} else {
778
			$this->setField("ParentID", $item);
779
		}
780
	}
781
 	
0 ignored issues
show
Coding Style introduced by
There is some trailing whitespace on this line which should be avoided as per coding-style.
Loading history...
782
	/**
783
	 * Get the parent of this page.
784
	 *
785
	 * @return SiteTree Parent of this page
786
	 */
787
	public function getParent() {
788
		if ($parentID = $this->getField("ParentID")) {
789
			return DataObject::get_by_id("SiteTree", $parentID);
790
		}
791
	}
792
793
	/**
794
	 * Return a string of the form "parent - page" or "grandparent - parent - page" using page titles
795
	 *
796
	 * @param int $level The maximum amount of levels to traverse.
797
	 * @param string $separator Seperating string
798
	 * @return string The resulting string
799
	 */
800
	public function NestedTitle($level = 2, $separator = " - ") {
801
		$item = $this;
802
		while($item && $level > 0) {
803
			$parts[] = $item->Title;
0 ignored issues
show
Coding Style Comprehensibility introduced by
$parts was never initialized. Although not strictly required by PHP, it is generally a good practice to add $parts = 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...
804
			$item = $item->Parent;
805
			$level--;
806
		}
807
		return implode($separator, array_reverse($parts));
0 ignored issues
show
Bug introduced by
The variable $parts 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...
808
	}
809
810
	/**
811
	 * This function should return true if the current user can execute this action. It can be overloaded to customise
812
	 * the security model for an application.
813
	 *
814
	 * Slightly altered from parent behaviour in {@link DataObject->can()}:
815
	 * - Checks for existence of a method named "can<$perm>()" on the object
816
	 * - Calls decorators and only returns for FALSE "vetoes"
817
	 * - Falls back to {@link Permission::check()}
818
	 * - Does NOT check for many-many relations named "Can<$perm>"
819
	 *
820
	 * @uses DataObjectDecorator->can()
821
	 *
822
	 * @param string $perm The permission to be checked, such as 'View'
823
	 * @param Member $member The member whose permissions need checking. Defaults to the currently logged in user.
824
	 * @return bool True if the the member is allowed to do the given action
825
	 */
826
	public function can($perm, $member = null) {
827 View Code Duplication
		if(!$member || !(is_a($member, 'Member')) || is_numeric($member)) {
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...
828
			$member = Member::currentUserID();
829
		}
830
831
		if($member && Permission::checkMember($member, "ADMIN")) return true;
832
		
833
		if(is_string($perm) && method_exists($this, 'can' . ucfirst($perm))) {
834
			$method = 'can' . ucfirst($perm);
835
			return $this->$method($member);
836
		}
837
		
838
		$results = $this->extend('can', $member);
839
		if($results && is_array($results)) if(!min($results)) return false;
0 ignored issues
show
Bug Best Practice introduced by
The expression $results of type array is implicitly converted to a boolean; are you sure this is intended? If so, consider using ! empty($expr) instead to make it clear that you intend to check for an array without elements.

This check marks implicit conversions of arrays to boolean values in a comparison. While in PHP an empty array is considered to be equal (but not identical) to false, this is not always apparent.

Consider making the comparison explicit by using empty(..) or ! empty(...) instead.

Loading history...
840
841
		return ($member && Permission::checkMember($member, $perm));
842
	}
843
844
	/**
845
	 * This function should return true if the current user can add children to this page. It can be overloaded to
846
	 * customise the security model for an application.
847
	 *
848
	 * Denies permission if any of the following conditions is true:
849
	 * - alternateCanAddChildren() on a extension returns false
850
	 * - canEdit() is not granted
851
	 * - There are no classes defined in {@link $allowed_children}
852
	 *
853
	 * @uses SiteTreeExtension->canAddChildren()
854
	 * @uses canEdit()
855
	 * @uses $allowed_children
856
	 *
857
	 * @param Member|int $member
858
	 * @return bool True if the current user can add children
859
	 */
860
	public function canAddChildren($member = null) {
861
		// Disable adding children to archived pages
862
		if($this->getIsDeletedFromStage()) {
863
			return false;
864
		}
865
866 View Code Duplication
		if(!$member || !(is_a($member, 'Member')) || is_numeric($member)) {
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...
867
			$member = Member::currentUserID();
868
		}
869
870
		if($member && Permission::checkMember($member, "ADMIN")) return true;
871
		
872
		// Standard mechanism for accepting permission changes from extensions
873
		$extended = $this->extendedCan('canAddChildren', $member);
874
		if($extended !== null) return $extended;
875
		
876
		return $this->canEdit($member) && $this->stat('allowed_children') != 'none';
877
	}
878
879
	/**
880
	 * This function should return true if the current user can view this page. It can be overloaded to customise the
881
	 * security model for an application.
882
	 *
883
	 * Denies permission if any of the following conditions is true:
884
	 * - canView() on any extension returns false
885
	 * - "CanViewType" directive is set to "Inherit" and any parent page return false for canView()
886
	 * - "CanViewType" directive is set to "LoggedInUsers" and no user is logged in
887
	 * - "CanViewType" directive is set to "OnlyTheseUsers" and user is not in the given groups
888
	 *
889
	 * @uses DataExtension->canView()
890
	 * @uses ViewerGroups()
891
	 *
892
	 * @param Member|int $member
893
	 * @return bool True if the current user can view this page
894
	 */
895
	public function canView($member = null) {
896 View Code Duplication
		if(!$member || !(is_a($member, 'Member')) || is_numeric($member)) {
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...
897
			$member = Member::currentUserID();
898
		}
899
900
		// admin override
901
		if($member && Permission::checkMember($member, array("ADMIN", "SITETREE_VIEW_ALL"))) return true;
902
		
903
		// Orphaned pages (in the current stage) are unavailable, except for admins via the CMS
904
		if($this->isOrphaned()) return false;
905
906
		// Standard mechanism for accepting permission changes from extensions
907
		$extended = $this->extendedCan('canView', $member);
908
		if($extended !== null) return $extended;
909
		
910
		// check for empty spec
911
		if(!$this->CanViewType || $this->CanViewType == 'Anyone') return true;
912
913
		// check for inherit
914
		if($this->CanViewType == 'Inherit') {
915
			if($this->ParentID) return $this->Parent()->canView($member);
0 ignored issues
show
Documentation introduced by
The property ParentID 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...
Bug introduced by
The method Parent() does not exist on SiteTree. Did you maybe mean setParent()?

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...
916
			else return $this->getSiteConfig()->canViewPages($member);
917
		}
918
		
919
		// check for any logged-in users
920
		if($this->CanViewType == 'LoggedInUsers' && $member) {
921
			return true;
922
		}
923
		
924
		// check for specific groups
925
		if($member && is_numeric($member)) $member = DataObject::get_by_id('Member', $member);
926
		if(
927
			$this->CanViewType == 'OnlyTheseUsers'
928
			&& $member
929
			&& $member->inGroups($this->ViewerGroups())
0 ignored issues
show
Documentation Bug introduced by
The method ViewerGroups 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...
930
		) return true;
931
		
932
		return false;
933
	}
934
935
	/**
936
	 * This function should return true if the current user can delete this page. It can be overloaded to customise the
937
	 * security model for an application.
938
	 *
939
	 * Denies permission if any of the following conditions is true:
940
	 * - canDelete() returns false on any extension
941
	 * - canEdit() returns false
942
	 * - any descendant page returns false for canDelete()
943
	 *
944
	 * @uses canDelete()
945
	 * @uses SiteTreeExtension->canDelete()
946
	 * @uses canEdit()
947
	 *
948
	 * @param Member $member
949
	 * @return bool True if the current user can delete this page
950
	 */
951
	public function canDelete($member = null) {
952 View Code Duplication
		if($member instanceof Member) $memberID = $member->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...
953
		else if(is_numeric($member)) $memberID = $member;
954
		else $memberID = Member::currentUserID();
955
		
956
		if($memberID && Permission::checkMember($memberID, array("ADMIN", "SITETREE_EDIT_ALL"))) {
957
			return true;
958
		}
959
		
960
		// Standard mechanism for accepting permission changes from extensions
961
		$extended = $this->extendedCan('canDelete', $memberID);
962
		if($extended !== null) return $extended;
963
				
964
		// Regular canEdit logic is handled by can_edit_multiple
965
		$results = self::can_delete_multiple(array($this->ID), $memberID);
966
		
967
		// If this page no longer exists in stage/live results won't contain the page.
968
		// Fail-over to false
969
		return isset($results[$this->ID]) ? $results[$this->ID] : false;
970
	}
971
972
	/**
973
	 * This function should return true if the current user can create new pages of this class, regardless of class. It
974
	 * can be overloaded to customise the security model for an application.
975
	 *
976
	 * By default, permission to create at the root level is based on the SiteConfig configuration, and permission to
977
	 * create beneath a parent is based on the ability to edit that parent page.
978
	 *
979
	 * Use {@link canAddChildren()} to control behaviour of creating children under this page.
980
	 *
981
	 * @uses $can_create
982
	 * @uses DataExtension->canCreate()
983
	 *
984
	 * @param Member $member
985
	 * @param array $context Optional array which may contain array('Parent' => $parentObj)
986
	 *                       If a parent page is known, it will be checked for validity.
987
	 *                       If omitted, it will be assumed this is to be created as a top level page.
988
	 * @return bool True if the current user can create pages on this class.
989
	 */
990
	public function canCreate($member = null, $context = array()) {
991 View Code Duplication
		if(!$member || !(is_a($member, 'Member')) || is_numeric($member)) {
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...
992
			$member = Member::currentUserID();
993
		}
994
995
		// Check parent (custom canCreate option for SiteTree)
996
		// Block children not allowed for this parent type
997
		$parent = isset($context['Parent']) ? $context['Parent'] : null;
998
		if($parent && !in_array(get_class($this), $parent->allowedChildren())) {
999
			return false;
1000
		}
1001
1002
		// Check permission
1003
		if($member && Permission::checkMember($member, "ADMIN")) {
1004
			return true;
1005
		}
1006
1007
		// Standard mechanism for accepting permission changes from extensions
1008
		$extended = $this->extendedCan(__FUNCTION__, $member, $context);
1009
		if($extended !== null) {
1010
			return $extended;
1011
		}
1012
1013
		// Fall over to inherited permissions
1014
		if($parent) {
1015
			return $parent->canAddChildren($member);
1016
		} else {
1017
			// This doesn't necessarily mean we are creating a root page, but that
1018
			// we don't know if there is a parent, so default to this permission
1019
			return SiteConfig::current_site_config()->canCreateTopLevel($member);
1020
		}
1021
	}
1022
1023
	/**
1024
	 * This function should return true if the current user can edit this page. It can be overloaded to customise the
1025
	 * security model for an application.
1026
	 *
1027
	 * Denies permission if any of the following conditions is true:
1028
	 * - canEdit() on any extension returns false
1029
	 * - canView() return false
1030
	 * - "CanEditType" directive is set to "Inherit" and any parent page return false for canEdit()
1031
	 * - "CanEditType" directive is set to "LoggedInUsers" and no user is logged in or doesn't have the
1032
	 *   CMS_Access_CMSMAIN permission code
1033
	 * - "CanEditType" directive is set to "OnlyTheseUsers" and user is not in the given groups
1034
	 *
1035
	 * @uses canView()
1036
	 * @uses EditorGroups()
1037
	 * @uses DataExtension->canEdit()
1038
	 *
1039
	 * @param Member $member Set to false if you want to explicitly test permissions without a valid user (useful for
1040
	 *                       unit tests)
1041
	 * @return bool True if the current user can edit this page
1042
	 */
1043
	public function canEdit($member = null) {
1044 View Code Duplication
		if($member instanceof Member) $memberID = $member->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...
1045
		else if(is_numeric($member)) $memberID = $member;
1046
		else $memberID = Member::currentUserID();
1047
		
1048
		if($memberID && Permission::checkMember($memberID, array("ADMIN", "SITETREE_EDIT_ALL"))) return true;
1049
		
1050
		// Standard mechanism for accepting permission changes from extensions
1051
		$extended = $this->extendedCan('canEdit', $memberID);
1052
		if($extended !== null) return $extended;
1053
1054
		if($this->ID) {
1055
			// Regular canEdit logic is handled by can_edit_multiple
1056
			$results = self::can_edit_multiple(array($this->ID), $memberID);
1057
1058
			// If this page no longer exists in stage/live results won't contain the page.
1059
			// Fail-over to false
1060
			return isset($results[$this->ID]) ? $results[$this->ID] : false;
1061
			
1062
		// Default for unsaved pages
1063
		} else {
1064
			return $this->getSiteConfig()->canEditPages($member);
1065
		}
1066
	}
1067
1068
	/**
1069
	 * @deprecated
1070
	 */
1071
	public function canDeleteFromLive($member = null) {
1072
		Deprecation::notice('4.0', 'Use canUnpublish');
1073
1074
		// Deprecated extension
1075
		$extended = $this->extendedCan('canDeleteFromLive', $member);
1076
		if($extended !== null) {
1077
			Deprecation::notice('4.0', 'Use canUnpublish in your extension instead');
1078
			return $extended;
1079
		}
1080
1081
		return $this->canUnpublish($member);
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...
1082
	}
1083
1084
	/**
1085
	 * Stub method to get the site config, unless the current class can provide an alternate.
1086
	 *
1087
	 * @return SiteConfig
1088
	 */
1089
	public function getSiteConfig() {
1090
		
1091
		if($this->hasMethod('alternateSiteConfig')) {
1092
			$altConfig = $this->alternateSiteConfig();
0 ignored issues
show
Bug introduced by
The method alternateSiteConfig() does not exist on SiteTree. Did you maybe mean config()?

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...
1093
			if($altConfig) return $altConfig;
1094
		}
1095
		
1096
		return SiteConfig::current_site_config();
1097
	}
1098
1099
	/**
1100
	 * Pre-populate the cache of canEdit, canView, canDelete, canPublish permissions. This method will use the static
1101
	 * can_(perm)_multiple method for efficiency.
1102
	 *
1103
	 * @param string          $permission    The permission: edit, view, publish, approve, etc.
1104
	 * @param array           $ids           An array of page IDs
1105
	 * @param callable|string $batchCallback The function/static method to call to calculate permissions.  Defaults
1106
	 *                                       to 'SiteTree::can_(permission)_multiple'
1107
	 */
1108
	static public function prepopulate_permission_cache($permission = 'CanEditType', $ids, $batchCallback = null) {
1109
		if(!$batchCallback) $batchCallback = "SiteTree::can_{$permission}_multiple";
1110
		
1111
		if(is_callable($batchCallback)) {
1112
			call_user_func($batchCallback, $ids, Member::currentUserID(), false);
1113
		} else {
1114
			user_error("SiteTree::prepopulate_permission_cache can't calculate '$permission' "
1115
				. "with callback '$batchCallback'", E_USER_WARNING);
1116
		}
1117
	}
1118
1119
	/**
1120
	 * This method is NOT a full replacement for the individual can*() methods, e.g. {@link canEdit()}. Rather than
1121
	 * checking (potentially slow) PHP logic, it relies on the database group associations, e.g. the "CanEditType" field
1122
	 * plus the "SiteTree_EditorGroups" many-many table. By batch checking multiple records, we can combine the queries
1123
	 * efficiently.
1124
	 *
1125
	 * Caches based on $typeField data. To invalidate the cache, use {@link SiteTree::reset()} or set the $useCached
1126
	 * property to FALSE.
1127
	 *
1128
	 * @param array  $ids              Of {@link SiteTree} IDs
1129
	 * @param int    $memberID         Member ID
1130
	 * @param string $typeField        A property on the data record, e.g. "CanEditType".
1131
	 * @param string $groupJoinTable   A many-many table name on this record, e.g. "SiteTree_EditorGroups"
1132
	 * @param string $siteConfigMethod Method to call on {@link SiteConfig} for toplevel items, e.g. "canEdit"
1133
	 * @param string $globalPermission If the member doesn't have this permission code, don't bother iterating deeper
1134
	 * @param bool   $useCached
1135
	 * @return array An map of {@link SiteTree} ID keys to boolean values
1136
	 */
1137
	public static function batch_permission_check($ids, $memberID, $typeField, $groupJoinTable, $siteConfigMethod,
1138
												  $globalPermission = null, $useCached = true) {
1139
		if($globalPermission === NULL) $globalPermission = array('CMS_ACCESS_LeftAndMain', 'CMS_ACCESS_CMSMain');
1140
1141
		// Sanitise the IDs
1142
		$ids = array_filter($ids, 'is_numeric');
1143
		
1144
		// This is the name used on the permission cache
1145
		// converts something like 'CanEditType' to 'edit'.
1146
		$cacheKey = strtolower(substr($typeField, 3, -4)) . "-$memberID";
1147
1148
		// Default result: nothing editable
1149
		$result = array_fill_keys($ids, false);
1150
		if($ids) {
0 ignored issues
show
Bug Best Practice introduced by
The expression $ids of type array is implicitly converted to a boolean; are you sure this is intended? If so, consider using ! empty($expr) instead to make it clear that you intend to check for an array without elements.

This check marks implicit conversions of arrays to boolean values in a comparison. While in PHP an empty array is considered to be equal (but not identical) to false, this is not always apparent.

Consider making the comparison explicit by using empty(..) or ! empty(...) instead.

Loading history...
1151
1152
			// Look in the cache for values
1153
			if($useCached && isset(self::$cache_permissions[$cacheKey])) {
1154
				$cachedValues = array_intersect_key(self::$cache_permissions[$cacheKey], $result);
1155
			
1156
				// If we can't find everything in the cache, then look up the remainder separately
1157
				$uncachedValues = array_diff_key($result, self::$cache_permissions[$cacheKey]);
1158
				if($uncachedValues) {
0 ignored issues
show
Bug Best Practice introduced by
The expression $uncachedValues of type array is implicitly converted to a boolean; are you sure this is intended? If so, consider using ! empty($expr) instead to make it clear that you intend to check for an array without elements.

This check marks implicit conversions of arrays to boolean values in a comparison. While in PHP an empty array is considered to be equal (but not identical) to false, this is not always apparent.

Consider making the comparison explicit by using empty(..) or ! empty(...) instead.

Loading history...
1159
					$cachedValues = self::batch_permission_check(array_keys($uncachedValues), $memberID, $typeField, $groupJoinTable, $siteConfigMethod, $globalPermission, false) + $cachedValues;
0 ignored issues
show
Bug introduced by
It seems like $globalPermission defined by array('CMS_ACCESS_LeftAn..., 'CMS_ACCESS_CMSMain') on line 1139 can also be of type array<integer,string,{"0":"string","1":"string"}>; however, SiteTree::batch_permission_check() does only seem to accept string|null, maybe add an additional type check?

If a method or function can return multiple different values and unless you are sure that you only can receive a single value in this context, we recommend to add an additional type check:

/**
 * @return array|string
 */
function returnsDifferentValues($x) {
    if ($x) {
        return 'foo';
    }

    return array();
}

$x = returnsDifferentValues($y);
if (is_array($x)) {
    // $x is an array.
}

If this a common case that PHP Analyzer should handle natively, please let us know by opening an issue.

Loading history...
1160
				}
1161
				return $cachedValues;
1162
			}
1163
		
1164
			// If a member doesn't have a certain permission then they can't edit anything
1165
			if(!$memberID || ($globalPermission && !Permission::checkMember($memberID, $globalPermission))) {
1166
				return $result;
1167
			}
1168
1169
			// Placeholder for parameterised ID list
1170
			$idPlaceholders = DB::placeholders($ids);
1171
1172
			// If page can't be viewed, don't grant edit permissions to do - implement can_view_multiple(), so this can
1173
			// be enabled
1174
			//$ids = array_keys(array_filter(self::can_view_multiple($ids, $memberID)));
1175
		
1176
			// Get the groups that the given member belongs to
1177
			$groupIDs = DataObject::get_by_id('Member', $memberID)->Groups()->column("ID");
1178
			$SQL_groupList = implode(", ", $groupIDs);
1179
			if (!$SQL_groupList) $SQL_groupList = '0';
1180
			
1181
			$combinedStageResult = array();
1182
1183
			foreach(array('Stage', 'Live') as $stage) {
1184
				// Start by filling the array with the pages that actually exist
1185
				$table = ($stage=='Stage') ? "SiteTree" : "SiteTree_$stage";
1186
				
1187
				if($ids) {
0 ignored issues
show
Bug Best Practice introduced by
The expression $ids of type array is implicitly converted to a boolean; are you sure this is intended? If so, consider using ! empty($expr) instead to make it clear that you intend to check for an array without elements.

This check marks implicit conversions of arrays to boolean values in a comparison. While in PHP an empty array is considered to be equal (but not identical) to false, this is not always apparent.

Consider making the comparison explicit by using empty(..) or ! empty(...) instead.

Loading history...
1188
					$idQuery = "SELECT \"ID\" FROM \"$table\" WHERE \"ID\" IN ($idPlaceholders)";
1189
					$stageIds = DB::prepared_query($idQuery, $ids)->column();
1190
				} else {
1191
					$stageIds = array();
1192
				}
1193
				$result = array_fill_keys($stageIds, false);
1194
				
1195
				// Get the uninherited permissions
1196
				$uninheritedPermissions = Versioned::get_by_stage("SiteTree", $stage)
1197
					->where(array(
1198
						"(\"$typeField\" = 'LoggedInUsers' OR
1199
						(\"$typeField\" = 'OnlyTheseUsers' AND \"$groupJoinTable\".\"SiteTreeID\" IS NOT NULL))
1200
						AND \"SiteTree\".\"ID\" IN ($idPlaceholders)"
1201
						=> $ids
1202
					))
1203
					->leftJoin($groupJoinTable, "\"$groupJoinTable\".\"SiteTreeID\" = \"SiteTree\".\"ID\" AND \"$groupJoinTable\".\"GroupID\" IN ($SQL_groupList)");
1204
				
1205
				if($uninheritedPermissions) {
1206
					// Set all the relevant items in $result to true
1207
					$result = array_fill_keys($uninheritedPermissions->column('ID'), true) + $result;
1208
				}
1209
1210
				// Get permissions that are inherited
1211
				$potentiallyInherited = Versioned::get_by_stage(
1212
					"SiteTree",
1213
					$stage,
1214
					array("\"$typeField\" = 'Inherit' AND \"SiteTree\".\"ID\" IN ($idPlaceholders)" => $ids)
0 ignored issues
show
Documentation introduced by
array("\"{$typeField}\" ...laceholders})" => $ids) is of type array<string|integer,array>, 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...
1215
				);
1216
1217
				if($potentiallyInherited) {
1218
					// Group $potentiallyInherited by ParentID; we'll look at the permission of all those parents and
1219
					// then see which ones the user has permission on
1220
					$groupedByParent = array();
1221
					foreach($potentiallyInherited as $item) {
1222
						if($item->ParentID) {
1223
							if(!isset($groupedByParent[$item->ParentID])) $groupedByParent[$item->ParentID] = array();
1224
							$groupedByParent[$item->ParentID][] = $item->ID;
1225
						} else {
1226
							// Might return different site config based on record context, e.g. when subsites module
1227
							// is used
1228
							$siteConfig = $item->getSiteConfig();
1229
							$result[$item->ID] = $siteConfig->{$siteConfigMethod}($memberID);
1230
						}
1231
					}
1232
1233
					if($groupedByParent) {
0 ignored issues
show
Bug Best Practice introduced by
The expression $groupedByParent of type array is implicitly converted to a boolean; are you sure this is intended? If so, consider using ! empty($expr) instead to make it clear that you intend to check for an array without elements.

This check marks implicit conversions of arrays to boolean values in a comparison. While in PHP an empty array is considered to be equal (but not identical) to false, this is not always apparent.

Consider making the comparison explicit by using empty(..) or ! empty(...) instead.

Loading history...
1234
						$actuallyInherited = self::batch_permission_check(array_keys($groupedByParent), $memberID, $typeField, $groupJoinTable, $siteConfigMethod);
1235
						if($actuallyInherited) {
1236
							$parentIDs = array_keys(array_filter($actuallyInherited));
1237
							foreach($parentIDs as $parentID) {
1238
								// Set all the relevant items in $result to true
1239
								$result = array_fill_keys($groupedByParent[$parentID], true) + $result;
1240
							}
1241
						}
1242
					}
1243
				}
1244
				
1245
				$combinedStageResult = $combinedStageResult + $result;
1246
				
1247
			}
1248
		}
1249
1250
		if(isset($combinedStageResult)) {
1251
			// Cache the results
1252
 			if(empty(self::$cache_permissions[$cacheKey])) self::$cache_permissions[$cacheKey] = array();
1253
 			self::$cache_permissions[$cacheKey] = $combinedStageResult + self::$cache_permissions[$cacheKey];
1254
1255
			return $combinedStageResult;
1256
		} else {
1257
			return array();
1258
		}
1259
	}
1260
1261
	/**
1262
	 * Get the 'can edit' information for a number of SiteTree pages.
1263
	 *
1264
	 * @param array $ids       An array of IDs of the SiteTree pages to look up
1265
	 * @param int   $memberID  ID of member
1266
	 * @param bool  $useCached Return values from the permission cache if they exist
1267
	 * @return array A map where the IDs are keys and the values are booleans stating whether the given page can be
1268
	 *                         edited
1269
	 */
1270
	static public function can_edit_multiple($ids, $memberID, $useCached = true) {
1271
		return self::batch_permission_check($ids, $memberID, 'CanEditType', 'SiteTree_EditorGroups', 'canEditPages', null, $useCached);
1272
	}
1273
1274
	/**
1275
	 * Get the 'can edit' information for a number of SiteTree pages.
1276
	 *
1277
	 * @param array $ids       An array of IDs of the SiteTree pages to look up
1278
	 * @param int   $memberID  ID of member
1279
	 * @param bool  $useCached Return values from the permission cache if they exist
1280
	 * @return array
1281
	 */
1282
	static public function can_delete_multiple($ids, $memberID, $useCached = true) {
1283
		$deletable = array();
0 ignored issues
show
Unused Code introduced by
$deletable 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...
1284
		$result = array_fill_keys($ids, false);
1285
		$cacheKey = "delete-$memberID";
1286
		
1287
		// Look in the cache for values
1288
		if($useCached && isset(self::$cache_permissions[$cacheKey])) {
1289
			$cachedValues = array_intersect_key(self::$cache_permissions[$cacheKey], $result);
1290
			
1291
			// If we can't find everything in the cache, then look up the remainder separately
1292
			$uncachedValues = array_diff_key($result, self::$cache_permissions[$cacheKey]);
1293
			if($uncachedValues) {
0 ignored issues
show
Bug Best Practice introduced by
The expression $uncachedValues of type array is implicitly converted to a boolean; are you sure this is intended? If so, consider using ! empty($expr) instead to make it clear that you intend to check for an array without elements.

This check marks implicit conversions of arrays to boolean values in a comparison. While in PHP an empty array is considered to be equal (but not identical) to false, this is not always apparent.

Consider making the comparison explicit by using empty(..) or ! empty(...) instead.

Loading history...
1294
				$cachedValues = self::can_delete_multiple(array_keys($uncachedValues), $memberID, false)
1295
					+ $cachedValues;
1296
			}
1297
			return $cachedValues;
1298
		}
1299
1300
		// You can only delete pages that you can edit
1301
		$editableIDs = array_keys(array_filter(self::can_edit_multiple($ids, $memberID)));
1302
		if($editableIDs) {
0 ignored issues
show
Bug Best Practice introduced by
The expression $editableIDs of type array<integer|string> is implicitly converted to a boolean; are you sure this is intended? If so, consider using ! empty($expr) instead to make it clear that you intend to check for an array without elements.

This check marks implicit conversions of arrays to boolean values in a comparison. While in PHP an empty array is considered to be equal (but not identical) to false, this is not always apparent.

Consider making the comparison explicit by using empty(..) or ! empty(...) instead.

Loading history...
1303
		
1304
			// You can only delete pages whose children you can delete
1305
			$editablePlaceholders = DB::placeholders($editableIDs);
1306
			$childRecords = SiteTree::get()->where(array(
1307
				"\"SiteTree\".\"ParentID\" IN ($editablePlaceholders)" => $editableIDs
1308
			));
1309
			if($childRecords) {
1310
				$children = $childRecords->map("ID", "ParentID");
1311
1312
				// Find out the children that can be deleted
1313
				$deletableChildren = self::can_delete_multiple($children->keys(), $memberID);
1314
				
1315
				// Get a list of all the parents that have no undeletable children
1316
				$deletableParents = array_fill_keys($editableIDs, true);
1317
				foreach($deletableChildren as $id => $canDelete) {
1318
					if(!$canDelete) unset($deletableParents[$children[$id]]);
1319
				}
1320
1321
				// Use that to filter the list of deletable parents that have children
1322
				$deletableParents = array_keys($deletableParents);
1323
1324
				// Also get the $ids that don't have children
1325
				$parents = array_unique($children->values());
1326
				$deletableLeafNodes = array_diff($editableIDs, $parents);
1327
1328
				// Combine the two
1329
				$deletable = array_merge($deletableParents, $deletableLeafNodes);
1330
1331
			} else {
1332
				$deletable = $editableIDs;
1333
			}
1334
		} else {
1335
			$deletable = array();
1336
		}
1337
		
1338
		// Convert the array of deletable IDs into a map of the original IDs with true/false as the value
1339
		return array_fill_keys($deletable, true) + array_fill_keys($ids, false);
1340
	}
1341
1342
	/**
1343
	 * Collate selected descendants of this page.
1344
	 *
1345
	 * {@link $condition} will be evaluated on each descendant, and if it is succeeds, that item will be added to the
1346
	 * $collator array.
1347
	 *
1348
	 * @param string $condition The PHP condition to be evaluated. The page will be called $item
1349
	 * @param array  $collator  An array, passed by reference, to collect all of the matching descendants.
1350
	 * @return bool
1351
	 */
1352
	public function collateDescendants($condition, &$collator) {
1353
		if($children = $this->Children()) {
0 ignored issues
show
Bug introduced by
The method Children() does not exist on SiteTree. Did you maybe mean duplicateWithChildren()?

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...
1354
			foreach($children as $item) {
1355
				if(eval("return $condition;")) $collator[] = $item;
1356
				$item->collateDescendants($condition, $collator);
1357
			}
1358
			return true;
1359
		}
1360
	}
1361
1362
	/**
1363
	 * Return the title, description, keywords and language metatags.
1364
	 *
1365
	 * @todo Move <title> tag in separate getter for easier customization and more obvious usage
1366
	 *
1367
	 * @param bool $includeTitle Show default <title>-tag, set to false for custom templating
1368
	 * @return string The XHTML metatags
1369
	 */
1370
	public function MetaTags($includeTitle = true) {
1371
		$tags = "";
1372
		if($includeTitle === true || $includeTitle == 'true') {
1373
			$tags .= "<title>" . Convert::raw2xml($this->Title) . "</title>\n";
1374
		}
1375
1376
		$generator = trim(Config::inst()->get('SiteTree', 'meta_generator'));
1377
		if (!empty($generator)) {
1378
			$tags .= "<meta name=\"generator\" content=\"" . Convert::raw2att($generator) . "\" />\n";
1379
		}
1380
1381
		$charset = Config::inst()->get('ContentNegotiator', 'encoding');
1382
		$tags .= "<meta http-equiv=\"Content-type\" content=\"text/html; charset=$charset\" />\n";
1383
		if($this->MetaDescription) {
1384
			$tags .= "<meta name=\"description\" content=\"" . Convert::raw2att($this->MetaDescription) . "\" />\n";
1385
		}
1386
		if($this->ExtraMeta) {
1387
			$tags .= $this->ExtraMeta . "\n";
1388
		}
1389
		
1390
		if(Permission::check('CMS_ACCESS_CMSMain')
1391
			&& in_array('CMSPreviewable', class_implements($this))
1392
			&& !$this instanceof ErrorPage
1393
			&& $this->ID > 0
1394
		) {
1395
			$tags .= "<meta name=\"x-page-id\" content=\"{$this->ID}\" />\n";
1396
			$tags .= "<meta name=\"x-cms-edit-link\" content=\"" . $this->CMSEditLink() . "\" />\n";
1397
		}
1398
1399
		$this->extend('MetaTags', $tags);
1400
1401
		return $tags;
1402
	}
1403
1404
	/**
1405
	 * Returns the object that contains the content that a user would associate with this page.
1406
	 *
1407
	 * Ordinarily, this is just the page itself, but for example on RedirectorPages or VirtualPages ContentSource() will
1408
	 * return the page that is linked to.
1409
	 *
1410
	 * @return $this
1411
	 */
1412
	public function ContentSource() {
1413
		return $this;
1414
	}
1415
1416
	/**
1417
	 * Add default records to database.
1418
	 *
1419
	 * This function is called whenever the database is built, after the database tables have all been created. Overload
1420
	 * this to add default records when the database is built, but make sure you call parent::requireDefaultRecords().
1421
	 */
1422
	public function requireDefaultRecords() {
1423
		parent::requireDefaultRecords();
1424
		
1425
		// default pages
1426
		if($this->class == 'SiteTree' && $this->config()->create_default_pages) {
1427
			if(!SiteTree::get_by_link(Config::inst()->get('RootURLController', 'default_homepage_link'))) {
1428
				$homepage = new Page();
1429
				$homepage->Title = _t('SiteTree.DEFAULTHOMETITLE', 'Home');
1430
				$homepage->Content = _t('SiteTree.DEFAULTHOMECONTENT', '<p>Welcome to SilverStripe! This is the default homepage. You can edit this page by opening <a href="admin/">the CMS</a>.</p><p>You can now access the <a href="http://docs.silverstripe.org">developer documentation</a>, or begin the <a href="http://www.silverstripe.org/learn/lessons">SilverStripe lessons</a>.</p>');
1431
				$homepage->URLSegment = Config::inst()->get('RootURLController', 'default_homepage_link');
1432
				$homepage->Sort = 1;
1433
				$homepage->write();
1434
				$homepage->publish('Stage', 'Live');
1435
				$homepage->flushCache();
1436
				DB::alteration_message('Home page created', 'created');
1437
			}
1438
1439
			if(DB::query("SELECT COUNT(*) FROM \"SiteTree\"")->value() == 1) {
1440
				$aboutus = new Page();
1441
				$aboutus->Title = _t('SiteTree.DEFAULTABOUTTITLE', 'About Us');
1442
				$aboutus->Content = _t('SiteTree.DEFAULTABOUTCONTENT', '<p>You can fill this page out with your own content, or delete it and create your own pages.<br /></p>');
1443
				$aboutus->Sort = 2;
1444
				$aboutus->write();
1445
				$aboutus->publish('Stage', 'Live');
1446
				$aboutus->flushCache();
1447
				DB::alteration_message('About Us page created', 'created');
1448
1449
				$contactus = new Page();
1450
				$contactus->Title = _t('SiteTree.DEFAULTCONTACTTITLE', 'Contact Us');
1451
				$contactus->Content = _t('SiteTree.DEFAULTCONTACTCONTENT', '<p>You can fill this page out with your own content, or delete it and create your own pages.<br /></p>');
1452
				$contactus->Sort = 3;
1453
				$contactus->write();
1454
				$contactus->publish('Stage', 'Live');
1455
				$contactus->flushCache();
1456
				DB::alteration_message('Contact Us page created', 'created');
1457
			}
1458
		}
1459
		
1460
		// schema migration
1461
		// @todo Move to migration task once infrastructure is implemented
1462
		if($this->class == 'SiteTree') {
1463
			$conn = DB::get_schema();
1464
			// only execute command if fields haven't been renamed to _obsolete_<fieldname> already by the task
1465
			if($conn->hasField('SiteTree' ,'Viewers')) {
1466
				$task = new UpgradeSiteTreePermissionSchemaTask();
1467
				$task->run(new SS_HTTPRequest('GET','/'));
1468
			}
1469
		}
1470
	}
1471
1472
	protected function onBeforeWrite() {
1473
		parent::onBeforeWrite();
1474
1475
		// If Sort hasn't been set, make this page come after it's siblings
1476
		if(!$this->Sort) {
1477
			$parentID = ($this->ParentID) ? $this->ParentID : 0;
0 ignored issues
show
Documentation introduced by
The property ParentID 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...
1478
			$this->Sort = DB::prepared_query(
1479
				"SELECT MAX(\"Sort\") + 1 FROM \"SiteTree\" WHERE \"ParentID\" = ?",
1480
				array($parentID)
1481
			)->value();
1482
		}
1483
1484
		// If there is no URLSegment set, generate one from Title
1485
		$defaultSegment = $this->generateURLSegment(_t(
1486
			'CMSMain.NEWPAGE',
1487
			array('pagetype' => $this->i18n_singular_name())
0 ignored issues
show
Documentation introduced by
array('pagetype' => $this->i18n_singular_name()) is of type array<string,string,{"pagetype":"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...
1488
		));
1489
		if((!$this->URLSegment || $this->URLSegment == $defaultSegment) && $this->Title) {
1490
			$this->URLSegment = $this->generateURLSegment($this->Title);
1491
		} else if($this->isChanged('URLSegment', 2)) {
1492
			// Do a strict check on change level, to avoid double encoding caused by
1493
			// bogus changes through forceChange()
1494
			$filter = URLSegmentFilter::create();
1495
			$this->URLSegment = $filter->filter($this->URLSegment);
1496
			// If after sanitising there is no URLSegment, give it a reasonable default
1497
			if(!$this->URLSegment) $this->URLSegment = "page-$this->ID";
1498
		}
1499
		
1500
		// Ensure that this object has a non-conflicting URLSegment value.
1501
		$count = 2;
1502
		while(!$this->validURLSegment()) {
1503
			$this->URLSegment = preg_replace('/-[0-9]+$/', null, $this->URLSegment) . '-' . $count;
1504
			$count++;
1505
		}
1506
1507
		$this->syncLinkTracking();
1508
1509
		// Check to see if we've only altered fields that shouldn't affect versioning
1510
		$fieldsIgnoredByVersioning = array('HasBrokenLink', 'Status', 'HasBrokenFile', 'ToDo', 'VersionID', 'SaveCount');
1511
		$changedFields = array_keys($this->getChangedFields(true, 2));
1512
1513
		// This more rigorous check is inline with the test that write() does to dedcide whether or not to write to the
1514
		// DB. We use that to avoid cluttering the system with a migrateVersion() call that doesn't get used
1515
		$oneChangedFields = array_keys($this->getChangedFields(true, 1));
1516
1517
		if($oneChangedFields && !array_diff($changedFields, $fieldsIgnoredByVersioning)) {
0 ignored issues
show
Bug Best Practice introduced by
The expression $oneChangedFields of type array<integer|string> is implicitly converted to a boolean; are you sure this is intended? If so, consider using ! empty($expr) instead to make it clear that you intend to check for an array without elements.

This check marks implicit conversions of arrays to boolean values in a comparison. While in PHP an empty array is considered to be equal (but not identical) to false, this is not always apparent.

Consider making the comparison explicit by using empty(..) or ! empty(...) instead.

Loading history...
1518
			// This will have the affect of preserving the versioning
1519
			$this->migrateVersion($this->Version);
0 ignored issues
show
Bug introduced by
The property Version does not seem to exist. Did you mean versioning?

An attempt at access to an undefined property has been detected. This may either be a typographical error or the property has been renamed but there are still references to its old name.

If you really want to allow access to undefined properties, you can define magic methods to allow access. See the php core documentation on Overloading.

Loading history...
Documentation Bug introduced by
The method migrateVersion 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...
1520
		}
1521
	}
1522
1523
	/**
1524
	 * Trigger synchronisation of link tracking
1525
	 *
1526
	 * {@see SiteTreeLinkTracking::augmentSyncLinkTracking}
1527
	 */
1528
	public function syncLinkTracking() {
1529
		$this->extend('augmentSyncLinkTracking');
1530
	}
1531
	
1532
	public function onAfterWrite() {
1533
		// Need to flush cache to avoid outdated versionnumber references
1534
		$this->flushCache();
1535
		
1536
		$linkedPages = $this->VirtualPages();
1537
		if($linkedPages) {
1538
			// The only way after a write() call to determine if it was triggered by a writeWithoutVersion(),
1539
			// which we have to pass on to the virtual page writes as well.
1540
			$previous = ($this->Version > 1) ? Versioned::get_version($this->class, $this->ID, $this->Version-1) : null;
0 ignored issues
show
Bug introduced by
The property Version does not seem to exist. Did you mean versioning?

An attempt at access to an undefined property has been detected. This may either be a typographical error or the property has been renamed but there are still references to its old name.

If you really want to allow access to undefined properties, you can define magic methods to allow access. See the php core documentation on Overloading.

Loading history...
Unused Code introduced by
$previous 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...
1541
			$withoutVersion = $this->getExtensionInstance('Versioned')->_nextWriteWithoutVersion;
0 ignored issues
show
Bug introduced by
The property _nextWriteWithoutVersion does not seem to exist in Extension.

An attempt at access to an undefined property has been detected. This may either be a typographical error or the property has been renamed but there are still references to its old name.

If you really want to allow access to undefined properties, you can define magic methods to allow access. See the php core documentation on Overloading.

Loading history...
1542
			foreach($linkedPages as $page) {
1543
				 $page->copyFrom($page->CopyContentFrom());
1544
				 if($withoutVersion) $page->writeWithoutVersion();
1545
				 else $page->write();
1546
			}
1547
		}
1548
		
1549
		parent::onAfterWrite();
1550
	}
1551
	
1552
	public function onBeforeDelete() {
1553
		parent::onBeforeDelete();
1554
		
1555
		// If deleting this page, delete all its children.
1556
		if(SiteTree::config()->enforce_strict_hierarchy && $children = $this->AllChildren()) {
0 ignored issues
show
Documentation Bug introduced by
The method AllChildren 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...
1557
			foreach($children as $child) {
1558
				$child->delete();
1559
			}
1560
		}
1561
	}
1562
	
1563
	public function onAfterDelete() {
1564
		// Need to flush cache to avoid outdated versionnumber references
1565
		$this->flushCache();
1566
		
1567
		// Need to mark pages depending to this one as broken
1568
		$dependentPages = $this->DependentPages();
1569
		if($dependentPages) foreach($dependentPages as $page) {
1570
			// $page->write() calls syncLinkTracking, which does all the hard work for us.
1571
			$page->write();
1572
		}
1573
		
1574
		parent::onAfterDelete();
1575
	}
1576
1577
	public function flushCache($persistent = true) {
1578
		parent::flushCache($persistent);
1579
		$this->_cache_statusFlags = null;
1580
	}
1581
	
1582
	public function validate() {
1583
		$result = parent::validate();
1584
1585
		// Allowed children validation
1586
		$parent = $this->getParent();
1587
		if($parent && $parent->exists()) {
1588
			// No need to check for subclasses or instanceof, as allowedChildren() already
1589
			// deconstructs any inheritance trees already.
1590
			$allowed = $parent->allowedChildren();
1591
			$subject = ($this instanceof VirtualPage && $this->CopyContentFromID) ? $this->CopyContentFrom() : $this;
0 ignored issues
show
Bug introduced by
The property CopyContentFromID does not seem to exist. Did you mean Content?

An attempt at access to an undefined property has been detected. This may either be a typographical error or the property has been renamed but there are still references to its old name.

If you really want to allow access to undefined properties, you can define magic methods to allow access. See the php core documentation on Overloading.

Loading history...
Documentation Bug introduced by
The method CopyContentFrom 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...
1592
			if(!in_array($subject->ClassName, $allowed)) {
1593
				
1594
				$result->error(
1595
					_t(
1596
						'SiteTree.PageTypeNotAllowed',
1597
						'Page type "{type}" not allowed as child of this parent page',
1598
						array('type' => $subject->i18n_singular_name())
0 ignored issues
show
Documentation introduced by
array('type' => $subject->i18n_singular_name()) is of type array<string,?,{"type":"?"}>, 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...
1599
					),
1600
					'ALLOWED_CHILDREN'
1601
				);
1602
			}
1603
		}
1604
1605
		// "Can be root" validation
1606 View Code Duplication
		if(!$this->stat('can_be_root') && !$this->ParentID) {
0 ignored issues
show
Documentation introduced by
The property ParentID 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...
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...
1607
			$result->error(
1608
				_t(
1609
					'SiteTree.PageTypNotAllowedOnRoot',
1610
					'Page type "{type}" is not allowed on the root level',
1611
					array('type' => $this->i18n_singular_name())
0 ignored issues
show
Documentation introduced by
array('type' => $this->i18n_singular_name()) is of type array<string,string,{"type":"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...
1612
				),
1613
				'CAN_BE_ROOT'
1614
			);
1615
		}
1616
		
1617
		return $result;
1618
	}
1619
	
1620
	/**
1621
	 * Returns true if this object has a URLSegment value that does not conflict with any other objects. This method
1622
	 * checks for:
1623
	 *  - A page with the same URLSegment that has a conflict
1624
	 *  - Conflicts with actions on the parent page
1625
	 *  - A conflict caused by a root page having the same URLSegment as a class name
1626
	 *
1627
	 * @return bool
1628
	 */
1629
	public function validURLSegment() {
1630
		if(self::config()->nested_urls && $parent = $this->Parent()) {
0 ignored issues
show
Bug introduced by
The method Parent() does not exist on SiteTree. Did you maybe mean setParent()?

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...
1631
			if($controller = ModelAsController::controller_for($parent)) {
1632
				if($controller instanceof Controller && $controller->hasAction($this->URLSegment)) return false;
1633
			}
1634
		}
1635
		
1636
		if(!self::config()->nested_urls || !$this->ParentID) {
0 ignored issues
show
Documentation introduced by
The property ParentID 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...
1637
			if(class_exists($this->URLSegment) && is_subclass_of($this->URLSegment, 'RequestHandler')) return false;
1638
		}
1639
		
1640
		// Filters by url, id, and parent
1641
		$filter = array('"SiteTree"."URLSegment"' => $this->URLSegment);
1642
		if($this->ID) {
1643
			$filter['"SiteTree"."ID" <> ?'] = $this->ID;
1644
		}
1645
		if(self::config()->nested_urls) {
1646
			$filter['"SiteTree"."ParentID"'] = $this->ParentID ? $this->ParentID : 0;
0 ignored issues
show
Documentation introduced by
The property ParentID 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...
1647
		}
1648
		
1649
		$votes = array_filter(
1650
			(array)$this->extend('augmentValidURLSegment'),
1651
			function($v) {return !is_null($v);}
1652
		);
1653
		if($votes) {
0 ignored issues
show
Bug Best Practice introduced by
The expression $votes of type array is implicitly converted to a boolean; are you sure this is intended? If so, consider using ! empty($expr) instead to make it clear that you intend to check for an array without elements.

This check marks implicit conversions of arrays to boolean values in a comparison. While in PHP an empty array is considered to be equal (but not identical) to false, this is not always apparent.

Consider making the comparison explicit by using empty(..) or ! empty(...) instead.

Loading history...
1654
			return min($votes);
1655
		}
1656
1657
		// Check existence
1658
		$existingPage = DataObject::get_one('SiteTree', $filter);
1659
		if ($existingPage) return false;
1660
1661
		return !($existingPage);
1662
		}
1663
		
1664
	/**
1665
	 * Generate a URL segment based on the title provided.
1666
	 *
1667
	 * If {@link Extension}s wish to alter URL segment generation, they can do so by defining
1668
	 * updateURLSegment(&$url, $title).  $url will be passed by reference and should be modified. $title will contain
1669
	 * the title that was originally used as the source of this generated URL. This lets extensions either start from
1670
	 * scratch, or incrementally modify the generated URL.
1671
	 *
1672
	 * @param string $title Page title
1673
	 * @return string Generated url segment
1674
	 */
1675
	public function generateURLSegment($title){
1676
		$filter = URLSegmentFilter::create();
1677
		$t = $filter->filter($title);
1678
		
1679
		// Fallback to generic page name if path is empty (= no valid, convertable characters)
1680
		if(!$t || $t == '-' || $t == '-1') $t = "page-$this->ID";
1681
		
1682
		// Hook for extensions
1683
		$this->extend('updateURLSegment', $t, $title);
1684
		
1685
		return $t;
1686
	}
1687
	
1688
	/**
1689
	 * Gets the URL segment for the latest draft version of this page.
1690
	 *
1691
	 * @return string
1692
	 */
1693
	public function getStageURLSegment() {
1694
		$stageRecord = Versioned::get_one_by_stage('SiteTree', 'Stage', array(
0 ignored issues
show
Documentation introduced by
array('"SiteTree"."ID"' => $this->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...
1695
			'"SiteTree"."ID"' => $this->ID
1696
		));
1697
		return ($stageRecord) ? $stageRecord->URLSegment : null;
1698
	}
1699
	
1700
	/**
1701
	 * Gets the URL segment for the currently published version of this page.
1702
	 *
1703
	 * @return string
1704
	 */
1705
	public function getLiveURLSegment() {
1706
		$liveRecord = Versioned::get_one_by_stage('SiteTree', 'Live', array(
0 ignored issues
show
Documentation introduced by
array('"SiteTree"."ID"' => $this->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...
1707
			'"SiteTree"."ID"' => $this->ID
1708
		));
1709
		return ($liveRecord) ? $liveRecord->URLSegment : null;
1710
	}
1711
	
1712
	/**
1713
	 * Rewrites any linked images on this page without creating a new version record.
1714
	 * Non-image files should be linked via shortcodes
1715
	 * Triggers the onRenameLinkedAsset action on extensions.
1716
	 *
1717
	 * @todo Implement image shortcodes and remove this feature
1718
	 */
1719
	public function rewriteFileLinks() {
1720
		// Skip live stage
1721
		if(\Versioned::current_stage() === \Versioned::get_live_stage()) {
1722
			return;
1723
		}
1724
1725
		// Update the content without actually creating a new version
1726
		foreach($this->db() as $fieldName => $fieldType) {
0 ignored issues
show
Bug introduced by
The expression $this->db() of type array|string|null is not guaranteed to be traversable. How about adding an additional type check?

There are different options of fixing this problem.

  1. If you want to be on the safe side, you can add an additional type-check:

    $collection = json_decode($data, true);
    if ( ! is_array($collection)) {
        throw new \RuntimeException('$collection must be an array.');
    }
    
    foreach ($collection as $item) { /** ... */ }
    
  2. If you are sure that the expression is traversable, you might want to add a doc comment cast to improve IDE auto-completion and static analysis:

    /** @var array $collection */
    $collection = json_decode($data, true);
    
    foreach ($collection as $item) { /** .. */ }
    
  3. Mark the issue as a false-positive: Just hover the remove button, in the top-right corner of this issue for more options.

Loading history...
1727
			// Skip if non HTML or if empty
1728
			if ($fieldType !== 'HTMLText') {
1729
				continue;
1730
			}
1731
			$fieldValue = $this->{$fieldName};
1732
			if(empty($fieldValue)) {
1733
				continue;
1734
			}
1735
1736
			// Regenerate content
1737
			$content = Image::regenerate_html_links($fieldValue);
1738
			if($content === $fieldValue) {
1739
				continue;
1740
			}
1741
1742
			// Write content directly without updating linked assets
1743
			$table = ClassInfo::table_for_object_field($this, $fieldName);
1744
			$query = sprintf('UPDATE "%s" SET "%s" = ? WHERE "ID" = ?', $table, $fieldName);
1745
			DB::prepared_query($query, array($content, $this->ID));
1746
1747
			// Update linked assets
1748
			$this->invokeWithExtensions('onRenameLinkedAsset');
1749
		}
1750
	}
1751
	
1752
	/**
1753
	 * Returns the pages that depend on this page. This includes virtual pages, pages that link to it, etc.
1754
	 *
1755
	 * @param bool $includeVirtuals Set to false to exlcude virtual pages.
1756
	 * @return ArrayList
1757
	 */
1758
	public function DependentPages($includeVirtuals = true) {
1759
		if(class_exists('Subsite')) {
1760
			$origDisableSubsiteFilter = Subsite::$disable_subsite_filter;
1761
			Subsite::disable_subsite_filter(true);
1762
		}
1763
		
1764
		// Content links
1765
		$items = new ArrayList();
1766
1767
		// We merge all into a regular SS_List, because DataList doesn't support merge
1768
		if($contentLinks = $this->BackLinkTracking()) {
0 ignored issues
show
Documentation Bug introduced by
The method BackLinkTracking 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...
1769
			$linkList = new ArrayList();
1770
			foreach($contentLinks as $item) {
1771
				$item->DependentLinkType = 'Content link';
1772
				$linkList->push($item);
1773
			}
1774
			$items->merge($linkList);
1775
		}
1776
		
1777
		// Virtual pages
1778
		if($includeVirtuals) {
1779
			$virtuals = $this->VirtualPages();
1780
			if($virtuals) {
1781
				$virtualList = new ArrayList();
1782
				foreach($virtuals as $item) {
1783
					$item->DependentLinkType = 'Virtual page';
1784
					$virtualList->push($item);
1785
				}
1786
				$items->merge($virtualList);
1787
			}
1788
		}
1789
1790
		// Redirector pages
1791
		$redirectors = RedirectorPage::get()->where(array(
1792
			'"RedirectorPage"."RedirectionType"' => 'Internal',
1793
			'"RedirectorPage"."LinkToID"' => $this->ID
1794
		));
1795
		if($redirectors) {
1796
			$redirectorList = new ArrayList();
1797
			foreach($redirectors as $item) {
1798
				$item->DependentLinkType = 'Redirector page';
1799
				$redirectorList->push($item);
1800
			}
1801
			$items->merge($redirectorList);
1802
		}
1803
1804
		if(class_exists('Subsite')) Subsite::disable_subsite_filter($origDisableSubsiteFilter);
0 ignored issues
show
Bug introduced by
The variable $origDisableSubsiteFilter 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...
1805
		
1806
		return $items;
1807
	}
1808
1809
	/**
1810
	 * Return all virtual pages that link to this page.
1811
	 *
1812
	 * @return DataList
1813
	 */
1814
	public function VirtualPages() {
1815
		
1816
		// Ignore new records
1817
		if(!$this->ID) return null;
1818
		
1819
		// Check subsite virtual pages
1820
		// @todo Refactor out subsite module specific code
1821
		if(class_exists('Subsite')) {
1822
			return Subsite::get_from_all_subsites('VirtualPage', array(
1823
				'"VirtualPage"."CopyContentFromID"' => $this->ID
1824
			));
1825
		}
1826
		
1827
		// Check existing virtualpages
1828
		if(class_exists('VirtualPage')) {
1829
			return VirtualPage::get()->where(array(
1830
				'"VirtualPage"."CopyContentFromID"' => $this->ID
1831
			));
1832
		}
1833
		
1834
		return null;
1835
	}
1836
1837
	/**
1838
	 * Returns a FieldList with which to create the main editing form.
1839
	 *
1840
	 * You can override this in your child classes to add extra fields - first get the parent fields using
1841
	 * parent::getCMSFields(), then use addFieldToTab() on the FieldList.
1842
	 *
1843
	 * See {@link getSettingsFields()} for a different set of fields concerned with configuration aspects on the record,
1844
	 * e.g. access control.
1845
	 *
1846
	 * @return FieldList The fields to be displayed in the CMS
1847
	 */
1848
	public function getCMSFields() {
1849
		require_once("forms/Form.php");
1850
		// Status / message
1851
		// Create a status message for multiple parents
1852
		if($this->ID && is_numeric($this->ID)) {
1853
			$linkedPages = $this->VirtualPages();
1854
1855
			$parentPageLinks = array();
1856
1857
			if($linkedPages->Count() > 0) {
1858
				foreach($linkedPages as $linkedPage) {
1859
					$parentPage = $linkedPage->Parent;
1860
					if($parentPage) {
1861
						if($parentPage->ID) {
1862
							$parentPageLinks[] = "<a class=\"cmsEditlink\" href=\"admin/pages/edit/show/$linkedPage->ID\">{$parentPage->Title}</a>";
1863
						} else {
1864
							$parentPageLinks[] = "<a class=\"cmsEditlink\" href=\"admin/pages/edit/show/$linkedPage->ID\">" .
1865
								_t('SiteTree.TOPLEVEL', 'Site Content (Top Level)') .
1866
								"</a>";
1867
						}
1868
					}
1869
				}
1870
1871
				$lastParent = array_pop($parentPageLinks);
1872
				$parentList = "'$lastParent'";
1873
1874
				if(count($parentPageLinks) > 0) {
1875
					$parentList = "'" . implode("', '", $parentPageLinks) . "' and "
1876
						. $parentList;
1877
				}
1878
1879
				$statusMessage[] = _t(
0 ignored issues
show
Coding Style Comprehensibility introduced by
$statusMessage was never initialized. Although not strictly required by PHP, it is generally a good practice to add $statusMessage = 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...
1880
					'SiteTree.APPEARSVIRTUALPAGES',
1881
					"This content also appears on the virtual pages in the {title} sections.",
1882
					array('title' => $parentList)
0 ignored issues
show
Documentation introduced by
array('title' => $parentList) 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...
1883
				);
1884
			}
1885
		}
1886
1887
		if($this->HasBrokenLink || $this->HasBrokenFile) {
0 ignored issues
show
Documentation introduced by
The property HasBrokenLink 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
The property HasBrokenFile 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...
1888
			$statusMessage[] = _t('SiteTree.HASBROKENLINKS', "This page has broken links.");
0 ignored issues
show
Bug introduced by
The variable $statusMessage 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...
1889
		}
1890
1891
		$dependentNote = '';
1892
		$dependentTable = new LiteralField('DependentNote', '<p></p>');
1893
		
1894
		// Create a table for showing pages linked to this one
1895
		$dependentPages = $this->DependentPages();
1896
		$dependentPagesCount = $dependentPages->Count();
1897
		if($dependentPagesCount) {
1898
			$dependentColumns = array(
1899
				'Title' => $this->fieldLabel('Title'),
1900
				'AbsoluteLink' => _t('SiteTree.DependtPageColumnURL', 'URL'),
1901
				'DependentLinkType' => _t('SiteTree.DependtPageColumnLinkType', 'Link type'),
1902
			);
1903
			if(class_exists('Subsite')) $dependentColumns['Subsite.Title'] = singleton('Subsite')->i18n_singular_name();
1904
			
1905
			$dependentNote = new LiteralField('DependentNote', '<p>' . _t('SiteTree.DEPENDENT_NOTE', 'The following pages depend on this page. This includes virtual pages, redirector pages, and pages with content links.') . '</p>');
1906
			$dependentTable = GridField::create(
1907
				'DependentPages',
1908
				false,
1909
				$dependentPages
1910
			);
1911
			$dependentTable->getConfig()->getComponentByType('GridFieldDataColumns')
0 ignored issues
show
Bug introduced by
It seems like you code against a concrete implementation and not the interface GridFieldComponent as the method setDisplayFields() does only exist in the following implementations of said interface: GridFieldDataColumns.

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...
1912
				->setDisplayFields($dependentColumns)
1913
				->setFieldFormatting(array(
1914
					'Title' => function($value, &$item) {
1915
						return sprintf(
1916
							'<a href="admin/pages/edit/show/%d">%s</a>',
1917
							(int)$item->ID,
1918
							Convert::raw2xml($item->Title)
1919
						);
1920
					},
1921
					'AbsoluteLink' => function($value, &$item) {
0 ignored issues
show
Unused Code introduced by
The parameter $item 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...
1922
						return sprintf(
1923
							'<a href="%s" target="_blank">%s</a>',
1924
							Convert::raw2xml($value),
1925
							Convert::raw2xml($value)
1926
						);
1927
					}
1928
				));
1929
		}
1930
		
1931
		$baseLink = Controller::join_links (
1932
			Director::absoluteBaseURL(),
1933
			(self::config()->nested_urls && $this->ParentID ? $this->Parent()->RelativeLink(true) : null)
0 ignored issues
show
Documentation introduced by
The property ParentID 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...
Bug introduced by
The method Parent() does not exist on SiteTree. Did you maybe mean setParent()?

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...
1934
		);
1935
		
1936
		$urlsegment = SiteTreeURLSegmentField::create("URLSegment", $this->fieldLabel('URLSegment'))
1937
			->setURLPrefix($baseLink)
1938
			->setDefaultURL($this->generateURLSegment(_t(
1939
				'CMSMain.NEWPAGE',
1940
				array('pagetype' => $this->i18n_singular_name())
0 ignored issues
show
Documentation introduced by
array('pagetype' => $this->i18n_singular_name()) is of type array<string,string,{"pagetype":"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...
1941
			)));
1942
		$helpText = (self::config()->nested_urls && count($this->Children())) ? $this->fieldLabel('LinkChangeNote') : '';
0 ignored issues
show
Bug introduced by
The method Children() does not exist on SiteTree. Did you maybe mean duplicateWithChildren()?

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...
1943
		if(!Config::inst()->get('URLSegmentFilter', 'default_allow_multibyte')) {
1944
			$helpText .= $helpText ? '<br />' : '';
1945
			$helpText .= _t('SiteTreeURLSegmentField.HelpChars', ' Special characters are automatically converted or removed.');
1946
		}
1947
		$urlsegment->setHelpText($helpText);
1948
		
1949
		$fields = new FieldList(
1950
			$rootTab = new TabSet("Root",
1951
				$tabMain = new Tab('Main',
1952
					new TextField("Title", $this->fieldLabel('Title')),
1953
					$urlsegment,
1954
					new TextField("MenuTitle", $this->fieldLabel('MenuTitle')),
1955
					$htmlField = new HtmlEditorField("Content", _t('SiteTree.HTMLEDITORTITLE', "Content", 'HTML editor title')),
1956
					ToggleCompositeField::create('Metadata', _t('SiteTree.MetadataToggle', 'Metadata'),
1957
						array(
1958
							$metaFieldDesc = new TextareaField("MetaDescription", $this->fieldLabel('MetaDescription')),
1959
							$metaFieldExtra = new TextareaField("ExtraMeta",$this->fieldLabel('ExtraMeta'))
1960
						)
1961
					)->setHeadingLevel(4)
1962
				),
1963
				$tabDependent = new Tab('Dependent',
1964
					$dependentNote,
1965
					$dependentTable
1966
				)
1967
			)
1968
		);
1969
		$htmlField->addExtraClass('stacked');
1970
		
1971
		// Help text for MetaData on page content editor
1972
		$metaFieldDesc
1973
			->setRightTitle(
1974
				_t(
1975
					'SiteTree.METADESCHELP',
1976
					"Search engines use this content for displaying search results (although it will not influence their ranking)."
1977
				)
1978
			)
1979
			->addExtraClass('help');
1980
		$metaFieldExtra
1981
			->setRightTitle(
1982
				_t(
1983
					'SiteTree.METAEXTRAHELP',
1984
					"HTML tags for additional meta information. For example &lt;meta name=\"customName\" content=\"your custom content here\" /&gt;"
1985
				)
1986
			)
1987
			->addExtraClass('help');
1988
1989
		// Conditional dependent pages tab
1990
		if($dependentPagesCount) $tabDependent->setTitle(_t('SiteTree.TABDEPENDENT', "Dependent pages") . " ($dependentPagesCount)");
1991
		else $fields->removeFieldFromTab('Root', 'Dependent');
1992
		
1993
		$tabMain->setTitle(_t('SiteTree.TABCONTENT', "Main Content"));
1994
1995
		if($this->ObsoleteClassName) {
0 ignored issues
show
Bug introduced by
The property ObsoleteClassName does not seem to exist. Did you mean ClassName?

An attempt at access to an undefined property has been detected. This may either be a typographical error or the property has been renamed but there are still references to its old name.

If you really want to allow access to undefined properties, you can define magic methods to allow access. See the php core documentation on Overloading.

Loading history...
1996
			$obsoleteWarning = _t(
1997
				'SiteTree.OBSOLETECLASS',
1998
				"This page is of obsolete type {type}. Saving will reset its type and you may lose data",
1999
				array('type' => $this->ObsoleteClassName)
0 ignored issues
show
Bug introduced by
The property ObsoleteClassName does not seem to exist. Did you mean ClassName?

An attempt at access to an undefined property has been detected. This may either be a typographical error or the property has been renamed but there are still references to its old name.

If you really want to allow access to undefined properties, you can define magic methods to allow access. See the php core documentation on Overloading.

Loading history...
Documentation introduced by
array('type' => $this->ObsoleteClassName) is of type array<string,?,{"type":"?"}>, 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...
2000
			);
2001
2002
			$fields->addFieldToTab(
2003
				"Root.Main",
2004
				new LiteralField("ObsoleteWarningHeader", "<p class=\"message warning\">$obsoleteWarning</p>"),
2005
				"Title"
2006
			);
2007
		}
2008
2009
		if(file_exists(BASE_PATH . '/install.php')) {
2010
			$fields->addFieldToTab("Root.Main", new LiteralField("InstallWarningHeader",
2011
				"<p class=\"message warning\">" . _t("SiteTree.REMOVE_INSTALL_WARNING",
2012
				"Warning: You should remove install.php from this SilverStripe install for security reasons.")
2013
				. "</p>"), "Title");
2014
		}
2015
2016
		// Backwards compat: Rewrite nested "Content" tabs to toplevel
2017
		$fields->setTabPathRewrites(array(
2018
			'/^Root\.Content\.Main$/' => 'Root.Main',
2019
			'/^Root\.Content\.([^.]+)$/' => 'Root.\\1',
2020
		));
2021
		
2022
		if(self::$runCMSFieldsExtensions) {
2023
			$this->extend('updateCMSFields', $fields);
2024
		}
2025
2026
		return $fields;
2027
	}
2028
	
2029
	
2030
	/**
2031
	 * Returns fields related to configuration aspects on this record, e.g. access control. See {@link getCMSFields()}
2032
	 * for content-related fields.
2033
	 *
2034
	 * @return FieldList
2035
	 */
2036
	public function getSettingsFields() {
2037
		$groupsMap = array();
2038
		foreach(Group::get() as $group) {
2039
			// Listboxfield values are escaped, use ASCII char instead of &raquo;
2040
			$groupsMap[$group->ID] = $group->getBreadcrumbs(' > ');
2041
		}
2042
		asort($groupsMap);
2043
		
2044
		$fields = new FieldList(
2045
			$rootTab = new TabSet("Root",
2046
				$tabBehaviour = new Tab('Settings',
2047
					new DropdownField(
2048
						"ClassName",
2049
						$this->fieldLabel('ClassName'),
2050
						$this->getClassDropdown()
2051
					),
2052
					$parentTypeSelector = new CompositeField(
2053
						new OptionsetField("ParentType", _t("SiteTree.PAGELOCATION", "Page location"), array(
2054
							"root" => _t("SiteTree.PARENTTYPE_ROOT", "Top-level page"),
2055
							"subpage" => _t("SiteTree.PARENTTYPE_SUBPAGE", "Sub-page underneath a parent page"),
2056
						)),
2057
						$parentIDField = new TreeDropdownField("ParentID", $this->fieldLabel('ParentID'), 'SiteTree', 'ID', 'MenuTitle')
2058
					),
2059
					$visibility = new FieldGroup(
2060
						new CheckboxField("ShowInMenus", $this->fieldLabel('ShowInMenus')),
2061
						new CheckboxField("ShowInSearch", $this->fieldLabel('ShowInSearch'))
2062
					),
2063
					$viewersOptionsField = new OptionsetField(
2064
						"CanViewType",
2065
						_t('SiteTree.ACCESSHEADER', "Who can view this page?")
2066
					),
2067
					$viewerGroupsField = ListboxField::create("ViewerGroups", _t('SiteTree.VIEWERGROUPS', "Viewer Groups"))
2068
						->setSource($groupsMap)
2069
						->setAttribute(
2070
							'data-placeholder',
2071
							_t('SiteTree.GroupPlaceholder', 'Click to select group')
2072
						),
2073
					$editorsOptionsField = new OptionsetField(
2074
						"CanEditType",
2075
						_t('SiteTree.EDITHEADER', "Who can edit this page?")
2076
					),
2077
					$editorGroupsField = ListboxField::create("EditorGroups", _t('SiteTree.EDITORGROUPS', "Editor Groups"))
2078
						->setSource($groupsMap)
2079
						->setAttribute(
2080
							'data-placeholder',
2081
							_t('SiteTree.GroupPlaceholder', 'Click to select group')
2082
						)
2083
				)
2084
			)
2085
		);
2086
		
2087
		$visibility->setTitle($this->fieldLabel('Visibility'));
2088
		
2089
2090
		// This filter ensures that the ParentID dropdown selection does not show this node,
2091
		// or its descendents, as this causes vanishing bugs
2092
		$parentIDField->setFilterFunction(create_function('$node', "return \$node->ID != {$this->ID};"));
2093
		$parentTypeSelector->addExtraClass('parentTypeSelector');
2094
		
2095
		$tabBehaviour->setTitle(_t('SiteTree.TABBEHAVIOUR', "Behavior"));
2096
		
2097
		// Make page location fields read-only if the user doesn't have the appropriate permission
2098
		if(!Permission::check("SITETREE_REORGANISE")) {
2099
			$fields->makeFieldReadonly('ParentType');
2100
			if($this->ParentType == 'root') {
0 ignored issues
show
Documentation introduced by
The property ParentType 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...
2101
				$fields->removeByName('ParentID');
2102
			} else {
2103
				$fields->makeFieldReadonly('ParentID');
2104
			}
2105
		}
2106
		
2107
		$viewersOptionsSource = array();
2108
		$viewersOptionsSource["Inherit"] = _t('SiteTree.INHERIT', "Inherit from parent page");
2109
		$viewersOptionsSource["Anyone"] = _t('SiteTree.ACCESSANYONE', "Anyone");
2110
		$viewersOptionsSource["LoggedInUsers"] = _t('SiteTree.ACCESSLOGGEDIN', "Logged-in users");
2111
		$viewersOptionsSource["OnlyTheseUsers"] = _t('SiteTree.ACCESSONLYTHESE', "Only these people (choose from list)");
2112
		$viewersOptionsField->setSource($viewersOptionsSource);
2113
		
2114
		$editorsOptionsSource = array();
2115
		$editorsOptionsSource["Inherit"] = _t('SiteTree.INHERIT', "Inherit from parent page");
2116
		$editorsOptionsSource["LoggedInUsers"] = _t('SiteTree.EDITANYONE', "Anyone who can log-in to the CMS");
2117
		$editorsOptionsSource["OnlyTheseUsers"] = _t('SiteTree.EDITONLYTHESE', "Only these people (choose from list)");
2118
		$editorsOptionsField->setSource($editorsOptionsSource);
2119
2120
		if(!Permission::check('SITETREE_GRANT_ACCESS')) {
2121
			$fields->makeFieldReadonly($viewersOptionsField);
2122
			if($this->CanViewType == 'OnlyTheseUsers') {
2123
				$fields->makeFieldReadonly($viewerGroupsField);
2124
			} else {
2125
				$fields->removeByName('ViewerGroups');
2126
			}
2127
			
2128
			$fields->makeFieldReadonly($editorsOptionsField);
2129
			if($this->CanEditType == 'OnlyTheseUsers') {
2130
				$fields->makeFieldReadonly($editorGroupsField);
2131
			} else {
2132
				$fields->removeByName('EditorGroups');
2133
			}
2134
		}
2135
		
2136
		if(self::$runCMSFieldsExtensions) {
2137
			$this->extend('updateSettingsFields', $fields);
2138
		}
2139
		
2140
		return $fields;
2141
	}
2142
	
2143
	/**
2144
	 * @param bool $includerelations A boolean value to indicate if the labels returned should include relation fields
2145
	 * @return array
2146
	 */
2147
	public function fieldLabels($includerelations = true) {
2148
		$cacheKey = $this->class . '_' . $includerelations;
2149
		if(!isset(self::$_cache_field_labels[$cacheKey])) {
2150
			$labels = parent::fieldLabels($includerelations);
2151
			$labels['Title'] = _t('SiteTree.PAGETITLE', "Page name");
2152
			$labels['MenuTitle'] = _t('SiteTree.MENUTITLE', "Navigation label");
2153
			$labels['MetaDescription'] = _t('SiteTree.METADESC', "Meta Description");
2154
			$labels['ExtraMeta'] = _t('SiteTree.METAEXTRA', "Custom Meta Tags");
2155
			$labels['ClassName'] = _t('SiteTree.PAGETYPE', "Page type", 'Classname of a page object');
2156
			$labels['ParentType'] = _t('SiteTree.PARENTTYPE', "Page location");
2157
			$labels['ParentID'] = _t('SiteTree.PARENTID', "Parent page");
2158
			$labels['ShowInMenus'] =_t('SiteTree.SHOWINMENUS', "Show in menus?");
2159
			$labels['ShowInSearch'] = _t('SiteTree.SHOWINSEARCH', "Show in search?");
2160
			$labels['ProvideComments'] = _t('SiteTree.ALLOWCOMMENTS', "Allow comments on this page?");
2161
			$labels['ViewerGroups'] = _t('SiteTree.VIEWERGROUPS', "Viewer Groups");
2162
			$labels['EditorGroups'] = _t('SiteTree.EDITORGROUPS', "Editor Groups");
2163
			$labels['URLSegment'] = _t('SiteTree.URLSegment', 'URL Segment', 'URL for this page');
2164
			$labels['Content'] = _t('SiteTree.Content', 'Content', 'Main HTML Content for a page');
2165
			$labels['CanViewType'] = _t('SiteTree.Viewers', 'Viewers Groups');
2166
			$labels['CanEditType'] = _t('SiteTree.Editors', 'Editors Groups');
2167
			$labels['Comments'] = _t('SiteTree.Comments', 'Comments');
2168
			$labels['Visibility'] = _t('SiteTree.Visibility', 'Visibility');
2169
			$labels['LinkChangeNote'] = _t (
2170
				'SiteTree.LINKCHANGENOTE', 'Changing this page\'s link will also affect the links of all child pages.'
2171
			);
2172
			
2173
			if($includerelations){
2174
				$labels['Parent'] = _t('SiteTree.has_one_Parent', 'Parent Page', 'The parent page in the site hierarchy');
2175
				$labels['LinkTracking'] = _t('SiteTree.many_many_LinkTracking', 'Link Tracking');
2176
				$labels['ImageTracking'] = _t('SiteTree.many_many_ImageTracking', 'Image Tracking');
2177
				$labels['BackLinkTracking'] = _t('SiteTree.many_many_BackLinkTracking', 'Backlink Tracking');
2178
			}
2179
2180
			self::$_cache_field_labels[$cacheKey] = $labels;
2181
		}
2182
2183
		return self::$_cache_field_labels[$cacheKey];
2184
	}
2185
2186
	/**
2187
	 * Get the actions available in the CMS for this page - eg Save, Publish.
2188
	 *
2189
	 * Frontend scripts and styles know how to handle the following FormFields:
2190
	 * - top-level FormActions appear as standalone buttons
2191
	 * - top-level CompositeField with FormActions within appear as grouped buttons
2192
	 * - TabSet & Tabs appear as a drop ups
2193
	 * - FormActions within the Tab are restyled as links
2194
	 * - major actions can provide alternate states for richer presentation (see ssui.button widget extension)
2195
	 *
2196
	 * @return FieldList The available actions for this page.
2197
	 */
2198
	public function getCMSActions() {
2199
		$existsOnLive = $this->getExistsOnLive();
2200
2201
		// Major actions appear as buttons immediately visible as page actions.
2202
		$majorActions = CompositeField::create()->setName('MajorActions')->setTag('fieldset')->addExtraClass('ss-ui-buttonset');
2203
2204
		// Minor options are hidden behind a drop-up and appear as links (although they are still FormActions).
2205
		$rootTabSet = new TabSet('ActionMenus');
2206
		$moreOptions = new Tab(
2207
			'MoreOptions',
2208
			_t('SiteTree.MoreOptions', 'More options', 'Expands a view for more buttons')
2209
		);
2210
		$rootTabSet->push($moreOptions);
2211
		$rootTabSet->addExtraClass('ss-ui-action-tabset action-menus');
2212
2213
		// Render page information into the "more-options" drop-up, on the top.
2214
		$live = Versioned::get_one_by_stage('SiteTree', 'Live', array(
0 ignored issues
show
Documentation introduced by
array('"SiteTree"."ID"' => $this->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...
2215
			'"SiteTree"."ID"' => $this->ID
2216
		));
2217
		$moreOptions->push(
2218
			new LiteralField('Information',
2219
				$this->customise(array(
2220
					'Live' => $live,
2221
					'ExistsOnLive' => $existsOnLive
2222
				))->renderWith('SiteTree_Information')
2223
			)
2224
		);
2225
2226
		// "readonly"/viewing version that isn't the current version of the record
2227
		$stageOrLiveRecord = Versioned::get_one_by_stage($this->class, Versioned::current_stage(), array(
0 ignored issues
show
Documentation introduced by
array('"SiteTree"."ID"' => $this->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...
2228
			'"SiteTree"."ID"' => $this->ID
2229
		));
2230
		if($stageOrLiveRecord && $stageOrLiveRecord->Version != $this->Version) {
0 ignored issues
show
Bug introduced by
The property Version does not seem to exist. Did you mean versioning?

An attempt at access to an undefined property has been detected. This may either be a typographical error or the property has been renamed but there are still references to its old name.

If you really want to allow access to undefined properties, you can define magic methods to allow access. See the php core documentation on Overloading.

Loading history...
2231
			$moreOptions->push(FormAction::create('email', _t('CMSMain.EMAIL', 'Email')));
2232
			$moreOptions->push(FormAction::create('rollback', _t('CMSMain.ROLLBACK', 'Roll back to this version')));
2233
2234
			$actions = new FieldList(array($majorActions, $rootTabSet));
2235
2236
			// getCMSActions() can be extended with updateCMSActions() on a extension
2237
			$this->extend('updateCMSActions', $actions);
2238
2239
			return $actions;
2240
		}
2241
2242 View Code Duplication
		if($this->isPublished() && $this->canPublish() && !$this->getIsDeletedFromStage() && $this->canUnpublish()) {
0 ignored issues
show
Documentation Bug introduced by
The method isPublished 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...
Documentation Bug introduced by
The method canPublish 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...
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...
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...
2243
			// "unpublish"
2244
			$moreOptions->push(
2245
				FormAction::create('unpublish', _t('SiteTree.BUTTONUNPUBLISH', 'Unpublish'), 'delete')
2246
					->setDescription(_t('SiteTree.BUTTONUNPUBLISHDESC', 'Remove this page from the published site'))
2247
					->addExtraClass('ss-ui-action-destructive')
2248
			);
2249
		}
2250
2251 View Code Duplication
		if($this->stagesDiffer('Stage', 'Live') && !$this->getIsDeletedFromStage()) {
0 ignored issues
show
Documentation Bug introduced by
The method stagesDiffer 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...
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...
2252
			if($this->isPublished() && $this->canEdit())	{
0 ignored issues
show
Documentation Bug introduced by
The method isPublished 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...
2253
				// "rollback"
2254
				$moreOptions->push(
2255
					FormAction::create('rollback', _t('SiteTree.BUTTONCANCELDRAFT', 'Cancel draft changes'), 'delete')
2256
						->setDescription(_t('SiteTree.BUTTONCANCELDRAFTDESC', 'Delete your draft and revert to the currently published page'))
2257
				);
2258
			}
2259
		}
2260
2261
		if($this->canEdit()) {
2262
			if($this->getIsDeletedFromStage()) {
2263
				// The usual major actions are not available, so we provide alternatives here.
2264
				if($existsOnLive) {
2265
					// "restore"
2266
					$majorActions->push(FormAction::create('revert',_t('CMSMain.RESTORE','Restore')));
2267
					if($this->canDelete() && $this->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...
2268
						// "delete from live"
2269
						$majorActions->push(
2270
							FormAction::create('deletefromlive',_t('CMSMain.DELETEFP','Delete'))
2271
								->addExtraClass('ss-ui-action-destructive')
2272
						);
2273
					}
2274
				} else {
2275
					// Determine if we should force a restore to root (where once it was a subpage)
2276
					$restoreToRoot = $this->isParentArchived();
2277
					
2278
					// "restore"
2279
					$title = $restoreToRoot
2280
						? _t('CMSMain.RESTORE_TO_ROOT','Restore draft at top level')
2281
						: _t('CMSMain.RESTORE','Restore draft');
2282
					$description = $restoreToRoot
2283
						? _t('CMSMain.RESTORE_TO_ROOT_DESC','Restore the archived version to draft as a top level page')
2284
						: _t('CMSMain.RESTORE_DESC', 'Restore the archived version to draft');
2285
					$majorActions->push(
2286
						FormAction::create('restore', $title)
2287
							->setDescription($description)
2288
							->setAttribute('data-to-root', $restoreToRoot)
0 ignored issues
show
Documentation introduced by
$restoreToRoot is of type boolean, 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...
2289
							->setAttribute('data-icon', 'decline')
2290
					);
2291
				}
2292
			} else {
2293
				// Detect use of legacy actions
2294
				// {@see CMSMain::enabled_legacy_actions}
2295
				$legacy = CMSMain::config()->enabled_legacy_actions;
2296
				if(in_array('CMSBatchAction_Delete', $legacy)) {
2297
					Deprecation::notice('4.0', 'Delete from Stage is deprecated. Use Archive instead.');
2298
					if($this->canDelete()) {
2299
						// delete
2300
						$moreOptions->push(
2301
							FormAction::create('delete',_t('CMSMain.DELETE','Delete draft'))
2302
								->addExtraClass('delete ss-ui-action-destructive')
2303
						);
2304
					}
2305
				} elseif($this->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...
2306
					// "archive"
2307
					$moreOptions->push(
2308
						FormAction::create('archive',_t('CMSMain.ARCHIVE','Archive'))
2309
							->setDescription(_t(
2310
								'SiteTree.BUTTONARCHIVEDESC',
2311
								'Unpublish and send to archive'
2312
							))
2313
							->addExtraClass('delete ss-ui-action-destructive')
2314
					);
2315
				}
2316
			
2317
				// "save", supports an alternate state that is still clickable, but notifies the user that the action is not needed.
2318
				$majorActions->push(
2319
					FormAction::create('save', _t('SiteTree.BUTTONSAVED', 'Saved'))
2320
						->setAttribute('data-icon', 'accept')
2321
						->setAttribute('data-icon-alternate', 'addpage')
2322
						->setAttribute('data-text-alternate', _t('CMSMain.SAVEDRAFT','Save draft'))
2323
				);
2324
			}
2325
		}
2326
2327
		if($this->canPublish() && !$this->getIsDeletedFromStage()) {
0 ignored issues
show
Documentation Bug introduced by
The method canPublish 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...
2328
			// "publish", as with "save", it supports an alternate state to show when action is needed.
2329
			$majorActions->push(
2330
				$publish = FormAction::create('publish', _t('SiteTree.BUTTONPUBLISHED', 'Published'))
2331
					->setAttribute('data-icon', 'accept')
2332
					->setAttribute('data-icon-alternate', 'disk')
2333
					->setAttribute('data-text-alternate', _t('SiteTree.BUTTONSAVEPUBLISH', 'Save & publish'))
2334
			);
2335
2336
			// Set up the initial state of the button to reflect the state of the underlying SiteTree object.
2337
			if($this->stagesDiffer('Stage', 'Live')) {
0 ignored issues
show
Documentation Bug introduced by
The method stagesDiffer 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...
2338
				$publish->addExtraClass('ss-ui-alternate');
2339
			}
2340
		}
2341
		
2342
		$actions = new FieldList(array($majorActions, $rootTabSet));
2343
		
2344
		// Hook for extensions to add/remove actions.
2345
		$this->extend('updateCMSActions', $actions);
2346
		
2347
		return $actions;
2348
	}
2349
	
2350
	/**
2351
	 * Publish this page.
2352
	 *
2353
	 * @uses SiteTreeExtension->onBeforePublish()
2354
	 * @uses SiteTreeExtension->onAfterPublish()
2355
	 * @return bool True if published
2356
	 */
2357
	public function doPublish() {
2358
		if (!$this->canPublish()) return false;
0 ignored issues
show
Documentation Bug introduced by
The method canPublish 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...
2359
		
2360
		$original = Versioned::get_one_by_stage("SiteTree", "Live", array(
0 ignored issues
show
Documentation introduced by
array('"SiteTree"."ID"' => $this->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...
2361
			'"SiteTree"."ID"' => $this->ID
2362
		));
2363
		if(!$original) $original = new SiteTree();
2364
2365
		// Handle activities undertaken by extensions
2366
		$this->invokeWithExtensions('onBeforePublish', $original);
2367
		//$this->PublishedByID = Member::currentUser()->ID;
2368
		$this->write();
2369
		$this->publish("Stage", "Live");
0 ignored issues
show
Bug introduced by
The method publish() does not exist on SiteTree. Did you maybe mean doPublish()?

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...
2370
2371
		DB::prepared_query('UPDATE "SiteTree_Live"
2372
			SET "Sort" = (SELECT "SiteTree"."Sort" FROM "SiteTree" WHERE "SiteTree_Live"."ID" = "SiteTree"."ID")
2373
			WHERE EXISTS (SELECT "SiteTree"."Sort" FROM "SiteTree" WHERE "SiteTree_Live"."ID" = "SiteTree"."ID") AND "ParentID" = ?',
2374
			array($this->ParentID)
0 ignored issues
show
Documentation introduced by
The property ParentID 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...
2375
		);
2376
			
2377
		// Publish any virtual pages that might need publishing
2378
		$linkedPages = $this->VirtualPages();
2379
		if($linkedPages) foreach($linkedPages as $page) {
2380
			$page->copyFrom($page->CopyContentFrom());
2381
			$page->write();
2382
			if($page->getExistsOnLive()) $page->doPublish();
2383
		}
2384
		
2385
		// Need to update pages linking to this one as no longer broken, on the live site
2386
		$origMode = Versioned::get_reading_mode();
2387
		Versioned::reading_stage('Live');
2388
		foreach($this->DependentPages(false) as $page) {
2389
			// $page->write() calls syncLinkTracking, which does all the hard work for us.
2390
			$page->write();
2391
		}
2392
		Versioned::set_reading_mode($origMode);
2393
		
2394
		// Handle activities undertaken by extensions
2395
		$this->invokeWithExtensions('onAfterPublish', $original);
2396
		
2397
		return true;
2398
	}
2399
	
2400
	/**
2401
	 * Unpublish this page - remove it from the live site
2402
	 *
2403
	 * Overrides {@see Versioned::doUnpublish()}
2404
	 *
2405
	 * @uses SiteTreeExtension->onBeforeUnpublish()
2406
	 * @uses SiteTreeExtension->onAfterUnpublish()
2407
	 */
2408
	public function doUnpublish() {
2409
		if(!$this->canUnpublish()) return false;
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...
2410
		if(!$this->ID) return false;
2411
		
2412
		$this->invokeWithExtensions('onBeforeUnpublish', $this);
2413
		
2414
		$origStage = Versioned::current_stage();
2415
		Versioned::reading_stage('Live');
2416
2417
		// We should only unpublish virtualpages that exist on live
2418
		$virtualPages = $this->VirtualPages();
2419
2420
		// This way our ID won't be unset
2421
		$clone = clone $this;
2422
		$clone->delete();
2423
2424
		// Rewrite backlinks
2425
		$dependentPages = $this->DependentPages(false);
2426
		if($dependentPages) foreach($dependentPages as $page) {
2427
			// $page->write() calls syncLinkTracking, which does all the hard work for us.
2428
			$page->write();
2429
		}
2430
		Versioned::reading_stage($origStage);
2431
2432
		// Unpublish any published virtual pages
2433
		if ($virtualPages) foreach($virtualPages as $vp) $vp->doUnpublish();
2434
2435
		// If we're on the draft site, then we can update the status.
2436
		// Otherwise, these lines will resurrect an inappropriate record
2437
		if(DB::prepared_query("SELECT \"ID\" FROM \"SiteTree\" WHERE \"ID\" = ?", array($this->ID))->value()
2438
			&& Versioned::current_stage() != 'Live') {
2439
			$this->write();
2440
		}
2441
2442
		$this->invokeWithExtensions('onAfterUnpublish', $this);
2443
2444
		return true;
2445
	}
2446
	
2447
	/**
2448
	 * Revert the draft changes: replace the draft content with the content on live
2449
	 */
2450
	public function doRevertToLive() {
2451
		$this->invokeWithExtensions('onBeforeRevertToLive', $this);
2452
2453
		$this->publish("Live", "Stage", false);
0 ignored issues
show
Bug introduced by
The method publish() does not exist on SiteTree. Did you maybe mean doPublish()?

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...
2454
2455
		// Use a clone to get the updates made by $this->publish
2456
		$clone = DataObject::get_by_id("SiteTree", $this->ID);
2457
		$clone->writeWithoutVersion();
2458
2459
		// Need to update pages linking to this one as no longer broken
2460
		foreach($this->DependentPages(false) as $page) {
2461
			// $page->write() calls syncLinkTracking, which does all the hard work for us.
2462
			$page->write();
2463
		}
2464
		
2465
		$this->invokeWithExtensions('onAfterRevertToLive', $this);
2466
		return true;
2467
	}
2468
2469
	/**
2470
	 * Determine if this page references a parent which is archived, and not available in stage
2471
	 *
2472
	 * @return bool True if there is an archived parent
2473
	 */
2474
	protected function isParentArchived() {
2475
		if($parentID = $this->ParentID) {
0 ignored issues
show
Documentation introduced by
The property ParentID does not exist on object<SiteTree>. Since you implemented __set, maybe consider adding a @property annotation.

Since your code implements the magic setter _set, this function will be called for any write 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.");
        }
    }

}

Since the property has write access only, you can use the @property-write 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...
2476
			$parentPage = Versioned::get_latest_version("SiteTree", $parentID);
2477
			if(!$parentPage || $parentPage->IsDeletedFromStage) {
2478
				return true;
2479
			}
2480
		}
2481
		return false;
2482
	}
2483
	
2484
	/**
2485
	 * Restore the content in the active copy of this SiteTree page to the stage site.
2486
	 *
2487
	 * @return self
2488
	 */
2489
	public function doRestoreToStage() {
2490
		$this->invokeWithExtensions('onBeforeRestoreToStage', $this);
2491
2492
		// Ensure that the parent page is restored, otherwise restore to root
2493
		if($this->isParentArchived()) {
2494
			$this->ParentID = 0;
0 ignored issues
show
Documentation introduced by
The property ParentID does not exist on object<SiteTree>. Since you implemented __set, maybe consider adding a @property annotation.

Since your code implements the magic setter _set, this function will be called for any write 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.");
        }
    }

}

Since the property has write access only, you can use the @property-write 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...
2495
		}
2496
		
2497
		// if no record can be found on draft stage (meaning it has been "deleted from draft" before),
2498
		// create an empty record
2499
		if(!DB::prepared_query("SELECT \"ID\" FROM \"SiteTree\" WHERE \"ID\" = ?", array($this->ID))->value()) {
2500
			$conn = DB::get_conn();
2501
			if(method_exists($conn, 'allowPrimaryKeyEditing')) $conn->allowPrimaryKeyEditing('SiteTree', true);
0 ignored issues
show
Bug introduced by
The method allowPrimaryKeyEditing() does not seem to exist on object<SS_Database>.

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...
2502
			DB::prepared_query("INSERT INTO \"SiteTree\" (\"ID\") VALUES (?)", array($this->ID));
2503
			if(method_exists($conn, 'allowPrimaryKeyEditing')) $conn->allowPrimaryKeyEditing('SiteTree', false);
0 ignored issues
show
Bug introduced by
The method allowPrimaryKeyEditing() does not seem to exist on object<SS_Database>.

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...
2504
		}
2505
		
2506
		$oldStage = Versioned::current_stage();
2507
		Versioned::reading_stage('Stage');
2508
		$this->forceChange();
2509
		$this->write();
2510
		
2511
		$result = DataObject::get_by_id($this->class, $this->ID);
2512
2513
		// Need to update pages linking to this one as no longer broken
2514
		foreach($result->DependentPages(false) as $page) {
2515
			// $page->write() calls syncLinkTracking, which does all the hard work for us.
2516
			$page->write();
2517
		}
2518
		
2519
		Versioned::reading_stage($oldStage);
2520
2521
		$this->invokeWithExtensions('onAfterRestoreToStage', $this);
2522
		
2523
		return $result;
2524
	}
2525
2526
	/**
2527
	 * @deprecated
2528
	 */
2529
	public function doDeleteFromLive() {
2530
		Deprecation::notice("4.0", "Use doUnpublish instead");
2531
		return $this->doUnpublish();
2532
	}
2533
2534
	/**
2535
	 * Check if this page is new - that is, if it has yet to have been written to the database.
2536
	 *
2537
	 * @return bool
2538
	 */
2539
	public function isNew() {
2540
		/**
2541
		 * This check was a problem for a self-hosted site, and may indicate a bug in the interpreter on their server,
2542
		 * or a bug here. Changing the condition from empty($this->ID) to !$this->ID && !$this->record['ID'] fixed this.
2543
		 */
2544
		if(empty($this->ID)) return true;
2545
2546
		if(is_numeric($this->ID)) return false;
2547
2548
		return stripos($this->ID, 'new') === 0;
2549
	}
2550
2551
	/**
2552
	 * Get the class dropdown used in the CMS to change the class of a page. This returns the list of options in the
2553
	 * dropdown as a Map from class name to singular name. Filters by {@link SiteTree->canCreate()}, as well as
2554
	 * {@link SiteTree::$needs_permission}.
2555
	 *
2556
	 * @return array
2557
	 */
2558
	protected function getClassDropdown() {
2559
		$classes = self::page_type_classes();
2560
		$currentClass = null;
2561
		$result = array();
0 ignored issues
show
Unused Code introduced by
$result 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...
2562
		
2563
		$result = array();
2564
		foreach($classes as $class) {
2565
			$instance = singleton($class);
2566
2567
			// if the current page type is this the same as the class type always show the page type in the list
2568
			if ($this->ClassName != $instance->ClassName) {
2569
				if($instance instanceof HiddenClass) continue;
2570
				if(!$instance->canCreate(null, array('Parent' => $this->ParentID ? $this->Parent() : null))) continue;
0 ignored issues
show
Documentation introduced by
The property ParentID 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...
Bug introduced by
The method Parent() does not exist on SiteTree. Did you maybe mean setParent()?

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...
2571
			}
2572
			
2573
			if($perms = $instance->stat('need_permission')) {
2574
				if(!$this->can($perms)) continue;
2575
			}
2576
2577
			$pageTypeName = $instance->i18n_singular_name();
2578
2579
			$currentClass = $class;
2580
			$result[$class] = $pageTypeName;
2581
2582
			// If we're in translation mode, the link between the translated pagetype title and the actual classname
2583
			// might not be obvious, so we add it in parantheses. Example: class "RedirectorPage" has the title
2584
			// "Weiterleitung" in German, so it shows up as "Weiterleitung (RedirectorPage)"
2585
			if(i18n::get_lang_from_locale(i18n::get_locale()) != 'en') {
2586
				$result[$class] = $result[$class] .  " ({$class})";
2587
			}
2588
		}
2589
		
2590
		// sort alphabetically, and put current on top
2591
		asort($result);
2592
		if($currentClass) {
2593
			$currentPageTypeName = $result[$currentClass];
2594
			unset($result[$currentClass]);
2595
			$result = array_reverse($result);
2596
			$result[$currentClass] = $currentPageTypeName;
2597
			$result = array_reverse($result);
2598
		}
2599
		
2600
		return $result;
2601
	}
2602
2603
	/**
2604
	 * Returns an array of the class names of classes that are allowed to be children of this class.
2605
	 *
2606
	 * @return string[]
2607
	 */
2608
	public function allowedChildren() {
2609
		$allowedChildren = array();
2610
		$candidates = $this->stat('allowed_children');
2611
		if($candidates && $candidates != "none" && $candidates != "SiteTree_root") {
2612
			foreach($candidates as $candidate) {
0 ignored issues
show
Bug introduced by
The expression $candidates of type array|integer|double|string|boolean is not guaranteed to be traversable. How about adding an additional type check?

There are different options of fixing this problem.

  1. If you want to be on the safe side, you can add an additional type-check:

    $collection = json_decode($data, true);
    if ( ! is_array($collection)) {
        throw new \RuntimeException('$collection must be an array.');
    }
    
    foreach ($collection as $item) { /** ... */ }
    
  2. If you are sure that the expression is traversable, you might want to add a doc comment cast to improve IDE auto-completion and static analysis:

    /** @var array $collection */
    $collection = json_decode($data, true);
    
    foreach ($collection as $item) { /** .. */ }
    
  3. Mark the issue as a false-positive: Just hover the remove button, in the top-right corner of this issue for more options.

Loading history...
2613
				// If a classname is prefixed by "*", such as "*Page", then only that class is allowed - no subclasses.
2614
				// Otherwise, the class and all its subclasses are allowed.
2615
				if(substr($candidate,0,1) == '*') {
2616
					$allowedChildren[] = substr($candidate,1);
2617
				} else {
2618
					$subclasses = ClassInfo::subclassesFor($candidate);
2619
					foreach($subclasses as $subclass) {
0 ignored issues
show
Bug introduced by
The expression $subclasses of type null|array is not guaranteed to be traversable. How about adding an additional type check?

There are different options of fixing this problem.

  1. If you want to be on the safe side, you can add an additional type-check:

    $collection = json_decode($data, true);
    if ( ! is_array($collection)) {
        throw new \RuntimeException('$collection must be an array.');
    }
    
    foreach ($collection as $item) { /** ... */ }
    
  2. If you are sure that the expression is traversable, you might want to add a doc comment cast to improve IDE auto-completion and static analysis:

    /** @var array $collection */
    $collection = json_decode($data, true);
    
    foreach ($collection as $item) { /** .. */ }
    
  3. Mark the issue as a false-positive: Just hover the remove button, in the top-right corner of this issue for more options.

Loading history...
2620
						if($subclass != "SiteTree_root") $allowedChildren[] = $subclass;
2621
					}
2622
				}
2623
			}
2624
		}
2625
		
2626
		return $allowedChildren;
2627
	}
2628
2629
	/**
2630
	 * Returns the class name of the default class for children of this page.
2631
	 *
2632
	 * @return string
2633
	 */
2634
	public function defaultChild() {
2635
		$default = $this->stat('default_child');
2636
		$allowed = $this->allowedChildren();
2637
		if($allowed) {
0 ignored issues
show
Bug Best Practice introduced by
The expression $allowed of type string[] is implicitly converted to a boolean; are you sure this is intended? If so, consider using ! empty($expr) instead to make it clear that you intend to check for an array without elements.

This check marks implicit conversions of arrays to boolean values in a comparison. While in PHP an empty array is considered to be equal (but not identical) to false, this is not always apparent.

Consider making the comparison explicit by using empty(..) or ! empty(...) instead.

Loading history...
2638
			if(!$default || !in_array($default, $allowed))
2639
				$default = reset($allowed);
2640
			return $default;
2641
		}
2642
	}
2643
2644
	/**
2645
	 * Returns the class name of the default class for the parent of this page.
2646
	 *
2647
	 * @return string
2648
	 */
2649
	public function defaultParent() {
2650
		return $this->stat('default_parent');
2651
	}
2652
2653
	/**
2654
	 * Get the title for use in menus for this page. If the MenuTitle field is set it returns that, else it returns the
2655
	 * Title field.
2656
	 *
2657
	 * @return string
2658
	 */
2659
	public function getMenuTitle(){
2660
		if($value = $this->getField("MenuTitle")) {
2661
			return $value;
2662
		} else {
2663
			return $this->getField("Title");
2664
		}
2665
	}
2666
2667
2668
	/**
2669
	 * Set the menu title for this page.
2670
	 *
2671
	 * @param string $value
2672
	 */
2673
	public function setMenuTitle($value) {
2674
		if($value == $this->getField("Title")) {
2675
			$this->setField("MenuTitle", null);
2676
		} else {
2677
			$this->setField("MenuTitle", $value);
2678
		}
2679
	}
2680
	
2681
	/**
2682
	 * A flag provides the user with additional data about the current page status, for example a "removed from draft"
2683
	 * status. Each page can have more than one status flag. Returns a map of a unique key to a (localized) title for
2684
	 * the flag. The unique key can be reused as a CSS class. Use the 'updateStatusFlags' extension point to customize
2685
	 * the flags.
2686
	 *
2687
	 * Example (simple):
2688
	 *   "deletedonlive" => "Deleted"
2689
	 *
2690
	 * Example (with optional title attribute):
2691
	 *   "deletedonlive" => array('text' => "Deleted", 'title' => 'This page has been deleted')
2692
	 *
2693
	 * @param bool $cached Whether to serve the fields from cache; false regenerate them
2694
	 * @return array
2695
	 */
2696
	public function getStatusFlags($cached = true) {
2697
		if(!$this->_cache_statusFlags || !$cached) {
2698
			$flags = array();
2699
			if($this->getIsDeletedFromStage()) {
2700
				if($this->getExistsOnLive()) {
2701
					$flags['removedfromdraft'] = array(
2702
						'text' => _t('SiteTree.REMOVEDFROMDRAFTSHORT', 'Removed from draft'),
2703
						'title' => _t('SiteTree.REMOVEDFROMDRAFTHELP', 'Page is published, but has been deleted from draft'),
2704
					);
2705
				} else {
2706
					$flags['archived'] = array(
2707
						'text' => _t('SiteTree.ARCHIVEDPAGESHORT', 'Archived'),
2708
						'title' => _t('SiteTree.ARCHIVEDPAGEHELP', 'Page is removed from draft and live'),
2709
					);
2710
				}
2711
			} else if($this->getIsAddedToStage()) {
2712
				$flags['addedtodraft'] = array(
2713
					'text' => _t('SiteTree.ADDEDTODRAFTSHORT', 'Draft'),
2714
					'title' => _t('SiteTree.ADDEDTODRAFTHELP', "Page has not been published yet")
2715
				);
2716
			} else if($this->getIsModifiedOnStage()) {
2717
				$flags['modified'] = array(
2718
					'text' => _t('SiteTree.MODIFIEDONDRAFTSHORT', 'Modified'),
2719
					'title' => _t('SiteTree.MODIFIEDONDRAFTHELP', 'Page has unpublished changes'),
2720
				);
2721
			}
2722
2723
			$this->extend('updateStatusFlags', $flags);
2724
2725
			$this->_cache_statusFlags = $flags;
2726
		}
2727
		
2728
		return $this->_cache_statusFlags;
2729
	}
2730
2731
	/**
2732
	 * getTreeTitle will return three <span> html DOM elements, an empty <span> with the class 'jstree-pageicon' in
2733
	 * front, following by a <span> wrapping around its MenutTitle, then following by a <span> indicating its
2734
	 * publication status.
2735
	 *
2736
	 * @return string An HTML string ready to be directly used in a template
2737
	 */
2738
	public function getTreeTitle() {
2739
		// Build the list of candidate children
2740
		$children = array();
2741
		$candidates = static::page_type_classes();
2742
		foreach($this->allowedChildren() as $childClass) {
2743
			if(!in_array($childClass, $candidates)) continue;
2744
			$child = singleton($childClass);
2745
			if($child->canCreate(null, array('Parent' => $this))) {
2746
				$children[$childClass] = $child->i18n_singular_name();
2747
			}
2748
		}
2749
		$flags = $this->getStatusFlags();
2750
		$treeTitle = sprintf(
2751
			"<span class=\"jstree-pageicon\"></span><span class=\"item\" data-allowedchildren=\"%s\">%s</span>",
2752
			Convert::raw2att(Convert::raw2json($children)),
2753
			Convert::raw2xml(str_replace(array("\n","\r"),"",$this->MenuTitle))
2754
		);
2755
		foreach($flags as $class => $data) {
2756
			if(is_string($data)) $data = array('text' => $data);
2757
			$treeTitle .= sprintf(
2758
				"<span class=\"badge %s\"%s>%s</span>",
2759
				'status-' . Convert::raw2xml($class),
2760
				(isset($data['title'])) ? sprintf(' title="%s"', Convert::raw2xml($data['title'])) : '',
2761
				Convert::raw2xml($data['text'])
2762
			);
2763
		}
2764
		
2765
		return $treeTitle;
2766
	}
2767
2768
	/**
2769
	 * Returns the page in the current page stack of the given level. Level(1) will return the main menu item that
2770
	 * we're currently inside, etc.
2771
	 *
2772
	 * @param int $level
2773
	 * @return SiteTree
2774
	 */
2775
	public function Level($level) {
2776
		$parent = $this;
2777
		$stack = array($parent);
2778
		while($parent = $parent->Parent) {
2779
			array_unshift($stack, $parent);
2780
		}
2781
2782
		return isset($stack[$level-1]) ? $stack[$level-1] : null;
2783
	}
2784
2785
	/**
2786
	 * Gets the depth of this page in the sitetree, where 1 is the root level
2787
	 *
2788
	 * @return int
2789
	 */
2790
	public function getPageLevel() {
2791
		if($this->ParentID) {
0 ignored issues
show
Documentation introduced by
The property ParentID 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...
2792
			return 1 + $this->Parent()->getPageLevel();
0 ignored issues
show
Bug introduced by
The method Parent() does not exist on SiteTree. Did you maybe mean setParent()?

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...
2793
		}
2794
		return 1;
2795
	}
2796
2797
	/**
2798
	 * Return the CSS classes to apply to this node in the CMS tree.
2799
	 *
2800
	 * @param string $numChildrenMethod
2801
	 * @return string
2802
	 */
2803
	public function CMSTreeClasses($numChildrenMethod="numChildren") {
2804
		$classes = sprintf('class-%s', $this->class);
2805
		if($this->HasBrokenFile || $this->HasBrokenLink) {
0 ignored issues
show
Documentation introduced by
The property HasBrokenFile 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
The property HasBrokenLink 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...
2806
			$classes .= " BrokenLink";
2807
		}
2808
2809
		if(!$this->canAddChildren()) {
2810
			$classes .= " nochildren";
2811
		}
2812
2813
		if(!$this->canEdit() && !$this->canAddChildren()) {
2814
			if (!$this->canView()) {
2815
				$classes .= " disabled";
2816
			} else {
2817
				$classes .= " edit-disabled";
2818
			}
2819
		}
2820
2821
		if(!$this->ShowInMenus) {
2822
			$classes .= " notinmenu";
2823
		}
2824
			
2825
		//TODO: Add integration
2826
		/*
2827
		if($this->hasExtension('Translatable') && $controller->Locale != Translatable::default_locale() && !$this->isTranslation())
2828
			$classes .= " untranslated ";
2829
		*/
2830
		$classes .= $this->markingClasses($numChildrenMethod);
0 ignored issues
show
Documentation Bug introduced by
The method markingClasses 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...
2831
2832
		return $classes;
2833
	}
2834
2835
	/**
2836
	 * Compares current draft with live version, and returns true if no draft version of this page exists  but the page
2837
	 * is still published (eg, after triggering "Delete from draft site" in the CMS).
2838
	 *
2839
	 * @return bool
2840
	 */
2841
	public function getIsDeletedFromStage() {
2842
		if(!$this->ID) return true;
2843
		if($this->isNew()) return false;
2844
2845
		$stageVersion = Versioned::get_versionnumber_by_stage('SiteTree', 'Stage', $this->ID);
2846
2847
		// Return true for both completely deleted pages and for pages just deleted from stage
2848
		return !($stageVersion);
2849
	}
2850
	
2851
	/**
2852
	 * Return true if this page exists on the live site
2853
	 *
2854
	 * @return bool
2855
	 */
2856
	public function getExistsOnLive() {
2857
		return (bool)Versioned::get_versionnumber_by_stage('SiteTree', 'Live', $this->ID);
2858
	}
2859
2860
	/**
2861
	 * Compares current draft with live version, and returns true if these versions differ, meaning there have been
2862
	 * unpublished changes to the draft site.
2863
	 *
2864
	 * @return bool
2865
	 */
2866
	public function getIsModifiedOnStage() {
2867
		// New unsaved pages could be never be published
2868
		if($this->isNew()) return false;
2869
		
2870
		$stageVersion = Versioned::get_versionnumber_by_stage('SiteTree', 'Stage', $this->ID);
2871
		$liveVersion =	Versioned::get_versionnumber_by_stage('SiteTree', 'Live', $this->ID);
2872
		
2873
		$isModified = ($stageVersion && $stageVersion != $liveVersion);
2874
		$this->extend('getIsModifiedOnStage', $isModified);
2875
		
2876
		return $isModified;
2877
	}
2878
	
2879
	/**
2880
	 * Compares current draft with live version, and returns true if no live version exists, meaning the page was never
2881
	 * published.
2882
	 *
2883
	 * @return bool
2884
	 */
2885
	public function getIsAddedToStage() {
2886
		// New unsaved pages could be never be published
2887
		if($this->isNew()) return false;
2888
		
2889
		$stageVersion = Versioned::get_versionnumber_by_stage('SiteTree', 'Stage', $this->ID);
2890
		$liveVersion =	Versioned::get_versionnumber_by_stage('SiteTree', 'Live', $this->ID);
2891
2892
		return ($stageVersion && !$liveVersion);
2893
	}
2894
	
2895
	/**
2896
	 * Stops extendCMSFields() being called on getCMSFields(). This is useful when you need access to fields added by
2897
	 * subclasses of SiteTree in a extension. Call before calling parent::getCMSFields(), and reenable afterwards.
2898
	 */
2899
	static public function disableCMSFieldsExtensions() {
2900
		self::$runCMSFieldsExtensions = false;
2901
	}
2902
	
2903
	/**
2904
	 * Reenables extendCMSFields() being called on getCMSFields() after it has been disabled by
2905
	 * disableCMSFieldsExtensions().
2906
	 */
2907
	static public function enableCMSFieldsExtensions() {
2908
		self::$runCMSFieldsExtensions = true;
2909
	}
2910
2911
	public function providePermissions() {
2912
		return array(
2913
			'SITETREE_GRANT_ACCESS' => array(
2914
				'name' => _t('SiteTree.PERMISSION_GRANTACCESS_DESCRIPTION', 'Manage access rights for content'),
2915
				'help' => _t('SiteTree.PERMISSION_GRANTACCESS_HELP',  'Allow setting of page-specific access restrictions in the "Pages" section.'),
2916
				'category' => _t('Permissions.PERMISSIONS_CATEGORY', 'Roles and access permissions'),
2917
				'sort' => 100
2918
			),
2919
			'SITETREE_VIEW_ALL' => array(
2920
				'name' => _t('SiteTree.VIEW_ALL_DESCRIPTION', 'View any page'),
2921
				'category' => _t('Permissions.CONTENT_CATEGORY', 'Content permissions'),
2922
				'sort' => -100,
2923
				'help' => _t('SiteTree.VIEW_ALL_HELP', 'Ability to view any page on the site, regardless of the settings on the Access tab.  Requires the "Access to \'Pages\' section" permission')
2924
			),
2925
			'SITETREE_EDIT_ALL' => array(
2926
				'name' => _t('SiteTree.EDIT_ALL_DESCRIPTION', 'Edit any page'),
2927
				'category' => _t('Permissions.CONTENT_CATEGORY', 'Content permissions'),
2928
				'sort' => -50,
2929
				'help' => _t('SiteTree.EDIT_ALL_HELP', 'Ability to edit any page on the site, regardless of the settings on the Access tab.  Requires the "Access to \'Pages\' section" permission')
2930
			),
2931
			'SITETREE_REORGANISE' => array(
2932
				'name' => _t('SiteTree.REORGANISE_DESCRIPTION', 'Change site structure'),
2933
				'category' => _t('Permissions.CONTENT_CATEGORY', 'Content permissions'),
2934
				'help' => _t('SiteTree.REORGANISE_HELP', 'Rearrange pages in the site tree through drag&drop.'),
2935
				'sort' => 100
2936
			),
2937
			'VIEW_DRAFT_CONTENT' => array(
2938
				'name' => _t('SiteTree.VIEW_DRAFT_CONTENT', 'View draft content'),
2939
				'category' => _t('Permissions.CONTENT_CATEGORY', 'Content permissions'),
2940
				'help' => _t('SiteTree.VIEW_DRAFT_CONTENT_HELP', 'Applies to viewing pages outside of the CMS in draft mode. Useful for external collaborators without CMS access.'),
2941
				'sort' => 100
2942
			)
2943
		);
2944
	}
2945
	
2946
	/**
2947
	 * Return the translated Singular name.
2948
	 *
2949
	 * @return string
2950
	 */
2951
	public function i18n_singular_name() {
2952
		// Convert 'Page' to 'SiteTree' for correct localization lookups
2953
		$class = ($this->class == 'Page') ? 'SiteTree' : $this->class;
2954
		return _t($class.'.SINGULARNAME', $this->singular_name());
2955
	}
2956
	
2957
	/**
2958
	 * Overloaded to also provide entities for 'Page' class which is usually located in custom code, hence textcollector
2959
	 * picks it up for the wrong folder.
2960
	 *
2961
	 * @return array
2962
	 */
2963
	public function provideI18nEntities() {
2964
		$entities = parent::provideI18nEntities();
2965
		
2966
		if(isset($entities['Page.SINGULARNAME'])) $entities['Page.SINGULARNAME'][3] = CMS_DIR;
2967
		if(isset($entities['Page.PLURALNAME'])) $entities['Page.PLURALNAME'][3] = CMS_DIR;		
2968
2969
		$entities[$this->class . '.DESCRIPTION'] = array(
2970
			$this->stat('description'),
2971
			'Description of the page type (shown in the "add page" dialog)'
2972
		);
2973
2974
		$entities['SiteTree.SINGULARNAME'][0] = 'Page';
2975
		$entities['SiteTree.PLURALNAME'][0] = 'Pages';
2976
2977
		return $entities;
0 ignored issues
show
Best Practice introduced by
The expression return $entities; seems to be an array, but some of its elements' types (null) are incompatible with the return type of the parent method DataObject::provideI18nEntities of type array<*,array<array|inte...double|string|boolean>>.

If you return a value from a function or method, it should be a sub-type of the type that is given by the parent type f.e. an interface, or abstract method. This is more formally defined by the Lizkov substitution principle, and guarantees that classes that depend on the parent type can use any instance of a child type interchangably. This principle also belongs to the SOLID principles for object oriented design.

Let’s take a look at an example:

class Author {
    private $name;

    public function __construct($name) {
        $this->name = $name;
    }

    public function getName() {
        return $this->name;
    }
}

abstract class Post {
    public function getAuthor() {
        return new Author('Johannes');
    }
}

class BlogPost extends Post {
    public function getAuthor() {
        return 'Johannes';
    }
}

class ForumPost extends Post { /* ... */ }

function my_function(Post $post) {
    echo strtoupper($post->getAuthor());
}

Our function my_function expects a Post object, and outputs the author of the post. The base class Post returns a simple string and outputting a simple string will work just fine. However, the child class BlogPost which is a sub-type of Post instead decided to return an object, and is therefore violating the SOLID principles. If a BlogPost were passed to my_function, PHP would not complain, but ultimately fail when executing the strtoupper call in its body.

Loading history...
2978
	}
2979
2980
	/**
2981
	 * Returns 'root' if the current page has no parent, or 'subpage' otherwise
2982
	 *
2983
	 * @return string
2984
	 */
2985
	public function getParentType() {
2986
		return $this->ParentID == 0 ? 'root' : 'subpage';
0 ignored issues
show
Documentation introduced by
The property ParentID 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...
2987
	}
2988
2989
	/**
2990
	 * Clear the permissions cache for SiteTree
2991
	 */
2992
	public static function reset() {
2993
		self::$cache_permissions = array();
2994
	}
2995
	
2996
	static public function on_db_reset() {
2997
		self::$cache_permissions = array();
2998
	}
2999
3000
}
3001