Completed
Pull Request — master (#1538)
by Damian
03:04
created

SiteTree::onAfterDelete()   A

Complexity

Conditions 3
Paths 2

Size

Total Lines 13
Code Lines 6

Duplication

Lines 0
Ratio 0 %

Importance

Changes 1
Bugs 0 Features 0
Metric Value
c 1
b 0
f 0
dl 0
loc 13
rs 9.4285
cc 3
eloc 6
nc 2
nop 0
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
		$oldReadingMode = Versioned::get_reading_mode();
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_reading_mode($oldReadingMode);
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
	 * Check if this page can be published
903
	 *
904
	 * @param Member $member
905
	 * @return bool
906
	 */
907
	public function canPublish($member = null) {
908
		if(!$member) {
909
			$member = Member::currentUser();
910
		}
911
912
		// Check extension
913
		$extended = $this->extendedCan('canPublish', $member);
0 ignored issues
show
Documentation introduced by
$member is of type object<DataObject>|null, but the function expects a object<Member>|integer.

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...
914
		if($extended !== null) {
915
			return $extended;
916
		}
917
918
		if(Permission::checkMember($member, "ADMIN")) {
919
			return true;
920
		}
921
922
		// Default to relying on edit permission
923
		return $this->canEdit($member);
0 ignored issues
show
Bug introduced by
It seems like $member defined by \Member::currentUser() on line 909 can also be of type object<DataObject>; however, SiteTree::canEdit() does only seem to accept object<Member>|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...
924
	}
925
926
	/**
927
	 * This function should return true if the current user can delete this page. It can be overloaded to customise the
928
	 * security model for an application.
929
	 *
930
	 * Denies permission if any of the following conditions is true:
931
	 * - canDelete() returns false on any extension
932
	 * - canEdit() returns false
933
	 * - any descendant page returns false for canDelete()
934
	 *
935
	 * @uses canDelete()
936
	 * @uses SiteTreeExtension->canDelete()
937
	 * @uses canEdit()
938
	 *
939
	 * @param Member $member
940
	 * @return bool True if the current user can delete this page
941
	 */
942
	public function canDelete($member = null) {
943 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...
944
		else if(is_numeric($member)) $memberID = $member;
945
		else $memberID = Member::currentUserID();
946
947
		// Standard mechanism for accepting permission changes from extensions
948
		$extended = $this->extendedCan('canDelete', $memberID);
949
		if($extended !== null) {
950
			return $extended;
951
		}
952
953
		// Default permission check
954
		if($memberID && Permission::checkMember($memberID, array("ADMIN", "SITETREE_EDIT_ALL"))) {
955
			return true;
956
		}
957
958
		// Regular canEdit logic is handled by can_edit_multiple
959
		$results = self::can_delete_multiple(array($this->ID), $memberID);
960
961
		// If this page no longer exists in stage/live results won't contain the page.
962
		// Fail-over to false
963
		return isset($results[$this->ID]) ? $results[$this->ID] : false;
964
	}
965
966
	/**
967
	 * This function should return true if the current user can create new pages of this class, regardless of class. It
968
	 * can be overloaded to customise the security model for an application.
969
	 *
970
	 * By default, permission to create at the root level is based on the SiteConfig configuration, and permission to
971
	 * create beneath a parent is based on the ability to edit that parent page.
972
	 *
973
	 * Use {@link canAddChildren()} to control behaviour of creating children under this page.
974
	 *
975
	 * @uses $can_create
976
	 * @uses DataExtension->canCreate()
977
	 *
978
	 * @param Member $member
979
	 * @param array $context Optional array which may contain array('Parent' => $parentObj)
980
	 *                       If a parent page is known, it will be checked for validity.
981
	 *                       If omitted, it will be assumed this is to be created as a top level page.
982
	 * @return bool True if the current user can create pages on this class.
983
	 */
984
	public function canCreate($member = null, $context = array()) {
985 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...
986
			$member = Member::currentUserID();
987
		}
988
989
		// Check parent (custom canCreate option for SiteTree)
990
		// Block children not allowed for this parent type
991
		$parent = isset($context['Parent']) ? $context['Parent'] : null;
992
		if($parent && !in_array(get_class($this), $parent->allowedChildren())) {
993
			return false;
994
		}
995
996
		// Standard mechanism for accepting permission changes from extensions
997
		$extended = $this->extendedCan(__FUNCTION__, $member, $context);
998
		if($extended !== null) {
999
			return $extended;
1000
		}
1001
1002
		// Check permission
1003
		if($member && Permission::checkMember($member, "ADMIN")) {
1004
			return true;
1005
		}
1006
1007
		// Fall over to inherited permissions
1008
		if($parent) {
1009
			return $parent->canAddChildren($member);
1010
		} else {
1011
			// This doesn't necessarily mean we are creating a root page, but that
1012
			// we don't know if there is a parent, so default to this permission
1013
			return SiteConfig::current_site_config()->canCreateTopLevel($member);
1014
		}
1015
	}
1016
1017
	/**
1018
	 * This function should return true if the current user can edit this page. It can be overloaded to customise the
1019
	 * security model for an application.
1020
	 *
1021
	 * Denies permission if any of the following conditions is true:
1022
	 * - canEdit() on any extension returns false
1023
	 * - canView() return false
1024
	 * - "CanEditType" directive is set to "Inherit" and any parent page return false for canEdit()
1025
	 * - "CanEditType" directive is set to "LoggedInUsers" and no user is logged in or doesn't have the
1026
	 *   CMS_Access_CMSMAIN permission code
1027
	 * - "CanEditType" directive is set to "OnlyTheseUsers" and user is not in the given groups
1028
	 *
1029
	 * @uses canView()
1030
	 * @uses EditorGroups()
1031
	 * @uses DataExtension->canEdit()
1032
	 *
1033
	 * @param Member $member Set to false if you want to explicitly test permissions without a valid user (useful for
1034
	 *                       unit tests)
1035
	 * @return bool True if the current user can edit this page
1036
	 */
1037
	public function canEdit($member = null) {
1038 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...
1039
		else if(is_numeric($member)) $memberID = $member;
1040
		else $memberID = Member::currentUserID();
1041
1042
		// Standard mechanism for accepting permission changes from extensions
1043
		$extended = $this->extendedCan('canEdit', $memberID);
1044
		if($extended !== null) {
1045
			return $extended;
1046
		}
1047
1048
		// Default permissions
1049
		if($memberID && Permission::checkMember($memberID, array("ADMIN", "SITETREE_EDIT_ALL"))) {
1050
			return true;
1051
		}
1052
1053
		if($this->ID) {
1054
			// Regular canEdit logic is handled by can_edit_multiple
1055
			$results = self::can_edit_multiple(array($this->ID), $memberID);
1056
1057
			// If this page no longer exists in stage/live results won't contain the page.
1058
			// Fail-over to false
1059
			return isset($results[$this->ID]) ? $results[$this->ID] : false;
1060
1061
		// Default for unsaved pages
1062
		} else {
1063
			return $this->getSiteConfig()->canEditPages($member);
1064
		}
1065
	}
1066
1067
	/**
1068
	 * Stub method to get the site config, unless the current class can provide an alternate.
1069
	 *
1070
	 * @return SiteConfig
1071
	 */
1072
	public function getSiteConfig() {
1073
1074
		if($this->hasMethod('alternateSiteConfig')) {
1075
			$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...
1076
			if($altConfig) return $altConfig;
1077
		}
1078
1079
		return SiteConfig::current_site_config();
1080
	}
1081
1082
	/**
1083
	 * Pre-populate the cache of canEdit, canView, canDelete, canPublish permissions. This method will use the static
1084
	 * can_(perm)_multiple method for efficiency.
1085
	 *
1086
	 * @param string          $permission    The permission: edit, view, publish, approve, etc.
1087
	 * @param array           $ids           An array of page IDs
1088
	 * @param callable|string $batchCallback The function/static method to call to calculate permissions.  Defaults
1089
	 *                                       to 'SiteTree::can_(permission)_multiple'
1090
	 */
1091
	static public function prepopulate_permission_cache($permission = 'CanEditType', $ids, $batchCallback = null) {
1092
		if(!$batchCallback) $batchCallback = "SiteTree::can_{$permission}_multiple";
1093
1094
		if(is_callable($batchCallback)) {
1095
			call_user_func($batchCallback, $ids, Member::currentUserID(), false);
1096
		} else {
1097
			user_error("SiteTree::prepopulate_permission_cache can't calculate '$permission' "
1098
				. "with callback '$batchCallback'", E_USER_WARNING);
1099
		}
1100
	}
1101
1102
	/**
1103
	 * This method is NOT a full replacement for the individual can*() methods, e.g. {@link canEdit()}. Rather than
1104
	 * checking (potentially slow) PHP logic, it relies on the database group associations, e.g. the "CanEditType" field
1105
	 * plus the "SiteTree_EditorGroups" many-many table. By batch checking multiple records, we can combine the queries
1106
	 * efficiently.
1107
	 *
1108
	 * Caches based on $typeField data. To invalidate the cache, use {@link SiteTree::reset()} or set the $useCached
1109
	 * property to FALSE.
1110
	 *
1111
	 * @param array  $ids              Of {@link SiteTree} IDs
1112
	 * @param int    $memberID         Member ID
1113
	 * @param string $typeField        A property on the data record, e.g. "CanEditType".
1114
	 * @param string $groupJoinTable   A many-many table name on this record, e.g. "SiteTree_EditorGroups"
1115
	 * @param string $siteConfigMethod Method to call on {@link SiteConfig} for toplevel items, e.g. "canEdit"
1116
	 * @param string $globalPermission If the member doesn't have this permission code, don't bother iterating deeper
1117
	 * @param bool   $useCached
1118
	 * @return array An map of {@link SiteTree} ID keys to boolean values
1119
	 */
