Completed
Push — master ( 092c89...478cc5 )
by Daniel
9s
created

SiteTree::getSettingsFields()   C

Complexity

Conditions 8
Paths 60

Size

Total Lines 106
Code Lines 71

Duplication

Lines 0
Ratio 0 %

Importance

Changes 1
Bugs 0 Features 0
Metric Value
c 1
b 0
f 0
dl 0
loc 106
rs 5.2676
cc 8
eloc 71
nc 60
nop 0

How to fix   Long Method   

Long Method

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

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

Commonly applied refactorings include:

1
<?php
2
/**
3
 * 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 $has_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...
136
		"VirtualPages" => "VirtualPage.CopyContentFrom"
137
	);
138
139
	private static $owned_by = array(
140
		"VirtualPages"
141
	);
142
143
	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...
144
		"Breadcrumbs" => "HTMLText",
145
		"LastEdited" => "SS_Datetime",
146
		"Created" => "SS_Datetime",
147
		'Link' => 'Text',
148
		'RelativeLink' => 'Text',
149
		'AbsoluteLink' => 'Text',
150
		'TreeTitle' => 'HTMLText',
151
	);
152
153
	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...
154
		"ShowInMenus" => 1,
155
		"ShowInSearch" => 1,
156
		"CanViewType" => "Inherit",
157
		"CanEditType" => "Inherit"
158
	);
159
160
	private static $versioning = array(
161
		"Stage",  "Live"
162
	);
163
164
	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...
165
166
	/**
167
	 * If this is false, the class cannot be created in the CMS by regular content authors, only by ADMINs.
168
	 * @var boolean
169
	 * @config
170
	 */
171
	private static $can_create = true;
172
173
	/**
174
	 * Icon to use in the CMS page tree. This should be the full filename, relative to the webroot.
175
	 * Also supports custom CSS rule contents (applied to the correct selector for the tree UI implementation).
176
	 *
177
	 * @see CMSMain::generateTreeStylingCSS()
178
	 * @config
179
	 * @var string
180
	 */
181
	private static $icon = null;
182
183
	/**
184
	 * @config
185
	 * @var string Description of the class functionality, typically shown to a user
186
	 * when selecting which page type to create. Translated through {@link provideI18nEntities()}.
187
	 */
188
	private static $description = 'Generic content page';
189
190
	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...
191
		"Hierarchy",
192
		"Versioned",
193
		"SiteTreeLinkTracking"
194
	);
195
196
	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...
197
		'Title',
198
		'Content',
199
	);
200
201
	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...
202
		'URLSegment' => 'URL'
203
	);
204
205
	/**
206
	 * @config
207
	 */
208
	private static $nested_urls = true;
209
210
	/**
211
	 * @config
212
	*/
213
	private static $create_default_pages = true;
214
215
	/**
216
	 * This controls whether of not extendCMSFields() is called by getCMSFields.
217
	 */
218
	private static $runCMSFieldsExtensions = true;
219
220
	/**
221
	 * Cache for canView/Edit/Publish/Delete permissions.
222
	 * Keyed by permission type (e.g. 'edit'), with an array
223
	 * of IDs mapped to their boolean permission ability (true=allow, false=deny).
224
	 * See {@link batch_permission_check()} for details.
225
	 */
226
	private static $cache_permissions = array();
227
228
	/**
229
	 * @config
230
	 * @var boolean
231
	 */
232
	private static $enforce_strict_hierarchy = true;
233
234
	/**
235
	 * The value used for the meta generator tag. Leave blank to omit the tag.
236
	 *
237
	 * @config
238
	 * @var string
239
	 */
240
	private static $meta_generator = 'SilverStripe - http://silverstripe.org';
241
242
	protected $_cache_statusFlags = null;
243
244
	/**
245
	 * Fetches the {@link SiteTree} object that maps to a link.
246
	 *
247
	 * If you have enabled {@link SiteTree::config()->nested_urls} on this site, then you can use a nested link such as
248
	 * "about-us/staff/", and this function will traverse down the URL chain and grab the appropriate link.
249
	 *
250
	 * Note that if no model can be found, this method will fall over to a extended alternateGetByLink method provided
251
	 * by a extension attached to {@link SiteTree}
252
	 *
253
	 * @param string $link  The link of the page to search for
254
	 * @param bool   $cache True (default) to use caching, false to force a fresh search from the database
255
	 * @return SiteTree
256
	 */
257
	static public function get_by_link($link, $cache = true) {
258
		if(trim($link, '/')) {
259
			$link = trim(Director::makeRelative($link), '/');
260
		} else {
261
			$link = RootURLController::get_homepage_link();
262
		}
263
264
		$parts = preg_split('|/+|', $link);
265
266
		// Grab the initial root level page to traverse down from.
267
		$URLSegment = array_shift($parts);
268
		$conditions = array('"SiteTree"."URLSegment"' => rawurlencode($URLSegment));
269
		if(self::config()->nested_urls) {
270
			$conditions[] = array('"SiteTree"."ParentID"' => 0);
271
		}
272
		$sitetree = DataObject::get_one('SiteTree', $conditions, $cache);
273
274
		/// Fall back on a unique URLSegment for b/c.
275
		if(	!$sitetree
276
			&& self::config()->nested_urls
277
			&& $page = DataObject::get_one('SiteTree', array(
278
				'"SiteTree"."URLSegment"' => $URLSegment
279
			), $cache)
280
		) {
281
			return $page;
282
		}
283
284
		// Attempt to grab an alternative page from extensions.
285
		if(!$sitetree) {
286
			$parentID = self::config()->nested_urls ? 0 : null;
287
288 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...
289
				foreach($alternatives as $alternative) if($alternative) $sitetree = $alternative;
290
			}
291
292
			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...
293
		}
294
295
		// Check if we have any more URL parts to parse.
296
		if(!self::config()->nested_urls || !count($parts)) return $sitetree;
297
298
		// Traverse down the remaining URL segments and grab the relevant SiteTree objects.
299
		foreach($parts as $segment) {
300
			$next = DataObject::get_one('SiteTree', array(
301
					'"SiteTree"."URLSegment"' => $segment,
302
					'"SiteTree"."ParentID"' => $sitetree->ID
303
				),
304
				$cache
305
			);
306
307
			if(!$next) {
308
				$parentID = (int) $sitetree->ID;
309
310 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...
311
					foreach($alternatives as $alternative) if($alternative) $next = $alternative;
312
				}
313
314
				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...
315
			}
316
317
			$sitetree->destroy();
318
			$sitetree = $next;
319
		}
320
321
		return $sitetree;
322
	}
323
324
	/**
325
	 * Return a subclass map of SiteTree that shouldn't be hidden through {@link SiteTree::$hide_ancestor}
326
	 *
327
	 * @return array
328
	 */
329
	public static function page_type_classes() {
330
		$classes = ClassInfo::getValidSubClasses();
331
332
		$baseClassIndex = array_search('SiteTree', $classes);
333
		if($baseClassIndex !== FALSE) unset($classes[$baseClassIndex]);
334
335
		$kill_ancestors = array();
336
337
		// figure out if there are any classes we don't want to appear
338
		foreach($classes as $class) {
339
			$instance = singleton($class);
340
341
			// do any of the progeny want to hide an ancestor?
342
			if($ancestor_to_hide = $instance->stat('hide_ancestor')) {
343
				// note for killing later
344
				$kill_ancestors[] = $ancestor_to_hide;
345
			}
346
		}
347
348
		// If any of the descendents don't want any of the elders to show up, cruelly render the elders surplus to
349
		// requirements
350
		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...
351
			$kill_ancestors = array_unique($kill_ancestors);
352
			foreach($kill_ancestors as $mark) {
353
				// unset from $classes
354
				$idx = array_search($mark, $classes, true);
355
				if ($idx !== false) {
356
					unset($classes[$idx]);
357
				}
358
			}
359
		}
360
361
		return $classes;
362
	}
363
364
	/**
365
	 * Replace a "[sitetree_link id=n]" shortcode with a link to the page with the corresponding ID.
366
	 *
367
	 * @param array      $arguments
368
	 * @param string     $content
369
	 * @param TextParser $parser
370
	 * @return string
371
	 */
372
	static public function link_shortcode_handler($arguments, $content = null, $parser = null) {
373
		if(!isset($arguments['id']) || !is_numeric($arguments['id'])) return;
374
375
		if (
376
			   !($page = DataObject::get_by_id('SiteTree', $arguments['id']))         // Get the current page by ID.
377
			&& !($page = Versioned::get_latest_version('SiteTree', $arguments['id'])) // Attempt link to old version.
378
		) {
379
			 return null; // There were no suitable matches at all.
380
		}
381
382
		$link = Convert::raw2att($page->Link());
383
384
		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...
385
			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...
386
		} else {
387
			return $link;
388
		}
389
	}
390
391
	/**
392
	 * Return the link for this {@link SiteTree} object, with the {@link Director::baseURL()} included.
393
	 *
394
	 * @param string $action Optional controller action (method).
395
	 *                       Note: URI encoding of this parameter is applied automatically through template casting,
396
	 *                       don't encode the passed parameter. Please use {@link Controller::join_links()} instead to
397
	 *                       append GET parameters.
398
	 * @return string
399
	 */
400
	public function Link($action = null) {
401
		return Controller::join_links(Director::baseURL(), $this->RelativeLink($action));
402
	}
403
404
	/**
405
	 * Get the absolute URL for this page, including protocol and host.
406
	 *
407
	 * @param string $action See {@link Link()}
408
	 * @return string
409
	 */
410
	public function AbsoluteLink($action = null) {
411
		if($this->hasMethod('alternateAbsoluteLink')) {
412
			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...
413
		} else {
414
			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 414 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...
415
		}
416
	}
417
418
	/**
419
	 * Base link used for previewing. Defaults to absolute URL, in order to account for domain changes, e.g. on multi
420
	 * site setups. Does not contain hints about the stage, see {@link SilverStripeNavigator} for details.
421
	 *
422
	 * @param string $action See {@link Link()}
423
	 * @return string
424
	 */
425
	public function PreviewLink($action = null) {
426
		if($this->hasMethod('alternatePreviewLink')) {
427
			Deprecation::notice('5.0', 'Use updatePreviewLink or override PreviewLink method');
428
			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...
429
		}
430
431
		$link = $this->AbsoluteLink($action);
432
		$this->extend('updatePreviewLink', $link, $action);
433
		return $link;
434
	}
435
436
	public function getMimeType() {
437
		return 'text/html';
438
	}
439
440
	/**
441
	 * Return the link for this {@link SiteTree} object relative to the SilverStripe root.
442
	 *
443
	 * By default, if this page is the current home page, and there is no action specified then this will return a link
444
	 * to the root of the site. However, if you set the $action parameter to TRUE then the link will not be rewritten
445
	 * and returned in its full form.
446
	 *
447
	 * @uses RootURLController::get_homepage_link()
448
	 *
449
	 * @param string $action See {@link Link()}
450
	 * @return string
451
	 */
452
	public function RelativeLink($action = null) {
453
		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...
454
			$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...
455
			// If page is removed select parent from version history (for archive page view)
456
			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...
457
				$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...
458
			}
459
			$base = $parent->RelativeLink($this->URLSegment);
460
		} 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...
461
			// Unset base for root-level homepages.
462
			// Note: Homepages with action parameters (or $action === true)
463
			// need to retain their URLSegment.
464
			$base = null;
465
		} else {
466
			$base = $this->URLSegment;
467
		}
468
469
		$this->extend('updateRelativeLink', $base, $action);
470
471
		// Legacy support: If $action === true, retain URLSegment for homepages,
472
		// but don't append any action
473
		if($action === true) $action = null;
474
475
		return Controller::join_links($base, '/', $action);
476
	}
477
478
	/**
479
	 * Get the absolute URL for this page on the Live site.
480
	 *
481
	 * @param bool $includeStageEqualsLive Whether to append the URL with ?stage=Live to force Live mode
482
	 * @return string
483
	 */
484
	public function getAbsoluteLiveLink($includeStageEqualsLive = true) {
485
		$oldStage = Versioned::get_stage();
486
		Versioned::set_stage(Versioned::LIVE);
487
		$live = Versioned::get_one_by_stage('SiteTree', Versioned::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...
488
			'"SiteTree"."ID"' => $this->ID
489
		));
490
		if($live) {
491
			$link = $live->AbsoluteLink();
492
			if($includeStageEqualsLive) $link .= '?stage=Live';
493
		} else {
494
			$link = null;
495
		}
496
497
		Versioned::set_stage($oldStage);
498
		return $link;
499
	}
500
501
	/**
502
	 * Generates a link to edit this page in the CMS.
503
	 *
504
	 * @return string
505
	 */
506
	public function CMSEditLink() {
507
		$link = Controller::join_links(
508
			singleton('CMSPageEditController')->Link('show'),
509
			$this->ID
510
		);
511
		return Director::absoluteURL($link);
0 ignored issues
show
Comprehensibility Best Practice introduced by
The expression \Director::absoluteURL($link); of type string|false adds false to the return on line 511 which is incompatible with the return type declared by the interface CMSPreviewable::CMSEditLink of type string. It seems like you forgot to handle an error condition.
Loading history...
512
	}
513
514
515
	/**
516
	 * Return a CSS identifier generated from this page's link.
517
	 *
518
	 * @return string The URL segment
519
	 */
520
	public function ElementName() {
521
		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...
522
	}