1120
	public static function batch_permission_check($ids, $memberID, $typeField, $groupJoinTable, $siteConfigMethod,
1121
												  $globalPermission = null, $useCached = true) {
1122
		if($globalPermission === NULL) $globalPermission = array('CMS_ACCESS_LeftAndMain', 'CMS_ACCESS_CMSMain');
1123
1124
		// Sanitise the IDs
1125
		$ids = array_filter($ids, 'is_numeric');
1126
1127
		// This is the name used on the permission cache
1128
		// converts something like 'CanEditType' to 'edit'.
1129
		$cacheKey = strtolower(substr($typeField, 3, -4)) . "-$memberID";
1130
1131
		// Default result: nothing editable
1132
		$result = array_fill_keys($ids, false);
1133
		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...
1134
1135
			// Look in the cache for values
1136
			if($useCached && isset(self::$cache_permissions[$cacheKey])) {
1137
				$cachedValues = array_intersect_key(self::$cache_permissions[$cacheKey], $result);
1138
1139
				// If we can't find everything in the cache, then look up the remainder separately
1140
				$uncachedValues = array_diff_key($result, self::$cache_permissions[$cacheKey]);
1141
				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...
1142
					$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 1122 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...
1143
				}
1144
				return $cachedValues;
1145
			}
1146
1147
			// If a member doesn't have a certain permission then they can't edit anything
1148
			if(!$memberID || ($globalPermission && !Permission::checkMember($memberID, $globalPermission))) {
1149
				return $result;
1150
			}
1151
1152
			// Placeholder for parameterised ID list
1153
			$idPlaceholders = DB::placeholders($ids);
1154
1155
			// If page can't be viewed, don't grant edit permissions to do - implement can_view_multiple(), so this can
1156
			// be enabled
1157
			//$ids = array_keys(array_filter(self::can_view_multiple($ids, $memberID)));
1158
1159
			// Get the groups that the given member belongs to
1160
			$groupIDs = DataObject::get_by_id('Member', $memberID)->Groups()->column("ID");
1161
			$SQL_groupList = implode(", ", $groupIDs);
1162
			if (!$SQL_groupList) $SQL_groupList = '0';
1163
1164
			$combinedStageResult = array();
1165
1166
			foreach(array(Versioned::DRAFT, Versioned::LIVE) as $stage) {
1167
				// Start by filling the array with the pages that actually exist
1168
				$table = ($stage=='Stage') ? "SiteTree" : "SiteTree_$stage";
1169
1170
				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...
1171
					$idQuery = "SELECT \"ID\" FROM \"$table\" WHERE \"ID\" IN ($idPlaceholders)";
1172
					$stageIds = DB::prepared_query($idQuery, $ids)->column();
1173
				} else {
1174
					$stageIds = array();
1175
				}
1176
				$result = array_fill_keys($stageIds, false);
1177
1178
				// Get the uninherited permissions
1179
				$uninheritedPermissions = Versioned::get_by_stage("SiteTree", $stage)
1180
					->where(array(
1181
						"(\"$typeField\" = 'LoggedInUsers' OR
1182
						(\"$typeField\" = 'OnlyTheseUsers' AND \"$groupJoinTable\".\"SiteTreeID\" IS NOT NULL))
1183
						AND \"SiteTree\".\"ID\" IN ($idPlaceholders)"
1184
						=> $ids
1185
					))
1186
					->leftJoin($groupJoinTable, "\"$groupJoinTable\".\"SiteTreeID\" = \"SiteTree\".\"ID\" AND \"$groupJoinTable\".\"GroupID\" IN ($SQL_groupList)");
1187
1188
				if($uninheritedPermissions) {
1189
					// Set all the relevant items in $result to true
1190
					$result = array_fill_keys($uninheritedPermissions->column('ID'), true) + $result;
1191
				}
1192
1193
				// Get permissions that are inherited
1194
				$potentiallyInherited = Versioned::get_by_stage(
1195
					"SiteTree",
1196
					$stage,
1197
					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...
1198
				);
1199
1200
				if($potentiallyInherited) {
1201
					// Group $potentiallyInherited by ParentID; we'll look at the permission of all those parents and
1202
					// then see which ones the user has permission on
1203
					$groupedByParent = array();
1204
					foreach($potentiallyInherited as $item) {
1205
						if($item->ParentID) {
1206
							if(!isset($groupedByParent[$item->ParentID])) $groupedByParent[$item->ParentID] = array();
1207
							$groupedByParent[$item->ParentID][] = $item->ID;
1208
						} else {
1209
							// Might return different site config based on record context, e.g. when subsites module
1210
							// is used
1211
							$siteConfig = $item->getSiteConfig();
1212
							$result[$item->ID] = $siteConfig->{$siteConfigMethod}($memberID);
1213
						}
1214
					}
1215
1216
					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...
1217
						$actuallyInherited = self::batch_permission_check(array_keys($groupedByParent), $memberID, $typeField, $groupJoinTable, $siteConfigMethod);
1218
						if($actuallyInherited) {
1219
							$parentIDs = array_keys(array_filter($actuallyInherited));
1220
							foreach($parentIDs as $parentID) {
1221
								// Set all the relevant items in $result to true
1222
								$result = array_fill_keys($groupedByParent[$parentID], true) + $result;
1223
							}
1224
						}
1225
					}
1226
				}
1227
1228
				$combinedStageResult = $combinedStageResult + $result;
1229
1230
			}
1231
		}
1232
1233
		if(isset($combinedStageResult)) {
1234
			// Cache the results
1235
 			if(empty(self::$cache_permissions[$cacheKey])) self::$cache_permissions[$cacheKey] = array();
1236
 			self::$cache_permissions[$cacheKey] = $combinedStageResult + self::$cache_permissions[$cacheKey];
1237
1238
			return $combinedStageResult;
1239
		} else {
1240
			return array();
1241
		}
1242
	}
1243
1244
	/**
1245
	 * Get the 'can edit' information for a number of SiteTree pages.
1246
	 *
1247
	 * @param array $ids       An array of IDs of the SiteTree pages to look up
1248
	 * @param int   $memberID  ID of member
1249
	 * @param bool  $useCached Return values from the permission cache if they exist
1250
	 * @return array A map where the IDs are keys and the values are booleans stating whether the given page can be
1251
	 *                         edited
1252
	 */
1253
	static public function can_edit_multiple($ids, $memberID, $useCached = true) {
1254
		return self::batch_permission_check($ids, $memberID, 'CanEditType', 'SiteTree_EditorGroups', 'canEditPages', null, $useCached);
1255
	}
1256
1257
	/**
1258
	 * Get the 'can edit' information for a number of SiteTree pages.
1259
	 *
1260
	 * @param array $ids       An array of IDs of the SiteTree pages to look up
1261
	 * @param int   $memberID  ID of member
1262
	 * @param bool  $useCached Return values from the permission cache if they exist
1263
	 * @return array
1264
	 */
1265
	static public function can_delete_multiple($ids, $memberID, $useCached = true) {
1266
		$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...
1267
		$result = array_fill_keys($ids, false);
1268
		$cacheKey = "delete-$memberID";
1269
1270
		// Look in the cache for values
1271
		if($useCached && isset(self::$cache_permissions[$cacheKey])) {
1272
			$cachedValues = array_intersect_key(self::$cache_permissions[$cacheKey], $result);
1273
1274
			// If we can't find everything in the cache, then look up the remainder separately
1275
			$uncachedValues = array_diff_key($result, self::$cache_permissions[$cacheKey]);
1276
			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...
1277
				$cachedValues = self::can_delete_multiple(array_keys($uncachedValues), $memberID, false)
1278
					+ $cachedValues;
1279
			}
1280
			return $cachedValues;
1281
		}
1282
1283
		// You can only delete pages that you can edit
1284
		$editableIDs = array_keys(array_filter(self::can_edit_multiple($ids, $memberID)));
1285
		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...
1286
1287
			// You can only delete pages whose children you can delete
1288
			$editablePlaceholders = DB::placeholders($editableIDs);
1289
			$childRecords = SiteTree::get()->where(array(
1290
				"\"SiteTree\".\"ParentID\" IN ($editablePlaceholders)" => $editableIDs
1291
			));
1292
			if($childRecords) {
1293
				$children = $childRecords->map("ID", "ParentID");
1294
1295
				// Find out the children that can be deleted
1296
				$deletableChildren = self::can_delete_multiple($children->keys(), $memberID);
1297
1298
				// Get a list of all the parents that have no undeletable children
1299
				$deletableParents = array_fill_keys($editableIDs, true);
1300
				foreach($deletableChildren as $id => $canDelete) {
1301
					if(!$canDelete) unset($deletableParents[$children[$id]]);
1302
				}
1303
1304
				// Use that to filter the list of deletable parents that have children
1305
				$deletableParents = array_keys($deletableParents);
1306
1307
				// Also get the $ids that don't have children
1308
				$parents = array_unique($children->values());
1309
				$deletableLeafNodes = array_diff($editableIDs, $parents);
1310
1311
				// Combine the two
1312
				$deletable = array_merge($deletableParents, $deletableLeafNodes);
1313
1314
			} else {
1315
				$deletable = $editableIDs;
1316
			}
1317
		} else {
1318
			$deletable = array();
1319
		}
1320
1321
		// Convert the array of deletable IDs into a map of the original IDs with true/false as the value
1322
		return array_fill_keys($deletable, true) + array_fill_keys($ids, false);
1323
	}
1324
1325
	/**
1326
	 * Collate selected descendants of this page.
1327
	 *
1328
	 * {@link $condition} will be evaluated on each descendant, and if it is succeeds, that item will be added to the
1329
	 * $collator array.
1330
	 *
1331
	 * @param string $condition The PHP condition to be evaluated. The page will be called $item
1332
	 * @param array  $collator  An array, passed by reference, to collect all of the matching descendants.
1333
	 * @return bool
1334
	 */
1335
	public function collateDescendants($condition, &$collator) {
1336
		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...
1337
			foreach($children as $item) {
1338
				if(eval("return $condition;")) $collator[] = $item;
1339
				$item->collateDescendants($condition, $collator);
1340
			}
1341
			return true;
1342
		}
1343
	}
1344
1345
	/**
1346
	 * Return the title, description, keywords and language metatags.
1347
	 *
1348
	 * @todo Move <title> tag in separate getter for easier customization and more obvious usage
1349
	 *
1350
	 * @param bool $includeTitle Show default <title>-tag, set to false for custom templating
1351
	 * @return string The XHTML metatags
1352
	 */
1353
	public function MetaTags($includeTitle = true) {
1354
		$tags = "";
1355
		if($includeTitle === true || $includeTitle == 'true') {
1356
			$tags .= "<title>" . Convert::raw2xml($this->Title) . "</title>\n";
1357
		}
1358
1359
		$generator = trim(Config::inst()->get('SiteTree', 'meta_generator'));
1360
		if (!empty($generator)) {
1361
			$tags .= "<meta name=\"generator\" content=\"" . Convert::raw2att($generator) . "\" />\n";
1362
		}
1363
1364
		$charset = Config::inst()->get('ContentNegotiator', 'encoding');
1365
		$tags .= "<meta http-equiv=\"Content-type\" content=\"text/html; charset=$charset\" />\n";
1366
		if($this->MetaDescription) {
1367
			$tags .= "<meta name=\"description\" content=\"" . Convert::raw2att($this->MetaDescription) . "\" />\n";
1368
		}
1369
		if($this->ExtraMeta) {
1370
			$tags .= $this->ExtraMeta . "\n";
1371
		}
1372
1373
		if(Permission::check('CMS_ACCESS_CMSMain')
1374
			&& in_array('CMSPreviewable', class_implements($this))
1375
			&& !$this instanceof ErrorPage
1376
			&& $this->ID > 0
1377
		) {
1378
			$tags .= "<meta name=\"x-page-id\" content=\"{$this->ID}\" />\n";
1379
			$tags .= "<meta name=\"x-cms-edit-link\" content=\"" . $this->CMSEditLink() . "\" />\n";
1380
		}
1381
1382
		$this->extend('MetaTags', $tags);
1383
1384
		return $tags;
1385
	}
1386
1387
	/**
1388
	 * Returns the object that contains the content that a user would associate with this page.
1389
	 *
1390
	 * Ordinarily, this is just the page itself, but for example on RedirectorPages or VirtualPages ContentSource() will
1391
	 * return the page that is linked to.
1392
	 *
1393
	 * @return $this
1394
	 */
1395
	public function ContentSource() {
1396
		return $this;
1397
	}
1398
1399
	/**
1400
	 * Add default records to database.
1401
	 *
1402
	 * This function is called whenever the database is built, after the database tables have all been created. Overload
1403
	 * this to add default records when the database is built, but make sure you call parent::requireDefaultRecords().
1404
	 */
1405
	public function requireDefaultRecords() {
1406
		parent::requireDefaultRecords();
1407
1408
		// default pages
1409
		if($this->class == 'SiteTree' && $this->config()->create_default_pages) {
1410
			if(!SiteTree::get_by_link(Config::inst()->get('RootURLController', 'default_homepage_link'))) {
1411
				$homepage = new Page();
1412
				$homepage->Title = _t('SiteTree.DEFAULTHOMETITLE', 'Home');
1413
				$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>');
1414
				$homepage->URLSegment = Config::inst()->get('RootURLController', 'default_homepage_link');
1415
				$homepage->Sort = 1;
1416
				$homepage->write();
1417
				$homepage->copyVersionToStage(Versioned::DRAFT, Versioned::LIVE);
1418
				$homepage->flushCache();
1419
				DB::alteration_message('Home page created', 'created');
1420
			}
1421
1422
			if(DB::query("SELECT COUNT(*) FROM \"SiteTree\"")->value() == 1) {
1423
				$aboutus = new Page();
1424
				$aboutus->Title = _t('SiteTree.DEFAULTABOUTTITLE', 'About Us');
1425
				$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>');
1426
				$aboutus->Sort = 2;
1427
				$aboutus->write();
1428
				$aboutus->copyVersionToStage(Versioned::DRAFT, Versioned::LIVE);
1429
				$aboutus->flushCache();
1430
				DB::alteration_message('About Us page created', 'created');
1431
1432
				$contactus = new Page();
1433
				$contactus->Title = _t('SiteTree.DEFAULTCONTACTTITLE', 'Contact Us');
1434
				$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>');
1435
				$contactus->Sort = 3;
1436
				$contactus->write();
1437
				$contactus->copyVersionToStage(Versioned::DRAFT, Versioned::LIVE);
1438
				$contactus->flushCache();
1439
				DB::alteration_message('Contact Us page created', 'created');
1440
			}
1441
		}
1442
1443
		// schema migration
1444
		// @todo Move to migration task once infrastructure is implemented
1445
		if($this->class == 'SiteTree') {
1446
			$conn = DB::get_schema();
1447
			// only execute command if fields haven't been renamed to _obsolete_<fieldname> already by the task
1448
			if($conn->hasField('SiteTree' ,'Viewers')) {
1449
				$task = new UpgradeSiteTreePermissionSchemaTask();
1450
				$task->run(new SS_HTTPRequest('GET','/'));
1451
			}
1452
		}
1453
	}
1454
1455
	protected function onBeforeWrite() {
1456
		parent::onBeforeWrite();
1457
1458
		// If Sort hasn't been set, make this page come after it's siblings
1459
		if(!$this->Sort) {
1460
			$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...
1461
			$this->Sort = DB::prepared_query(
1462
				"SELECT MAX(\"Sort\") + 1 FROM \"SiteTree\" WHERE \"ParentID\" = ?",
1463
				array($parentID)
1464
			)->value();
1465
		}
1466
1467
		// If there is no URLSegment set, generate one from Title
1468
		$defaultSegment = $this->generateURLSegment(_t(
1469
			'CMSMain.NEWPAGE',
1470
			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...
1471
		));
1472
		if((!$this->URLSegment || $this->URLSegment == $defaultSegment) && $this->Title) {
1473
			$this->URLSegment = $this->generateURLSegment($this->Title);
1474
		} else if($this->isChanged('URLSegment', 2)) {
1475
			// Do a strict check on change level, to avoid double encoding caused by
1476
			// bogus changes through forceChange()
1477
			$filter = URLSegmentFilter::create();
1478
			$this->URLSegment = $filter->filter($this->URLSegment);
1479
			// If after sanitising there is no URLSegment, give it a reasonable default
1480
			if(!$this->URLSegment) $this->URLSegment = "page-$this->ID";
1481
		}
1482
1483
		// Ensure that this object has a non-conflicting URLSegment value.
1484
		$count = 2;
1485
		while(!$this->validURLSegment()) {
1486
			$this->URLSegment = preg_replace('/-[0-9]+$/', null, $this->URLSegment) . '-' . $count;
1487
			$count++;
1488
		}
1489
1490
		$this->syncLinkTracking();
1491
1492
		// Check to see if we've only altered fields that shouldn't affect versioning
1493
		$fieldsIgnoredByVersioning = array('HasBrokenLink', 'Status', 'HasBrokenFile', 'ToDo', 'VersionID', 'SaveCount');
1494
		$changedFields = array_keys($this->getChangedFields(true, 2));
1495
1496
		// This more rigorous check is inline with the test that write() does to decide whether or not to write to the
1497
		// DB. We use that to avoid cluttering the system with a migrateVersion() call that doesn't get used
1498
		$oneChangedFields = array_keys($this->getChangedFields(true, 1));
1499
1500
		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...
1501
			// This will have the affect of preserving the versioning
1502
			$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...
1503
		}
1504
	}
1505
1506
	/**
1507
	 * Trigger synchronisation of link tracking
1508
	 *
1509
	 * {@see SiteTreeLinkTracking::augmentSyncLinkTracking}
1510
	 */
1511
	public function syncLinkTracking() {
1512
		$this->extend('augmentSyncLinkTracking');
1513
	}
1514
1515
	public function onBeforeDelete() {
1516
		parent::onBeforeDelete();
1517
1518
		// If deleting this page, delete all its children.
1519
		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...
1520
			foreach($children as $child) {
1521
				$child->delete();
1522
			}
1523
		}
1524
	}
1525
1526
	public function onAfterDelete() {
1527
		// Need to flush cache to avoid outdated versionnumber references
1528
		$this->flushCache();
1529
1530
		// Need to mark pages depending to this one as broken
1531
		$dependentPages = $this->DependentPages();
1532
		if($dependentPages) foreach($dependentPages as $page) {
1533
			// $page->write() calls syncLinkTracking, which does all the hard work for us.
1534
			$page->write();
1535
		}
1536
1537
		parent::onAfterDelete();
1538
	}
1539
1540
	public function flushCache($persistent = true) {
1541
		parent::flushCache($persistent);
1542
		$this->_cache_statusFlags = null;
1543
	}
1544
1545
	public function validate() {
1546
		$result = parent::validate();
1547
1548
		// Allowed children validation
1549
		$parent = $this->getParent();
1550
		if($parent && $parent->exists()) {
1551
			// No need to check for subclasses or instanceof, as allowedChildren() already
1552
			// deconstructs any inheritance trees already.
1553
			$allowed = $parent->allowedChildren();
1554
			$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...
1555
			if(!in_array($subject->ClassName, $allowed)) {
1556
1557
				$result->error(
1558
					_t(
1559
						'SiteTree.PageTypeNotAllowed',
1560
						'Page type "{type}" not allowed as child of this parent page',
1561
						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...
1562
					),
1563
					'ALLOWED_CHILDREN'
1564
				);
1565
			}
1566
		}
1567
1568
		// "Can be root" validation
1569
		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...
1570
			$result->error(
1571
				_t(
1572
					'SiteTree.PageTypNotAllowedOnRoot',
1573
					'Page type "{type}" is not allowed on the root level',
1574
					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...
1575
				),
1576
				'CAN_BE_ROOT'
1577
			);
1578
		}
1579
1580
		return $result;
1581
	}
1582
1583
	/**
1584
	 * Returns true if this object has a URLSegment value that does not conflict with any other objects. This method
1585
	 * checks for:
1586
	 *  - A page with the same URLSegment that has a conflict
1587
	 *  - Conflicts with actions on the parent page
1588
	 *  - A conflict caused by a root page having the same URLSegment as a class name
1589
	 *
1590
	 * @return bool
1591
	 */
1592
	public function validURLSegment() {
1593
		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...
1594
			if($controller = ModelAsController::controller_for($parent)) {
1595
				if($controller instanceof Controller && $controller->hasAction($this->URLSegment)) return false;
1596
			}
1597
		}
1598
1599
		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...
1600
			if(class_exists($this->URLSegment) && is_subclass_of($this->URLSegment, 'RequestHandler')) return false;
1601
		}