523
524
	/**
525
	 * Returns true if this is the currently active page being used to handle this request.
526
	 *
527
	 * @return bool
528
	 */
529
	public function isCurrent() {
530
		return $this->ID ? $this->ID == Director::get_current_page()->ID : $this === Director::get_current_page();
531
	}
532
533
	/**
534
	 * Check if this page is in the currently active section (e.g. it is either current or one of its children is
535
	 * currently being viewed).
536
	 *
537
	 * @return bool
538
	 */
539
	public function isSection() {
540
		return $this->isCurrent() || (
541
			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...
542
		);
543
	}
544
545
	/**
546
	 * Check if the parent of this page has been removed (or made otherwise unavailable), and is still referenced by
547
	 * this child. Any such orphaned page may still require access via the CMS, but should not be shown as accessible
548
	 * to external users.
549
	 *
550
	 * @return bool
551
	 */
552
	public function isOrphaned() {
553
		// Always false for root pages
554
		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...
555
556
		// Parent must exist and not be an orphan itself
557
		$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...
558
		return !$parent || !$parent->exists() || $parent->isOrphaned();
559
	}
560
561
	/**
562
	 * Return "link" or "current" depending on if this is the {@link SiteTree::isCurrent()} current page.
563
	 *
564
	 * @return string
565
	 */
566
	public function LinkOrCurrent() {
567
		return $this->isCurrent() ? 'current' : 'link';
568
	}
569
570
	/**
571
	 * Return "link" or "section" depending on if this is the {@link SiteTree::isSeciton()} current section.
572
	 *
573
	 * @return string
574
	 */
575
	public function LinkOrSection() {
576
		return $this->isSection() ? 'section' : 'link';
577
	}
578
579
	/**
580
	 * Return "link", "current" or "section" depending on if this page is the current page, or not on the current page
581
	 * but in the current section.
582
	 *
583
	 * @return string
584
	 */
585
	public function LinkingMode() {
586
		if($this->isCurrent()) {
587
			return 'current';
588
		} elseif($this->isSection()) {
589
			return 'section';
590
		} else {
591
			return 'link';
592
		}
593
	}
594
595
	/**
596
	 * Check if this page is in the given current section.
597
	 *
598
	 * @param string $sectionName Name of the section to check
599
	 * @return bool True if we are in the given section
600
	 */
601
	public function InSection($sectionName) {
602
		$page = Director::get_current_page();
603
		while($page) {
604
			if($sectionName == $page->URLSegment)
605
				return true;
606
			$page = $page->Parent;
607
		}
608
		return false;
609
	}
610
611
	/**
612
	 * Create a duplicate of this node. Doesn't affect joined data - create a custom overloading of this if you need
613
	 * such behaviour.
614
	 *
615
	 * @param bool $doWrite Whether to write the new object before returning it
616
	 * @return self The duplicated object
617
	 */
618
	 public function duplicate($doWrite = true) {
619
620
		$page = parent::duplicate(false);
621
		$page->Sort = 0;
622
		$this->invokeWithExtensions('onBeforeDuplicate', $page);
623
624
		if($doWrite) {
625
			$page->write();
626
627
			$page = $this->duplicateManyManyRelations($this, $page);
628
		}
629
		$this->invokeWithExtensions('onAfterDuplicate', $page);
630
631
		return $page;
632
	}
633
634
	/**
635
	 * Duplicates each child of this node recursively and returns the top-level duplicate node.
636
	 *
637
	 * @return self The duplicated object
638
	 */
639
	public function duplicateWithChildren() {
640
		$clone = $this->duplicate();
641
		$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...
642
643
		if($children) {
644
			foreach($children as $child) {
645
				$childClone = method_exists($child, 'duplicateWithChildren')
646
					? $child->duplicateWithChildren()
647
					: $child->duplicate();
648
				$childClone->ParentID = $clone->ID;
649
				$childClone->write();
650
			}
651
		}
652
653
		return $clone;
654
	}
655
656
	/**
657
	 * Duplicate this node and its children as a child of the node with the given ID
658
	 *
659
	 * @param int $id ID of the new node's new parent
660
	 */
661
	public function duplicateAsChild($id) {
662
		$newSiteTree = $this->duplicate();
663
		$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...
664
		$newSiteTree->Sort = 0;
665
		$newSiteTree->write();
666
	}
667
668
	/**
669
	 * Return a breadcrumb trail to this page. Excludes "hidden" pages (with ShowInMenus=0) by default.
670
	 *
671
	 * @param int $maxDepth The maximum depth to traverse.
672
	 * @param boolean $unlinked Whether to link page titles.
673
	 * @param boolean|string $stopAtPageType ClassName of a page to stop the upwards traversal.
674
	 * @param boolean $showHidden Include pages marked with the attribute ShowInMenus = 0
675
	 * @return HTMLText The breadcrumb trail.
676
	 */
677
	public function Breadcrumbs($maxDepth = 20, $unlinked = false, $stopAtPageType = false, $showHidden = false) {
678
		$pages = $this->getBreadcrumbItems($maxDepth, $stopAtPageType, $showHidden);
679
		$template = new SSViewer('BreadcrumbsTemplate');
680
		return $template->process($this->customise(new ArrayData(array(
681
			"Pages" => $pages,
682
			"Unlinked" => $unlinked
683
		))));
684
	}
685
686
687
	/**
688
	 * Returns a list of breadcrumbs for the current page.
689
	 *
690
	 * @param int $maxDepth The maximum depth to traverse.
691
	 * @param boolean|string $stopAtPageType ClassName of a page to stop the upwards traversal.
692
	 * @param boolean $showHidden Include pages marked with the attribute ShowInMenus = 0
693
	 *
694
	 * @return ArrayList
695
	*/
696
	public function getBreadcrumbItems($maxDepth = 20, $stopAtPageType = false, $showHidden = false) {
697
		$page = $this;
698
		$pages = array();
699
700
		while(
701
			$page
702
 			&& (!$maxDepth || count($pages) < $maxDepth)
703
 			&& (!$stopAtPageType || $page->ClassName != $stopAtPageType)
704
 		) {
705
			if($showHidden || $page->ShowInMenus || ($page->ID == $this->ID)) {
706
				$pages[] = $page;
707
			}
708
709
			$page = $page->Parent;
710
		}
711
712
		return new ArrayList(array_reverse($pages));
713
	}
714
715
716
	/**
717
	 * Make this page a child of another page.
718
	 *
719
	 * If the parent page does not exist, resolve it to a valid ID before updating this page's reference.
720
	 *
721
	 * @param SiteTree|int $item Either the parent object, or the parent ID
722
	 */
723
	public function setParent($item) {
724
		if(is_object($item)) {
725
			if (!$item->exists()) $item->write();
726
			$this->setField("ParentID", $item->ID);
727
		} else {
728
			$this->setField("ParentID", $item);
729
		}
730
	}
731
732
	/**
733
	 * Get the parent of this page.
734
	 *
735
	 * @return SiteTree Parent of this page
736
	 */
737
	public function getParent() {
738
		if ($parentID = $this->getField("ParentID")) {
739
			return DataObject::get_by_id("SiteTree", $parentID);
740
		}
741
	}
742
743
	/**
744
	 * Return a string of the form "parent - page" or "grandparent - parent - page" using page titles
745
	 *
746
	 * @param int $level The maximum amount of levels to traverse.
747
	 * @param string $separator Seperating string
748
	 * @return string The resulting string
749
	 */
750
	public function NestedTitle($level = 2, $separator = " - ") {
751
		$item = $this;
752
		while($item && $level > 0) {
753
			$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...
754
			$item = $item->Parent;
755
			$level--;
756
		}
757
		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...
758
	}
759
760
	/**
761
	 * This function should return true if the current user can execute this action. It can be overloaded to customise
762
	 * the security model for an application.
763
	 *
764
	 * Slightly altered from parent behaviour in {@link DataObject->can()}:
765
	 * - Checks for existence of a method named "can<$perm>()" on the object
766
	 * - Calls decorators and only returns for FALSE "vetoes"
767
	 * - Falls back to {@link Permission::check()}
768
	 * - Does NOT check for many-many relations named "Can<$perm>"
769
	 *
770
	 * @uses DataObjectDecorator->can()
771
	 *
772
	 * @param string $perm The permission to be checked, such as 'View'
773
	 * @param Member $member The member whose permissions need checking. Defaults to the currently logged in user.
774
	 * @param array $context Context argument for canCreate()
775
	 * @return bool True if the the member is allowed to do the given action
776
	 */
777
	public function can($perm, $member = null, $context = array()) {
778 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...
779
			$member = Member::currentUserID();
780
		}
781
782
		if($member && Permission::checkMember($member, "ADMIN")) return true;
783
784
		if(is_string($perm) && method_exists($this, 'can' . ucfirst($perm))) {
785
			$method = 'can' . ucfirst($perm);
786
			return $this->$method($member);
787
		}
788
789
		$results = $this->extend('can', $member);
790
		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...
791
792
		return ($member && Permission::checkMember($member, $perm));
793
	}
794
795
	/**
796
	 * This function should return true if the current user can add children to this page. It can be overloaded to
797
	 * customise the security model for an application.
798
	 *
799
	 * Denies permission if any of the following conditions is true:
800
	 * - alternateCanAddChildren() on a extension returns false
801
	 * - canEdit() is not granted
802
	 * - There are no classes defined in {@link $allowed_children}
803
	 *
804
	 * @uses SiteTreeExtension->canAddChildren()
805
	 * @uses canEdit()
806
	 * @uses $allowed_children
807
	 *
808
	 * @param Member|int $member
809
	 * @return bool True if the current user can add children
810
	 */
811
	public function canAddChildren($member = null) {
812
		// Disable adding children to archived pages
813
		if($this->getIsDeletedFromStage()) {
814
			return false;
815
		}
816
817 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...
818
			$member = Member::currentUserID();
819
		}
820
821
		// Standard mechanism for accepting permission changes from extensions
822
		$extended = $this->extendedCan('canAddChildren', $member);
823
		if($extended !== null) {
824
			return $extended;
825
		}
826
827
		// Default permissions
828
		if($member && Permission::checkMember($member, "ADMIN")) {
829
			return true;
830
		}
831
832
		return $this->canEdit($member) && $this->stat('allowed_children') != 'none';
833
	}
834
835
	/**
836
	 * This function should return true if the current user can view this page. It can be overloaded to customise the
837
	 * security model for an application.
838
	 *
839
	 * Denies permission if any of the following conditions is true:
840
	 * - canView() on any extension returns false
841
	 * - "CanViewType" directive is set to "Inherit" and any parent page return false for canView()
842
	 * - "CanViewType" directive is set to "LoggedInUsers" and no user is logged in
843
	 * - "CanViewType" directive is set to "OnlyTheseUsers" and user is not in the given groups
844
	 *
845
	 * @uses DataExtension->canView()
846
	 * @uses ViewerGroups()
847
	 *
848
	 * @param Member|int $member
849
	 * @return bool True if the current user can view this page
850
	 */
851
	public function canView($member = null) {
852 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...
853
			$member = Member::currentUserID();
854
		}
855
856
		// Standard mechanism for accepting permission changes from extensions
857
		$extended = $this->extendedCan('canView', $member);
858
		if($extended !== null) {
859
			return $extended;
860
		}
861
862
		// admin override
863
		if($member && Permission::checkMember($member, array("ADMIN", "SITETREE_VIEW_ALL"))) {
864
			return true;
865
		}
866
867
		// Orphaned pages (in the current stage) are unavailable, except for admins via the CMS
868
		if($this->isOrphaned()) {
869
			return false;
870
		}
871
872
		// check for empty spec
873
		if(!$this->CanViewType || $this->CanViewType == 'Anyone') {
874
			return true;
875
		}
876
877
		// check for inherit
878
		if($this->CanViewType == 'Inherit') {
879
			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...
880
			else return $this->getSiteConfig()->canViewPages($member);
881
		}
882
883
		// check for any logged-in users
884
		if($this->CanViewType == 'LoggedInUsers' && $member) {
885
			return true;
886
		}
887
888
		// check for specific groups
889
		if($member && is_numeric($member)) {
890
			$member = DataObject::get_by_id('Member', $member);
891
		}
892
		if(
893
			$this->CanViewType == 'OnlyTheseUsers'
894
			&& $member
895
			&& $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...
896
		) return true;
897
898
		return false;
899
	}
900
901
	/**
902
	 * This function should return true if the current user can delete this page. It can be overloaded to customise the
903
	 * security model for an application.
904
	 *
905
	 * Denies permission if any of the following conditions is true:
906
	 * - canDelete() returns false on any extension
907
	 * - canEdit() returns false
908
	 * - any descendant page returns false for canDelete()
909
	 *
910
	 * @uses canDelete()
911
	 * @uses SiteTreeExtension->canDelete()
912
	 * @uses canEdit()
913
	 *
914
	 * @param Member $member
915
	 * @return bool True if the current user can delete this page
916
	 */
917
	public function canDelete($member = null) {
918 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...
919
		else if(is_numeric($member)) $memberID = $member;
920
		else $memberID = Member::currentUserID();
921
922
		// Standard mechanism for accepting permission changes from extensions
923
		$extended = $this->extendedCan('canDelete', $memberID);
924
		if($extended !== null) {
925
			return $extended;
926
		}
927
928
		// Default permission check
929
		if($memberID && Permission::checkMember($memberID, array("ADMIN", "SITETREE_EDIT_ALL"))) {
930
			return true;
931
		}
932
933
		// Regular canEdit logic is handled by can_edit_multiple
934
		$results = self::can_delete_multiple(array($this->ID), $memberID);
935
936
		// If this page no longer exists in stage/live results won't contain the page.
937
		// Fail-over to false
938
		return isset($results[$this->ID]) ? $results[$this->ID] : false;
939
	}
940
941
	/**
942
	 * This function should return true if the current user can create new pages of this class, regardless of class. It
943
	 * can be overloaded to customise the security model for an application.
944
	 *
945
	 * By default, permission to create at the root level is based on the SiteConfig configuration, and permission to
946
	 * create beneath a parent is based on the ability to edit that parent page.
947
	 *
948
	 * Use {@link canAddChildren()} to control behaviour of creating children under this page.
949
	 *
950
	 * @uses $can_create
951
	 * @uses DataExtension->canCreate()
952
	 *
953
	 * @param Member $member
954
	 * @param array $context Optional array which may contain array('Parent' => $parentObj)
955
	 *                       If a parent page is known, it will be checked for validity.
956
	 *                       If omitted, it will be assumed this is to be created as a top level page.
957
	 * @return bool True if the current user can create pages on this class.
958
	 */
959
	public function canCreate($member = null, $context = array()) {
960 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...
961
			$member = Member::currentUserID();
962
		}
963
964
		// Check parent (custom canCreate option for SiteTree)
965
		// Block children not allowed for this parent type
966
		$parent = isset($context['Parent']) ? $context['Parent'] : null;
967
		if($parent && !in_array(get_class($this), $parent->allowedChildren())) {
968
			return false;
969
		}
970
971
		// Standard mechanism for accepting permission changes from extensions
972
		$extended = $this->extendedCan(__FUNCTION__, $member, $context);
973
		if($extended !== null) {
974
			return $extended;
975
		}
976
977
		// Check permission
978
		if($member && Permission::checkMember($member, "ADMIN")) {
979
			return true;
980
		}
981
982
		// Fall over to inherited permissions
983
		if($parent) {
984
			return $parent->canAddChildren($member);
985
		} else {
986
			// This doesn't necessarily mean we are creating a root page, but that
987
			// we don't know if there is a parent, so default to this permission
988
			return SiteConfig::current_site_config()->canCreateTopLevel($member);
989
		}
990
	}
991
992
	/**
993
	 * This function should return true if the current user can edit this page. It can be overloaded to customise the
994
	 * security model for an application.
995
	 *
996
	 * Denies permission if any of the following conditions is true:
997
	 * - canEdit() on any extension returns false
998
	 * - canView() return false
999
	 * - "CanEditType" directive is set to "Inherit" and any parent page return false for canEdit()
1000
	 * - "CanEditType" directive is set to "LoggedInUsers" and no user is logged in or doesn't have the
1001
	 *   CMS_Access_CMSMAIN permission code
1002
	 * - "CanEditType" directive is set to "OnlyTheseUsers" and user is not in the given groups
1003
	 *
1004
	 * @uses canView()
1005
	 * @uses EditorGroups()
1006
	 * @uses DataExtension->canEdit()
1007
	 *
1008
	 * @param Member $member Set to false if you want to explicitly test permissions without a valid user (useful for
1009
	 *                       unit tests)
1010
	 * @return bool True if the current user can edit this page
1011
	 */
1012
	public function canEdit($member = null) {
1013 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...
1014
		else if(is_numeric($member)) $memberID = $member;
1015
		else $memberID = Member::currentUserID();
1016
1017
		// Standard mechanism for accepting permission changes from extensions
1018
		$extended = $this->extendedCan('canEdit', $memberID);
1019
		if($extended !== null) {
1020
			return $extended;
1021
		}
1022
1023
		// Default permissions
1024
		if($memberID && Permission::checkMember($memberID, array("ADMIN", "SITETREE_EDIT_ALL"))) {
1025
			return true;
1026
		}
1027
1028
		if($this->ID) {
1029
			// Regular canEdit logic is handled by can_edit_multiple
1030
			$results = self::can_edit_multiple(array($this->ID), $memberID);
1031
1032
			// If this page no longer exists in stage/live results won't contain the page.
1033
			// Fail-over to false
1034
			return isset($results[$this->ID]) ? $results[$this->ID] : false;
1035
1036
		// Default for unsaved pages
1037
		} else {
1038
			return $this->getSiteConfig()->canEditPages($member);
1039
		}
1040
	}
1041
1042
	/**
1043
	 * Stub method to get the site config, unless the current class can provide an alternate.
1044
	 *
1045
	 * @return SiteConfig
1046
	 */
1047
	public function getSiteConfig() {
1048
1049
		if($this->hasMethod('alternateSiteConfig')) {
1050
			$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...
1051
			if($altConfig) return $altConfig;
1052
		}
1053
1054
		return SiteConfig::current_site_config();
1055
	}
1056
1057
	/**
1058
	 * Pre-populate the cache of canEdit, canView, canDelete, canPublish permissions. This method will use the static
1059
	 * can_(perm)_multiple method for efficiency.
1060
	 *
1061
	 * @param string          $permission    The permission: edit, view, publish, approve, etc.
1062
	 * @param array           $ids           An array of page IDs
1063
	 * @param callable|string $batchCallback The function/static method to call to calculate permissions.  Defaults
1064
	 *                                       to 'SiteTree::can_(permission)_multiple'
1065
	 */
1066
	static public function prepopulate_permission_cache($permission = 'CanEditType', $ids, $batchCallback = null) {
1067
		if(!$batchCallback) $batchCallback = "SiteTree::can_{$permission}_multiple";
1068
1069
		if(is_callable($batchCallback)) {
1070
			call_user_func($batchCallback, $ids, Member::currentUserID(), false);
1071
		} else {
1072
			user_error("SiteTree::prepopulate_permission_cache can't calculate '$permission' "
1073
				. "with callback '$batchCallback'", E_USER_WARNING);
1074
		}
1075
	}
1076
1077
	/**
1078
	 * This method is NOT a full replacement for the individual can*() methods, e.g. {@link canEdit()}. Rather than
1079
	 * checking (potentially slow) PHP logic, it relies on the database group associations, e.g. the "CanEditType" field
1080
	 * plus the "SiteTree_EditorGroups" many-many table. By batch checking multiple records, we can combine the queries
1081
	 * efficiently.
1082
	 *
1083
	 * Caches based on $typeField data. To invalidate the cache, use {@link SiteTree::reset()} or set the $useCached
1084
	 * property to FALSE.
1085
	 *
1086
	 * @param array  $ids              Of {@link SiteTree} IDs
1087
	 * @param int    $memberID         Member ID
1088
	 * @param string $typeField        A property on the data record, e.g. "CanEditType".
1089
	 * @param string $groupJoinTable   A many-many table name on this record, e.g. "SiteTree_EditorGroups"
1090
	 * @param string $siteConfigMethod Method to call on {@link SiteConfig} for toplevel items, e.g. "canEdit"
1091
	 * @param string $globalPermission If the member doesn't have this permission code, don't bother iterating deeper
1092
	 * @param bool   $useCached
1093
	 * @return array An map of {@link SiteTree} ID keys to boolean values
1094
	 */
1095
	public static function batch_permission_check($ids, $memberID, $typeField, $groupJoinTable, $siteConfigMethod,
1096
												  $globalPermission = null, $useCached = true) {
1097
		if($globalPermission === NULL) $globalPermission = array('CMS_ACCESS_LeftAndMain', 'CMS_ACCESS_CMSMain');
1098
1099
		// Sanitise the IDs
1100
		$ids = array_filter($ids, 'is_numeric');
1101
1102
		// This is the name used on the permission cache
1103
		// converts something like 'CanEditType' to 'edit'.
1104
		$cacheKey = strtolower(substr($typeField, 3, -4)) . "-$memberID";
1105
1106
		// Default result: nothing editable
1107
		$result = array_fill_keys($ids, false);
1108
		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...
1109
1110
			// Look in the cache for values
1111
			if($useCached && isset(self::$cache_permissions[$cacheKey])) {
1112
				$cachedValues = array_intersect_key(self::$cache_permissions[$cacheKey], $result);
1113
1114
				// If we can't find everything in the cache, then look up the remainder separately
1115
				$uncachedValues = array_diff_key($result, self::$cache_permissions[$cacheKey]);
1116
				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...
1117
					$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 1097 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...
1118
				}
1119
				return $cachedValues;
1120
			}
1121
1122
			// If a member doesn't have a certain permission then they can't edit anything
1123
			if(!$memberID || ($globalPermission && !Permission::checkMember($memberID, $globalPermission))) {
1124
				return $result;
1125
			}
1126
1127
			// Placeholder for parameterised ID list
1128
			$idPlaceholders = DB::placeholders($ids);
1129
1130
			// If page can't be viewed, don't grant edit permissions to do - implement can_view_multiple(), so this can
1131
			// be enabled
1132
			//$ids = array_keys(array_filter(self::can_view_multiple($ids, $memberID)));
1133
1134
			// Get the groups that the given member belongs to
1135
			$groupIDs = DataObject::get_by_id('Member', $memberID)->Groups()->column("ID");
1136
			$SQL_groupList = implode(", ", $groupIDs);
1137
			if (!$SQL_groupList) $SQL_groupList = '0';
1138
1139
			$combinedStageResult = array();
1140
1141
			foreach(array(Versioned::DRAFT, Versioned::LIVE) as $stage) {
1142
				// Start by filling the array with the pages that actually exist
1143
				$table = ($stage=='Stage') ? "SiteTree" : "SiteTree_$stage";
1144
1145
				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...
1146
					$idQuery = "SELECT \"ID\" FROM \"$table\" WHERE \"ID\" IN ($idPlaceholders)";
1147
					$stageIds = DB::prepared_query($idQuery, $ids)->column();
1148
				} else {
1149
					$stageIds = array();
1150
				}
1151
				$result = array_fill_keys($stageIds, false);
1152
1153
				// Get the uninherited permissions
1154
				$uninheritedPermissions = Versioned::get_by_stage("SiteTree", $stage)
1155
					->where(array(
1156
						"(\"$typeField\" = 'LoggedInUsers' OR
1157
						(\"$typeField\" = 'OnlyTheseUsers' AND \"$groupJoinTable\".\"SiteTreeID\" IS NOT NULL))
1158
						AND \"SiteTree\".\"ID\" IN ($idPlaceholders)"
1159
						=> $ids
1160
					))
1161
					->leftJoin($groupJoinTable, "\"$groupJoinTable\".\"SiteTreeID\" = \"SiteTree\".\"ID\" AND \"$groupJoinTable\".\"GroupID\" IN ($SQL_groupList)");
1162
1163
				if($uninheritedPermissions) {
1164
					// Set all the relevant items in $result to true
1165
					$result = array_fill_keys($uninheritedPermissions->column('ID'), true) + $result;
1166
				}
1167
1168
				// Get permissions that are inherited
1169
				$potentiallyInherited = Versioned::get_by_stage(
1170
					"SiteTree",
1171
					$stage,
1172
					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...
1173
				);
1174
1175
				if($potentiallyInherited) {
1176
					// Group $potentiallyInherited by ParentID; we'll look at the permission of all those parents and
1177
					// then see which ones the user has permission on
1178
					$groupedByParent = array();
1179
					foreach($potentiallyInherited as $item) {
1180
						if($item->ParentID) {
1181
							if(!isset($groupedByParent[$item->ParentID])) $groupedByParent[$item->ParentID] = array();
1182
							$groupedByParent[$item->ParentID][] = $item->ID;
1183
						} else {
1184
							// Might return different site config based on record context, e.g. when subsites module
1185
							// is used
1186
							$siteConfig = $item->getSiteConfig();
1187
							$result[$item->ID] = $siteConfig->{$siteConfigMethod}($memberID);
1188
						}
1189
					}
1190
1191
					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...
1192
						$actuallyInherited = self::batch_permission_check(array_keys($groupedByParent), $memberID, $typeField, $groupJoinTable, $siteConfigMethod);
1193
						if($actuallyInherited) {
1194
							$parentIDs = array_keys(array_filter($actuallyInherited));
1195
							foreach($parentIDs as $parentID) {
1196
								// Set all the relevant items in $result to true
1197
								$result = array_fill_keys($groupedByParent[$parentID], true) + $result;
1198
							}
1199
						}
1200
					}
1201
				}
1202
1203
				$combinedStageResult = $combinedStageResult + $result;
1204
1205
			}
1206
		}
1207
1208
		if(isset($combinedStageResult)) {
1209
			// Cache the results
1210
 			if(empty(self::$cache_permissions[$cacheKey])) self::$cache_permissions[$cacheKey] = array();
1211
 			self::$cache_permissions[$cacheKey] = $combinedStageResult + self::$cache_permissions[$cacheKey];
1212
1213
			return $combinedStageResult;
1214
		} else {
1215
			return array();
1216
		}
1217
	}
1218
1219
	/**
1220
	 * Get the 'can edit' information for a number of SiteTree pages.
1221
	 *
1222
	 * @param array $ids       An array of IDs of the SiteTree pages to look up
1223
	 * @param int   $memberID  ID of member
1224
	 * @param bool  $useCached Return values from the permission cache if they exist
1225
	 * @return array A map where the IDs are keys and the values are booleans stating whether the given page can be
1226
	 *                         edited
1227
	 */