1602
1603
		// Filters by url, id, and parent
1604
		$filter = array('"SiteTree"."URLSegment"' => $this->URLSegment);
1605
		if($this->ID) {
1606
			$filter['"SiteTree"."ID" <> ?'] = $this->ID;
1607
		}
1608
		if(self::config()->nested_urls) {
1609
			$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...
1610
		}
1611
1612
		$votes = array_filter(
1613
			(array)$this->extend('augmentValidURLSegment'),
1614
			function($v) {return !is_null($v);}
1615
		);
1616
		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...
1617
			return min($votes);
1618
		}
1619
1620
		// Check existence
1621
		$existingPage = DataObject::get_one('SiteTree', $filter);
1622
		if ($existingPage) return false;
1623
1624
		return !($existingPage);
1625
		}
1626
1627
	/**
1628
	 * Generate a URL segment based on the title provided.
1629
	 *
1630
	 * If {@link Extension}s wish to alter URL segment generation, they can do so by defining
1631
	 * updateURLSegment(&$url, $title).  $url will be passed by reference and should be modified. $title will contain
1632
	 * the title that was originally used as the source of this generated URL. This lets extensions either start from
1633
	 * scratch, or incrementally modify the generated URL.
1634
	 *
1635
	 * @param string $title Page title
1636
	 * @return string Generated url segment
1637
	 */
1638
	public function generateURLSegment($title){
1639
		$filter = URLSegmentFilter::create();
1640
		$t = $filter->filter($title);
1641
1642
		// Fallback to generic page name if path is empty (= no valid, convertable characters)
1643
		if(!$t || $t == '-' || $t == '-1') $t = "page-$this->ID";
1644
1645
		// Hook for extensions
1646
		$this->extend('updateURLSegment', $t, $title);
1647
1648
		return $t;
1649
	}
1650
1651
	/**
1652
	 * Gets the URL segment for the latest draft version of this page.
1653
	 *
1654
	 * @return string
1655
	 */
1656
	public function getStageURLSegment() {
1657
		$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...
1658
			'"SiteTree"."ID"' => $this->ID
1659
		));
1660
		return ($stageRecord) ? $stageRecord->URLSegment : null;
1661
	}
1662
1663
	/**
1664
	 * Gets the URL segment for the currently published version of this page.
1665
	 *
1666
	 * @return string
1667
	 */
1668
	public function getLiveURLSegment() {
1669
		$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...
1670
			'"SiteTree"."ID"' => $this->ID
1671
		));
1672
		return ($liveRecord) ? $liveRecord->URLSegment : null;
1673
	}
1674
1675
	/**
1676
	 * Returns the pages that depend on this page. This includes virtual pages, pages that link to it, etc.
1677
	 *
1678
	 * @param bool $includeVirtuals Set to false to exlcude virtual pages.
1679
	 * @return ArrayList
1680
	 */
1681
	public function DependentPages($includeVirtuals = true) {
1682
		if(class_exists('Subsite')) {
1683
			$origDisableSubsiteFilter = Subsite::$disable_subsite_filter;
1684
			Subsite::disable_subsite_filter(true);
1685
		}
1686
1687
		// Content links
1688
		$items = new ArrayList();
1689
1690
		// We merge all into a regular SS_List, because DataList doesn't support merge
1691
		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...
1692
			$linkList = new ArrayList();
1693
			foreach($contentLinks as $item) {
1694
				$item->DependentLinkType = 'Content link';
1695
				$linkList->push($item);
1696
			}
1697
			$items->merge($linkList);
1698
		}
1699
1700
		// Virtual pages
1701
		if($includeVirtuals) {
1702
			$virtuals = $this->VirtualPages();
1703
			if($virtuals) {
1704
				$virtualList = new ArrayList();
1705
				foreach($virtuals as $item) {
1706
					$item->DependentLinkType = 'Virtual page';
1707
					$virtualList->push($item);
1708
				}
1709
				$items->merge($virtualList);
1710
			}
1711
		}
1712
1713
		// Redirector pages
1714
		$redirectors = RedirectorPage::get()->where(array(
1715
			'"RedirectorPage"."RedirectionType"' => 'Internal',
1716
			'"RedirectorPage"."LinkToID"' => $this->ID
1717
		));
1718
		if($redirectors) {
1719
			$redirectorList = new ArrayList();
1720
			foreach($redirectors as $item) {
1721
				$item->DependentLinkType = 'Redirector page';
1722
				$redirectorList->push($item);
1723
			}
1724
			$items->merge($redirectorList);
1725
		}
1726
1727
		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...
1728
1729
		return $items;
1730
	}
1731
1732
	/**
1733
	 * Return all virtual pages that link to this page.
1734
	 *
1735
	 * @return DataList
1736
	 */
1737
	public function VirtualPages() {
1738
		$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...
1739
1740
		// Disable subsite filter for these pages
1741
		if($pages instanceof DataList) {
1742
			return $pages->setDataQueryParam('Subsite.filter', false);
1743
		} else {
1744
			return $pages;
1745
		}
1746
	}
1747
1748
	/**
1749
	 * Returns a FieldList with which to create the main editing form.
1750
	 *
1751
	 * You can override this in your child classes to add extra fields - first get the parent fields using
1752
	 * parent::getCMSFields(), then use addFieldToTab() on the FieldList.
1753
	 *
1754
	 * See {@link getSettingsFields()} for a different set of fields concerned with configuration aspects on the record,
1755
	 * e.g. access control.
1756
	 *
1757
	 * @return FieldList The fields to be displayed in the CMS
1758
	 */
1759
	public function getCMSFields() {
1760
		require_once("forms/Form.php");
1761
		// Status / message
1762
		// Create a status message for multiple parents
1763
		if($this->ID && is_numeric($this->ID)) {
1764
			$linkedPages = $this->VirtualPages();
1765
1766
			$parentPageLinks = array();
1767
1768
			if($linkedPages->Count() > 0) {
1769
				foreach($linkedPages as $linkedPage) {
1770
					$parentPage = $linkedPage->Parent;
1771
					if($parentPage) {
1772
						if($parentPage->ID) {
1773
							$parentPageLinks[] = "<a class=\"cmsEditlink\" href=\"admin/pages/edit/show/$linkedPage->ID\">{$parentPage->Title}</a>";
1774
						} else {
1775
							$parentPageLinks[] = "<a class=\"cmsEditlink\" href=\"admin/pages/edit/show/$linkedPage->ID\">" .
1776
								_t('SiteTree.TOPLEVEL', 'Site Content (Top Level)') .
1777
								"</a>";
1778
						}
1779
					}
1780
				}
1781
1782
				$lastParent = array_pop($parentPageLinks);
1783
				$parentList = "'$lastParent'";
1784
1785
				if(count($parentPageLinks) > 0) {
1786
					$parentList = "'" . implode("', '", $parentPageLinks) . "' and "
1787
						. $parentList;
1788
				}
1789
1790
				$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...
1791
					'SiteTree.APPEARSVIRTUALPAGES',
1792
					"This content also appears on the virtual pages in the {title} sections.",
1793
					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...
1794
				);
1795
			}
1796
		}
1797
1798
		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...
1799
			$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...
1800
		}
1801
1802
		$dependentNote = '';
1803
		$dependentTable = new LiteralField('DependentNote', '<p></p>');
1804
1805
		// Create a table for showing pages linked to this one
1806
		$dependentPages = $this->DependentPages();
1807
		$dependentPagesCount = $dependentPages->Count();
1808
		if($dependentPagesCount) {
1809
			$dependentColumns = array(
1810
				'Title' => $this->fieldLabel('Title'),
1811
				'AbsoluteLink' => _t('SiteTree.DependtPageColumnURL', 'URL'),
1812
				'DependentLinkType' => _t('SiteTree.DependtPageColumnLinkType', 'Link type'),
1813
			);
1814
			if(class_exists('Subsite')) $dependentColumns['Subsite.Title'] = singleton('Subsite')->i18n_singular_name();
1815
1816
			$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>');
1817
			$dependentTable = GridField::create(
1818
				'DependentPages',
1819
				false,
1820
				$dependentPages
1821
			);
1822
			$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...
1823
				->setDisplayFields($dependentColumns)
1824
				->setFieldFormatting(array(
1825
					'Title' => function($value, &$item) {
1826
						return sprintf(
1827
							'<a href="admin/pages/edit/show/%d">%s</a>',
1828
							(int)$item->ID,
1829
							Convert::raw2xml($item->Title)
1830
						);
1831
					},
1832
					'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...
1833
						return sprintf(
1834
							'<a href="%s" target="_blank">%s</a>',
1835
							Convert::raw2xml($value),
1836
							Convert::raw2xml($value)
1837
						);
1838
					}
1839
				));
1840
		}