1228
	static public function can_edit_multiple($ids, $memberID, $useCached = true) {
1229
		return self::batch_permission_check($ids, $memberID, 'CanEditType', 'SiteTree_EditorGroups', 'canEditPages', null, $useCached);
1230
	}
1231
1232
	/**
1233
	 * Get the 'can edit' information for a number of SiteTree pages.
1234
	 *
1235
	 * @param array $ids       An array of IDs of the SiteTree pages to look up
1236
	 * @param int   $memberID  ID of member
1237
	 * @param bool  $useCached Return values from the permission cache if they exist
1238
	 * @return array
1239
	 */
1240
	static public function can_delete_multiple($ids, $memberID, $useCached = true) {
1241
		$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...
1242
		$result = array_fill_keys($ids, false);
1243
		$cacheKey = "delete-$memberID";
1244
1245
		// Look in the cache for values
1246
		if($useCached && isset(self::$cache_permissions[$cacheKey])) {
1247
			$cachedValues = array_intersect_key(self::$cache_permissions[$cacheKey], $result);
1248
1249
			// If we can't find everything in the cache, then look up the remainder separately
1250
			$uncachedValues = array_diff_key($result, self::$cache_permissions[$cacheKey]);
1251
			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...
1252
				$cachedValues = self::can_delete_multiple(array_keys($uncachedValues), $memberID, false)
1253
					+ $cachedValues;
1254
			}
1255
			return $cachedValues;
1256
		}
1257
1258
		// You can only delete pages that you can edit
1259
		$editableIDs = array_keys(array_filter(self::can_edit_multiple($ids, $memberID)));
1260
		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...
1261
1262
			// You can only delete pages whose children you can delete
1263
			$editablePlaceholders = DB::placeholders($editableIDs);
1264
			$childRecords = SiteTree::get()->where(array(
1265
				"\"SiteTree\".\"ParentID\" IN ($editablePlaceholders)" => $editableIDs
1266
			));
1267
			if($childRecords) {
1268
				$children = $childRecords->map("ID", "ParentID");
1269
1270
				// Find out the children that can be deleted
1271
				$deletableChildren = self::can_delete_multiple($children->keys(), $memberID);
1272
1273
				// Get a list of all the parents that have no undeletable children
1274
				$deletableParents = array_fill_keys($editableIDs, true);
1275
				foreach($deletableChildren as $id => $canDelete) {
1276
					if(!$canDelete) unset($deletableParents[$children[$id]]);
1277
				}
1278
1279
				// Use that to filter the list of deletable parents that have children
1280
				$deletableParents = array_keys($deletableParents);
1281
1282
				// Also get the $ids that don't have children
1283
				$parents = array_unique($children->values());
1284
				$deletableLeafNodes = array_diff($editableIDs, $parents);
1285
1286
				// Combine the two
1287
				$deletable = array_merge($deletableParents, $deletableLeafNodes);
1288
1289
			} else {
1290
				$deletable = $editableIDs;
1291
			}
1292
		} else {
1293
			$deletable = array();
1294
		}
1295
1296
		// Convert the array of deletable IDs into a map of the original IDs with true/false as the value
1297
		return array_fill_keys($deletable, true) + array_fill_keys($ids, false);
1298
	}
1299
1300
	/**
1301
	 * Collate selected descendants of this page.
1302
	 *
1303
	 * {@link $condition} will be evaluated on each descendant, and if it is succeeds, that item will be added to the
1304
	 * $collator array.
1305
	 *
1306
	 * @param string $condition The PHP condition to be evaluated. The page will be called $item
1307
	 * @param array  $collator  An array, passed by reference, to collect all of the matching descendants.
1308
	 * @return bool
1309
	 */
1310
	public function collateDescendants($condition, &$collator) {
1311
		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...
1312
			foreach($children as $item) {
1313
				if(eval("return $condition;")) $collator[] = $item;
1314
				$item->collateDescendants($condition, $collator);
1315
			}
1316
			return true;
1317
		}
1318
	}
1319
1320
	/**
1321
	 * Return the title, description, keywords and language metatags.
1322
	 *
1323
	 * @todo Move <title> tag in separate getter for easier customization and more obvious usage
1324
	 *
1325
	 * @param bool $includeTitle Show default <title>-tag, set to false for custom templating
1326
	 * @return string The XHTML metatags
1327
	 */
1328
	public function MetaTags($includeTitle = true) {
1329
		$tags = "";
1330
		if($includeTitle === true || $includeTitle == 'true') {
1331
			$tags .= "<title>" . Convert::raw2xml($this->Title) . "</title>\n";
1332
		}
1333
1334
		$generator = trim(Config::inst()->get('SiteTree', 'meta_generator'));
1335
		if (!empty($generator)) {
1336
			$tags .= "<meta name=\"generator\" content=\"" . Convert::raw2att($generator) . "\" />\n";
1337
		}
1338
1339
		$charset = Config::inst()->get('ContentNegotiator', 'encoding');
1340
		$tags .= "<meta http-equiv=\"Content-type\" content=\"text/html; charset=$charset\" />\n";
1341
		if($this->MetaDescription) {
1342
			$tags .= "<meta name=\"description\" content=\"" . Convert::raw2att($this->MetaDescription) . "\" />\n";
1343
		}
1344
		if($this->ExtraMeta) {
1345
			$tags .= $this->ExtraMeta . "\n";
1346
		}
1347
1348
		if(Permission::check('CMS_ACCESS_CMSMain')
1349
			&& in_array('CMSPreviewable', class_implements($this))
1350
			&& !$this instanceof ErrorPage
1351
			&& $this->ID > 0
1352
		) {
1353
			$tags .= "<meta name=\"x-page-id\" content=\"{$this->ID}\" />\n";
1354
			$tags .= "<meta name=\"x-cms-edit-link\" content=\"" . $this->CMSEditLink() . "\" />\n";
1355
		}
1356
1357
		$this->extend('MetaTags', $tags);
1358
1359
		return $tags;
1360
	}
1361
1362
	/**
1363
	 * Returns the object that contains the content that a user would associate with this page.
1364
	 *
1365
	 * Ordinarily, this is just the page itself, but for example on RedirectorPages or VirtualPages ContentSource() will
1366
	 * return the page that is linked to.
1367
	 *
1368
	 * @return $this
1369
	 */
1370
	public function ContentSource() {
1371
		return $this;
1372
	}
1373
1374
	/**
1375
	 * Add default records to database.
1376
	 *
1377
	 * This function is called whenever the database is built, after the database tables have all been created. Overload
1378
	 * this to add default records when the database is built, but make sure you call parent::requireDefaultRecords().
1379
	 */
1380
	public function requireDefaultRecords() {
1381
		parent::requireDefaultRecords();
1382
1383
		// default pages
1384
		if($this->class == 'SiteTree' && $this->config()->create_default_pages) {
1385
			if(!SiteTree::get_by_link(Config::inst()->get('RootURLController', 'default_homepage_link'))) {
1386
				$homepage = new Page();
1387
				$homepage->Title = _t('SiteTree.DEFAULTHOMETITLE', 'Home');
1388
				$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>');
1389
				$homepage->URLSegment = Config::inst()->get('RootURLController', 'default_homepage_link');
1390
				$homepage->Sort = 1;
1391
				$homepage->write();
1392
				$homepage->copyVersionToStage(Versioned::DRAFT, Versioned::LIVE);
1393
				$homepage->flushCache();
1394
				DB::alteration_message('Home page created', 'created');
1395
			}
1396
1397
			if(DB::query("SELECT COUNT(*) FROM \"SiteTree\"")->value() == 1) {
1398
				$aboutus = new Page();
1399
				$aboutus->Title = _t('SiteTree.DEFAULTABOUTTITLE', 'About Us');
1400
				$aboutus->Content = _t('SiteTree.DEFAULTABOUTCONTENT', '<p>You can fill this page out with your own content, or delete it and create your own pages.</p>');
1401
				$aboutus->Sort = 2;
1402
				$aboutus->write();
1403
				$aboutus->copyVersionToStage(Versioned::DRAFT, Versioned::LIVE);
1404
				$aboutus->flushCache();
1405
				DB::alteration_message('About Us page created', 'created');
1406
1407
				$contactus = new Page();
1408
				$contactus->Title = _t('SiteTree.DEFAULTCONTACTTITLE', 'Contact Us');
1409
				$contactus->Content = _t('SiteTree.DEFAULTCONTACTCONTENT', '<p>You can fill this page out with your own content, or delete it and create your own pages.</p>');
1410
				$contactus->Sort = 3;
1411
				$contactus->write();
1412
				$contactus->copyVersionToStage(Versioned::DRAFT, Versioned::LIVE);
1413
				$contactus->flushCache();
1414
				DB::alteration_message('Contact Us page created', 'created');
1415
			}
1416
		}
1417
1418
		// schema migration
1419
		// @todo Move to migration task once infrastructure is implemented
1420
		if($this->class == 'SiteTree') {
1421
			$conn = DB::get_schema();
1422
			// only execute command if fields haven't been renamed to _obsolete_<fieldname> already by the task
1423
			if($conn->hasField('SiteTree' ,'Viewers')) {
1424
				$task = new UpgradeSiteTreePermissionSchemaTask();
1425
				$task->run(new SS_HTTPRequest('GET','/'));
1426
			}
1427
		}
1428
	}
1429
1430
	protected function onBeforeWrite() {
1431
		parent::onBeforeWrite();
1432
1433
		// If Sort hasn't been set, make this page come after it's siblings
1434
		if(!$this->Sort) {
1435
			$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...
1436
			$this->Sort = DB::prepared_query(
1437
				"SELECT MAX(\"Sort\") + 1 FROM \"SiteTree\" WHERE \"ParentID\" = ?",
1438
				array($parentID)
1439
			)->value();
1440
		}
1441
1442
		// If there is no URLSegment set, generate one from Title
1443
		$defaultSegment = $this->generateURLSegment(_t(
1444
			'CMSMain.NEWPAGE',
1445
			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...
1446
		));
1447
		if((!$this->URLSegment || $this->URLSegment == $defaultSegment) && $this->Title) {
1448
			$this->URLSegment = $this->generateURLSegment($this->Title);
1449
		} else if($this->isChanged('URLSegment', 2)) {
1450
			// Do a strict check on change level, to avoid double encoding caused by
1451
			// bogus changes through forceChange()
1452
			$filter = URLSegmentFilter::create();
1453
			$this->URLSegment = $filter->filter($this->URLSegment);
1454
			// If after sanitising there is no URLSegment, give it a reasonable default
1455
			if(!$this->URLSegment) $this->URLSegment = "page-$this->ID";
1456
		}
1457
1458
		// Ensure that this object has a non-conflicting URLSegment value.
1459
		$count = 2;
1460
		while(!$this->validURLSegment()) {
1461
			$this->URLSegment = preg_replace('/-[0-9]+$/', null, $this->URLSegment) . '-' . $count;
1462
			$count++;
1463
		}
1464
1465
		$this->syncLinkTracking();
1466
1467
		// Check to see if we've only altered fields that shouldn't affect versioning
1468
		$fieldsIgnoredByVersioning = array('HasBrokenLink', 'Status', 'HasBrokenFile', 'ToDo', 'VersionID', 'SaveCount');
1469
		$changedFields = array_keys($this->getChangedFields(true, 2));
1470
1471
		// This more rigorous check is inline with the test that write() does to decide whether or not to write to the
1472
		// DB. We use that to avoid cluttering the system with a migrateVersion() call that doesn't get used
1473
		$oneChangedFields = array_keys($this->getChangedFields(true, 1));
1474
1475
		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...
1476
			// This will have the affect of preserving the versioning
1477
			$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...
1478
		}
1479
	}
1480
1481
	/**
1482
	 * Trigger synchronisation of link tracking
1483
	 *
1484
	 * {@see SiteTreeLinkTracking::augmentSyncLinkTracking}
1485
	 */
1486
	public function syncLinkTracking() {
1487
		$this->extend('augmentSyncLinkTracking');
1488
	}
1489
1490
	public function onBeforeDelete() {
1491
		parent::onBeforeDelete();
1492
1493
		// If deleting this page, delete all its children.
1494
		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...
1495
			foreach($children as $child) {
1496
				$child->delete();
1497
			}
1498
		}
1499
	}
1500
1501
	public function onAfterDelete() {
1502
		// Need to flush cache to avoid outdated versionnumber references
1503
		$this->flushCache();
1504
1505
		// Need to mark pages depending to this one as broken
1506
		$dependentPages = $this->DependentPages();
1507
		if($dependentPages) foreach($dependentPages as $page) {
1508
			// $page->write() calls syncLinkTracking, which does all the hard work for us.
1509
			$page->write();
1510
		}
1511
1512
		parent::onAfterDelete();
1513
	}
1514
1515
	public function flushCache($persistent = true) {
1516
		parent::flushCache($persistent);
1517
		$this->_cache_statusFlags = null;
1518
	}