1841
1842
		$baseLink = Controller::join_links (
1843
			Director::absoluteBaseURL(),
1844
			(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...
1845
		);
1846
1847
		$urlsegment = SiteTreeURLSegmentField::create("URLSegment", $this->fieldLabel('URLSegment'))
1848
			->setURLPrefix($baseLink)
1849
			->setDefaultURL($this->generateURLSegment(_t(
1850
				'CMSMain.NEWPAGE',
1851
				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...
1852
			)));
1853
		$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...
1854
		if(!Config::inst()->get('URLSegmentFilter', 'default_allow_multibyte')) {
1855
			$helpText .= $helpText ? '<br />' : '';
1856
			$helpText .= _t('SiteTreeURLSegmentField.HelpChars', ' Special characters are automatically converted or removed.');
1857
		}
1858
		$urlsegment->setHelpText($helpText);
1859
1860
		$fields = new FieldList(
1861
			$rootTab = new TabSet("Root",
1862
				$tabMain = new Tab('Main',
1863
					new TextField("Title", $this->fieldLabel('Title')),
1864
					$urlsegment,
1865
					new TextField("MenuTitle", $this->fieldLabel('MenuTitle')),
1866
					$htmlField = new HTMLEditorField("Content", _t('SiteTree.HTMLEDITORTITLE', "Content", 'HTML editor title')),
1867
					ToggleCompositeField::create('Metadata', _t('SiteTree.MetadataToggle', 'Metadata'),
1868
						array(
1869
							$metaFieldDesc = new TextareaField("MetaDescription", $this->fieldLabel('MetaDescription')),
1870
							$metaFieldExtra = new TextareaField("ExtraMeta",$this->fieldLabel('ExtraMeta'))
1871
						)
1872
					)->setHeadingLevel(4)
1873
				),
1874
				$tabDependent = new Tab('Dependent',
1875
					$dependentNote,
1876
					$dependentTable
1877
				)
1878
			)
1879
		);
1880
		$htmlField->addExtraClass('stacked');
1881
1882
		// Help text for MetaData on page content editor
1883
		$metaFieldDesc
1884
			->setRightTitle(
1885
				_t(
1886
					'SiteTree.METADESCHELP',
1887
					"Search engines use this content for displaying search results (although it will not influence their ranking)."
1888
				)
1889
			)
1890
			->addExtraClass('help');
1891
		$metaFieldExtra
1892
			->setRightTitle(
1893
				_t(
1894
					'SiteTree.METAEXTRAHELP',
1895
					"HTML tags for additional meta information. For example &lt;meta name=\"customName\" content=\"your custom content here\" /&gt;"
1896
				)
1897
			)
1898
			->addExtraClass('help');
1899
1900
		// Conditional dependent pages tab
1901
		if($dependentPagesCount) $tabDependent->setTitle(_t('SiteTree.TABDEPENDENT', "Dependent pages") . " ($dependentPagesCount)");
1902
		else $fields->removeFieldFromTab('Root', 'Dependent');
1903
1904
		$tabMain->setTitle(_t('SiteTree.TABCONTENT', "Main Content"));
1905
1906
		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...
1907
			$obsoleteWarning = _t(
1908
				'SiteTree.OBSOLETECLASS',
1909
				"This page is of obsolete type {type}. Saving will reset its type and you may lose data",
1910
				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...
1911
			);
1912
1913
			$fields->addFieldToTab(
1914
				"Root.Main",
1915
				new LiteralField("ObsoleteWarningHeader", "<p class=\"message warning\">$obsoleteWarning</p>"),
1916
				"Title"
1917
			);
1918
		}
1919
1920
		if(file_exists(BASE_PATH . '/install.php')) {
1921
			$fields->addFieldToTab("Root.Main", new LiteralField("InstallWarningHeader",
1922
				"<p class=\"message warning\">" . _t("SiteTree.REMOVE_INSTALL_WARNING",
1923
				"Warning: You should remove install.php from this SilverStripe install for security reasons.")
1924
				. "</p>"), "Title");
1925
		}
1926
1927
		// Backwards compat: Rewrite nested "Content" tabs to toplevel
1928
		$fields->setTabPathRewrites(array(
1929
			'/^Root\.Content\.Main$/' => 'Root.Main',
1930
			'/^Root\.Content\.([^.]+)$/' => 'Root.\\1',
1931
		));
1932
1933
		if(self::$runCMSFieldsExtensions) {
1934
			$this->extend('updateCMSFields', $fields);
1935
		}
1936
1937
		return $fields;
1938
	}
1939
1940
1941
	/**
1942
	 * Returns fields related to configuration aspects on this record, e.g. access control. See {@link getCMSFields()}
1943
	 * for content-related fields.
1944
	 *
1945
	 * @return FieldList
1946
	 */
1947
	public function getSettingsFields() {
1948
		$groupsMap = array();
1949
		foreach(Group::get() as $group) {
1950
			// Listboxfield values are escaped, use ASCII char instead of &raquo;
1951
			$groupsMap[$group->ID] = $group->getBreadcrumbs(' > ');
1952
		}
1953
		asort($groupsMap);
1954
1955
		$fields = new FieldList(
1956
			$rootTab = new TabSet("Root",
1957
				$tabBehaviour = new Tab('Settings',
1958
					new DropdownField(
1959
						"ClassName",
1960
						$this->fieldLabel('ClassName'),
1961
						$this->getClassDropdown()
1962
					),
1963
					$parentTypeSelector = new CompositeField(
1964
						new OptionsetField("ParentType", _t("SiteTree.PAGELOCATION", "Page location"), array(
1965
							"root" => _t("SiteTree.PARENTTYPE_ROOT", "Top-level page"),
1966
							"subpage" => _t("SiteTree.PARENTTYPE_SUBPAGE", "Sub-page underneath a parent page"),
1967
						)),
1968
						$parentIDField = new TreeDropdownField("ParentID", $this->fieldLabel('ParentID'), 'SiteTree', 'ID', 'MenuTitle')
1969
					),
1970
					$visibility = new FieldGroup(
1971
						new CheckboxField("ShowInMenus", $this->fieldLabel('ShowInMenus')),
1972
						new CheckboxField("ShowInSearch", $this->fieldLabel('ShowInSearch'))
1973
					),
1974
					$viewersOptionsField = new OptionsetField(
1975
						"CanViewType",
1976
						_t('SiteTree.ACCESSHEADER', "Who can view this page?")
1977
					),
1978
					$viewerGroupsField = ListboxField::create("ViewerGroups", _t('SiteTree.VIEWERGROUPS', "Viewer Groups"))
1979
						->setSource($groupsMap)
1980
						->setAttribute(
1981
							'data-placeholder',
1982
							_t('SiteTree.GroupPlaceholder', 'Click to select group')
1983
						),
1984
					$editorsOptionsField = new OptionsetField(
1985
						"CanEditType",
1986
						_t('SiteTree.EDITHEADER', "Who can edit this page?")
1987
					),
1988
					$editorGroupsField = ListboxField::create("EditorGroups", _t('SiteTree.EDITORGROUPS', "Editor Groups"))
1989
						->setSource($groupsMap)
1990
						->setAttribute(
1991
							'data-placeholder',
1992
							_t('SiteTree.GroupPlaceholder', 'Click to select group')
1993
						)
1994
				)
1995
			)
1996
		);
1997
1998
		$visibility->setTitle($this->fieldLabel('Visibility'));
1999
2000
2001
		// This filter ensures that the ParentID dropdown selection does not show this node,
2002
		// or its descendents, as this causes vanishing bugs
2003
		$parentIDField->setFilterFunction(create_function('$node', "return \$node->ID != {$this->ID};"));
2004
		$parentTypeSelector->addExtraClass('parentTypeSelector');
2005
2006
		$tabBehaviour->setTitle(_t('SiteTree.TABBEHAVIOUR', "Behavior"));
2007
2008
		// Make page location fields read-only if the user doesn't have the appropriate permission
2009
		if(!Permission::check("SITETREE_REORGANISE")) {
2010
			$fields->makeFieldReadonly('ParentType');
2011
			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...
2012
				$fields->removeByName('ParentID');
2013
			} else {
2014
				$fields->makeFieldReadonly('ParentID');
2015
			}
2016
		}
2017
2018
		$viewersOptionsSource = array();
2019
		$viewersOptionsSource["Inherit"] = _t('SiteTree.INHERIT', "Inherit from parent page");
2020
		$viewersOptionsSource["Anyone"] = _t('SiteTree.ACCESSANYONE', "Anyone");
2021
		$viewersOptionsSource["LoggedInUsers"] = _t('SiteTree.ACCESSLOGGEDIN', "Logged-in users");
2022
		$viewersOptionsSource["OnlyTheseUsers"] = _t('SiteTree.ACCESSONLYTHESE', "Only these people (choose from list)");
2023
		$viewersOptionsField->setSource($viewersOptionsSource);
2024
2025
		$editorsOptionsSource = array();
2026
		$editorsOptionsSource["Inherit"] = _t('SiteTree.INHERIT', "Inherit from parent page");
2027
		$editorsOptionsSource["LoggedInUsers"] = _t('SiteTree.EDITANYONE', "Anyone who can log-in to the CMS");
2028
		$editorsOptionsSource["OnlyTheseUsers"] = _t('SiteTree.EDITONLYTHESE', "Only these people (choose from list)");
2029
		$editorsOptionsField->setSource($editorsOptionsSource);
2030
2031
		if(!Permission::check('SITETREE_GRANT_ACCESS')) {
2032
			$fields->makeFieldReadonly($viewersOptionsField);
2033
			if($this->CanViewType == 'OnlyTheseUsers') {
2034
				$fields->makeFieldReadonly($viewerGroupsField);
2035
			} else {
2036
				$fields->removeByName('ViewerGroups');
2037
			}
2038
2039
			$fields->makeFieldReadonly($editorsOptionsField);
2040
			if($this->CanEditType == 'OnlyTheseUsers') {
2041
				$fields->makeFieldReadonly($editorGroupsField);
2042
			} else {
2043
				$fields->removeByName('EditorGroups');
2044
			}
2045
		}
2046
2047
		if(self::$runCMSFieldsExtensions) {
2048
			$this->extend('updateSettingsFields', $fields);
2049
		}
2050
2051
		return $fields;
2052
	}
2053
2054
	/**
2055
	 * @param bool $includerelations A boolean value to indicate if the labels returned should include relation fields
2056
	 * @return array
2057
	 */