1519
1520
	public function validate() {
1521
		$result = parent::validate();
1522
1523
		// Allowed children validation
1524
		$parent = $this->getParent();
1525
		if($parent && $parent->exists()) {
1526
			// No need to check for subclasses or instanceof, as allowedChildren() already
1527
			// deconstructs any inheritance trees already.
1528
			$allowed = $parent->allowedChildren();
1529
			$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...
1530
			if(!in_array($subject->ClassName, $allowed)) {
1531
1532
				$result->error(
1533
					_t(
1534
						'SiteTree.PageTypeNotAllowed',
1535
						'Page type "{type}" not allowed as child of this parent page',
1536
						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...
1537
					),
1538
					'ALLOWED_CHILDREN'
1539
				);
1540
			}
1541
		}
1542
1543
		// "Can be root" validation
1544
		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...
1545
			$result->error(
1546
				_t(
1547
					'SiteTree.PageTypNotAllowedOnRoot',
1548
					'Page type "{type}" is not allowed on the root level',
1549
					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...
1550
				),
1551
				'CAN_BE_ROOT'
1552
			);
1553
		}
1554
1555
		return $result;
1556
	}
1557
1558
	/**
1559
	 * Returns true if this object has a URLSegment value that does not conflict with any other objects. This method
1560
	 * checks for:
1561
	 *  - A page with the same URLSegment that has a conflict
1562
	 *  - Conflicts with actions on the parent page
1563
	 *  - A conflict caused by a root page having the same URLSegment as a class name
1564
	 *
1565
	 * @return bool
1566
	 */
1567
	public function validURLSegment() {
1568
		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...
1569
			if($controller = ModelAsController::controller_for($parent)) {
1570
				if($controller instanceof Controller && $controller->hasAction($this->URLSegment)) return false;
1571
			}
1572
		}
1573
1574
		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...
1575
			if(class_exists($this->URLSegment) && is_subclass_of($this->URLSegment, 'RequestHandler')) return false;
1576
		}
1577
1578
		// Filters by url, id, and parent
1579
		$filter = array('"SiteTree"."URLSegment"' => $this->URLSegment);
1580
		if($this->ID) {
1581
			$filter['"SiteTree"."ID" <> ?'] = $this->ID;
1582
		}
1583
		if(self::config()->nested_urls) {
1584
			$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...
1585
		}
1586
1587
		$votes = array_filter(
1588
			(array)$this->extend('augmentValidURLSegment'),
1589
			function($v) {return !is_null($v);}
1590
		);
1591
		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...
1592
			return min($votes);
1593
		}
1594
1595
		// Check existence
1596
		$existingPage = DataObject::get_one('SiteTree', $filter);
1597
		if ($existingPage) return false;
1598
1599
		return !($existingPage);
1600
		}
1601
1602
	/**
1603
	 * Generate a URL segment based on the title provided.
1604
	 *
1605
	 * If {@link Extension}s wish to alter URL segment generation, they can do so by defining
1606
	 * updateURLSegment(&$url, $title).  $url will be passed by reference and should be modified. $title will contain
1607
	 * the title that was originally used as the source of this generated URL. This lets extensions either start from
1608
	 * scratch, or incrementally modify the generated URL.
1609
	 *
1610
	 * @param string $title Page title
1611
	 * @return string Generated url segment
1612
	 */
1613
	public function generateURLSegment($title){
1614
		$filter = URLSegmentFilter::create();
1615
		$t = $filter->filter($title);
1616
1617
		// Fallback to generic page name if path is empty (= no valid, convertable characters)
1618
		if(!$t || $t == '-' || $t == '-1') $t = "page-$this->ID";
1619
1620
		// Hook for extensions
1621
		$this->extend('updateURLSegment', $t, $title);
1622
1623
		return $t;
1624
	}
1625
1626
	/**
1627
	 * Gets the URL segment for the latest draft version of this page.
1628
	 *
1629
	 * @return string
1630
	 */
1631
	public function getStageURLSegment() {
1632
		$stageRecord = Versioned::get_one_by_stage('SiteTree', Versioned::DRAFT, 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...
1633
			'"SiteTree"."ID"' => $this->ID
1634
		));
1635
		return ($stageRecord) ? $stageRecord->URLSegment : null;
1636
	}
1637
1638
	/**
1639
	 * Gets the URL segment for the currently published version of this page.
1640
	 *
1641
	 * @return string
1642
	 */
1643
	public function getLiveURLSegment() {
1644
		$liveRecord = Versioned::get_one_by_stage('SiteTree', Versioned::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...
1645
			'"SiteTree"."ID"' => $this->ID
1646
		));
1647
		return ($liveRecord) ? $liveRecord->URLSegment : null;
1648
	}
1649
1650
	/**
1651
	 * Returns the pages that depend on this page. This includes virtual pages, pages that link to it, etc.
1652
	 *
1653
	 * @param bool $includeVirtuals Set to false to exlcude virtual pages.
1654
	 * @return ArrayList
1655
	 */
1656
	public function DependentPages($includeVirtuals = true) {
1657
		if(class_exists('Subsite')) {
1658
			$origDisableSubsiteFilter = Subsite::$disable_subsite_filter;
1659
			Subsite::disable_subsite_filter(true);
1660
		}
1661
1662
		// Content links
1663
		$items = new ArrayList();
1664
1665
		// We merge all into a regular SS_List, because DataList doesn't support merge
1666
		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...
1667
			$linkList = new ArrayList();
1668
			foreach($contentLinks as $item) {
1669
				$item->DependentLinkType = 'Content link';
1670
				$linkList->push($item);
1671
			}
1672
			$items->merge($linkList);
1673
		}
1674
1675
		// Virtual pages
1676
		if($includeVirtuals) {
1677
			$virtuals = $this->VirtualPages();
1678
			if($virtuals) {
1679
				$virtualList = new ArrayList();
1680
				foreach($virtuals as $item) {
1681
					$item->DependentLinkType = 'Virtual page';
1682
					$virtualList->push($item);
1683
				}
1684
				$items->merge($virtualList);
1685
			}
1686
		}
1687
1688
		// Redirector pages
1689
		$redirectors = RedirectorPage::get()->where(array(
1690
			'"RedirectorPage"."RedirectionType"' => 'Internal',
1691
			'"RedirectorPage"."LinkToID"' => $this->ID
1692
		));
1693
		if($redirectors) {
1694
			$redirectorList = new ArrayList();
1695
			foreach($redirectors as $item) {
1696
				$item->DependentLinkType = 'Redirector page';
1697
				$redirectorList->push($item);
1698
			}
1699
			$items->merge($redirectorList);
1700
		}
1701
1702
		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...
1703
1704
		return $items;
1705
	}
1706
1707
	/**
1708
	 * Return all virtual pages that link to this page.
1709
	 *
1710
	 * @return DataList
1711
	 */
1712
	public function VirtualPages() {
1713
		$pages = parent::VirtualPages();
0 ignored issues
show
Bug introduced by
It seems like you code against a specific sub-type and not the parent class DataObject as the method VirtualPages() does only exist in the following sub-classes of DataObject: SiteTree. Maybe you want to instanceof check for one of these explicitly?

Let’s take a look at an example:

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

class MyUser extends 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 sub-classes 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 parent class:

    abstract class User
    {
        /** @return string */
        abstract public function getPassword();
    
        /** @return string */
        abstract public function getDisplayName();
    }
    
Loading history...
1714
1715
		// Disable subsite filter for these pages
1716
		if($pages instanceof DataList) {
1717
			return $pages->setDataQueryParam('Subsite.filter', false);
1718
		} else {
1719
			return $pages;
1720
		}
1721
	}
1722
1723
	/**
1724
	 * Returns a FieldList with which to create the main editing form.
1725
	 *
1726
	 * You can override this in your child classes to add extra fields - first get the parent fields using
1727
	 * parent::getCMSFields(), then use addFieldToTab() on the FieldList.
1728
	 *
1729
	 * See {@link getSettingsFields()} for a different set of fields concerned with configuration aspects on the record,
1730
	 * e.g. access control.
1731
	 *
1732
	 * @return FieldList The fields to be displayed in the CMS
1733
	 */
1734
	public function getCMSFields() {
1735
		require_once("forms/Form.php");
1736
		// Status / message
1737
		// Create a status message for multiple parents
1738
		if($this->ID && is_numeric($this->ID)) {
1739
			$linkedPages = $this->VirtualPages();
1740
1741
			$parentPageLinks = array();
1742
1743
			if($linkedPages->Count() > 0) {
1744
				foreach($linkedPages as $linkedPage) {
1745
					$parentPage = $linkedPage->Parent;
1746
					if($parentPage) {
1747
						if($parentPage->ID) {
1748
							$parentPageLinks[] = "<a class=\"cmsEditlink\" href=\"admin/pages/edit/show/$linkedPage->ID\">{$parentPage->Title}</a>";
1749
						} else {
1750
							$parentPageLinks[] = "<a class=\"cmsEditlink\" href=\"admin/pages/edit/show/$linkedPage->ID\">" .
1751
								_t('SiteTree.TOPLEVEL', 'Site Content (Top Level)') .
1752
								"</a>";
1753
						}
1754
					}
1755
				}
1756
1757
				$lastParent = array_pop($parentPageLinks);
1758
				$parentList = "'$lastParent'";
1759
1760
				if(count($parentPageLinks) > 0) {
1761
					$parentList = "'" . implode("', '", $parentPageLinks) . "' and "
1762
						. $parentList;
1763
				}
1764
1765
				$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...
1766
					'SiteTree.APPEARSVIRTUALPAGES',
1767
					"This content also appears on the virtual pages in the {title} sections.",
1768
					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...
1769
				);
1770
			}
1771
		}
1772
1773
		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...
1774
			$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...
1775
		}
1776
1777
		$dependentNote = '';
1778
		$dependentTable = new LiteralField('DependentNote', '<p></p>');
1779
1780
		// Create a table for showing pages linked to this one
1781
		$dependentPages = $this->DependentPages();
1782
		$dependentPagesCount = $dependentPages->Count();
1783
		if($dependentPagesCount) {
1784
			$dependentColumns = array(
1785
				'Title' => $this->fieldLabel('Title'),
1786
				'AbsoluteLink' => _t('SiteTree.DependtPageColumnURL', 'URL'),
1787
				'DependentLinkType' => _t('SiteTree.DependtPageColumnLinkType', 'Link type'),
1788
			);
1789
			if(class_exists('Subsite')) $dependentColumns['Subsite.Title'] = singleton('Subsite')->i18n_singular_name();
1790
1791
			$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>');
1792
			$dependentTable = GridField::create(
1793
				'DependentPages',
1794
				false,
1795
				$dependentPages
1796
			);
1797
			$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...
1798
				->setDisplayFields($dependentColumns)
1799
				->setFieldFormatting(array(
1800
					'Title' => function($value, &$item) {
1801
						return sprintf(
1802
							'<a href="admin/pages/edit/show/%d">%s</a>',
1803
							(int)$item->ID,
1804
							Convert::raw2xml($item->Title)
1805
						);
1806
					},
1807
					'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...
1808
						return sprintf(
1809
							'<a href="%s" target="_blank">%s</a>',
1810
							Convert::raw2xml($value),
1811
							Convert::raw2xml($value)
1812
						);
1813
					}
1814
				));
1815
		}
1816
1817
		$baseLink = Controller::join_links (
1818
			Director::absoluteBaseURL(),
1819
			(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...
1820
		);
1821
1822
		$urlsegment = SiteTreeURLSegmentField::create("URLSegment", $this->fieldLabel('URLSegment'))
1823
			->setURLPrefix($baseLink)
1824
			->setDefaultURL($this->generateURLSegment(_t(
1825
				'CMSMain.NEWPAGE',
1826
				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...
1827
			)));
1828
		$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...
1829
		if(!Config::inst()->get('URLSegmentFilter', 'default_allow_multibyte')) {
1830
			$helpText .= $helpText ? '<br />' : '';
1831
			$helpText .= _t('SiteTreeURLSegmentField.HelpChars', ' Special characters are automatically converted or removed.');
1832
		}
1833
		$urlsegment->setHelpText($helpText);
1834
1835
		$fields = new FieldList(
1836
			$rootTab = new TabSet("Root",
1837
				$tabMain = new Tab('Main',
1838
					new TextField("Title", $this->fieldLabel('Title')),
1839
					$urlsegment,
1840
					new TextField("MenuTitle", $this->fieldLabel('MenuTitle')),
1841
					$htmlField = new HTMLEditorField("Content", _t('SiteTree.HTMLEDITORTITLE', "Content", 'HTML editor title')),
1842
					ToggleCompositeField::create('Metadata', _t('SiteTree.MetadataToggle', 'Metadata'),
1843
						array(
1844
							$metaFieldDesc = new TextareaField("MetaDescription", $this->fieldLabel('MetaDescription')),
1845
							$metaFieldExtra = new TextareaField("ExtraMeta",$this->fieldLabel('ExtraMeta'))
1846
						)
1847
					)->setHeadingLevel(4)
1848
				),
1849
				$tabDependent = new Tab('Dependent',
1850
					$dependentNote,
1851
					$dependentTable
1852
				)
1853
			)
1854
		);
1855
		$htmlField->addExtraClass('stacked');
1856
1857
		// Help text for MetaData on page content editor
1858
		$metaFieldDesc
1859
			->setRightTitle(
1860
				_t(
1861
					'SiteTree.METADESCHELP',
1862
					"Search engines use this content for displaying search results (although it will not influence their ranking)."
1863
				)
1864
			)
1865
			->addExtraClass('help');
1866
		$metaFieldExtra
1867
			->setRightTitle(
1868
				_t(
1869
					'SiteTree.METAEXTRAHELP',
1870
					"HTML tags for additional meta information. For example &lt;meta name=\"customName\" content=\"your custom content here\" /&gt;"
1871
				)
1872
			)
1873
			->addExtraClass('help');
1874
1875
		// Conditional dependent pages tab
1876
		if($dependentPagesCount) $tabDependent->setTitle(_t('SiteTree.TABDEPENDENT', "Dependent pages") . " ($dependentPagesCount)");
1877
		else $fields->removeFieldFromTab('Root', 'Dependent');
1878
1879
		$tabMain->setTitle(_t('SiteTree.TABCONTENT', "Main Content"));
1880
1881
		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...
1882
			$obsoleteWarning = _t(
1883
				'SiteTree.OBSOLETECLASS',
1884
				"This page is of obsolete type {type}. Saving will reset its type and you may lose data",
1885
				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...
1886
			);
1887
1888
			$fields->addFieldToTab(
1889
				"Root.Main",
1890
				new LiteralField("ObsoleteWarningHeader", "<p class=\"message warning\">$obsoleteWarning</p>"),
1891
				"Title"
1892
			);
1893
		}
1894
1895
		if(file_exists(BASE_PATH . '/install.php')) {
1896
			$fields->addFieldToTab("Root.Main", new LiteralField("InstallWarningHeader",
1897
				"<p class=\"message warning\">" . _t("SiteTree.REMOVE_INSTALL_WARNING",
1898
				"Warning: You should remove install.php from this SilverStripe install for security reasons.")
1899
				. "</p>"), "Title");
1900
		}
1901
1902
		// Backwards compat: Rewrite nested "Content" tabs to toplevel
1903
		$fields->setTabPathRewrites(array(
1904
			'/^Root\.Content\.Main$/' => 'Root.Main',
1905
			'/^Root\.Content\.([^.]+)$/' => 'Root.\\1',
1906
		));
1907
1908
		if(self::$runCMSFieldsExtensions) {
1909
			$this->extend('updateCMSFields', $fields);
1910
		}
1911
1912
		return $fields;
1913
	}
1914
1915
1916
	/**
1917
	 * Returns fields related to configuration aspects on this record, e.g. access control. See {@link getCMSFields()}
1918
	 * for content-related fields.
1919
	 *
1920
	 * @return FieldList
1921
	 */
1922
	public function getSettingsFields() {
1923
		$groupsMap = array();
1924
		foreach(Group::get() as $group) {
1925
			// Listboxfield values are escaped, use ASCII char instead of &raquo;
1926
			$groupsMap[$group->ID] = $group->getBreadcrumbs(' > ');
1927
		}
1928
		asort($groupsMap);
1929
1930
		$fields = new FieldList(
1931
			$rootTab = new TabSet("Root",
1932
				$tabBehaviour = new Tab('Settings',
1933
					new DropdownField(
1934
						"ClassName",
1935
						$this->fieldLabel('ClassName'),
1936
						$this->getClassDropdown()
1937
					),
1938
					$parentTypeSelector = new CompositeField(
1939
						new OptionsetField("ParentType", _t("SiteTree.PAGELOCATION", "Page location"), array(
1940
							"root" => _t("SiteTree.PARENTTYPE_ROOT", "Top-level page"),
1941
							"subpage" => _t("SiteTree.PARENTTYPE_SUBPAGE", "Sub-page underneath a parent page"),
1942
						)),
1943
						$parentIDField = new TreeDropdownField("ParentID", $this->fieldLabel('ParentID'), 'SiteTree', 'ID', 'MenuTitle')
1944
					),
1945
					$visibility = new FieldGroup(
1946
						new CheckboxField("ShowInMenus", $this->fieldLabel('ShowInMenus')),
1947
						new CheckboxField("ShowInSearch", $this->fieldLabel('ShowInSearch'))
1948
					),
1949
					$viewersOptionsField = new OptionsetField(
1950
						"CanViewType",
1951
						_t('SiteTree.ACCESSHEADER', "Who can view this page?")
1952
					),
1953
					$viewerGroupsField = ListboxField::create("ViewerGroups", _t('SiteTree.VIEWERGROUPS', "Viewer Groups"))
1954
						->setSource($groupsMap)
1955
						->setAttribute(
1956
							'data-placeholder',
1957
							_t('SiteTree.GroupPlaceholder', 'Click to select group')
1958
						),
1959
					$editorsOptionsField = new OptionsetField(
1960
						"CanEditType",
1961
						_t('SiteTree.EDITHEADER', "Who can edit this page?")
1962
					),
1963
					$editorGroupsField = ListboxField::create("EditorGroups", _t('SiteTree.EDITORGROUPS', "Editor Groups"))
1964
						->setSource($groupsMap)
1965
						->setAttribute(
1966
							'data-placeholder',
1967
							_t('SiteTree.GroupPlaceholder', 'Click to select group')
1968
						)
1969
				)
1970
			)
1971
		);
1972
1973
		$visibility->setTitle($this->fieldLabel('Visibility'));
1974
1975
1976
		// This filter ensures that the ParentID dropdown selection does not show this node,
1977
		// or its descendents, as this causes vanishing bugs
1978
		$parentIDField->setFilterFunction(create_function('$node', "return \$node->ID != {$this->ID};"));
1979
		$parentTypeSelector->addExtraClass('parentTypeSelector');
1980
1981
		$tabBehaviour->setTitle(_t('SiteTree.TABBEHAVIOUR', "Behavior"));
1982
1983
		// Make page location fields read-only if the user doesn't have the appropriate permission
1984
		if(!Permission::check("SITETREE_REORGANISE")) {
1985
			$fields->makeFieldReadonly('ParentType');
1986
			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...
1987
				$fields->removeByName('ParentID');
1988
			} else {
1989
				$fields->makeFieldReadonly('ParentID');
1990
			}
1991
		}
1992
1993
		$viewersOptionsSource = array();
1994
		$viewersOptionsSource["Inherit"] = _t('SiteTree.INHERIT', "Inherit from parent page");
1995
		$viewersOptionsSource["Anyone"] = _t('SiteTree.ACCESSANYONE', "Anyone");
1996
		$viewersOptionsSource["LoggedInUsers"] = _t('SiteTree.ACCESSLOGGEDIN', "Logged-in users");
1997
		$viewersOptionsSource["OnlyTheseUsers"] = _t('SiteTree.ACCESSONLYTHESE', "Only these people (choose from list)");
1998
		$viewersOptionsField->setSource($viewersOptionsSource);
1999
2000
		$editorsOptionsSource = array();
2001
		$editorsOptionsSource["Inherit"] = _t('SiteTree.INHERIT', "Inherit from parent page");
2002
		$editorsOptionsSource["LoggedInUsers"] = _t('SiteTree.EDITANYONE', "Anyone who can log-in to the CMS");
2003
		$editorsOptionsSource["OnlyTheseUsers"] = _t('SiteTree.EDITONLYTHESE', "Only these people (choose from list)");
2004
		$editorsOptionsField->setSource($editorsOptionsSource);
2005
2006
		if(!Permission::check('SITETREE_GRANT_ACCESS')) {
2007
			$fields->makeFieldReadonly($viewersOptionsField);
2008
			if($this->CanViewType == 'OnlyTheseUsers') {
2009
				$fields->makeFieldReadonly($viewerGroupsField);
2010
			} else {
2011
				$fields->removeByName('ViewerGroups');
2012
			}
2013
2014
			$fields->makeFieldReadonly($editorsOptionsField);
2015
			if($this->CanEditType == 'OnlyTheseUsers') {
2016
				$fields->makeFieldReadonly($editorGroupsField);
2017
			} else {
2018
				$fields->removeByName('EditorGroups');
2019
			}
2020
		}
2021
2022
		if(self::$runCMSFieldsExtensions) {
2023
			$this->extend('updateSettingsFields', $fields);
2024
		}
2025
2026
		return $fields;
2027
	}
2028
2029
	/**
2030
	 * @param bool $includerelations A boolean value to indicate if the labels returned should include relation fields
2031
	 * @return array
2032
	 */
2033
	public function fieldLabels($includerelations = true) {
2034
		$cacheKey = $this->class . '_' . $includerelations;
2035
		if(!isset(self::$_cache_field_labels[$cacheKey])) {
2036
			$labels = parent::fieldLabels($includerelations);
2037
			$labels['Title'] = _t('SiteTree.PAGETITLE', "Page name");
2038
			$labels['MenuTitle'] = _t('SiteTree.MENUTITLE', "Navigation label");
2039
			$labels['MetaDescription'] = _t('SiteTree.METADESC', "Meta Description");
2040
			$labels['ExtraMeta'] = _t('SiteTree.METAEXTRA', "Custom Meta Tags");
2041
			$labels['ClassName'] = _t('SiteTree.PAGETYPE', "Page type", 'Classname of a page object');
2042
			$labels['ParentType'] = _t('SiteTree.PARENTTYPE', "Page location");
2043
			$labels['ParentID'] = _t('SiteTree.PARENTID', "Parent page");
2044
			$labels['ShowInMenus'] =_t('SiteTree.SHOWINMENUS', "Show in menus?");
2045
			$labels['ShowInSearch'] = _t('SiteTree.SHOWINSEARCH', "Show in search?");
2046
			$labels['ProvideComments'] = _t('SiteTree.ALLOWCOMMENTS', "Allow comments on this page?");
2047
			$labels['ViewerGroups'] = _t('SiteTree.VIEWERGROUPS', "Viewer Groups");
2048
			$labels['EditorGroups'] = _t('SiteTree.EDITORGROUPS', "Editor Groups");
2049
			$labels['URLSegment'] = _t('SiteTree.URLSegment', 'URL Segment', 'URL for this page');
2050
			$labels['Content'] = _t('SiteTree.Content', 'Content', 'Main HTML Content for a page');
2051
			$labels['CanViewType'] = _t('SiteTree.Viewers', 'Viewers Groups');
2052
			$labels['CanEditType'] = _t('SiteTree.Editors', 'Editors Groups');
2053
			$labels['Comments'] = _t('SiteTree.Comments', 'Comments');
2054
			$labels['Visibility'] = _t('SiteTree.Visibility', 'Visibility');
2055
			$labels['LinkChangeNote'] = _t (
2056
				'SiteTree.LINKCHANGENOTE', 'Changing this page\'s link will also affect the links of all child pages.'
2057
			);
2058
2059
			if($includerelations){
2060
				$labels['Parent'] = _t('SiteTree.has_one_Parent', 'Parent Page', 'The parent page in the site hierarchy');
2061
				$labels['LinkTracking'] = _t('SiteTree.many_many_LinkTracking', 'Link Tracking');
2062
				$labels['ImageTracking'] = _t('SiteTree.many_many_ImageTracking', 'Image Tracking');
2063
				$labels['BackLinkTracking'] = _t('SiteTree.many_many_BackLinkTracking', 'Backlink Tracking');
2064
			}
2065
2066
			self::$_cache_field_labels[$cacheKey] = $labels;
2067
		}
2068
2069
		return self::$_cache_field_labels[$cacheKey];
2070
	}
2071
2072
	/**
2073
	 * Get the actions available in the CMS for this page - eg Save, Publish.
2074
	 *
2075
	 * Frontend scripts and styles know how to handle the following FormFields:
2076
	 * - top-level FormActions appear as standalone buttons
2077
	 * - top-level CompositeField with FormActions within appear as grouped buttons
2078
	 * - TabSet & Tabs appear as a drop ups
2079
	 * - FormActions within the Tab are restyled as links
2080
	 * - major actions can provide alternate states for richer presentation (see ssui.button widget extension)
2081
	 *
2082
	 * @return FieldList The available actions for this page.
2083
	 */
2084
	public function getCMSActions() {
2085
		$existsOnLive = $this->isPublished();
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...
2086
2087
		// Major actions appear as buttons immediately visible as page actions.
2088
		$majorActions = CompositeField::create()->setName('MajorActions')->setTag('fieldset')->addExtraClass('ss-ui-buttonset noborder');
2089
2090
		// Minor options are hidden behind a drop-up and appear as links (although they are still FormActions).
2091
		$rootTabSet = new TabSet('ActionMenus');
2092
		$moreOptions = new Tab(
2093
			'MoreOptions',
2094
			_t('SiteTree.MoreOptions', 'More options', 'Expands a view for more buttons')
2095
		);
2096
		$rootTabSet->push($moreOptions);
2097
		$rootTabSet->addExtraClass('ss-ui-action-tabset action-menus noborder');
2098
2099
		// Render page information into the "more-options" drop-up, on the top.
2100
		$live = Versioned::get_one_by_stage('SiteTree', Versioned::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...
2101
			'"SiteTree"."ID"' => $this->ID
2102
		));
2103
		$moreOptions->push(
2104
			new LiteralField('Information',
2105
				$this->customise(array(
2106
					'Live' => $live,
2107
					'ExistsOnLive' => $existsOnLive
2108
				))->renderWith('SiteTree_Information')
2109
			)
2110
		);
2111
2112
		$moreOptions->push(AddToCampaignHandler_FormAction::create());
2113
2114
		// "readonly"/viewing version that isn't the current version of the record
2115
		$stageOrLiveRecord = Versioned::get_one_by_stage($this->class, Versioned::get_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...
2116
			'"SiteTree"."ID"' => $this->ID
2117
		));
2118
		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...
2119
			$moreOptions->push(FormAction::create('email', _t('CMSMain.EMAIL', 'Email')));
2120
			$moreOptions->push(FormAction::create('rollback', _t('CMSMain.ROLLBACK', 'Roll back to this version')));