2058
	public function fieldLabels($includerelations = true) {
2059
		$cacheKey = $this->class . '_' . $includerelations;
2060
		if(!isset(self::$_cache_field_labels[$cacheKey])) {
2061
			$labels = parent::fieldLabels($includerelations);
2062
			$labels['Title'] = _t('SiteTree.PAGETITLE', "Page name");
2063
			$labels['MenuTitle'] = _t('SiteTree.MENUTITLE', "Navigation label");
2064
			$labels['MetaDescription'] = _t('SiteTree.METADESC', "Meta Description");
2065
			$labels['ExtraMeta'] = _t('SiteTree.METAEXTRA', "Custom Meta Tags");
2066
			$labels['ClassName'] = _t('SiteTree.PAGETYPE', "Page type", 'Classname of a page object');
2067
			$labels['ParentType'] = _t('SiteTree.PARENTTYPE', "Page location");
2068
			$labels['ParentID'] = _t('SiteTree.PARENTID', "Parent page");
2069
			$labels['ShowInMenus'] =_t('SiteTree.SHOWINMENUS', "Show in menus?");
2070
			$labels['ShowInSearch'] = _t('SiteTree.SHOWINSEARCH', "Show in search?");
2071
			$labels['ProvideComments'] = _t('SiteTree.ALLOWCOMMENTS', "Allow comments on this page?");
2072
			$labels['ViewerGroups'] = _t('SiteTree.VIEWERGROUPS', "Viewer Groups");
2073
			$labels['EditorGroups'] = _t('SiteTree.EDITORGROUPS', "Editor Groups");
2074
			$labels['URLSegment'] = _t('SiteTree.URLSegment', 'URL Segment', 'URL for this page');
2075
			$labels['Content'] = _t('SiteTree.Content', 'Content', 'Main HTML Content for a page');
2076
			$labels['CanViewType'] = _t('SiteTree.Viewers', 'Viewers Groups');
2077
			$labels['CanEditType'] = _t('SiteTree.Editors', 'Editors Groups');
2078
			$labels['Comments'] = _t('SiteTree.Comments', 'Comments');
2079
			$labels['Visibility'] = _t('SiteTree.Visibility', 'Visibility');
2080
			$labels['LinkChangeNote'] = _t (
2081
				'SiteTree.LINKCHANGENOTE', 'Changing this page\'s link will also affect the links of all child pages.'
2082
			);
2083
2084
			if($includerelations){
2085
				$labels['Parent'] = _t('SiteTree.has_one_Parent', 'Parent Page', 'The parent page in the site hierarchy');
2086
				$labels['LinkTracking'] = _t('SiteTree.many_many_LinkTracking', 'Link Tracking');
2087
				$labels['ImageTracking'] = _t('SiteTree.many_many_ImageTracking', 'Image Tracking');
2088
				$labels['BackLinkTracking'] = _t('SiteTree.many_many_BackLinkTracking', 'Backlink Tracking');
2089
			}
2090
2091
			self::$_cache_field_labels[$cacheKey] = $labels;
2092
		}
2093
2094
		return self::$_cache_field_labels[$cacheKey];
2095
	}
2096
2097
	/**
2098
	 * Get the actions available in the CMS for this page - eg Save, Publish.
2099
	 *
2100
	 * Frontend scripts and styles know how to handle the following FormFields:
2101
	 * - top-level FormActions appear as standalone buttons
2102
	 * - top-level CompositeField with FormActions within appear as grouped buttons
2103
	 * - TabSet & Tabs appear as a drop ups
2104
	 * - FormActions within the Tab are restyled as links
2105
	 * - major actions can provide alternate states for richer presentation (see ssui.button widget extension)
2106
	 *
2107
	 * @return FieldList The available actions for this page.
2108
	 */
2109
	public function getCMSActions() {
2110
		$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...
2111
2112
		// Major actions appear as buttons immediately visible as page actions.
2113
		$majorActions = CompositeField::create()->setName('MajorActions')->setTag('fieldset')->addExtraClass('btn-group ss-ui-buttonset noborder');
2114
2115
		// Minor options are hidden behind a drop-up and appear as links (although they are still FormActions).
2116
		$rootTabSet = new TabSet('ActionMenus');
2117
		$moreOptions = new Tab(
2118
			'MoreOptions',
2119
			_t('SiteTree.MoreOptions', 'More options', 'Expands a view for more buttons')
2120
		);
2121
		$rootTabSet->push($moreOptions);
2122
		$rootTabSet->addExtraClass('ss-ui-action-tabset action-menus noborder');
2123
2124
		// Render page information into the "more-options" drop-up, on the top.
2125
		$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...
2126
			'"SiteTree"."ID"' => $this->ID
2127
		));
2128
		$moreOptions->push(
2129
			new LiteralField('Information',
2130
				$this->customise(array(
2131
					'Live' => $live,
2132
					'ExistsOnLive' => $existsOnLive
2133
				))->renderWith('SiteTree_Information')
2134
			)
2135
		);
2136
2137
		$moreOptions->push(AddToCampaignHandler_FormAction::create());
2138
2139
		// "readonly"/viewing version that isn't the current version of the record
2140
		$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...
2141
			'"SiteTree"."ID"' => $this->ID
2142
		));
2143
		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...
2144
			$moreOptions->push(FormAction::create('email', _t('CMSMain.EMAIL', 'Email')));
2145
			$moreOptions->push(FormAction::create('rollback', _t('CMSMain.ROLLBACK', 'Roll back to this version')));
2146
2147
			$actions = new FieldList(array($majorActions, $rootTabSet));
2148
2149
			// getCMSActions() can be extended with updateCMSActions() on a extension
2150
			$this->extend('updateCMSActions', $actions);
2151
2152
			return $actions;
2153
		}
2154
2155
		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 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
			// "unpublish"
2157
			$moreOptions->push(
2158
				FormAction::create('unpublish', _t('SiteTree.BUTTONUNPUBLISH', 'Unpublish'), 'delete')
2159
					->setDescription(_t('SiteTree.BUTTONUNPUBLISHDESC', 'Remove this page from the published site'))
2160
					->addExtraClass('ss-ui-action-destructive')
2161
			);
2162
		}
2163
2164
		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...
2165
			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...
2166
				// "rollback"
2167
				$moreOptions->push(
2168
					FormAction::create('rollback', _t('SiteTree.BUTTONCANCELDRAFT', 'Cancel draft changes'), 'delete')
2169
						->setDescription(_t('SiteTree.BUTTONCANCELDRAFTDESC', 'Delete your draft and revert to the currently published page'))
2170
				);
2171
			}
2172
		}
2173
2174
		if($this->canEdit()) {
2175
			if($this->getIsDeletedFromStage()) {
2176
				// The usual major actions are not available, so we provide alternatives here.
2177
				if($existsOnLive) {
2178
					// "restore"
2179
					$majorActions->push(FormAction::create('revert',_t('CMSMain.RESTORE','Restore')));
2180
					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...
2181
						// "delete from live"
2182
						$majorActions->push(
2183
							FormAction::create('deletefromlive',_t('CMSMain.DELETEFP','Delete'))
2184
								->addExtraClass('ss-ui-action-destructive')
2185
						);
2186
					}
2187
				} else {
2188
					// Determine if we should force a restore to root (where once it was a subpage)
2189
					$restoreToRoot = $this->isParentArchived();
2190
2191
					// "restore"
2192
					$title = $restoreToRoot
2193
						? _t('CMSMain.RESTORE_TO_ROOT','Restore draft at top level')
2194
						: _t('CMSMain.RESTORE','Restore draft');
2195
					$description = $restoreToRoot
2196
						? _t('CMSMain.RESTORE_TO_ROOT_DESC','Restore the archived version to draft as a top level page')
2197
						: _t('CMSMain.RESTORE_DESC', 'Restore the archived version to draft');
2198
					$majorActions->push(
2199
						FormAction::create('restore', $title)
2200
							->setDescription($description)
2201
							->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...
2202
							->setAttribute('data-icon', 'decline')
2203
					);
2204
				}
2205
			} else {
2206
					if($this->canDelete()) {
2207
						// delete
2208
						$moreOptions->push(
2209
							FormAction::create('delete',_t('CMSMain.DELETE','Delete draft'))
2210
								->addExtraClass('delete ss-ui-action-destructive')
2211
						);
2212
					}
2213
				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...
2214
					// "archive"
2215
					$moreOptions->push(
2216
						FormAction::create('archive',_t('CMSMain.ARCHIVE','Archive'))
2217
							->setDescription(_t(
2218
								'SiteTree.BUTTONARCHIVEDESC',
2219
								'Unpublish and send to archive'
2220
							))
2221
							->addExtraClass('delete ss-ui-action-destructive')
2222
					);
2223
				}
2224
2225
				// "save", supports an alternate state that is still clickable, but notifies the user that the action is not needed.
2226
				$majorActions->push(
2227
					FormAction::create('save', _t('SiteTree.BUTTONSAVED', 'Saved'))
2228
						->setAttribute('data-icon', 'accept')
2229
						->setAttribute('data-icon-alternate', 'addpage')
2230
						->setAttribute('data-text-alternate', _t('CMSMain.SAVEDRAFT','Save draft'))
2231
				);
2232
			}
2233
		}
2234
2235
		if($this->canPublish() && !$this->getIsDeletedFromStage()) {
2236
			// "publish", as with "save", it supports an alternate state to show when action is needed.
2237
			$majorActions->push(
2238
				$publish = FormAction::create('publish', _t('SiteTree.BUTTONPUBLISHED', 'Published'))
2239
					->setAttribute('data-icon', 'accept')
2240
					->setAttribute('data-icon-alternate', 'disk')
2241
					->setAttribute('data-text-alternate', _t('SiteTree.BUTTONSAVEPUBLISH', 'Save & publish'))
2242
			);
2243
2244
			// Set up the initial state of the button to reflect the state of the underlying SiteTree object.
2245
			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...
2246
				$publish->addExtraClass('ss-ui-alternate');
2247
			}
2248
		}
2249
2250
		$actions = new FieldList(array($majorActions, $rootTabSet));
2251
2252
		// Hook for extensions to add/remove actions.
2253
		$this->extend('updateCMSActions', $actions);
2254
2255
		return $actions;
2256
	}
2257
2258
	public function onAfterPublish() {
2259
		// Force live sort order to match stage sort order
2260
		DB::prepared_query('UPDATE "SiteTree_Live"
2261
			SET "Sort" = (SELECT "SiteTree"."Sort" FROM "SiteTree" WHERE "SiteTree_Live"."ID" = "SiteTree"."ID")
2262
			WHERE EXISTS (SELECT "SiteTree"."Sort" FROM "SiteTree" WHERE "SiteTree_Live"."ID" = "SiteTree"."ID") AND "ParentID" = ?',
2263
			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...
2264
		);
2265
		}
2266
2267
	/**
2268
	 * Update draft dependant pages
2269
	 */
2270
	public function onAfterRevertToLive() {
2271
		// Use an alias to get the updates made by $this->publish
2272
		/** @var SiteTree $stageSelf */
2273
		$stageSelf = Versioned::get_by_stage('SiteTree', Versioned::DRAFT)->byID($this->ID);
2274
		$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...
2275
2276
		// Need to update pages linking to this one as no longer broken
2277
		foreach($stageSelf->DependentPages() as $page) {
2278
			/** @var SiteTree $page */
2279
			$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...
2280
		}
2281
	}
2282
2283
	/**
2284
	 * Determine if this page references a parent which is archived, and not available in stage
2285
	 *
2286
	 * @return bool True if there is an archived parent
2287
	 */
2288
	protected function isParentArchived() {
2289
		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...
2290
			$parentPage = Versioned::get_latest_version("SiteTree", $parentID);
2291
			if(!$parentPage || $parentPage->IsDeletedFromStage) {
2292
				return true;
2293
			}
2294
		}
2295
		return false;
2296
	}
2297
2298
	/**
2299
	 * Restore the content in the active copy of this SiteTree page to the stage site.
2300
	 *
2301
	 * @return self
2302
	 */
2303
	public function doRestoreToStage() {
2304
		$this->invokeWithExtensions('onBeforeRestoreToStage', $this);
2305
2306
		// Ensure that the parent page is restored, otherwise restore to root
2307
		if($this->isParentArchived()) {
2308
			$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...
2309
		}
2310
2311
		// if no record can be found on draft stage (meaning it has been "deleted from draft" before),
2312
		// create an empty record
2313
		if(!DB::prepared_query("SELECT \"ID\" FROM \"SiteTree\" WHERE \"ID\" = ?", array($this->ID))->value()) {
2314
			$conn = DB::get_conn();
2315
			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...
2316
			DB::prepared_query("INSERT INTO \"SiteTree\" (\"ID\") VALUES (?)", array($this->ID));
2317
			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...
2318
		}
2319
2320
		$oldReadingMode = Versioned::get_reading_mode();
2321
		Versioned::set_stage(Versioned::DRAFT);
2322
		$this->forceChange();
2323
		$this->write();
2324
2325
		$result = DataObject::get_by_id($this->class, $this->ID);
2326
2327
		// Need to update pages linking to this one as no longer broken
2328
		foreach($result->DependentPages(false) as $page) {
2329
			// $page->write() calls syncLinkTracking, which does all the hard work for us.
2330
			$page->write();
2331
		}
2332
2333
		Versioned::set_reading_mode($oldReadingMode);
2334
2335
		$this->invokeWithExtensions('onAfterRestoreToStage', $this);
2336
2337
		return $result;
2338
	}
2339
2340
	/**
2341
	 * Check if this page is new - that is, if it has yet to have been written to the database.
2342
	 *
2343
	 * @return bool
2344
	 */
2345
	public function isNew() {
2346
		/**
2347
		 * This check was a problem for a self-hosted site, and may indicate a bug in the interpreter on their server,
2348
		 * or a bug here. Changing the condition from empty($this->ID) to !$this->ID && !$this->record['ID'] fixed this.
2349
		 */
2350
		if(empty($this->ID)) return true;
2351
2352
		if(is_numeric($this->ID)) return false;
2353
2354
		return stripos($this->ID, 'new') === 0;
2355
	}
2356
2357
	/**
2358
	 * Get the class dropdown used in the CMS to change the class of a page. This returns the list of options in the
2359
	 * dropdown as a Map from class name to singular name. Filters by {@link SiteTree->canCreate()}, as well as
2360
	 * {@link SiteTree::$needs_permission}.
2361
	 *
2362
	 * @return array
2363
	 */
2364
	protected function getClassDropdown() {
2365
		$classes = self::page_type_classes();
2366
		$currentClass = null;
2367
		$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...
2368
2369
		$result = array();
2370
		foreach($classes as $class) {
2371
			$instance = singleton($class);
2372
2373
			// if the current page type is this the same as the class type always show the page type in the list
2374
			if ($this->ClassName != $instance->ClassName) {
2375
				if($instance instanceof HiddenClass) continue;
2376
				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...
2377
			}
2378
2379
			if($perms = $instance->stat('need_permission')) {
2380
				if(!$this->can($perms)) continue;
2381
			}
2382
2383
			$pageTypeName = $instance->i18n_singular_name();
2384
2385
			$currentClass = $class;
2386
			$result[$class] = $pageTypeName;
2387
2388
			// If we're in translation mode, the link between the translated pagetype title and the actual classname
2389
			// might not be obvious, so we add it in parantheses. Example: class "RedirectorPage" has the title
2390
			// "Weiterleitung" in German, so it shows up as "Weiterleitung (RedirectorPage)"
2391
			if(i18n::get_lang_from_locale(i18n::get_locale()) != 'en') {
2392
				$result[$class] = $result[$class] .  " ({$class})";
2393
			}
2394
		}
2395
2396
		// sort alphabetically, and put current on top
2397
		asort($result);
2398
		if($currentClass) {
2399
			$currentPageTypeName = $result[$currentClass];
2400
			unset($result[$currentClass]);
2401
			$result = array_reverse($result);
2402
			$result[$currentClass] = $currentPageTypeName;
2403
			$result = array_reverse($result);
2404
		}
2405
2406
		return $result;
2407
	}
2408
2409
	/**
2410
	 * Returns an array of the class names of classes that are allowed to be children of this class.
2411
	 *
2412
	 * @return string[]
2413
	 */
2414
	public function allowedChildren() {
2415
		$allowedChildren = array();
2416
		$candidates = $this->stat('allowed_children');
2417
		if($candidates && $candidates != "none" && $candidates != "SiteTree_root") {
2418
			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...
2419
				// If a classname is prefixed by "*", such as "*Page", then only that class is allowed - no subclasses.
2420
				// Otherwise, the class and all its subclasses are allowed.
2421
				if(substr($candidate,0,1) == '*') {
2422
					$allowedChildren[] = substr($candidate,1);
2423
				} else {
2424
					$subclasses = ClassInfo::subclassesFor($candidate);
2425
					foreach($subclasses as $subclass) {
2426
						if($subclass != "SiteTree_root") $allowedChildren[] = $subclass;
2427
					}
2428
				}
2429
			}
2430
		}
2431
2432
		return $allowedChildren;
2433
	}
2434
2435
	/**
2436
	 * Returns the class name of the default class for children of this page.
2437
	 *
2438
	 * @return string
2439
	 */
2440
	public function defaultChild() {
2441
		$default = $this->stat('default_child');
2442
		$allowed = $this->allowedChildren();
2443
		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...
2444
			if(!$default || !in_array($default, $allowed))
2445
				$default = reset($allowed);
2446
			return $default;
2447
		}
2448
	}
2449
2450
	/**
2451
	 * Returns the class name of the default class for the parent of this page.
2452
	 *
2453
	 * @return string
2454
	 */
2455
	public function defaultParent() {
2456
		return $this->stat('default_parent');
2457
	}
2458
2459
	/**
2460
	 * Get the title for use in menus for this page. If the MenuTitle field is set it returns that, else it returns the
2461
	 * Title field.
2462
	 *
2463
	 * @return string
2464
	 */
2465
	public function getMenuTitle(){
2466
		if($value = $this->getField("MenuTitle")) {
2467
			return $value;
2468
		} else {
2469
			return $this->getField("Title");
2470
		}
2471
	}
2472
2473
2474
	/**
2475
	 * Set the menu title for this page.
2476
	 *
2477
	 * @param string $value
2478
	 */
2479
	public function setMenuTitle($value) {
2480
		if($value == $this->getField("Title")) {
2481
			$this->setField("MenuTitle", null);
2482
		} else {
2483
			$this->setField("MenuTitle", $value);
2484
		}
2485
	}
2486
2487
	/**
2488
	 * A flag provides the user with additional data about the current page status, for example a "removed from draft"
2489
	 * status. Each page can have more than one status flag. Returns a map of a unique key to a (localized) title for
2490
	 * the flag. The unique key can be reused as a CSS class. Use the 'updateStatusFlags' extension point to customize
2491
	 * the flags.
2492
	 *
2493
	 * Example (simple):
2494
	 *   "deletedonlive" => "Deleted"
2495
	 *
2496
	 * Example (with optional title attribute):
2497
	 *   "deletedonlive" => array('text' => "Deleted", 'title' => 'This page has been deleted')
2498
	 *
2499
	 * @param bool $cached Whether to serve the fields from cache; false regenerate them
2500
	 * @return array
2501
	 */
2502
	public function getStatusFlags($cached = true) {
2503
		if(!$this->_cache_statusFlags || !$cached) {
2504
			$flags = array();
2505
			if($this->getIsDeletedFromStage()) {
2506
				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...
2507
					$flags['removedfromdraft'] = array(
2508
						'text' => _t('SiteTree.REMOVEDFROMDRAFTSHORT', 'Removed from draft'),
2509
						'title' => _t('SiteTree.REMOVEDFROMDRAFTHELP', 'Page is published, but has been deleted from draft'),
2510
					);
2511
				} else {
2512
					$flags['archived'] = array(
2513
						'text' => _t('SiteTree.ARCHIVEDPAGESHORT', 'Archived'),
2514
						'title' => _t('SiteTree.ARCHIVEDPAGEHELP', 'Page is removed from draft and live'),
2515
					);
2516
				}
2517
			} else if($this->getIsAddedToStage()) {
2518
				$flags['addedtodraft'] = array(
2519
					'text' => _t('SiteTree.ADDEDTODRAFTSHORT', 'Draft'),
2520
					'title' => _t('SiteTree.ADDEDTODRAFTHELP', "Page has not been published yet")
2521
				);
2522
			} else if($this->getIsModifiedOnStage()) {
2523
				$flags['modified'] = array(
2524
					'text' => _t('SiteTree.MODIFIEDONDRAFTSHORT', 'Modified'),
2525
					'title' => _t('SiteTree.MODIFIEDONDRAFTHELP', 'Page has unpublished changes'),
2526
				);
2527
			}
2528
2529
			$this->extend('updateStatusFlags', $flags);
2530
2531
			$this->_cache_statusFlags = $flags;
2532
		}
2533
2534
		return $this->_cache_statusFlags;
2535
	}
2536
2537
	/**
2538
	 * getTreeTitle will return three <span> html DOM elements, an empty <span> with the class 'jstree-pageicon' in
2539
	 * front, following by a <span> wrapping around its MenutTitle, then following by a <span> indicating its
2540
	 * publication status.
2541
	 *
2542
	 * @return string An HTML string ready to be directly used in a template
2543
	 */