2121
2122
			$actions = new FieldList(array($majorActions, $rootTabSet));
2123
2124
			// getCMSActions() can be extended with updateCMSActions() on a extension
2125
			$this->extend('updateCMSActions', $actions);
2126
2127
			return $actions;
2128
		}
2129
2130
		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...
2131
			// "unpublish"
2132
			$moreOptions->push(
2133
				FormAction::create('unpublish', _t('SiteTree.BUTTONUNPUBLISH', 'Unpublish'), 'delete')
2134
					->setDescription(_t('SiteTree.BUTTONUNPUBLISHDESC', 'Remove this page from the published site'))
2135
					->addExtraClass('ss-ui-action-destructive')
2136
			);
2137
		}
2138
2139
		if($this->stagesDiffer(Versioned::DRAFT, Versioned::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...
2140
			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...
2141
				// "rollback"
2142
				$moreOptions->push(
2143
					FormAction::create('rollback', _t('SiteTree.BUTTONCANCELDRAFT', 'Cancel draft changes'), 'delete')
2144
						->setDescription(_t('SiteTree.BUTTONCANCELDRAFTDESC', 'Delete your draft and revert to the currently published page'))
2145
				);
2146
			}
2147
		}
2148
2149
		if($this->canEdit()) {
2150
			if($this->getIsDeletedFromStage()) {
2151
				// The usual major actions are not available, so we provide alternatives here.
2152
				if($existsOnLive) {
2153
					// "restore"
2154
					$majorActions->push(FormAction::create('revert',_t('CMSMain.RESTORE','Restore')));
2155
					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...
2156
						// "delete from live"
2157
						$majorActions->push(
2158
							FormAction::create('deletefromlive',_t('CMSMain.DELETEFP','Delete'))
2159
								->addExtraClass('ss-ui-action-destructive')
2160
						);
2161
					}
2162
				} else {
2163
					// Determine if we should force a restore to root (where once it was a subpage)
2164
					$restoreToRoot = $this->isParentArchived();
2165
2166
					// "restore"
2167
					$title = $restoreToRoot
2168
						? _t('CMSMain.RESTORE_TO_ROOT','Restore draft at top level')
2169
						: _t('CMSMain.RESTORE','Restore draft');
2170
					$description = $restoreToRoot
2171
						? _t('CMSMain.RESTORE_TO_ROOT_DESC','Restore the archived version to draft as a top level page')
2172
						: _t('CMSMain.RESTORE_DESC', 'Restore the archived version to draft');
2173
					$majorActions->push(
2174
						FormAction::create('restore', $title)
2175
							->setDescription($description)
2176
							->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...
2177
							->setAttribute('data-icon', 'decline')
2178
					);
2179
				}
2180
			} else {
2181
					if($this->canDelete()) {
2182
						// delete
2183
						$moreOptions->push(
2184
							FormAction::create('delete',_t('CMSMain.DELETE','Delete draft'))
2185
								->addExtraClass('delete ss-ui-action-destructive')
2186
						);
2187
					}
2188
				if($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...
2189
					// "archive"
2190
					$moreOptions->push(
2191
						FormAction::create('archive',_t('CMSMain.ARCHIVE','Archive'))
2192
							->setDescription(_t(
2193
								'SiteTree.BUTTONARCHIVEDESC',
2194
								'Unpublish and send to archive'
2195
							))
2196
							->addExtraClass('delete ss-ui-action-destructive')
2197
					);
2198
				}
2199
2200
				// "save", supports an alternate state that is still clickable, but notifies the user that the action is not needed.
2201
				$majorActions->push(
2202
					FormAction::create('save', _t('SiteTree.BUTTONSAVED', 'Saved'))
2203
						->setAttribute('data-icon', 'accept')
2204
						->setAttribute('data-icon-alternate', 'addpage')
2205
						->setAttribute('data-text-alternate', _t('CMSMain.SAVEDRAFT','Save draft'))
2206
				);
2207
			}
2208
		}
2209
2210
		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...
2211
			// "publish", as with "save", it supports an alternate state to show when action is needed.
2212
			$majorActions->push(
2213
				$publish = FormAction::create('publish', _t('SiteTree.BUTTONPUBLISHED', 'Published'))
2214
					->setAttribute('data-icon', 'accept')
2215
					->setAttribute('data-icon-alternate', 'disk')
2216
					->setAttribute('data-text-alternate', _t('SiteTree.BUTTONSAVEPUBLISH', 'Save & publish'))
2217
			);
2218
2219
			// Set up the initial state of the button to reflect the state of the underlying SiteTree object.
2220
			if($this->stagesDiffer(Versioned::DRAFT, Versioned::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...
2221
				$publish->addExtraClass('ss-ui-alternate');
2222
			}
2223
		}
2224
2225
		$actions = new FieldList(array($majorActions, $rootTabSet));
2226
2227
		// Hook for extensions to add/remove actions.
2228
		$this->extend('updateCMSActions', $actions);
2229
2230
		return $actions;
2231
	}
2232
2233
	public function onAfterPublish() {
2234
		// Force live sort order to match stage sort order
2235
		DB::prepared_query('UPDATE "SiteTree_Live"
2236
			SET "Sort" = (SELECT "SiteTree"."Sort" FROM "SiteTree" WHERE "SiteTree_Live"."ID" = "SiteTree"."ID")
2237
			WHERE EXISTS (SELECT "SiteTree"."Sort" FROM "SiteTree" WHERE "SiteTree_Live"."ID" = "SiteTree"."ID") AND "ParentID" = ?',
2238
			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...
2239
		);
2240
		}
2241
2242
	/**
2243
	 * Update draft dependant pages
2244
	 */
2245
	public function onAfterRevertToLive() {
2246
		// Use an alias to get the updates made by $this->publish
2247
		/** @var SiteTree $stageSelf */
2248
		$stageSelf = Versioned::get_by_stage('SiteTree', Versioned::DRAFT)->byID($this->ID);
2249
		$stageSelf->writeWithoutVersion();
0 ignored issues
show
Documentation Bug introduced by
The method writeWithoutVersion 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...
2250
2251
		// Need to update pages linking to this one as no longer broken
2252
		foreach($stageSelf->DependentPages() as $page) {
2253
			/** @var SiteTree $page */
2254
			$page->writeWithoutVersion();
0 ignored issues
show
Documentation Bug introduced by
The method writeWithoutVersion 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...
2255
		}
2256
	}
2257
2258
	/**
2259
	 * Determine if this page references a parent which is archived, and not available in stage
2260
	 *
2261
	 * @return bool True if there is an archived parent
2262
	 */
2263
	protected function isParentArchived() {
2264
		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...
2265
			$parentPage = Versioned::get_latest_version("SiteTree", $parentID);
2266
			if(!$parentPage || $parentPage->IsDeletedFromStage) {
2267
				return true;
2268
			}
2269
		}
2270
		return false;
2271
	}
2272
2273
	/**
2274
	 * Restore the content in the active copy of this SiteTree page to the stage site.
2275
	 *
2276
	 * @return self
2277
	 */
2278
	public function doRestoreToStage() {
2279
		$this->invokeWithExtensions('onBeforeRestoreToStage', $this);
2280
2281
		// Ensure that the parent page is restored, otherwise restore to root
2282
		if($this->isParentArchived()) {
2283
			$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...
2284
		}
2285
2286
		// if no record can be found on draft stage (meaning it has been "deleted from draft" before),
2287
		// create an empty record
2288
		if(!DB::prepared_query("SELECT \"ID\" FROM \"SiteTree\" WHERE \"ID\" = ?", array($this->ID))->value()) {
2289
			$conn = DB::get_conn();
2290
			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...
2291
			DB::prepared_query("INSERT INTO \"SiteTree\" (\"ID\") VALUES (?)", array($this->ID));
2292
			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...
2293
		}
2294
2295
		$oldStage = Versioned::get_stage();
2296
		Versioned::set_stage(Versioned::DRAFT);
2297
		$this->forceChange();
2298
		$this->write();
2299
2300
		$result = DataObject::get_by_id($this->class, $this->ID);
2301
2302
		// Need to update pages linking to this one as no longer broken
2303
		foreach($result->DependentPages(false) as $page) {
2304
			// $page->write() calls syncLinkTracking, which does all the hard work for us.
2305
			$page->write();
2306
		}
2307
2308
		Versioned::set_stage($oldStage);
2309
2310
		$this->invokeWithExtensions('onAfterRestoreToStage', $this);
2311
2312
		return $result;
2313
	}
2314
2315
	/**
2316
	 * Check if this page is new - that is, if it has yet to have been written to the database.
2317
	 *
2318
	 * @return bool
2319
	 */
2320
	public function isNew() {
2321
		/**
2322
		 * This check was a problem for a self-hosted site, and may indicate a bug in the interpreter on their server,
2323
		 * or a bug here. Changing the condition from empty($this->ID) to !$this->ID && !$this->record['ID'] fixed this.
2324
		 */
2325
		if(empty($this->ID)) return true;
2326
2327
		if(is_numeric($this->ID)) return false;
2328
2329
		return stripos($this->ID, 'new') === 0;
2330
	}
2331
2332
	/**
2333
	 * Get the class dropdown used in the CMS to change the class of a page. This returns the list of options in the
2334
	 * dropdown as a Map from class name to singular name. Filters by {@link SiteTree->canCreate()}, as well as
2335
	 * {@link SiteTree::$needs_permission}.
2336
	 *
2337
	 * @return array
2338
	 */
2339
	protected function getClassDropdown() {
2340
		$classes = self::page_type_classes();
2341
		$currentClass = null;
2342
		$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...
2343
2344
		$result = array();
2345
		foreach($classes as $class) {
2346
			$instance = singleton($class);
2347
2348
			// if the current page type is this the same as the class type always show the page type in the list
2349
			if ($this->ClassName != $instance->ClassName) {
2350
				if($instance instanceof HiddenClass) continue;
2351
				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...
2352
			}
2353
2354
			if($perms = $instance->stat('need_permission')) {
2355
				if(!$this->can($perms)) continue;
2356
			}
2357
2358
			$pageTypeName = $instance->i18n_singular_name();
2359
2360
			$currentClass = $class;
2361
			$result[$class] = $pageTypeName;
2362
2363
			// If we're in translation mode, the link between the translated pagetype title and the actual classname
2364
			// might not be obvious, so we add it in parantheses. Example: class "RedirectorPage" has the title
2365
			// "Weiterleitung" in German, so it shows up as "Weiterleitung (RedirectorPage)"
2366
			if(i18n::get_lang_from_locale(i18n::get_locale()) != 'en') {
2367
				$result[$class] = $result[$class] .  " ({$class})";
2368
			}
2369
		}
2370
2371
		// sort alphabetically, and put current on top
2372
		asort($result);
2373
		if($currentClass) {
2374
			$currentPageTypeName = $result[$currentClass];
2375
			unset($result[$currentClass]);
2376
			$result = array_reverse($result);
2377
			$result[$currentClass] = $currentPageTypeName;
2378
			$result = array_reverse($result);
2379
		}
2380
2381
		return $result;
2382
	}
2383
2384
	/**
2385
	 * Returns an array of the class names of classes that are allowed to be children of this class.
2386
	 *
2387
	 * @return string[]
2388
	 */
2389
	public function allowedChildren() {
2390
		$allowedChildren = array();
2391
		$candidates = $this->stat('allowed_children');
2392
		if($candidates && $candidates != "none" && $candidates != "SiteTree_root") {
2393
			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...
2394
				// If a classname is prefixed by "*", such as "*Page", then only that class is allowed - no subclasses.
2395
				// Otherwise, the class and all its subclasses are allowed.
2396
				if(substr($candidate,0,1) == '*') {
2397
					$allowedChildren[] = substr($candidate,1);
2398
				} else {
2399
					$subclasses = ClassInfo::subclassesFor($candidate);
2400
					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...
2401
						if($subclass != "SiteTree_root") $allowedChildren[] = $subclass;
2402
					}
2403
				}
2404
			}
2405
		}
2406
2407
		return $allowedChildren;
2408
	}
2409
2410
	/**
2411
	 * Returns the class name of the default class for children of this page.
2412
	 *
2413
	 * @return string
2414
	 */
2415
	public function defaultChild() {
2416
		$default = $this->stat('default_child');
2417
		$allowed = $this->allowedChildren();
2418
		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...
2419
			if(!$default || !in_array($default, $allowed))
2420
				$default = reset($allowed);
2421
			return $default;
2422
		}
2423
	}
2424
2425
	/**
2426
	 * Returns the class name of the default class for the parent of this page.
2427
	 *
2428
	 * @return string
2429
	 */
2430
	public function defaultParent() {
2431
		return $this->stat('default_parent');
2432
	}
2433
2434
	/**
2435
	 * Get the title for use in menus for this page. If the MenuTitle field is set it returns that, else it returns the
2436
	 * Title field.
2437
	 *
2438
	 * @return string
2439
	 */
2440
	public function getMenuTitle(){
2441
		if($value = $this->getField("MenuTitle")) {
2442
			return $value;
2443
		} else {
2444
			return $this->getField("Title");
2445
		}
2446
	}
2447
2448
2449
	/**
2450
	 * Set the menu title for this page.
2451
	 *
2452
	 * @param string $value
2453
	 */
2454
	public function setMenuTitle($value) {
2455
		if($value == $this->getField("Title")) {
2456
			$this->setField("MenuTitle", null);
2457
		} else {
2458
			$this->setField("MenuTitle", $value);
2459
		}
2460
	}
2461
2462
	/**
2463
	 * A flag provides the user with additional data about the current page status, for example a "removed from draft"
2464
	 * status. Each page can have more than one status flag. Returns a map of a unique key to a (localized) title for
2465
	 * the flag. The unique key can be reused as a CSS class. Use the 'updateStatusFlags' extension point to customize
2466
	 * the flags.
2467
	 *
2468
	 * Example (simple):
2469
	 *   "deletedonlive" => "Deleted"
2470
	 *
2471
	 * Example (with optional title attribute):
2472
	 *   "deletedonlive" => array('text' => "Deleted", 'title' => 'This page has been deleted')
2473
	 *
2474
	 * @param bool $cached Whether to serve the fields from cache; false regenerate them
2475
	 * @return array
2476
	 */
2477
	public function getStatusFlags($cached = true) {
2478
		if(!$this->_cache_statusFlags || !$cached) {
2479
			$flags = array();
2480
			if($this->getIsDeletedFromStage()) {
2481
				if($this->isPublished()) {
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...
2482
					$flags['removedfromdraft'] = array(
2483
						'text' => _t('SiteTree.REMOVEDFROMDRAFTSHORT', 'Removed from draft'),
2484
						'title' => _t('SiteTree.REMOVEDFROMDRAFTHELP', 'Page is published, but has been deleted from draft'),
2485
					);
2486
				} else {
2487
					$flags['archived'] = array(
2488
						'text' => _t('SiteTree.ARCHIVEDPAGESHORT', 'Archived'),
2489
						'title' => _t('SiteTree.ARCHIVEDPAGEHELP', 'Page is removed from draft and live'),
2490
					);
2491
				}
2492
			} else if($this->getIsAddedToStage()) {
2493
				$flags['addedtodraft'] = array(
2494
					'text' => _t('SiteTree.ADDEDTODRAFTSHORT', 'Draft'),
2495
					'title' => _t('SiteTree.ADDEDTODRAFTHELP', "Page has not been published yet")
2496
				);
2497
			} else if($this->getIsModifiedOnStage()) {
2498
				$flags['modified'] = array(
2499
					'text' => _t('SiteTree.MODIFIEDONDRAFTSHORT', 'Modified'),
2500
					'title' => _t('SiteTree.MODIFIEDONDRAFTHELP', 'Page has unpublished changes'),
2501
				);
2502
			}
2503
2504
			$this->extend('updateStatusFlags', $flags);
2505
2506
			$this->_cache_statusFlags = $flags;
2507
		}
2508
2509
		return $this->_cache_statusFlags;
2510
	}
2511
2512
	/**
2513
	 * getTreeTitle will return three <span> html DOM elements, an empty <span> with the class 'jstree-pageicon' in
2514
	 * front, following by a <span> wrapping around its MenutTitle, then following by a <span> indicating its
2515
	 * publication status.
2516
	 *
2517
	 * @return string An HTML string ready to be directly used in a template
2518
	 */
2519
	public function getTreeTitle() {
2520
		// Build the list of candidate children
2521
		$children = array();
2522
		$candidates = static::page_type_classes();
2523
		foreach($this->allowedChildren() as $childClass) {
2524
			if(!in_array($childClass, $candidates)) continue;
2525
			$child = singleton($childClass);
2526
			if($child->canCreate(null, array('Parent' => $this))) {
2527
				$children[$childClass] = $child->i18n_singular_name();
2528
			}
2529
		}
2530
		$flags = $this->getStatusFlags();
2531
		$treeTitle = sprintf(
2532
			"<span class=\"jstree-pageicon\"></span><span class=\"item\" data-allowedchildren=\"%s\">%s</span>",
2533
			Convert::raw2att(Convert::raw2json($children)),
2534
			Convert::raw2xml(str_replace(array("\n","\r"),"",$this->MenuTitle))
2535
		);
2536
		foreach($flags as $class => $data) {
2537
			if(is_string($data)) $data = array('text' => $data);
2538
			$treeTitle .= sprintf(
2539
				"<span class=\"badge %s\"%s>%s</span>",
2540
				'status-' . Convert::raw2xml($class),
2541
				(isset($data['title'])) ? sprintf(' title="%s"', Convert::raw2xml($data['title'])) : '',
2542
				Convert::raw2xml($data['text'])
2543
			);
2544
		}
2545
2546
		return $treeTitle;
2547
	}
2548
2549
	/**
2550
	 * Returns the page in the current page stack of the given level. Level(1) will return the main menu item that
2551
	 * we're currently inside, etc.
2552
	 *
2553
	 * @param int $level
2554
	 * @return SiteTree
2555
	 */
2556
	public function Level($level) {
2557
		$parent = $this;
2558
		$stack = array($parent);
2559
		while($parent = $parent->Parent) {
2560
			array_unshift($stack, $parent);
2561
		}
2562
2563
		return isset($stack[$level-1]) ? $stack[$level-1] : null;
2564
	}
2565
2566
	/**
2567
	 * Gets the depth of this page in the sitetree, where 1 is the root level
2568
	 *
2569
	 * @return int
2570
	 */
2571
	public function getPageLevel() {
2572
		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...
2573
			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...
2574
		}
2575
		return 1;
2576
	}
2577
2578
	/**
2579
	 * Return the CSS classes to apply to this node in the CMS tree.
2580
	 *
2581
	 * @param string $numChildrenMethod
2582
	 * @return string
2583
	 */
2584
	public function CMSTreeClasses($numChildrenMethod="numChildren") {
2585
		$classes = sprintf('class-%s', $this->class);
2586
		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...
2587
			$classes .= " BrokenLink";
2588
		}
2589
2590
		if(!$this->canAddChildren()) {
2591
			$classes .= " nochildren";
2592
		}
2593
2594
		if(!$this->canEdit() && !$this->canAddChildren()) {
2595
			if (!$this->canView()) {
2596
				$classes .= " disabled";
2597
			} else {
2598
				$classes .= " edit-disabled";
2599
			}
2600
		}
2601
2602
		if(!$this->ShowInMenus) {
2603
			$classes .= " notinmenu";
2604
		}
2605
2606
		//TODO: Add integration
2607
		/*
2608
		if($this->hasExtension('Translatable') && $controller->Locale != Translatable::default_locale() && !$this->isTranslation())
2609
			$classes .= " untranslated ";
2610
		*/
2611
		$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...
2612
2613
		return $classes;
2614
	}
2615
2616
	/**
2617
	 * Compares current draft with live version, and returns true if no draft version of this page exists  but the page
2618
	 * is still published (eg, after triggering "Delete from draft site" in the CMS).
2619
	 *
2620
	 * @return bool
2621
	 */
2622
	public function getIsDeletedFromStage() {
2623
		if(!$this->ID) return true;
2624
		if($this->isNew()) return false;
2625
2626
		$stageVersion = Versioned::get_versionnumber_by_stage('SiteTree', Versioned::DRAFT, $this->ID);
2627
2628
		// Return true for both completely deleted pages and for pages just deleted from stage
2629
		return !($stageVersion);
2630
	}
2631
2632
	/**
2633
	 * Return true if this page exists on the live site
2634
	 *
2635
	 * @return bool
2636
	 */
2637
	public function getExistsOnLive() {
2638
		return $this->isPublished();
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...
2639
	}
2640
2641
	/**
2642
	 * Compares current draft with live version, and returns true if these versions differ, meaning there have been
2643
	 * unpublished changes to the draft site.
2644
	 *
2645
	 * @return bool
2646
	 */
2647
	public function getIsModifiedOnStage() {
2648
		// New unsaved pages could be never be published
2649
		if($this->isNew()) return false;
2650
2651
		$stageVersion = Versioned::get_versionnumber_by_stage('SiteTree', 'Stage', $this->ID);
2652
		$liveVersion =	Versioned::get_versionnumber_by_stage('SiteTree', 'Live', $this->ID);
2653
2654
		$isModified = ($stageVersion && $stageVersion != $liveVersion);
2655
		$this->extend('getIsModifiedOnStage', $isModified);
2656
2657
		return $isModified;
2658
	}
2659
2660
	/**
2661
	 * Compares current draft with live version, and returns true if no live version exists, meaning the page was never
2662
	 * published.
2663
	 *
2664
	 * @return bool
2665
	 */
2666
	public function getIsAddedToStage() {
2667
		// New unsaved pages could be never be published
2668
		if($this->isNew()) return false;
2669
2670
		$stageVersion = Versioned::get_versionnumber_by_stage('SiteTree', 'Stage', $this->ID);
2671
		$liveVersion =	Versioned::get_versionnumber_by_stage('SiteTree', 'Live', $this->ID);
2672
2673
		return ($stageVersion && !$liveVersion);
2674
	}
2675
2676
	/**
2677
	 * Stops extendCMSFields() being called on getCMSFields(). This is useful when you need access to fields added by
2678
	 * subclasses of SiteTree in a extension. Call before calling parent::getCMSFields(), and reenable afterwards.
2679
	 */
2680
	static public function disableCMSFieldsExtensions() {
2681
		self::$runCMSFieldsExtensions = false;
2682
	}
2683
2684
	/**
2685
	 * Reenables extendCMSFields() being called on getCMSFields() after it has been disabled by
2686
	 * disableCMSFieldsExtensions().
2687
	 */
2688
	static public function enableCMSFieldsExtensions() {
2689
		self::$runCMSFieldsExtensions = true;
2690
	}
2691
2692
	public function providePermissions() {
2693
		return array(
2694
			'SITETREE_GRANT_ACCESS' => array(
2695
				'name' => _t('SiteTree.PERMISSION_GRANTACCESS_DESCRIPTION', 'Manage access rights for content'),
2696
				'help' => _t('SiteTree.PERMISSION_GRANTACCESS_HELP',  'Allow setting of page-specific access restrictions in the "Pages" section.'),
2697
				'category' => _t('Permissions.PERMISSIONS_CATEGORY', 'Roles and access permissions'),
2698
				'sort' => 100
2699
			),
2700
			'SITETREE_VIEW_ALL' => array(
2701
				'name' => _t('SiteTree.VIEW_ALL_DESCRIPTION', 'View any page'),
2702
				'category' => _t('Permissions.CONTENT_CATEGORY', 'Content permissions'),
2703
				'sort' => -100,
2704
				'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')
2705
			),
2706
			'SITETREE_EDIT_ALL' => array(
2707
				'name' => _t('SiteTree.EDIT_ALL_DESCRIPTION', 'Edit any page'),
2708
				'category' => _t('Permissions.CONTENT_CATEGORY', 'Content permissions'),
2709
				'sort' => -50,
2710
				'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')
2711
			),
2712
			'SITETREE_REORGANISE' => array(
2713
				'name' => _t('SiteTree.REORGANISE_DESCRIPTION', 'Change site structure'),
2714
				'category' => _t('Permissions.CONTENT_CATEGORY', 'Content permissions'),
2715
				'help' => _t('SiteTree.REORGANISE_HELP', 'Rearrange pages in the site tree through drag&drop.'),
2716
				'sort' => 100
2717
			),
2718
			'VIEW_DRAFT_CONTENT' => array(
2719
				'name' => _t('SiteTree.VIEW_DRAFT_CONTENT', 'View draft content'),
2720
				'category' => _t('Permissions.CONTENT_CATEGORY', 'Content permissions'),
2721
				'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.'),
2722
				'sort' => 100
2723
			)
2724
		);
2725
	}
2726
2727
	/**
2728
	 * Return the translated Singular name.
2729
	 *
2730
	 * @return string
2731
	 */
2732
	public function i18n_singular_name() {
2733
		// Convert 'Page' to 'SiteTree' for correct localization lookups
2734
		$class = ($this->class == 'Page') ? 'SiteTree' : $this->class;
2735
		return _t($class.'.SINGULARNAME', $this->singular_name());
2736
	}
2737
2738
	/**
2739
	 * Overloaded to also provide entities for 'Page' class which is usually located in custom code, hence textcollector
2740
	 * picks it up for the wrong folder.
2741
	 *
2742
	 * @return array
2743
	 */
2744
	public function provideI18nEntities() {
2745
		$entities = parent::provideI18nEntities();
2746
2747
		if(isset($entities['Page.SINGULARNAME'])) $entities['Page.SINGULARNAME'][3] = CMS_DIR;
2748
		if(isset($entities['Page.PLURALNAME'])) $entities['Page.PLURALNAME'][3] = CMS_DIR;
2749
2750
		$entities[$this->class . '.DESCRIPTION'] = array(
2751
			$this->stat('description'),
2752
			'Description of the page type (shown in the "add page" dialog)'
2753
		);
2754
2755
		$entities['SiteTree.SINGULARNAME'][0] = 'Page';
2756
		$entities['SiteTree.PLURALNAME'][0] = 'Pages';
2757
2758
		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...
2759
	}
2760
2761
	/**
2762
	 * Returns 'root' if the current page has no parent, or 'subpage' otherwise
2763
	 *
2764
	 * @return string
2765
	 */
2766
	public function getParentType() {
2767
		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...
2768
	}
2769
2770
	/**
2771
	 * Clear the permissions cache for SiteTree
2772
	 */
2773
	public static function reset() {
2774
		self::$cache_permissions = array();
2775
	}
2776
2777
	static public function on_db_reset() {
2778
		self::$cache_permissions = array();
2779
	}
2780
2781
}
2782