2544
	public function getTreeTitle() {
2545
		// Build the list of candidate children
2546
		$children = array();
2547
		$candidates = static::page_type_classes();
2548
		foreach($this->allowedChildren() as $childClass) {
2549
			if(!in_array($childClass, $candidates)) continue;
2550
			$child = singleton($childClass);
2551
			if($child->canCreate(null, array('Parent' => $this))) {
2552
				$children[$childClass] = $child->i18n_singular_name();
2553
			}
2554
		}
2555
		$flags = $this->getStatusFlags();
2556
		$treeTitle = sprintf(
2557
			"<span class=\"jstree-pageicon\"></span><span class=\"item\" data-allowedchildren=\"%s\">%s</span>",
2558
			Convert::raw2att(Convert::raw2json($children)),
2559
			Convert::raw2xml(str_replace(array("\n","\r"),"",$this->MenuTitle))
2560
		);
2561
		foreach($flags as $class => $data) {
2562
			if(is_string($data)) $data = array('text' => $data);
2563
			$treeTitle .= sprintf(
2564
				"<span class=\"badge %s\"%s>%s</span>",
2565
				'status-' . Convert::raw2xml($class),
2566
				(isset($data['title'])) ? sprintf(' title="%s"', Convert::raw2xml($data['title'])) : '',
2567
				Convert::raw2xml($data['text'])
2568
			);
2569
		}
2570
2571
		return $treeTitle;
2572
	}
2573
2574
	/**
2575
	 * Returns the page in the current page stack of the given level. Level(1) will return the main menu item that
2576
	 * we're currently inside, etc.
2577
	 *
2578
	 * @param int $level
2579
	 * @return SiteTree
2580
	 */
2581
	public function Level($level) {
2582
		$parent = $this;
2583
		$stack = array($parent);
2584
		while($parent = $parent->Parent) {
2585
			array_unshift($stack, $parent);
2586
		}
2587
2588
		return isset($stack[$level-1]) ? $stack[$level-1] : null;
2589
	}
2590
2591
	/**
2592
	 * Gets the depth of this page in the sitetree, where 1 is the root level
2593
	 *
2594
	 * @return int
2595
	 */
2596
	public function getPageLevel() {
2597
		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...
2598
			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...
2599
		}
2600
		return 1;
2601
	}
2602
2603
	/**
2604
	 * Return the CSS classes to apply to this node in the CMS tree.
2605
	 *
2606
	 * @param string $numChildrenMethod
2607
	 * @return string
2608
	 */
2609
	public function CMSTreeClasses($numChildrenMethod="numChildren") {
2610
		$classes = sprintf('class-%s', $this->class);
2611
		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...
2612
			$classes .= " BrokenLink";
2613
		}
2614
2615
		if(!$this->canAddChildren()) {
2616
			$classes .= " nochildren";
2617
		}
2618
2619
		if(!$this->canEdit() && !$this->canAddChildren()) {
2620
			if (!$this->canView()) {
2621
				$classes .= " disabled";
2622
			} else {
2623
				$classes .= " edit-disabled";
2624
			}
2625
		}
2626
2627
		if(!$this->ShowInMenus) {
2628
			$classes .= " notinmenu";
2629
		}
2630
2631
		//TODO: Add integration
2632
		/*
2633
		if($this->hasExtension('Translatable') && $controller->Locale != Translatable::default_locale() && !$this->isTranslation())
2634
			$classes .= " untranslated ";
2635
		*/
2636
		$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...
2637
2638
		return $classes;
2639
	}
2640
2641
	/**
2642
	 * Compares current draft with live version, and returns true if no draft version of this page exists  but the page
2643
	 * is still published (eg, after triggering "Delete from draft site" in the CMS).
2644
	 *
2645
	 * @return bool
2646
	 */
2647
	public function getIsDeletedFromStage() {
2648
		if(!$this->ID) return true;
2649
		if($this->isNew()) return false;
2650
2651
		$stageVersion = Versioned::get_versionnumber_by_stage('SiteTree', Versioned::DRAFT, $this->ID);
2652
2653
		// Return true for both completely deleted pages and for pages just deleted from stage
2654
		return !($stageVersion);
2655
	}
2656
2657
	/**
2658
	 * Return true if this page exists on the live site
2659
	 *
2660
	 * @return bool
2661
	 */
2662
	public function getExistsOnLive() {
2663
		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...
2664
	}
2665
2666
	/**
2667
	 * Compares current draft with live version, and returns true if these versions differ, meaning there have been
2668
	 * unpublished changes to the draft site.
2669
	 *
2670
	 * @return bool
2671
	 */
2672
	public function getIsModifiedOnStage() {
2673
		// New unsaved pages could be never be published
2674
		if($this->isNew()) return false;
2675
2676
		$stageVersion = Versioned::get_versionnumber_by_stage('SiteTree', 'Stage', $this->ID);
2677
		$liveVersion =	Versioned::get_versionnumber_by_stage('SiteTree', 'Live', $this->ID);
2678
2679
		$isModified = ($stageVersion && $stageVersion != $liveVersion);
2680
		$this->extend('getIsModifiedOnStage', $isModified);
2681
2682
		return $isModified;
2683
	}
2684
2685
	/**
2686
	 * Compares current draft with live version, and returns true if no live version exists, meaning the page was never
2687
	 * published.
2688
	 *
2689
	 * @return bool
2690
	 */
2691
	public function getIsAddedToStage() {
2692
		// New unsaved pages could be never be published
2693
		if($this->isNew()) return false;
2694
2695
		$stageVersion = Versioned::get_versionnumber_by_stage('SiteTree', 'Stage', $this->ID);
2696
		$liveVersion =	Versioned::get_versionnumber_by_stage('SiteTree', 'Live', $this->ID);
2697
2698
		return ($stageVersion && !$liveVersion);
2699
	}
2700
2701
	/**
2702
	 * Stops extendCMSFields() being called on getCMSFields(). This is useful when you need access to fields added by
2703
	 * subclasses of SiteTree in a extension. Call before calling parent::getCMSFields(), and reenable afterwards.
2704
	 */
2705
	static public function disableCMSFieldsExtensions() {
2706
		self::$runCMSFieldsExtensions = false;
2707
	}
2708
2709
	/**
2710
	 * Reenables extendCMSFields() being called on getCMSFields() after it has been disabled by
2711
	 * disableCMSFieldsExtensions().
2712
	 */
2713
	static public function enableCMSFieldsExtensions() {
2714
		self::$runCMSFieldsExtensions = true;
2715
	}
2716
2717
	public function providePermissions() {
2718
		return array(
2719
			'SITETREE_GRANT_ACCESS' => array(
2720
				'name' => _t('SiteTree.PERMISSION_GRANTACCESS_DESCRIPTION', 'Manage access rights for content'),
2721
				'help' => _t('SiteTree.PERMISSION_GRANTACCESS_HELP',  'Allow setting of page-specific access restrictions in the "Pages" section.'),
2722
				'category' => _t('Permissions.PERMISSIONS_CATEGORY', 'Roles and access permissions'),
2723
				'sort' => 100
2724
			),
2725
			'SITETREE_VIEW_ALL' => array(
2726
				'name' => _t('SiteTree.VIEW_ALL_DESCRIPTION', 'View any page'),
2727
				'category' => _t('Permissions.CONTENT_CATEGORY', 'Content permissions'),
2728
				'sort' => -100,
2729
				'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')
2730
			),
2731
			'SITETREE_EDIT_ALL' => array(
2732
				'name' => _t('SiteTree.EDIT_ALL_DESCRIPTION', 'Edit any page'),
2733
				'category' => _t('Permissions.CONTENT_CATEGORY', 'Content permissions'),
2734
				'sort' => -50,
2735
				'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')
2736
			),
2737
			'SITETREE_REORGANISE' => array(
2738
				'name' => _t('SiteTree.REORGANISE_DESCRIPTION', 'Change site structure'),
2739
				'category' => _t('Permissions.CONTENT_CATEGORY', 'Content permissions'),
2740
				'help' => _t('SiteTree.REORGANISE_HELP', 'Rearrange pages in the site tree through drag&drop.'),
2741
				'sort' => 100
2742
			),
2743
			'VIEW_DRAFT_CONTENT' => array(
2744
				'name' => _t('SiteTree.VIEW_DRAFT_CONTENT', 'View draft content'),
2745
				'category' => _t('Permissions.CONTENT_CATEGORY', 'Content permissions'),
2746
				'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.'),
2747
				'sort' => 100
2748
			)
2749
		);
2750
	}
2751
2752
	/**
2753
	 * Return the translated Singular name.
2754
	 *
2755
	 * @return string
2756
	 */
2757
	public function i18n_singular_name() {
2758
		// Convert 'Page' to 'SiteTree' for correct localization lookups
2759
		$class = ($this->class == 'Page') ? 'SiteTree' : $this->class;
2760
		return _t($class.'.SINGULARNAME', $this->singular_name());
2761
	}
2762
2763
	/**
2764
	 * Overloaded to also provide entities for 'Page' class which is usually located in custom code, hence textcollector
2765
	 * picks it up for the wrong folder.
2766
	 *
2767
	 * @return array
2768
	 */
2769
	public function provideI18nEntities() {
2770
		$entities = parent::provideI18nEntities();
2771
2772
		if(isset($entities['Page.SINGULARNAME'])) $entities['Page.SINGULARNAME'][3] = CMS_DIR;
2773
		if(isset($entities['Page.PLURALNAME'])) $entities['Page.PLURALNAME'][3] = CMS_DIR;
2774
2775
		$entities[$this->class . '.DESCRIPTION'] = array(
2776
			$this->stat('description'),
2777
			'Description of the page type (shown in the "add page" dialog)'
2778
		);
2779
2780
		$entities['SiteTree.SINGULARNAME'][0] = 'Page';
2781
		$entities['SiteTree.PLURALNAME'][0] = 'Pages';
2782
2783
		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...
2784
	}
2785
2786
	/**
2787
	 * Returns 'root' if the current page has no parent, or 'subpage' otherwise
2788
	 *
2789
	 * @return string
2790
	 */
2791
	public function getParentType() {
2792
		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...
2793
	}
2794
2795
	/**
2796
	 * Clear the permissions cache for SiteTree
2797
	 */
2798
	public static function reset() {
2799
		self::$cache_permissions = array();
2800
	}
2801
2802
	static public function on_db_reset() {
2803
		self::$cache_permissions = array();
2804
	}
2805
2806
}
2807