Completed
Pull Request — master (#1525)
by Damian
02:59
created

SiteTree::RelativeLink()   D

Complexity

Conditions 9
Paths 8

Size

Total Lines 25
Code Lines 13

Duplication

Lines 0
Ratio 0 %

Importance

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

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

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

Loading history...
289
				foreach($alternatives as $alternative) if($alternative) $sitetree = $alternative;
290
			}
291
292
			if(!$sitetree) return false;
0 ignored issues
show
Bug Best Practice introduced by
The return type of return false; (false) is incompatible with the return type documented by SiteTree::get_by_link of type SiteTree.

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

Let’s take a look at an example:

class Author {
    private $name;

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

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

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

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

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

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

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

Loading history...
293
		}
294
295
		// Check if we have any more URL parts to parse.
296
		if(!self::config()->nested_urls || !count($parts)) return $sitetree;
297
298
		// Traverse down the remaining URL segments and grab the relevant SiteTree objects.
299
		foreach($parts as $segment) {
300
			$next = DataObject::get_one('SiteTree', array(
301
					'"SiteTree"."URLSegment"' => $segment,
302
					'"SiteTree"."ParentID"' => $sitetree->ID
303
				),
304
				$cache
305
			);
306
307
			if(!$next) {
308
				$parentID = (int) $sitetree->ID;
309
310 View Code Duplication
				if($alternatives = singleton('SiteTree')->extend('alternateGetByLink', $segment, $parentID)) {
0 ignored issues
show
Duplication introduced by
This code seems to be duplicated across your project.

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

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

Loading history...
311
					foreach($alternatives as $alternative) if($alternative) $next = $alternative;
312
				}
313
314
				if(!$next) return false;
0 ignored issues
show
Bug Best Practice introduced by
The return type of return false; (false) is incompatible with the return type documented by SiteTree::get_by_link of type SiteTree.

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

Let’s take a look at an example:

class Author {
    private $name;

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

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

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

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

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

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

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

Loading history...
315
			}
316
317
			$sitetree->destroy();
318
			$sitetree = $next;
319
		}
320
321
		return $sitetree;
322
	}
323
324
	/**
325
	 * Return a subclass map of SiteTree that shouldn't be hidden through {@link SiteTree::$hide_ancestor}
326
	 *
327
	 * @return array
328
	 */
329
	public static function page_type_classes() {
330
		$classes = ClassInfo::getValidSubClasses();
331
332
		$baseClassIndex = array_search('SiteTree', $classes);
333
		if($baseClassIndex !== FALSE) unset($classes[$baseClassIndex]);
334
335
		$kill_ancestors = array();
336
337
		// figure out if there are any classes we don't want to appear
338
		foreach($classes as $class) {
339
			$instance = singleton($class);
340
341
			// do any of the progeny want to hide an ancestor?
342
			if($ancestor_to_hide = $instance->stat('hide_ancestor')) {
343
				// note for killing later
344
				$kill_ancestors[] = $ancestor_to_hide;
345
			}
346
		}
347
348
		// If any of the descendents don't want any of the elders to show up, cruelly render the elders surplus to
349
		// requirements
350
		if($kill_ancestors) {
0 ignored issues
show
Bug Best Practice introduced by
The expression $kill_ancestors of type array is implicitly converted to a boolean; are you sure this is intended? If so, consider using ! empty($expr) instead to make it clear that you intend to check for an array without elements.

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

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

Loading history...
351
			$kill_ancestors = array_unique($kill_ancestors);
352
			foreach($kill_ancestors as $mark) {
353
				// unset from $classes
354
				$idx = array_search($mark, $classes, true);
355
				if ($idx !== false) {
356
					unset($classes[$idx]);
357
				}
358
			}
359
		}
360
361
		return $classes;
362
	}
363
364
	/**
365
	 * Replace a "[sitetree_link id=n]" shortcode with a link to the page with the corresponding ID.
366
	 *
367
	 * @param array      $arguments
368
	 * @param string     $content
369
	 * @param TextParser $parser
370
	 * @return string
371
	 */
372
	static public function link_shortcode_handler($arguments, $content = null, $parser = null) {
373
		if(!isset($arguments['id']) || !is_numeric($arguments['id'])) return;
374
375
		if (
376
			   !($page = DataObject::get_by_id('SiteTree', $arguments['id']))         // Get the current page by ID.
377
			&& !($page = Versioned::get_latest_version('SiteTree', $arguments['id'])) // Attempt link to old version.
378
		) {
379
			 return null; // There were no suitable matches at all.
380
		}
381
382
		$link = Convert::raw2att($page->Link());
383
384
		if($content) {
0 ignored issues
show
Bug Best Practice introduced by
The expression $content of type string|null is loosely compared to true; this is ambiguous if the string can be empty. You might want to explicitly use !== null instead.

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

For string values, the empty string '' is a special case, in particular the following results might be unexpected:

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

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

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

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

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

Loading history...
Bug introduced by
It seems like $parser is not always an object, but can also be of type null. Maybe add an additional type check?

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

function someFunction(A $objectMaybe = null)
{
    if ($objectMaybe instanceof A) {
        $objectMaybe->doSomething();
    }
}
Loading history...
386
		} else {
387
			return $link;
388
		}
389
	}
390
391
	/**
392
	 * Return the link for this {@link SiteTree} object, with the {@link Director::baseURL()} included.
393
	 *
394
	 * @param string $action Optional controller action (method).
395
	 *                       Note: URI encoding of this parameter is applied automatically through template casting,
396
	 *                       don't encode the passed parameter. Please use {@link Controller::join_links()} instead to
397
	 *                       append GET parameters.
398
	 * @return string
399
	 */
400
	public function Link($action = null) {
401
		return Controller::join_links(Director::baseURL(), $this->RelativeLink($action));
402
	}
403
404
	/**
405
	 * Get the absolute URL for this page, including protocol and host.
406
	 *
407
	 * @param string $action See {@link Link()}
408
	 * @return string
409
	 */
410
	public function AbsoluteLink($action = null) {
411
		if($this->hasMethod('alternateAbsoluteLink')) {
412
			return $this->alternateAbsoluteLink($action);
0 ignored issues
show
Bug introduced by
The method alternateAbsoluteLink() does not exist on SiteTree. Did you maybe mean AbsoluteLink()?

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

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

Loading history...
413
		} else {
414
			return Director::absoluteURL($this->Link($action));
0 ignored issues
show
Comprehensibility Best Practice introduced by
The expression \Director::absoluteURL($this->Link($action)); of type string|false adds false to the return on line 414 which is incompatible with the return type documented by SiteTree::AbsoluteLink of type string. It seems like you forgot to handle an error condition.
Loading history...
415
		}
416
	}
417
418
	/**
419
	 * Base link used for previewing. Defaults to absolute URL, in order to account for domain changes, e.g. on multi
420
	 * site setups. Does not contain hints about the stage, see {@link SilverStripeNavigator} for details.
421
	 *
422
	 * @param string $action See {@link Link()}
423
	 * @return string
424
	 */
425
	public function PreviewLink($action = null) {
426
		if($this->hasMethod('alternatePreviewLink')) {
427
			Deprecation::notice('5.0', 'Use updatePreviewLink or override PreviewLink method');
428
			return $this->alternatePreviewLink($action);
0 ignored issues
show
Bug introduced by
The method alternatePreviewLink() does not exist on SiteTree. Did you maybe mean PreviewLink()?

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

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

Loading history...
429
		}
430
431
		$link = $this->AbsoluteLink($action);
432
		$this->extend('updatePreviewLink', $link, $action);
433
		return $link;
434
	}
435
436
	public function getMimeType() {
437
		return 'text/html';
438
	}
439
440
	/**
441
	 * Return the link for this {@link SiteTree} object relative to the SilverStripe root.
442
	 *
443
	 * By default, if this page is the current home page, and there is no action specified then this will return a link
444
	 * to the root of the site. However, if you set the $action parameter to TRUE then the link will not be rewritten
445
	 * and returned in its full form.
446
	 *
447
	 * @uses RootURLController::get_homepage_link()
448
	 *
449
	 * @param string $action See {@link Link()}
450
	 * @return string
451
	 */
452
	public function RelativeLink($action = null) {
453
		if($this->ParentID && self::config()->nested_urls) {
0 ignored issues
show
Documentation introduced by
The property ParentID does not exist on object<SiteTree>. Since you implemented __get, maybe consider adding a @property annotation.

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

<?php

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

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

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

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

}

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

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

See also the PhpDoc documentation for @property.

Loading history...
454
			$parent = $this->Parent();
0 ignored issues
show
Bug introduced by
The method Parent() does not exist on SiteTree. Did you maybe mean setParent()?

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

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

Loading history...
455
			// If page is removed select parent from version history (for archive page view)
456
			if((!$parent || !$parent->exists()) && $this->IsDeletedFromStage) {
0 ignored issues
show
Documentation introduced by
The property IsDeletedFromStage does not exist on object<SiteTree>. Since you implemented __get, maybe consider adding a @property annotation.

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

<?php

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

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

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

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

}

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

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

See also the PhpDoc documentation for @property.

Loading history...
457
				$parent = Versioned::get_latest_version('SiteTree', $this->ParentID);
0 ignored issues
show
Documentation introduced by
The property ParentID does not exist on object<SiteTree>. Since you implemented __get, maybe consider adding a @property annotation.

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

<?php

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

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

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

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

}

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

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

See also the PhpDoc documentation for @property.

Loading history...
458
			}
459
			$base = $parent->RelativeLink($this->URLSegment);
460
		} elseif(!$action && $this->URLSegment == RootURLController::get_homepage_link()) {
0 ignored issues
show
Bug Best Practice introduced by
The expression $action of type string|null is loosely compared to false; this is ambiguous if the string can be empty. You might want to explicitly use === null instead.

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

For string values, the empty string '' is a special case, in particular the following results might be unexpected:

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

// It is often better to use strict comparison
'' === false // false
'' === null  // false
Loading history...
461
			// Unset base for root-level homepages.
462
			// Note: Homepages with action parameters (or $action === true)
463
			// need to retain their URLSegment.
464
			$base = null;
465
		} else {
466
			$base = $this->URLSegment;
467
		}
468
469
		$this->extend('updateRelativeLink', $base, $action);
470
471
		// Legacy support: If $action === true, retain URLSegment for homepages,
472
		// but don't append any action
473
		if($action === true) $action = null;
474
475
		return Controller::join_links($base, '/', $action);
476
	}
477
478
	/**
479
	 * Get the absolute URL for this page on the Live site.
480
	 *
481
	 * @param bool $includeStageEqualsLive Whether to append the URL with ?stage=Live to force Live mode
482
	 * @return string
483
	 */
484
	public function getAbsoluteLiveLink($includeStageEqualsLive = true) {
485
		$oldStage = Versioned::get_stage();
486
		Versioned::set_stage(Versioned::LIVE);
487
		$live = Versioned::get_one_by_stage('SiteTree', Versioned::LIVE, array(
0 ignored issues
show
Documentation introduced by
array('"SiteTree"."ID"' => $this->ID) is of type array<string,integer,{"\...e\".\"ID\"":"integer"}>, but the function expects a string.

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

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

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

function acceptsInteger($int) { }

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

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
Loading history...
488
			'"SiteTree"."ID"' => $this->ID
489
		));
490
		if($live) {
491
			$link = $live->AbsoluteLink();
492
			if($includeStageEqualsLive) $link .= '?stage=Live';
493
		} else {
494
			$link = null;
495
		}
496
497
		Versioned::set_stage($oldStage);
498
		return $link;
499
	}
500
501
	/**
502
	 * Generates a link to edit this page in the CMS.
503
	 *
504
	 * @return string
505
	 */
506
	public function CMSEditLink() {
507
		$link = Controller::join_links(
508
			singleton('CMSPageEditController')->Link('show'),
509
			$this->ID
510
		);
511
		return Director::absoluteURL($link);
0 ignored issues
show
Comprehensibility Best Practice introduced by
The expression \Director::absoluteURL($link); of type string|false adds false to the return on line 511 which is incompatible with the return type declared by the interface CMSPreviewable::CMSEditLink of type string. It seems like you forgot to handle an error condition.
Loading history...
512
	}
513
514
515
	/**
516
	 * Return a CSS identifier generated from this page's link.
517
	 *
518
	 * @return string The URL segment
519
	 */
520
	public function ElementName() {
521
		return str_replace('/', '-', trim($this->RelativeLink(true), '/'));
0 ignored issues
show
Documentation introduced by
true is of type boolean, but the function expects a string|null.

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

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

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

function acceptsInteger($int) { }

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

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
Loading history...
522
	}
523
524
	/**
525
	 * Returns true if this is the currently active page being used to handle this request.
526
	 *
527
	 * @return bool
528
	 */
529
	public function isCurrent() {
530
		return $this->ID ? $this->ID == Director::get_current_page()->ID : $this === Director::get_current_page();
531
	}
532
533
	/**
534
	 * Check if this page is in the currently active section (e.g. it is either current or one of its children is
535
	 * currently being viewed).
536
	 *
537
	 * @return bool
538
	 */
539
	public function isSection() {
540
		return $this->isCurrent() || (
541
			Director::get_current_page() instanceof SiteTree && in_array($this->ID, Director::get_current_page()->getAncestors()->column())
0 ignored issues
show
Documentation Bug introduced by
The method getAncestors does not exist on object<SiteTree>? Since you implemented __call, maybe consider adding a @method annotation.

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

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

class ParentClass {
    private $data = array();

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

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

/**
 * If this class knows which fields exist, you can specify the methods here:
 *
 * @method string getName()
 */
class SomeClass extends ParentClass { }
Loading history...
542
		);
543
	}
544
545
	/**
546
	 * Check if the parent of this page has been removed (or made otherwise unavailable), and is still referenced by
547
	 * this child. Any such orphaned page may still require access via the CMS, but should not be shown as accessible
548
	 * to external users.
549
	 *
550
	 * @return bool
551
	 */
552
	public function isOrphaned() {
553
		// Always false for root pages
554
		if(empty($this->ParentID)) return false;
0 ignored issues
show
Documentation introduced by
The property ParentID does not exist on object<SiteTree>. Since you implemented __get, maybe consider adding a @property annotation.

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

<?php

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

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

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

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

}

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

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

See also the PhpDoc documentation for @property.

Loading history...
555
556
		// Parent must exist and not be an orphan itself
557
		$parent = $this->Parent();
0 ignored issues
show
Bug introduced by
The method Parent() does not exist on SiteTree. Did you maybe mean setParent()?

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

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

Loading history...
558
		return !$parent || !$parent->exists() || $parent->isOrphaned();
559
	}
560
561
	/**
562
	 * Return "link" or "current" depending on if this is the {@link SiteTree::isCurrent()} current page.
563
	 *
564
	 * @return string
565
	 */
566
	public function LinkOrCurrent() {
567
		return $this->isCurrent() ? 'current' : 'link';
568
	}
569
570
	/**
571
	 * Return "link" or "section" depending on if this is the {@link SiteTree::isSeciton()} current section.
572
	 *
573
	 * @return string
574
	 */
575
	public function LinkOrSection() {
576
		return $this->isSection() ? 'section' : 'link';
577
	}
578
579
	/**
580
	 * Return "link", "current" or "section" depending on if this page is the current page, or not on the current page
581
	 * but in the current section.
582
	 *
583
	 * @return string
584
	 */
585
	public function LinkingMode() {
586
		if($this->isCurrent()) {
587
			return 'current';
588
		} elseif($this->isSection()) {
589
			return 'section';
590
		} else {
591
			return 'link';
592
		}
593
	}
594
595
	/**
596
	 * Check if this page is in the given current section.
597
	 *
598
	 * @param string $sectionName Name of the section to check
599
	 * @return bool True if we are in the given section
600
	 */
601
	public function InSection($sectionName) {
602
		$page = Director::get_current_page();
603
		while($page) {
604
			if($sectionName == $page->URLSegment)
605
				return true;
606
			$page = $page->Parent;
607
		}
608
		return false;
609
	}
610
611
	/**
612
	 * Reset Sort on duped page
613
	 *
614
	 * @param SiteTree $original
615
	 * @param bool $doWrite
616
	 */
617
	public function onBeforeDuplicate($original, $doWrite) {
0 ignored issues
show
Unused Code introduced by
The parameter $original is not used and could be removed.

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

Loading history...
Unused Code introduced by
The parameter $doWrite 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...
618
		$this->Sort = 0;
619
	}
620
621
	/**
622
	 * Duplicates each child of this node recursively and returns the top-level duplicate node.
623
	 *
624
	 * @return self The duplicated object
625
	 */
626
	public function duplicateWithChildren() {
627
		$clone = $this->duplicate();
628
		$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...
629
630
		if($children) {
631
			foreach($children as $child) {
632
				$childClone = method_exists($child, 'duplicateWithChildren')
633
					? $child->duplicateWithChildren()
634
					: $child->duplicate();
635
				$childClone->ParentID = $clone->ID;
636
				$childClone->write();
637
			}
638
		}
639
640
		return $clone;
641
	}
642
643
	/**
644
	 * Duplicate this node and its children as a child of the node with the given ID
645
	 *
646
	 * @param int $id ID of the new node's new parent
647
	 */
648
	public function duplicateAsChild($id) {
649
		$newSiteTree = $this->duplicate();
650
		$newSiteTree->ParentID = $id;
651
		$newSiteTree->Sort = 0;
652
		$newSiteTree->write();
653
	}
654
655
	/**
656
	 * Return a breadcrumb trail to this page. Excludes "hidden" pages (with ShowInMenus=0) by default.
657
	 *
658
	 * @param int $maxDepth The maximum depth to traverse.
659
	 * @param boolean $unlinked Whether to link page titles.
660
	 * @param boolean|string $stopAtPageType ClassName of a page to stop the upwards traversal.
661
	 * @param boolean $showHidden Include pages marked with the attribute ShowInMenus = 0
662
	 * @return HTMLText The breadcrumb trail.
663
	 */
664
	public function Breadcrumbs($maxDepth = 20, $unlinked = false, $stopAtPageType = false, $showHidden = false) {
665
		$pages = $this->getBreadcrumbItems($maxDepth, $stopAtPageType, $showHidden);
666
		$template = new SSViewer('BreadcrumbsTemplate');
667
		return $template->process($this->customise(new ArrayData(array(
668
			"Pages" => $pages,
669
			"Unlinked" => $unlinked
670
		))));
671
	}
672
673
674
	/**
675
	 * Returns a list of breadcrumbs for the current page.
676
	 *
677
	 * @param int $maxDepth The maximum depth to traverse.
678
	 * @param boolean|string $stopAtPageType ClassName of a page to stop the upwards traversal.
679
	 * @param boolean $showHidden Include pages marked with the attribute ShowInMenus = 0
680
	 *
681
	 * @return ArrayList
682
	*/
683
	public function getBreadcrumbItems($maxDepth = 20, $stopAtPageType = false, $showHidden = false) {
684
		$page = $this;
685
		$pages = array();
686
687
		while(
688
			$page
689
 			&& (!$maxDepth || count($pages) < $maxDepth)
690
 			&& (!$stopAtPageType || $page->ClassName != $stopAtPageType)
691
 		) {
692
			if($showHidden || $page->ShowInMenus || ($page->ID == $this->ID)) {
693
				$pages[] = $page;
694
			}
695
696
			$page = $page->Parent;
697
		}
698
699
		return new ArrayList(array_reverse($pages));
700
	}
701
702
703
	/**
704
	 * Make this page a child of another page.
705
	 *
706
	 * If the parent page does not exist, resolve it to a valid ID before updating this page's reference.
707
	 *
708
	 * @param SiteTree|int $item Either the parent object, or the parent ID
709
	 */
710
	public function setParent($item) {
711
		if(is_object($item)) {
712
			if (!$item->exists()) $item->write();
713
			$this->setField("ParentID", $item->ID);
714
		} else {
715
			$this->setField("ParentID", $item);
716
		}
717
	}
718
719
	/**
720
	 * Get the parent of this page.
721
	 *
722
	 * @return SiteTree Parent of this page
723
	 */
724
	public function getParent() {
725
		if ($parentID = $this->getField("ParentID")) {
726
			return DataObject::get_by_id("SiteTree", $parentID);
727
		}
728
	}
729
730
	/**
731
	 * Return a string of the form "parent - page" or "grandparent - parent - page" using page titles
732
	 *
733
	 * @param int $level The maximum amount of levels to traverse.
734
	 * @param string $separator Seperating string
735
	 * @return string The resulting string
736
	 */
737
	public function NestedTitle($level = 2, $separator = " - ") {
738
		$item = $this;
739
		while($item && $level > 0) {
740
			$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...
741
			$item = $item->Parent;
742
			$level--;
743
		}
744
		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...
745
	}
746
747
	/**
748
	 * This function should return true if the current user can execute this action. It can be overloaded to customise
749
	 * the security model for an application.
750
	 *
751
	 * Slightly altered from parent behaviour in {@link DataObject->can()}:
752
	 * - Checks for existence of a method named "can<$perm>()" on the object
753
	 * - Calls decorators and only returns for FALSE "vetoes"
754
	 * - Falls back to {@link Permission::check()}
755
	 * - Does NOT check for many-many relations named "Can<$perm>"
756
	 *
757
	 * @uses DataObjectDecorator->can()
758
	 *
759
	 * @param string $perm The permission to be checked, such as 'View'
760
	 * @param Member $member The member whose permissions need checking. Defaults to the currently logged in user.
761
	 * @param array $context Context argument for canCreate()
762
	 * @return bool True if the the member is allowed to do the given action
763
	 */
764
	public function can($perm, $member = null, $context = array()) {
765 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...
766
			$member = Member::currentUserID();
767
		}
768
769
		if($member && Permission::checkMember($member, "ADMIN")) return true;
770
771
		if(is_string($perm) && method_exists($this, 'can' . ucfirst($perm))) {
772
			$method = 'can' . ucfirst($perm);
773
			return $this->$method($member);
774
		}
775
776
		$results = $this->extend('can', $member);
777
		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...
778
779
		return ($member && Permission::checkMember($member, $perm));
780
	}
781
782
	/**
783
	 * This function should return true if the current user can add children to this page. It can be overloaded to
784
	 * customise the security model for an application.
785
	 *
786
	 * Denies permission if any of the following conditions is true:
787
	 * - alternateCanAddChildren() on a extension returns false
788
	 * - canEdit() is not granted
789
	 * - There are no classes defined in {@link $allowed_children}
790
	 *
791
	 * @uses SiteTreeExtension->canAddChildren()
792
	 * @uses canEdit()
793
	 * @uses $allowed_children
794
	 *
795
	 * @param Member|int $member
796
	 * @return bool True if the current user can add children
797
	 */
798
	public function canAddChildren($member = null) {
799
		// Disable adding children to archived pages
800
		if($this->getIsDeletedFromStage()) {
801
			return false;
802
		}
803
804 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...
805
			$member = Member::currentUserID();
806
		}
807
808
		// Standard mechanism for accepting permission changes from extensions
809
		$extended = $this->extendedCan('canAddChildren', $member);
810
		if($extended !== null) {
811
			return $extended;
812
		}
813
814
		// Default permissions
815
		if($member && Permission::checkMember($member, "ADMIN")) {
816
			return true;
817
		}
818
819
		return $this->canEdit($member) && $this->stat('allowed_children') != 'none';
820
	}
821
822
	/**
823
	 * This function should return true if the current user can view this page. It can be overloaded to customise the
824
	 * security model for an application.
825
	 *
826
	 * Denies permission if any of the following conditions is true:
827
	 * - canView() on any extension returns false
828
	 * - "CanViewType" directive is set to "Inherit" and any parent page return false for canView()
829
	 * - "CanViewType" directive is set to "LoggedInUsers" and no user is logged in
830
	 * - "CanViewType" directive is set to "OnlyTheseUsers" and user is not in the given groups
831
	 *
832
	 * @uses DataExtension->canView()
833
	 * @uses ViewerGroups()
834
	 *
835
	 * @param Member|int $member
836
	 * @return bool True if the current user can view this page
837
	 */
838
	public function canView($member = null) {
839 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...
840
			$member = Member::currentUserID();
841
		}
842
843
		// Standard mechanism for accepting permission changes from extensions
844
		$extended = $this->extendedCan('canView', $member);
845
		if($extended !== null) {
846
			return $extended;
847
		}
848
849
		// admin override
850
		if($member && Permission::checkMember($member, array("ADMIN", "SITETREE_VIEW_ALL"))) {
851
			return true;
852
		}
853
854
		// Orphaned pages (in the current stage) are unavailable, except for admins via the CMS
855
		if($this->isOrphaned()) {
856
			return false;
857
		}
858
859
		// check for empty spec
860
		if(!$this->CanViewType || $this->CanViewType == 'Anyone') {
861
			return true;
862
		}
863
864
		// check for inherit
865
		if($this->CanViewType == 'Inherit') {
866
			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...
867
			else return $this->getSiteConfig()->canViewPages($member);
868
		}
869
870
		// check for any logged-in users
871
		if($this->CanViewType == 'LoggedInUsers' && $member) {
872
			return true;
873
		}
874
875
		// check for specific groups
876
		if($member && is_numeric($member)) {
877
			$member = DataObject::get_by_id('Member', $member);
878
		}
879
		if(
880
			$this->CanViewType == 'OnlyTheseUsers'
881
			&& $member
882
			&& $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...
883
		) return true;
884
885
		return false;
886
	}
887
888
	/**
889
	 * This function should return true if the current user can delete this page. It can be overloaded to customise the
890
	 * security model for an application.
891
	 *
892
	 * Denies permission if any of the following conditions is true:
893
	 * - canDelete() returns false on any extension
894
	 * - canEdit() returns false
895
	 * - any descendant page returns false for canDelete()
896
	 *
897
	 * @uses canDelete()
898
	 * @uses SiteTreeExtension->canDelete()
899
	 * @uses canEdit()
900
	 *
901
	 * @param Member $member
902
	 * @return bool True if the current user can delete this page
903
	 */
904
	public function canDelete($member = null) {
905 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...
906
		else if(is_numeric($member)) $memberID = $member;
907
		else $memberID = Member::currentUserID();
908
909
		// Standard mechanism for accepting permission changes from extensions
910
		$extended = $this->extendedCan('canDelete', $memberID);
911
		if($extended !== null) {
912
			return $extended;
913
		}
914
915
		// Default permission check
916
		if($memberID && Permission::checkMember($memberID, array("ADMIN", "SITETREE_EDIT_ALL"))) {
917
			return true;
918
		}
919
920
		// Regular canEdit logic is handled by can_edit_multiple
921
		$results = self::can_delete_multiple(array($this->ID), $memberID);
922
923
		// If this page no longer exists in stage/live results won't contain the page.
924
		// Fail-over to false
925
		return isset($results[$this->ID]) ? $results[$this->ID] : false;
926
	}
927
928
	/**
929
	 * This function should return true if the current user can create new pages of this class, regardless of class. It
930
	 * can be overloaded to customise the security model for an application.
931
	 *
932
	 * By default, permission to create at the root level is based on the SiteConfig configuration, and permission to
933
	 * create beneath a parent is based on the ability to edit that parent page.
934
	 *
935
	 * Use {@link canAddChildren()} to control behaviour of creating children under this page.
936
	 *
937
	 * @uses $can_create
938
	 * @uses DataExtension->canCreate()
939
	 *
940
	 * @param Member $member
941
	 * @param array $context Optional array which may contain array('Parent' => $parentObj)
942
	 *                       If a parent page is known, it will be checked for validity.
943
	 *                       If omitted, it will be assumed this is to be created as a top level page.
944
	 * @return bool True if the current user can create pages on this class.
945
	 */
946
	public function canCreate($member = null, $context = array()) {
947 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...
948
			$member = Member::currentUserID();
949
		}
950
951
		// Check parent (custom canCreate option for SiteTree)
952
		// Block children not allowed for this parent type
953
		$parent = isset($context['Parent']) ? $context['Parent'] : null;
954
		if($parent && !in_array(get_class($this), $parent->allowedChildren())) {
955
			return false;
956
		}
957
958
		// Standard mechanism for accepting permission changes from extensions
959
		$extended = $this->extendedCan(__FUNCTION__, $member, $context);
960
		if($extended !== null) {
961
			return $extended;
962
		}
963
964
		// Check permission
965
		if($member && Permission::checkMember($member, "ADMIN")) {
966
			return true;
967
		}
968
969
		// Fall over to inherited permissions
970
		if($parent) {
971
			return $parent->canAddChildren($member);
972
		} else {
973
			// This doesn't necessarily mean we are creating a root page, but that
974
			// we don't know if there is a parent, so default to this permission
975
			return SiteConfig::current_site_config()->canCreateTopLevel($member);
976
		}
977
	}
978
979
	/**
980
	 * This function should return true if the current user can edit this page. It can be overloaded to customise the
981
	 * security model for an application.
982
	 *
983
	 * Denies permission if any of the following conditions is true:
984
	 * - canEdit() on any extension returns false
985
	 * - canView() return false
986
	 * - "CanEditType" directive is set to "Inherit" and any parent page return false for canEdit()
987
	 * - "CanEditType" directive is set to "LoggedInUsers" and no user is logged in or doesn't have the
988
	 *   CMS_Access_CMSMAIN permission code
989
	 * - "CanEditType" directive is set to "OnlyTheseUsers" and user is not in the given groups
990
	 *
991
	 * @uses canView()
992
	 * @uses EditorGroups()
993
	 * @uses DataExtension->canEdit()
994
	 *
995
	 * @param Member $member Set to false if you want to explicitly test permissions without a valid user (useful for
996
	 *                       unit tests)
997
	 * @return bool True if the current user can edit this page
998
	 */
999
	public function canEdit($member = null) {
1000 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...
1001
		else if(is_numeric($member)) $memberID = $member;
1002
		else $memberID = Member::currentUserID();
1003
1004
		// Standard mechanism for accepting permission changes from extensions
1005
		$extended = $this->extendedCan('canEdit', $memberID);
1006
		if($extended !== null) {
1007
			return $extended;
1008
		}
1009
1010
		// Default permissions
1011
		if($memberID && Permission::checkMember($memberID, array("ADMIN", "SITETREE_EDIT_ALL"))) {
1012
			return true;
1013
		}
1014
1015
		if($this->ID) {
1016
			// Regular canEdit logic is handled by can_edit_multiple
1017
			$results = self::can_edit_multiple(array($this->ID), $memberID);
1018
1019
			// If this page no longer exists in stage/live results won't contain the page.
1020
			// Fail-over to false
1021
			return isset($results[$this->ID]) ? $results[$this->ID] : false;
1022
1023
		// Default for unsaved pages
1024
		} else {
1025
			return $this->getSiteConfig()->canEditPages($member);
1026
		}
1027
	}
1028
1029
	/**
1030
	 * Stub method to get the site config, unless the current class can provide an alternate.
1031
	 *
1032
	 * @return SiteConfig
1033
	 */
1034
	public function getSiteConfig() {
1035
1036
		if($this->hasMethod('alternateSiteConfig')) {
1037
			$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...
1038
			if($altConfig) return $altConfig;
1039
		}
1040
1041
		return SiteConfig::current_site_config();
1042
	}
1043
1044
	/**
1045
	 * Pre-populate the cache of canEdit, canView, canDelete, canPublish permissions. This method will use the static
1046
	 * can_(perm)_multiple method for efficiency.
1047
	 *
1048
	 * @param string          $permission    The permission: edit, view, publish, approve, etc.
1049
	 * @param array           $ids           An array of page IDs
1050
	 * @param callable|string $batchCallback The function/static method to call to calculate permissions.  Defaults
1051
	 *                                       to 'SiteTree::can_(permission)_multiple'
1052
	 */
1053
	static public function prepopulate_permission_cache($permission = 'CanEditType', $ids, $batchCallback = null) {
1054
		if(!$batchCallback) $batchCallback = "SiteTree::can_{$permission}_multiple";
1055
1056
		if(is_callable($batchCallback)) {
1057
			call_user_func($batchCallback, $ids, Member::currentUserID(), false);
1058
		} else {
1059
			user_error("SiteTree::prepopulate_permission_cache can't calculate '$permission' "
1060
				. "with callback '$batchCallback'", E_USER_WARNING);
1061
		}
1062
	}
1063
1064
	/**
1065
	 * This method is NOT a full replacement for the individual can*() methods, e.g. {@link canEdit()}. Rather than
1066
	 * checking (potentially slow) PHP logic, it relies on the database group associations, e.g. the "CanEditType" field
1067
	 * plus the "SiteTree_EditorGroups" many-many table. By batch checking multiple records, we can combine the queries
1068
	 * efficiently.
1069
	 *
1070
	 * Caches based on $typeField data. To invalidate the cache, use {@link SiteTree::reset()} or set the $useCached
1071
	 * property to FALSE.
1072
	 *
1073
	 * @param array  $ids              Of {@link SiteTree} IDs
1074
	 * @param int    $memberID         Member ID
1075
	 * @param string $typeField        A property on the data record, e.g. "CanEditType".
1076
	 * @param string $groupJoinTable   A many-many table name on this record, e.g. "SiteTree_EditorGroups"
1077
	 * @param string $siteConfigMethod Method to call on {@link SiteConfig} for toplevel items, e.g. "canEdit"
1078
	 * @param string $globalPermission If the member doesn't have this permission code, don't bother iterating deeper
1079
	 * @param bool   $useCached
1080
	 * @return array An map of {@link SiteTree} ID keys to boolean values
1081
	 */
1082
	public static function batch_permission_check($ids, $memberID, $typeField, $groupJoinTable, $siteConfigMethod,
1083
												  $globalPermission = null, $useCached = true) {
1084
		if($globalPermission === NULL) $globalPermission = array('CMS_ACCESS_LeftAndMain', 'CMS_ACCESS_CMSMain');
1085
1086
		// Sanitise the IDs
1087
		$ids = array_filter($ids, 'is_numeric');
1088
1089
		// This is the name used on the permission cache
1090
		// converts something like 'CanEditType' to 'edit'.
1091
		$cacheKey = strtolower(substr($typeField, 3, -4)) . "-$memberID";
1092
1093
		// Default result: nothing editable
1094
		$result = array_fill_keys($ids, false);
1095
		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...
1096
1097
			// Look in the cache for values
1098
			if($useCached && isset(self::$cache_permissions[$cacheKey])) {
1099
				$cachedValues = array_intersect_key(self::$cache_permissions[$cacheKey], $result);
1100
1101
				// If we can't find everything in the cache, then look up the remainder separately
1102
				$uncachedValues = array_diff_key($result, self::$cache_permissions[$cacheKey]);
1103
				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...
1104
					$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 1084 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...
1105
				}
1106
				return $cachedValues;
1107
			}
1108
1109
			// If a member doesn't have a certain permission then they can't edit anything
1110
			if(!$memberID || ($globalPermission && !Permission::checkMember($memberID, $globalPermission))) {
1111
				return $result;
1112
			}
1113
1114
			// Placeholder for parameterised ID list
1115
			$idPlaceholders = DB::placeholders($ids);
1116
1117
			// If page can't be viewed, don't grant edit permissions to do - implement can_view_multiple(), so this can
1118
			// be enabled
1119
			//$ids = array_keys(array_filter(self::can_view_multiple($ids, $memberID)));
1120
1121
			// Get the groups that the given member belongs to
1122
			$groupIDs = DataObject::get_by_id('Member', $memberID)->Groups()->column("ID");
1123
			$SQL_groupList = implode(", ", $groupIDs);
1124
			if (!$SQL_groupList) $SQL_groupList = '0';
1125
1126
			$combinedStageResult = array();
1127
1128
			foreach(array(Versioned::DRAFT, Versioned::LIVE) as $stage) {
1129
				// Start by filling the array with the pages that actually exist
1130
				$table = ($stage=='Stage') ? "SiteTree" : "SiteTree_$stage";
1131
1132
				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...
1133
					$idQuery = "SELECT \"ID\" FROM \"$table\" WHERE \"ID\" IN ($idPlaceholders)";
1134
					$stageIds = DB::prepared_query($idQuery, $ids)->column();
1135
				} else {
1136
					$stageIds = array();
1137
				}
1138
				$result = array_fill_keys($stageIds, false);
1139
1140
				// Get the uninherited permissions
1141
				$uninheritedPermissions = Versioned::get_by_stage("SiteTree", $stage)
1142
					->where(array(
1143
						"(\"$typeField\" = 'LoggedInUsers' OR
1144
						(\"$typeField\" = 'OnlyTheseUsers' AND \"$groupJoinTable\".\"SiteTreeID\" IS NOT NULL))
1145
						AND \"SiteTree\".\"ID\" IN ($idPlaceholders)"
1146
						=> $ids
1147
					))
1148
					->leftJoin($groupJoinTable, "\"$groupJoinTable\".\"SiteTreeID\" = \"SiteTree\".\"ID\" AND \"$groupJoinTable\".\"GroupID\" IN ($SQL_groupList)");
1149
1150
				if($uninheritedPermissions) {
1151
					// Set all the relevant items in $result to true
1152
					$result = array_fill_keys($uninheritedPermissions->column('ID'), true) + $result;
1153
				}
1154
1155
				// Get permissions that are inherited
1156
				$potentiallyInherited = Versioned::get_by_stage(
1157
					"SiteTree",
1158
					$stage,
1159
					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...
1160
				);
1161
1162
				if($potentiallyInherited) {
1163
					// Group $potentiallyInherited by ParentID; we'll look at the permission of all those parents and
1164
					// then see which ones the user has permission on
1165
					$groupedByParent = array();
1166
					foreach($potentiallyInherited as $item) {
1167
						if($item->ParentID) {
1168
							if(!isset($groupedByParent[$item->ParentID])) $groupedByParent[$item->ParentID] = array();
1169
							$groupedByParent[$item->ParentID][] = $item->ID;
1170
						} else {
1171
							// Might return different site config based on record context, e.g. when subsites module
1172
							// is used
1173
							$siteConfig = $item->getSiteConfig();
1174
							$result[$item->ID] = $siteConfig->{$siteConfigMethod}($memberID);
1175
						}
1176
					}
1177
1178
					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...
1179
						$actuallyInherited = self::batch_permission_check(array_keys($groupedByParent), $memberID, $typeField, $groupJoinTable, $siteConfigMethod);
1180
						if($actuallyInherited) {
1181
							$parentIDs = array_keys(array_filter($actuallyInherited));
1182
							foreach($parentIDs as $parentID) {
1183
								// Set all the relevant items in $result to true
1184
								$result = array_fill_keys($groupedByParent[$parentID], true) + $result;
1185
							}
1186
						}
1187
					}
1188
				}
1189
1190
				$combinedStageResult = $combinedStageResult + $result;
1191
1192
			}
1193
		}
1194
1195
		if(isset($combinedStageResult)) {
1196
			// Cache the results
1197
 			if(empty(self::$cache_permissions[$cacheKey])) self::$cache_permissions[$cacheKey] = array();
1198
 			self::$cache_permissions[$cacheKey] = $combinedStageResult + self::$cache_permissions[$cacheKey];
1199
1200
			return $combinedStageResult;
1201
		} else {
1202
			return array();
1203
		}
1204
	}
1205
1206
	/**
1207
	 * Get the 'can edit' information for a number of SiteTree pages.
1208
	 *
1209
	 * @param array $ids       An array of IDs of the SiteTree pages to look up
1210
	 * @param int   $memberID  ID of member
1211
	 * @param bool  $useCached Return values from the permission cache if they exist
1212
	 * @return array A map where the IDs are keys and the values are booleans stating whether the given page can be
1213
	 *                         edited
1214
	 */
1215
	static public function can_edit_multiple($ids, $memberID, $useCached = true) {
1216
		return self::batch_permission_check($ids, $memberID, 'CanEditType', 'SiteTree_EditorGroups', 'canEditPages', null, $useCached);
1217
	}
1218
1219
	/**
1220
	 * Get the 'can edit' information for a number of SiteTree pages.
1221
	 *
1222
	 * @param array $ids       An array of IDs of the SiteTree pages to look up
1223
	 * @param int   $memberID  ID of member
1224
	 * @param bool  $useCached Return values from the permission cache if they exist
1225
	 * @return array
1226
	 */
1227
	static public function can_delete_multiple($ids, $memberID, $useCached = true) {
1228
		$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...
1229
		$result = array_fill_keys($ids, false);
1230
		$cacheKey = "delete-$memberID";
1231
1232
		// Look in the cache for values
1233
		if($useCached && isset(self::$cache_permissions[$cacheKey])) {
1234
			$cachedValues = array_intersect_key(self::$cache_permissions[$cacheKey], $result);
1235
1236
			// If we can't find everything in the cache, then look up the remainder separately
1237
			$uncachedValues = array_diff_key($result, self::$cache_permissions[$cacheKey]);
1238
			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...
1239
				$cachedValues = self::can_delete_multiple(array_keys($uncachedValues), $memberID, false)
1240
					+ $cachedValues;
1241
			}
1242
			return $cachedValues;
1243
		}
1244
1245
		// You can only delete pages that you can edit
1246
		$editableIDs = array_keys(array_filter(self::can_edit_multiple($ids, $memberID)));
1247
		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...
1248
1249
			// You can only delete pages whose children you can delete
1250
			$editablePlaceholders = DB::placeholders($editableIDs);
1251
			$childRecords = SiteTree::get()->where(array(
1252
				"\"SiteTree\".\"ParentID\" IN ($editablePlaceholders)" => $editableIDs
1253
			));
1254
			if($childRecords) {
1255
				$children = $childRecords->map("ID", "ParentID");
1256
1257
				// Find out the children that can be deleted
1258
				$deletableChildren = self::can_delete_multiple($children->keys(), $memberID);
1259
1260
				// Get a list of all the parents that have no undeletable children
1261
				$deletableParents = array_fill_keys($editableIDs, true);
1262
				foreach($deletableChildren as $id => $canDelete) {
1263
					if(!$canDelete) unset($deletableParents[$children[$id]]);
1264
				}
1265
1266
				// Use that to filter the list of deletable parents that have children
1267
				$deletableParents = array_keys($deletableParents);
1268
1269
				// Also get the $ids that don't have children
1270
				$parents = array_unique($children->values());
1271
				$deletableLeafNodes = array_diff($editableIDs, $parents);
1272
1273
				// Combine the two
1274
				$deletable = array_merge($deletableParents, $deletableLeafNodes);
1275
1276
			} else {
1277
				$deletable = $editableIDs;
1278
			}
1279
		} else {
1280
			$deletable = array();
1281
		}
1282
1283
		// Convert the array of deletable IDs into a map of the original IDs with true/false as the value
1284
		return array_fill_keys($deletable, true) + array_fill_keys($ids, false);
1285
	}
1286
1287
	/**
1288
	 * Collate selected descendants of this page.
1289
	 *
1290
	 * {@link $condition} will be evaluated on each descendant, and if it is succeeds, that item will be added to the
1291
	 * $collator array.
1292
	 *
1293
	 * @param string $condition The PHP condition to be evaluated. The page will be called $item
1294
	 * @param array  $collator  An array, passed by reference, to collect all of the matching descendants.
1295
	 * @return bool
1296
	 */
1297
	public function collateDescendants($condition, &$collator) {
1298
		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...
1299
			foreach($children as $item) {
1300
				if(eval("return $condition;")) $collator[] = $item;
1301
				$item->collateDescendants($condition, $collator);
1302
			}
1303
			return true;
1304
		}
1305
	}
1306
1307
	/**
1308
	 * Return the title, description, keywords and language metatags.
1309
	 *
1310
	 * @todo Move <title> tag in separate getter for easier customization and more obvious usage
1311
	 *
1312
	 * @param bool $includeTitle Show default <title>-tag, set to false for custom templating
1313
	 * @return string The XHTML metatags
1314
	 */
1315
	public function MetaTags($includeTitle = true) {
1316
		$tags = "";
1317
		if($includeTitle === true || $includeTitle == 'true') {
1318
			$tags .= "<title>" . Convert::raw2xml($this->Title) . "</title>\n";
1319
		}
1320
1321
		$generator = trim(Config::inst()->get('SiteTree', 'meta_generator'));
1322
		if (!empty($generator)) {
1323
			$tags .= "<meta name=\"generator\" content=\"" . Convert::raw2att($generator) . "\" />\n";
1324
		}
1325
1326
		$charset = Config::inst()->get('ContentNegotiator', 'encoding');
1327
		$tags .= "<meta http-equiv=\"Content-type\" content=\"text/html; charset=$charset\" />\n";
1328
		if($this->MetaDescription) {
1329
			$tags .= "<meta name=\"description\" content=\"" . Convert::raw2att($this->MetaDescription) . "\" />\n";
1330
		}
1331
		if($this->ExtraMeta) {
1332
			$tags .= $this->ExtraMeta . "\n";
1333
		}
1334
1335
		if(Permission::check('CMS_ACCESS_CMSMain')
1336
			&& in_array('CMSPreviewable', class_implements($this))
1337
			&& !$this instanceof ErrorPage
1338
			&& $this->ID > 0
1339
		) {
1340
			$tags .= "<meta name=\"x-page-id\" content=\"{$this->ID}\" />\n";
1341
			$tags .= "<meta name=\"x-cms-edit-link\" content=\"" . $this->CMSEditLink() . "\" />\n";
1342
		}
1343
1344
		$this->extend('MetaTags', $tags);
1345
1346
		return $tags;
1347
	}
1348
1349
	/**
1350
	 * Returns the object that contains the content that a user would associate with this page.
1351
	 *
1352
	 * Ordinarily, this is just the page itself, but for example on RedirectorPages or VirtualPages ContentSource() will
1353
	 * return the page that is linked to.
1354
	 *
1355
	 * @return $this
1356
	 */
1357
	public function ContentSource() {
1358
		return $this;
1359
	}
1360
1361
	/**
1362
	 * Add default records to database.
1363
	 *
1364
	 * This function is called whenever the database is built, after the database tables have all been created. Overload
1365
	 * this to add default records when the database is built, but make sure you call parent::requireDefaultRecords().
1366
	 */
1367
	public function requireDefaultRecords() {
1368
		parent::requireDefaultRecords();
1369
1370
		// default pages
1371
		if($this->class == 'SiteTree' && $this->config()->create_default_pages) {
1372
			if(!SiteTree::get_by_link(Config::inst()->get('RootURLController', 'default_homepage_link'))) {
1373
				$homepage = new Page();
1374
				$homepage->Title = _t('SiteTree.DEFAULTHOMETITLE', 'Home');
1375
				$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>');
1376
				$homepage->URLSegment = Config::inst()->get('RootURLController', 'default_homepage_link');
1377
				$homepage->Sort = 1;
1378
				$homepage->write();
1379
				$homepage->copyVersionToStage(Versioned::DRAFT, Versioned::LIVE);
1380
				$homepage->flushCache();
1381
				DB::alteration_message('Home page created', 'created');
1382
			}
1383
1384
			if(DB::query("SELECT COUNT(*) FROM \"SiteTree\"")->value() == 1) {
1385
				$aboutus = new Page();
1386
				$aboutus->Title = _t('SiteTree.DEFAULTABOUTTITLE', 'About Us');
1387
				$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>');
1388
				$aboutus->Sort = 2;
1389
				$aboutus->write();
1390
				$aboutus->copyVersionToStage(Versioned::DRAFT, Versioned::LIVE);
1391
				$aboutus->flushCache();
1392
				DB::alteration_message('About Us page created', 'created');
1393
1394
				$contactus = new Page();
1395
				$contactus->Title = _t('SiteTree.DEFAULTCONTACTTITLE', 'Contact Us');
1396
				$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>');
1397
				$contactus->Sort = 3;
1398
				$contactus->write();
1399
				$contactus->copyVersionToStage(Versioned::DRAFT, Versioned::LIVE);
1400
				$contactus->flushCache();
1401
				DB::alteration_message('Contact Us page created', 'created');
1402
			}
1403
		}
1404
1405
		// schema migration
1406
		// @todo Move to migration task once infrastructure is implemented
1407
		if($this->class == 'SiteTree') {
1408
			$conn = DB::get_schema();
1409
			// only execute command if fields haven't been renamed to _obsolete_<fieldname> already by the task
1410
			if($conn->hasField('SiteTree' ,'Viewers')) {
1411
				$task = new UpgradeSiteTreePermissionSchemaTask();
1412
				$task->run(new SS_HTTPRequest('GET','/'));
1413
			}
1414
		}
1415
	}
1416
1417
	protected function onBeforeWrite() {
1418
		parent::onBeforeWrite();
1419
1420
		// If Sort hasn't been set, make this page come after it's siblings
1421
		if(!$this->Sort) {
1422
			$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...
1423
			$this->Sort = DB::prepared_query(
1424
				"SELECT MAX(\"Sort\") + 1 FROM \"SiteTree\" WHERE \"ParentID\" = ?",
1425
				array($parentID)
1426
			)->value();
1427
		}
1428
1429
		// If there is no URLSegment set, generate one from Title
1430
		$defaultSegment = $this->generateURLSegment(_t(
1431
			'CMSMain.NEWPAGE',
1432
			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...
1433
		));
1434
		if((!$this->URLSegment || $this->URLSegment == $defaultSegment) && $this->Title) {
1435
			$this->URLSegment = $this->generateURLSegment($this->Title);
1436
		} else if($this->isChanged('URLSegment', 2)) {
1437
			// Do a strict check on change level, to avoid double encoding caused by
1438
			// bogus changes through forceChange()
1439
			$filter = URLSegmentFilter::create();
1440
			$this->URLSegment = $filter->filter($this->URLSegment);
1441
			// If after sanitising there is no URLSegment, give it a reasonable default
1442
			if(!$this->URLSegment) $this->URLSegment = "page-$this->ID";
1443
		}
1444
1445
		// Ensure that this object has a non-conflicting URLSegment value.
1446
		$count = 2;
1447
		while(!$this->validURLSegment()) {
1448
			$this->URLSegment = preg_replace('/-[0-9]+$/', null, $this->URLSegment) . '-' . $count;
1449
			$count++;
1450
		}
1451
1452
		$this->syncLinkTracking();
1453
1454
		// Check to see if we've only altered fields that shouldn't affect versioning
1455
		$fieldsIgnoredByVersioning = array('HasBrokenLink', 'Status', 'HasBrokenFile', 'ToDo', 'VersionID', 'SaveCount');
1456
		$changedFields = array_keys($this->getChangedFields(true, 2));
1457
1458
		// This more rigorous check is inline with the test that write() does to decide whether or not to write to the
1459
		// DB. We use that to avoid cluttering the system with a migrateVersion() call that doesn't get used
1460
		$oneChangedFields = array_keys($this->getChangedFields(true, 1));
1461
1462
		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...
1463
			// This will have the affect of preserving the versioning
1464
			$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...
1465
		}
1466
	}
1467
1468
	/**
1469
	 * Trigger synchronisation of link tracking
1470
	 *
1471
	 * {@see SiteTreeLinkTracking::augmentSyncLinkTracking}
1472
	 */
1473
	public function syncLinkTracking() {
1474
		$this->extend('augmentSyncLinkTracking');
1475
	}
1476
1477
	public function onBeforeDelete() {
1478
		parent::onBeforeDelete();
1479
1480
		// If deleting this page, delete all its children.
1481
		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...
1482
			foreach($children as $child) {
1483
				$child->delete();
1484
			}
1485
		}
1486
	}
1487
1488
	public function onAfterDelete() {
1489
		// Need to flush cache to avoid outdated versionnumber references
1490
		$this->flushCache();
1491
1492
		// Need to mark pages depending to this one as broken
1493
		$dependentPages = $this->DependentPages();
1494
		if($dependentPages) foreach($dependentPages as $page) {
1495
			// $page->write() calls syncLinkTracking, which does all the hard work for us.
1496
			$page->write();
1497
		}
1498
1499
		parent::onAfterDelete();
1500
	}
1501
1502
	public function flushCache($persistent = true) {
1503
		parent::flushCache($persistent);
1504
		$this->_cache_statusFlags = null;
1505
	}
1506
1507
	public function validate() {
1508
		$result = parent::validate();
1509
1510
		// Allowed children validation
1511
		$parent = $this->getParent();
1512
		if($parent && $parent->exists()) {
1513
			// No need to check for subclasses or instanceof, as allowedChildren() already
1514
			// deconstructs any inheritance trees already.
1515
			$allowed = $parent->allowedChildren();
1516
			$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...
1517
			if(!in_array($subject->ClassName, $allowed)) {
1518
1519
				$result->error(
1520
					_t(
1521
						'SiteTree.PageTypeNotAllowed',
1522
						'Page type "{type}" not allowed as child of this parent page',
1523
						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...
1524
					),
1525
					'ALLOWED_CHILDREN'
1526
				);
1527
			}
1528
		}
1529
1530
		// "Can be root" validation
1531
		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...
1532
			$result->error(
1533
				_t(
1534
					'SiteTree.PageTypNotAllowedOnRoot',
1535
					'Page type "{type}" is not allowed on the root level',
1536
					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...
1537
				),
1538
				'CAN_BE_ROOT'
1539
			);
1540
		}
1541
1542
		return $result;
1543
	}
1544
1545
	/**
1546
	 * Returns true if this object has a URLSegment value that does not conflict with any other objects. This method
1547
	 * checks for:
1548
	 *  - A page with the same URLSegment that has a conflict
1549
	 *  - Conflicts with actions on the parent page
1550
	 *  - A conflict caused by a root page having the same URLSegment as a class name
1551
	 *
1552
	 * @return bool
1553
	 */
1554
	public function validURLSegment() {
1555
		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...
1556
			if($controller = ModelAsController::controller_for($parent)) {
1557
				if($controller instanceof Controller && $controller->hasAction($this->URLSegment)) return false;
1558
			}
1559
		}
1560
1561
		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...
1562
			if(class_exists($this->URLSegment) && is_subclass_of($this->URLSegment, 'RequestHandler')) return false;
1563
		}
1564
1565
		// Filters by url, id, and parent
1566
		$filter = array('"SiteTree"."URLSegment"' => $this->URLSegment);
1567
		if($this->ID) {
1568
			$filter['"SiteTree"."ID" <> ?'] = $this->ID;
1569
		}
1570
		if(self::config()->nested_urls) {
1571
			$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...
1572
		}
1573
1574
		$votes = array_filter(
1575
			(array)$this->extend('augmentValidURLSegment'),
1576
			function($v) {return !is_null($v);}
1577
		);
1578
		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...
1579
			return min($votes);
1580
		}
1581
1582
		// Check existence
1583
		$existingPage = DataObject::get_one('SiteTree', $filter);
1584
		if ($existingPage) return false;
1585
1586
		return !($existingPage);
1587
		}
1588
1589
	/**
1590
	 * Generate a URL segment based on the title provided.
1591
	 *
1592
	 * If {@link Extension}s wish to alter URL segment generation, they can do so by defining
1593
	 * updateURLSegment(&$url, $title).  $url will be passed by reference and should be modified. $title will contain
1594
	 * the title that was originally used as the source of this generated URL. This lets extensions either start from
1595
	 * scratch, or incrementally modify the generated URL.
1596
	 *
1597
	 * @param string $title Page title
1598
	 * @return string Generated url segment
1599
	 */
1600
	public function generateURLSegment($title){
1601
		$filter = URLSegmentFilter::create();
1602
		$t = $filter->filter($title);
1603
1604
		// Fallback to generic page name if path is empty (= no valid, convertable characters)
1605
		if(!$t || $t == '-' || $t == '-1') $t = "page-$this->ID";
1606
1607
		// Hook for extensions
1608
		$this->extend('updateURLSegment', $t, $title);
1609
1610
		return $t;
1611
	}
1612
1613
	/**
1614
	 * Gets the URL segment for the latest draft version of this page.
1615
	 *
1616
	 * @return string
1617
	 */
1618
	public function getStageURLSegment() {
1619
		$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...
1620
			'"SiteTree"."ID"' => $this->ID
1621
		));
1622
		return ($stageRecord) ? $stageRecord->URLSegment : null;
1623
	}
1624
1625
	/**
1626
	 * Gets the URL segment for the currently published version of this page.
1627
	 *
1628
	 * @return string
1629
	 */
1630
	public function getLiveURLSegment() {
1631
		$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...
1632
			'"SiteTree"."ID"' => $this->ID
1633
		));
1634
		return ($liveRecord) ? $liveRecord->URLSegment : null;
1635
	}
1636
1637
	/**
1638
	 * Returns the pages that depend on this page. This includes virtual pages, pages that link to it, etc.
1639
	 *
1640
	 * @param bool $includeVirtuals Set to false to exlcude virtual pages.
1641
	 * @return ArrayList
1642
	 */
1643
	public function DependentPages($includeVirtuals = true) {
1644
		if(class_exists('Subsite')) {
1645
			$origDisableSubsiteFilter = Subsite::$disable_subsite_filter;
1646
			Subsite::disable_subsite_filter(true);
1647
		}
1648
1649
		// Content links
1650
		$items = new ArrayList();
1651
1652
		// We merge all into a regular SS_List, because DataList doesn't support merge
1653
		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...
1654
			$linkList = new ArrayList();
1655
			foreach($contentLinks as $item) {
1656
				$item->DependentLinkType = 'Content link';
1657
				$linkList->push($item);
1658
			}
1659
			$items->merge($linkList);
1660
		}
1661
1662
		// Virtual pages
1663
		if($includeVirtuals) {
1664
			$virtuals = $this->VirtualPages();
1665
			if($virtuals) {
1666
				$virtualList = new ArrayList();
1667
				foreach($virtuals as $item) {
1668
					$item->DependentLinkType = 'Virtual page';
1669
					$virtualList->push($item);
1670
				}
1671
				$items->merge($virtualList);
1672
			}
1673
		}
1674
1675
		// Redirector pages
1676
		$redirectors = RedirectorPage::get()->where(array(
1677
			'"RedirectorPage"."RedirectionType"' => 'Internal',
1678
			'"RedirectorPage"."LinkToID"' => $this->ID
1679
		));
1680
		if($redirectors) {
1681
			$redirectorList = new ArrayList();
1682
			foreach($redirectors as $item) {
1683
				$item->DependentLinkType = 'Redirector page';
1684
				$redirectorList->push($item);
1685
			}
1686
			$items->merge($redirectorList);
1687
		}
1688
1689
		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...
1690
1691
		return $items;
1692
	}
1693
1694
	/**
1695
	 * Return all virtual pages that link to this page.
1696
	 *
1697
	 * @return DataList
1698
	 */
1699
	public function VirtualPages() {
1700
		$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...
1701
1702
		// Disable subsite filter for these pages
1703
		if($pages instanceof DataList) {
1704
			return $pages->setDataQueryParam('Subsite.filter', false);
1705
		} else {
1706
			return $pages;
1707
		}
1708
	}
1709
1710
	/**
1711
	 * Returns a FieldList with which to create the main editing form.
1712
	 *
1713
	 * You can override this in your child classes to add extra fields - first get the parent fields using
1714
	 * parent::getCMSFields(), then use addFieldToTab() on the FieldList.
1715
	 *
1716
	 * See {@link getSettingsFields()} for a different set of fields concerned with configuration aspects on the record,
1717
	 * e.g. access control.
1718
	 *
1719
	 * @return FieldList The fields to be displayed in the CMS
1720
	 */
1721
	public function getCMSFields() {
1722
		require_once("forms/Form.php");
1723
		// Status / message
1724
		// Create a status message for multiple parents
1725
		if($this->ID && is_numeric($this->ID)) {
1726
			$linkedPages = $this->VirtualPages();
1727
1728
			$parentPageLinks = array();
1729
1730
			if($linkedPages->Count() > 0) {
1731
				foreach($linkedPages as $linkedPage) {
1732
					$parentPage = $linkedPage->Parent;
1733
					if($parentPage) {
1734
						if($parentPage->ID) {
1735
							$parentPageLinks[] = "<a class=\"cmsEditlink\" href=\"admin/pages/edit/show/$linkedPage->ID\">{$parentPage->Title}</a>";
1736
						} else {
1737
							$parentPageLinks[] = "<a class=\"cmsEditlink\" href=\"admin/pages/edit/show/$linkedPage->ID\">" .
1738
								_t('SiteTree.TOPLEVEL', 'Site Content (Top Level)') .
1739
								"</a>";
1740
						}
1741
					}
1742
				}
1743
1744
				$lastParent = array_pop($parentPageLinks);
1745
				$parentList = "'$lastParent'";
1746
1747
				if(count($parentPageLinks) > 0) {
1748
					$parentList = "'" . implode("', '", $parentPageLinks) . "' and "
1749
						. $parentList;
1750
				}
1751
1752
				$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...
1753
					'SiteTree.APPEARSVIRTUALPAGES',
1754
					"This content also appears on the virtual pages in the {title} sections.",
1755
					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...
1756
				);
1757
			}
1758
		}
1759
1760
		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...
1761
			$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...
1762
		}
1763
1764
		$dependentNote = '';
1765
		$dependentTable = new LiteralField('DependentNote', '<p></p>');
1766
1767
		// Create a table for showing pages linked to this one
1768
		$dependentPages = $this->DependentPages();
1769
		$dependentPagesCount = $dependentPages->Count();
1770
		if($dependentPagesCount) {
1771
			$dependentColumns = array(
1772
				'Title' => $this->fieldLabel('Title'),
1773
				'AbsoluteLink' => _t('SiteTree.DependtPageColumnURL', 'URL'),
1774
				'DependentLinkType' => _t('SiteTree.DependtPageColumnLinkType', 'Link type'),
1775
			);
1776
			if(class_exists('Subsite')) $dependentColumns['Subsite.Title'] = singleton('Subsite')->i18n_singular_name();
1777
1778
			$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>');
1779
			$dependentTable = GridField::create(
1780
				'DependentPages',
1781
				false,
1782
				$dependentPages
1783
			);
1784
			$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...
1785
				->setDisplayFields($dependentColumns)
1786
				->setFieldFormatting(array(
1787
					'Title' => function($value, &$item) {
1788
						return sprintf(
1789
							'<a href="admin/pages/edit/show/%d">%s</a>',
1790
							(int)$item->ID,
1791
							Convert::raw2xml($item->Title)
1792
						);
1793
					},
1794
					'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...
1795
						return sprintf(
1796
							'<a href="%s" target="_blank">%s</a>',
1797
							Convert::raw2xml($value),
1798
							Convert::raw2xml($value)
1799
						);
1800
					}
1801
				));
1802
		}
1803
1804
		$baseLink = Controller::join_links (
1805
			Director::absoluteBaseURL(),
1806
			(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...
1807
		);
1808
1809
		$urlsegment = SiteTreeURLSegmentField::create("URLSegment", $this->fieldLabel('URLSegment'))
1810
			->setURLPrefix($baseLink)
1811
			->setDefaultURL($this->generateURLSegment(_t(
1812
				'CMSMain.NEWPAGE',
1813
				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...
1814
			)));
1815
		$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...
1816
		if(!Config::inst()->get('URLSegmentFilter', 'default_allow_multibyte')) {
1817
			$helpText .= $helpText ? '<br />' : '';
1818
			$helpText .= _t('SiteTreeURLSegmentField.HelpChars', ' Special characters are automatically converted or removed.');
1819
		}
1820
		$urlsegment->setHelpText($helpText);
1821
1822
		$fields = new FieldList(
1823
			$rootTab = new TabSet("Root",
1824
				$tabMain = new Tab('Main',
1825
					new TextField("Title", $this->fieldLabel('Title')),
1826
					$urlsegment,
1827
					new TextField("MenuTitle", $this->fieldLabel('MenuTitle')),
1828
					$htmlField = new HTMLEditorField("Content", _t('SiteTree.HTMLEDITORTITLE', "Content", 'HTML editor title')),
1829
					ToggleCompositeField::create('Metadata', _t('SiteTree.MetadataToggle', 'Metadata'),
1830
						array(
1831
							$metaFieldDesc = new TextareaField("MetaDescription", $this->fieldLabel('MetaDescription')),
1832
							$metaFieldExtra = new TextareaField("ExtraMeta",$this->fieldLabel('ExtraMeta'))
1833
						)
1834
					)->setHeadingLevel(4)
1835
				),
1836
				$tabDependent = new Tab('Dependent',
1837
					$dependentNote,
1838
					$dependentTable
1839
				)
1840
			)
1841
		);
1842
		$htmlField->addExtraClass('stacked');
1843
1844
		// Help text for MetaData on page content editor
1845
		$metaFieldDesc
1846
			->setRightTitle(
1847
				_t(
1848
					'SiteTree.METADESCHELP',
1849
					"Search engines use this content for displaying search results (although it will not influence their ranking)."
1850
				)
1851
			)
1852
			->addExtraClass('help');
1853
		$metaFieldExtra
1854
			->setRightTitle(
1855
				_t(
1856
					'SiteTree.METAEXTRAHELP',
1857
					"HTML tags for additional meta information. For example &lt;meta name=\"customName\" content=\"your custom content here\" /&gt;"
1858
				)
1859
			)
1860
			->addExtraClass('help');
1861
1862
		// Conditional dependent pages tab
1863
		if($dependentPagesCount) $tabDependent->setTitle(_t('SiteTree.TABDEPENDENT', "Dependent pages") . " ($dependentPagesCount)");
1864
		else $fields->removeFieldFromTab('Root', 'Dependent');
1865
1866
		$tabMain->setTitle(_t('SiteTree.TABCONTENT', "Main Content"));
1867
1868
		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...
1869
			$obsoleteWarning = _t(
1870
				'SiteTree.OBSOLETECLASS',
1871
				"This page is of obsolete type {type}. Saving will reset its type and you may lose data",
1872
				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...
1873
			);
1874
1875
			$fields->addFieldToTab(
1876
				"Root.Main",
1877
				new LiteralField("ObsoleteWarningHeader", "<p class=\"message warning\">$obsoleteWarning</p>"),
1878
				"Title"
1879
			);
1880
		}
1881
1882
		if(file_exists(BASE_PATH . '/install.php')) {
1883
			$fields->addFieldToTab("Root.Main", new LiteralField("InstallWarningHeader",
1884
				"<p class=\"message warning\">" . _t("SiteTree.REMOVE_INSTALL_WARNING",
1885
				"Warning: You should remove install.php from this SilverStripe install for security reasons.")
1886
				. "</p>"), "Title");
1887
		}
1888
1889
		// Backwards compat: Rewrite nested "Content" tabs to toplevel
1890
		$fields->setTabPathRewrites(array(
1891
			'/^Root\.Content\.Main$/' => 'Root.Main',
1892
			'/^Root\.Content\.([^.]+)$/' => 'Root.\\1',
1893
		));
1894
1895
		if(self::$runCMSFieldsExtensions) {
1896
			$this->extend('updateCMSFields', $fields);
1897
		}
1898
1899
		return $fields;
1900
	}
1901
1902
1903
	/**
1904
	 * Returns fields related to configuration aspects on this record, e.g. access control. See {@link getCMSFields()}
1905
	 * for content-related fields.
1906
	 *
1907
	 * @return FieldList
1908
	 */
1909
	public function getSettingsFields() {
1910
		$groupsMap = array();
1911
		foreach(Group::get() as $group) {
1912
			// Listboxfield values are escaped, use ASCII char instead of &raquo;
1913
			$groupsMap[$group->ID] = $group->getBreadcrumbs(' > ');
1914
		}
1915
		asort($groupsMap);
1916
1917
		$fields = new FieldList(
1918
			$rootTab = new TabSet("Root",
1919
				$tabBehaviour = new Tab('Settings',
1920
					new DropdownField(
1921
						"ClassName",
1922
						$this->fieldLabel('ClassName'),
1923
						$this->getClassDropdown()
1924
					),
1925
					$parentTypeSelector = new CompositeField(
1926
						new OptionsetField("ParentType", _t("SiteTree.PAGELOCATION", "Page location"), array(
1927
							"root" => _t("SiteTree.PARENTTYPE_ROOT", "Top-level page"),
1928
							"subpage" => _t("SiteTree.PARENTTYPE_SUBPAGE", "Sub-page underneath a parent page"),
1929
						)),
1930
						$parentIDField = new TreeDropdownField("ParentID", $this->fieldLabel('ParentID'), 'SiteTree', 'ID', 'MenuTitle')
1931
					),
1932
					$visibility = new FieldGroup(
1933
						new CheckboxField("ShowInMenus", $this->fieldLabel('ShowInMenus')),
1934
						new CheckboxField("ShowInSearch", $this->fieldLabel('ShowInSearch'))
1935
					),
1936
					$viewersOptionsField = new OptionsetField(
1937
						"CanViewType",
1938
						_t('SiteTree.ACCESSHEADER', "Who can view this page?")
1939
					),
1940
					$viewerGroupsField = ListboxField::create("ViewerGroups", _t('SiteTree.VIEWERGROUPS', "Viewer Groups"))
1941
						->setSource($groupsMap)
1942
						->setAttribute(
1943
							'data-placeholder',
1944
							_t('SiteTree.GroupPlaceholder', 'Click to select group')
1945
						),
1946
					$editorsOptionsField = new OptionsetField(
1947
						"CanEditType",
1948
						_t('SiteTree.EDITHEADER', "Who can edit this page?")
1949
					),
1950
					$editorGroupsField = ListboxField::create("EditorGroups", _t('SiteTree.EDITORGROUPS', "Editor Groups"))
1951
						->setSource($groupsMap)
1952
						->setAttribute(
1953
							'data-placeholder',
1954
							_t('SiteTree.GroupPlaceholder', 'Click to select group')
1955
						)
1956
				)
1957
			)
1958
		);
1959
1960
		$visibility->setTitle($this->fieldLabel('Visibility'));
1961
1962
1963
		// This filter ensures that the ParentID dropdown selection does not show this node,
1964
		// or its descendents, as this causes vanishing bugs
1965
		$parentIDField->setFilterFunction(create_function('$node', "return \$node->ID != {$this->ID};"));
1966
		$parentTypeSelector->addExtraClass('parentTypeSelector');
1967
1968
		$tabBehaviour->setTitle(_t('SiteTree.TABBEHAVIOUR', "Behavior"));
1969
1970
		// Make page location fields read-only if the user doesn't have the appropriate permission
1971
		if(!Permission::check("SITETREE_REORGANISE")) {
1972
			$fields->makeFieldReadonly('ParentType');
1973
			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...
1974
				$fields->removeByName('ParentID');
1975
			} else {
1976
				$fields->makeFieldReadonly('ParentID');
1977
			}
1978
		}
1979
1980
		$viewersOptionsSource = array();
1981
		$viewersOptionsSource["Inherit"] = _t('SiteTree.INHERIT', "Inherit from parent page");
1982
		$viewersOptionsSource["Anyone"] = _t('SiteTree.ACCESSANYONE', "Anyone");
1983
		$viewersOptionsSource["LoggedInUsers"] = _t('SiteTree.ACCESSLOGGEDIN', "Logged-in users");
1984
		$viewersOptionsSource["OnlyTheseUsers"] = _t('SiteTree.ACCESSONLYTHESE', "Only these people (choose from list)");
1985
		$viewersOptionsField->setSource($viewersOptionsSource);
1986
1987
		$editorsOptionsSource = array();
1988
		$editorsOptionsSource["Inherit"] = _t('SiteTree.INHERIT', "Inherit from parent page");
1989
		$editorsOptionsSource["LoggedInUsers"] = _t('SiteTree.EDITANYONE', "Anyone who can log-in to the CMS");
1990
		$editorsOptionsSource["OnlyTheseUsers"] = _t('SiteTree.EDITONLYTHESE', "Only these people (choose from list)");
1991
		$editorsOptionsField->setSource($editorsOptionsSource);
1992
1993
		if(!Permission::check('SITETREE_GRANT_ACCESS')) {
1994
			$fields->makeFieldReadonly($viewersOptionsField);
1995
			if($this->CanViewType == 'OnlyTheseUsers') {
1996
				$fields->makeFieldReadonly($viewerGroupsField);
1997
			} else {
1998
				$fields->removeByName('ViewerGroups');
1999
			}
2000
2001
			$fields->makeFieldReadonly($editorsOptionsField);
2002
			if($this->CanEditType == 'OnlyTheseUsers') {
2003
				$fields->makeFieldReadonly($editorGroupsField);
2004
			} else {
2005
				$fields->removeByName('EditorGroups');
2006
			}
2007
		}
2008
2009
		if(self::$runCMSFieldsExtensions) {
2010
			$this->extend('updateSettingsFields', $fields);
2011
		}
2012
2013
		return $fields;
2014
	}
2015
2016
	/**
2017
	 * @param bool $includerelations A boolean value to indicate if the labels returned should include relation fields
2018
	 * @return array
2019
	 */
2020
	public function fieldLabels($includerelations = true) {
2021
		$cacheKey = $this->class . '_' . $includerelations;
2022
		if(!isset(self::$_cache_field_labels[$cacheKey])) {
2023
			$labels = parent::fieldLabels($includerelations);
2024
			$labels['Title'] = _t('SiteTree.PAGETITLE', "Page name");
2025
			$labels['MenuTitle'] = _t('SiteTree.MENUTITLE', "Navigation label");
2026
			$labels['MetaDescription'] = _t('SiteTree.METADESC', "Meta Description");
2027
			$labels['ExtraMeta'] = _t('SiteTree.METAEXTRA', "Custom Meta Tags");
2028
			$labels['ClassName'] = _t('SiteTree.PAGETYPE', "Page type", 'Classname of a page object');
2029
			$labels['ParentType'] = _t('SiteTree.PARENTTYPE', "Page location");
2030
			$labels['ParentID'] = _t('SiteTree.PARENTID', "Parent page");
2031
			$labels['ShowInMenus'] =_t('SiteTree.SHOWINMENUS', "Show in menus?");
2032
			$labels['ShowInSearch'] = _t('SiteTree.SHOWINSEARCH', "Show in search?");
2033
			$labels['ProvideComments'] = _t('SiteTree.ALLOWCOMMENTS', "Allow comments on this page?");
2034
			$labels['ViewerGroups'] = _t('SiteTree.VIEWERGROUPS', "Viewer Groups");
2035
			$labels['EditorGroups'] = _t('SiteTree.EDITORGROUPS', "Editor Groups");
2036
			$labels['URLSegment'] = _t('SiteTree.URLSegment', 'URL Segment', 'URL for this page');
2037
			$labels['Content'] = _t('SiteTree.Content', 'Content', 'Main HTML Content for a page');
2038
			$labels['CanViewType'] = _t('SiteTree.Viewers', 'Viewers Groups');
2039
			$labels['CanEditType'] = _t('SiteTree.Editors', 'Editors Groups');
2040
			$labels['Comments'] = _t('SiteTree.Comments', 'Comments');
2041
			$labels['Visibility'] = _t('SiteTree.Visibility', 'Visibility');
2042
			$labels['LinkChangeNote'] = _t (
2043
				'SiteTree.LINKCHANGENOTE', 'Changing this page\'s link will also affect the links of all child pages.'
2044
			);
2045
2046
			if($includerelations){
2047
				$labels['Parent'] = _t('SiteTree.has_one_Parent', 'Parent Page', 'The parent page in the site hierarchy');
2048
				$labels['LinkTracking'] = _t('SiteTree.many_many_LinkTracking', 'Link Tracking');
2049
				$labels['ImageTracking'] = _t('SiteTree.many_many_ImageTracking', 'Image Tracking');
2050
				$labels['BackLinkTracking'] = _t('SiteTree.many_many_BackLinkTracking', 'Backlink Tracking');
2051
			}
2052
2053
			self::$_cache_field_labels[$cacheKey] = $labels;
2054
		}
2055
2056
		return self::$_cache_field_labels[$cacheKey];
2057
	}
2058
2059
	/**
2060
	 * Get the actions available in the CMS for this page - eg Save, Publish.
2061
	 *
2062
	 * Frontend scripts and styles know how to handle the following FormFields:
2063
	 * - top-level FormActions appear as standalone buttons
2064
	 * - top-level CompositeField with FormActions within appear as grouped buttons
2065
	 * - TabSet & Tabs appear as a drop ups
2066
	 * - FormActions within the Tab are restyled as links
2067
	 * - major actions can provide alternate states for richer presentation (see ssui.button widget extension)
2068
	 *
2069
	 * @return FieldList The available actions for this page.
2070
	 */
2071
	public function getCMSActions() {
2072
		$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...
2073
2074
		// Major actions appear as buttons immediately visible as page actions.
2075
		$majorActions = CompositeField::create()->setName('MajorActions')->setTag('fieldset')->addExtraClass('btn-group ss-ui-buttonset noborder');
2076
2077
		// Minor options are hidden behind a drop-up and appear as links (although they are still FormActions).
2078
		$rootTabSet = new TabSet('ActionMenus');
2079
		$moreOptions = new Tab(
2080
			'MoreOptions',
2081
			_t('SiteTree.MoreOptions', 'More options', 'Expands a view for more buttons')
2082
		);
2083
		$rootTabSet->push($moreOptions);
2084
		$rootTabSet->addExtraClass('ss-ui-action-tabset action-menus noborder');
2085
2086
		// Render page information into the "more-options" drop-up, on the top.
2087
		$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...
2088
			'"SiteTree"."ID"' => $this->ID
2089
		));
2090
		$moreOptions->push(
2091
			new LiteralField('Information',
2092
				$this->customise(array(
2093
					'Live' => $live,
2094
					'ExistsOnLive' => $existsOnLive
2095
				))->renderWith('SiteTree_Information')
2096
			)
2097
		);
2098
2099
		$moreOptions->push(AddToCampaignHandler_FormAction::create());
2100
2101
		// "readonly"/viewing version that isn't the current version of the record
2102
		$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...
2103
			'"SiteTree"."ID"' => $this->ID
2104
		));
2105
		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...
2106
			$moreOptions->push(FormAction::create('email', _t('CMSMain.EMAIL', 'Email')));
2107
			$moreOptions->push(FormAction::create('rollback', _t('CMSMain.ROLLBACK', 'Roll back to this version')));
2108
2109
			$actions = new FieldList(array($majorActions, $rootTabSet));
2110
2111
			// getCMSActions() can be extended with updateCMSActions() on a extension
2112
			$this->extend('updateCMSActions', $actions);
2113
2114
			return $actions;
2115
		}
2116
2117
		if($this->isPublished() && $this->canPublish() && !$this->getIsDeletedFromStage() && $this->canUnpublish()) {
0 ignored issues
show
Documentation Bug introduced by
The method isPublished does not exist on object<SiteTree>? Since you implemented __call, maybe consider adding a @method annotation.

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

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

class ParentClass {
    private $data = array();

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

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

/**
 * If this class knows which fields exist, you can specify the methods here:
 *
 * @method string getName()
 */
class SomeClass extends ParentClass { }
Loading history...
Documentation Bug introduced by
The method canPublish does not exist on object<SiteTree>? Since you implemented __call, maybe consider adding a @method annotation.

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

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

class ParentClass {
    private $data = array();

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

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

/**
 * If this class knows which fields exist, you can specify the methods here:
 *
 * @method string getName()
 */
class SomeClass extends ParentClass { }
Loading history...
Documentation Bug introduced by
The method canUnpublish does not exist on object<SiteTree>? Since you implemented __call, maybe consider adding a @method annotation.

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

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

class ParentClass {
    private $data = array();

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

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

/**
 * If this class knows which fields exist, you can specify the methods here:
 *
 * @method string getName()
 */
class SomeClass extends ParentClass { }
Loading history...
2118
			// "unpublish"
2119
			$moreOptions->push(
2120
				FormAction::create('unpublish', _t('SiteTree.BUTTONUNPUBLISH', 'Unpublish'), 'delete')
2121
					->setDescription(_t('SiteTree.BUTTONUNPUBLISHDESC', 'Remove this page from the published site'))
2122
					->addExtraClass('ss-ui-action-destructive')
2123
			);
2124
		}
2125
2126
		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...
2127
			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...
2128
				// "rollback"
2129
				$moreOptions->push(
2130
					FormAction::create('rollback', _t('SiteTree.BUTTONCANCELDRAFT', 'Cancel draft changes'), 'delete')
2131
						->setDescription(_t('SiteTree.BUTTONCANCELDRAFTDESC', 'Delete your draft and revert to the currently published page'))
2132
				);
2133
			}
2134
		}
2135
2136
		if($this->canEdit()) {
2137
			if($this->getIsDeletedFromStage()) {
2138
				// The usual major actions are not available, so we provide alternatives here.
2139
				if($existsOnLive) {
2140
					// "restore"
2141
					$majorActions->push(FormAction::create('revert',_t('CMSMain.RESTORE','Restore')));
2142
					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...
2143
						// "delete from live"
2144
						$majorActions->push(
2145
							FormAction::create('deletefromlive',_t('CMSMain.DELETEFP','Delete'))
2146
								->addExtraClass('ss-ui-action-destructive')
2147
						);
2148
					}
2149
				} else {
2150
					// Determine if we should force a restore to root (where once it was a subpage)
2151
					$restoreToRoot = $this->isParentArchived();
2152
2153
					// "restore"
2154
					$title = $restoreToRoot
2155
						? _t('CMSMain.RESTORE_TO_ROOT','Restore draft at top level')
2156
						: _t('CMSMain.RESTORE','Restore draft');
2157
					$description = $restoreToRoot
2158
						? _t('CMSMain.RESTORE_TO_ROOT_DESC','Restore the archived version to draft as a top level page')
2159
						: _t('CMSMain.RESTORE_DESC', 'Restore the archived version to draft');
2160
					$majorActions->push(
2161
						FormAction::create('restore', $title)
2162
							->setDescription($description)
2163
							->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...
2164
							->setAttribute('data-icon', 'decline')
2165
					);
2166
				}
2167
			} else {
2168
					if($this->canDelete()) {
2169
						// delete
2170
						$moreOptions->push(
2171
							FormAction::create('delete',_t('CMSMain.DELETE','Delete draft'))
2172
								->addExtraClass('delete ss-ui-action-destructive')
2173
						);
2174
					}
2175
				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...
2176
					// "archive"
2177
					$moreOptions->push(
2178
						FormAction::create('archive',_t('CMSMain.ARCHIVE','Archive'))
2179
							->setDescription(_t(
2180
								'SiteTree.BUTTONARCHIVEDESC',
2181
								'Unpublish and send to archive'
2182
							))
2183
							->addExtraClass('delete ss-ui-action-destructive')
2184
					);
2185
				}
2186
2187
				// "save", supports an alternate state that is still clickable, but notifies the user that the action is not needed.
2188
				$majorActions->push(
2189
					FormAction::create('save', _t('SiteTree.BUTTONSAVED', 'Saved'))
2190
						->setAttribute('data-icon', 'accept')
2191
						->setAttribute('data-icon-alternate', 'addpage')
2192
						->setAttribute('data-text-alternate', _t('CMSMain.SAVEDRAFT','Save draft'))
2193
				);
2194
			}
2195
		}
2196
2197
		if($this->canPublish() && !$this->getIsDeletedFromStage()) {
0 ignored issues
show
Documentation Bug introduced by
The method canPublish does not exist on object<SiteTree>? Since you implemented __call, maybe consider adding a @method annotation.

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

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

class ParentClass {
    private $data = array();

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

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

/**
 * If this class knows which fields exist, you can specify the methods here:
 *
 * @method string getName()
 */
class SomeClass extends ParentClass { }
Loading history...
2198
			// "publish", as with "save", it supports an alternate state to show when action is needed.
2199
			$majorActions->push(
2200
				$publish = FormAction::create('publish', _t('SiteTree.BUTTONPUBLISHED', 'Published'))
2201
					->setAttribute('data-icon', 'accept')
2202
					->setAttribute('data-icon-alternate', 'disk')
2203
					->setAttribute('data-text-alternate', _t('SiteTree.BUTTONSAVEPUBLISH', 'Save & publish'))
2204
			);
2205
2206
			// Set up the initial state of the button to reflect the state of the underlying SiteTree object.
2207
			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...
2208
				$publish->addExtraClass('ss-ui-alternate');
2209
			}
2210
		}
2211
2212
		$actions = new FieldList(array($majorActions, $rootTabSet));
2213
2214
		// Hook for extensions to add/remove actions.
2215
		$this->extend('updateCMSActions', $actions);
2216
2217
		return $actions;
2218
	}
2219
2220
	public function onAfterPublish() {
2221
		// Force live sort order to match stage sort order
2222
		DB::prepared_query('UPDATE "SiteTree_Live"
2223
			SET "Sort" = (SELECT "SiteTree"."Sort" FROM "SiteTree" WHERE "SiteTree_Live"."ID" = "SiteTree"."ID")
2224
			WHERE EXISTS (SELECT "SiteTree"."Sort" FROM "SiteTree" WHERE "SiteTree_Live"."ID" = "SiteTree"."ID") AND "ParentID" = ?',
2225
			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...
2226
		);
2227
		}
2228
2229
	/**
2230
	 * Update draft dependant pages
2231
	 */
2232
	public function onAfterRevertToLive() {
2233
		// Use an alias to get the updates made by $this->publish
2234
		/** @var SiteTree $stageSelf */
2235
		$stageSelf = Versioned::get_by_stage('SiteTree', Versioned::DRAFT)->byID($this->ID);
2236
		$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...
2237
2238
		// Need to update pages linking to this one as no longer broken
2239
		foreach($stageSelf->DependentPages() as $page) {
2240
			/** @var SiteTree $page */
2241
			$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...
2242
		}
2243
	}
2244
2245
	/**
2246
	 * Determine if this page references a parent which is archived, and not available in stage
2247
	 *
2248
	 * @return bool True if there is an archived parent
2249
	 */
2250
	protected function isParentArchived() {
2251
		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...
2252
			$parentPage = Versioned::get_latest_version("SiteTree", $parentID);
2253
			if(!$parentPage || $parentPage->IsDeletedFromStage) {
2254
				return true;
2255
			}
2256
		}
2257
		return false;
2258
	}
2259
2260
	/**
2261
	 * Restore the content in the active copy of this SiteTree page to the stage site.
2262
	 *
2263
	 * @return self
2264
	 */
2265
	public function doRestoreToStage() {
2266
		$this->invokeWithExtensions('onBeforeRestoreToStage', $this);
2267
2268
		// Ensure that the parent page is restored, otherwise restore to root
2269
		if($this->isParentArchived()) {
2270
			$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...
2271
		}
2272
2273
		// if no record can be found on draft stage (meaning it has been "deleted from draft" before),
2274
		// create an empty record
2275
		if(!DB::prepared_query("SELECT \"ID\" FROM \"SiteTree\" WHERE \"ID\" = ?", array($this->ID))->value()) {
2276
			$conn = DB::get_conn();
2277
			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...
2278
			DB::prepared_query("INSERT INTO \"SiteTree\" (\"ID\") VALUES (?)", array($this->ID));
2279
			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...
2280
		}
2281
2282
		$oldStage = Versioned::get_stage();
2283
		Versioned::set_stage(Versioned::DRAFT);
2284
		$this->forceChange();
2285
		$this->write();
2286
2287
		$result = DataObject::get_by_id($this->class, $this->ID);
2288
2289
		// Need to update pages linking to this one as no longer broken
2290
		foreach($result->DependentPages(false) as $page) {
2291
			// $page->write() calls syncLinkTracking, which does all the hard work for us.
2292
			$page->write();
2293
		}
2294
2295
		Versioned::set_stage($oldStage);
2296
2297
		$this->invokeWithExtensions('onAfterRestoreToStage', $this);
2298
2299
		return $result;
2300
	}
2301
2302
	/**
2303
	 * Check if this page is new - that is, if it has yet to have been written to the database.
2304
	 *
2305
	 * @return bool
2306
	 */
2307
	public function isNew() {
2308
		/**
2309
		 * This check was a problem for a self-hosted site, and may indicate a bug in the interpreter on their server,
2310
		 * or a bug here. Changing the condition from empty($this->ID) to !$this->ID && !$this->record['ID'] fixed this.
2311
		 */
2312
		if(empty($this->ID)) return true;
2313
2314
		if(is_numeric($this->ID)) return false;
2315
2316
		return stripos($this->ID, 'new') === 0;
2317
	}
2318
2319
	/**
2320
	 * Get the class dropdown used in the CMS to change the class of a page. This returns the list of options in the
2321
	 * dropdown as a Map from class name to singular name. Filters by {@link SiteTree->canCreate()}, as well as
2322
	 * {@link SiteTree::$needs_permission}.
2323
	 *
2324
	 * @return array
2325
	 */
2326
	protected function getClassDropdown() {
2327
		$classes = self::page_type_classes();
2328
		$currentClass = null;
2329
		$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...
2330
2331
		$result = array();
2332
		foreach($classes as $class) {
2333
			$instance = singleton($class);
2334
2335
			// if the current page type is this the same as the class type always show the page type in the list
2336
			if ($this->ClassName != $instance->ClassName) {
2337
				if($instance instanceof HiddenClass) continue;
2338
				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...
2339
			}
2340
2341
			if($perms = $instance->stat('need_permission')) {
2342
				if(!$this->can($perms)) continue;
2343
			}
2344
2345
			$pageTypeName = $instance->i18n_singular_name();
2346
2347
			$currentClass = $class;
2348
			$result[$class] = $pageTypeName;
2349
2350
			// If we're in translation mode, the link between the translated pagetype title and the actual classname
2351
			// might not be obvious, so we add it in parantheses. Example: class "RedirectorPage" has the title
2352
			// "Weiterleitung" in German, so it shows up as "Weiterleitung (RedirectorPage)"
2353
			if(i18n::get_lang_from_locale(i18n::get_locale()) != 'en') {
2354
				$result[$class] = $result[$class] .  " ({$class})";
2355
			}
2356
		}
2357
2358
		// sort alphabetically, and put current on top
2359
		asort($result);
2360
		if($currentClass) {
2361
			$currentPageTypeName = $result[$currentClass];
2362
			unset($result[$currentClass]);
2363
			$result = array_reverse($result);
2364
			$result[$currentClass] = $currentPageTypeName;
2365
			$result = array_reverse($result);
2366
		}
2367
2368
		return $result;
2369
	}
2370
2371
	/**
2372
	 * Returns an array of the class names of classes that are allowed to be children of this class.
2373
	 *
2374
	 * @return string[]
2375
	 */
2376
	public function allowedChildren() {
2377
		$allowedChildren = array();
2378
		$candidates = $this->stat('allowed_children');
2379
		if($candidates && $candidates != "none" && $candidates != "SiteTree_root") {
2380
			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...
2381
				// If a classname is prefixed by "*", such as "*Page", then only that class is allowed - no subclasses.
2382
				// Otherwise, the class and all its subclasses are allowed.
2383
				if(substr($candidate,0,1) == '*') {
2384
					$allowedChildren[] = substr($candidate,1);
2385
				} else {
2386
					$subclasses = ClassInfo::subclassesFor($candidate);
2387
					foreach($subclasses as $subclass) {
0 ignored issues
show
Bug introduced by
The expression $subclasses of type null|array is not guaranteed to be traversable. How about adding an additional type check?

There are different options of fixing this problem.

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

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

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

Loading history...
2388
						if($subclass != "SiteTree_root") $allowedChildren[] = $subclass;
2389
					}
2390
				}
2391
			}
2392
		}
2393
2394
		return $allowedChildren;
2395
	}
2396
2397
	/**
2398
	 * Returns the class name of the default class for children of this page.
2399
	 *
2400
	 * @return string
2401
	 */
2402
	public function defaultChild() {
2403
		$default = $this->stat('default_child');
2404
		$allowed = $this->allowedChildren();
2405
		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...
2406
			if(!$default || !in_array($default, $allowed))
2407
				$default = reset($allowed);
2408
			return $default;
2409
		}
2410
	}
2411
2412
	/**
2413
	 * Returns the class name of the default class for the parent of this page.
2414
	 *
2415
	 * @return string
2416
	 */
2417
	public function defaultParent() {
2418
		return $this->stat('default_parent');
2419
	}
2420
2421
	/**
2422
	 * Get the title for use in menus for this page. If the MenuTitle field is set it returns that, else it returns the
2423
	 * Title field.
2424
	 *
2425
	 * @return string
2426
	 */
2427
	public function getMenuTitle(){
2428
		if($value = $this->getField("MenuTitle")) {
2429
			return $value;
2430
		} else {
2431
			return $this->getField("Title");
2432
		}
2433
	}
2434
2435
2436
	/**
2437
	 * Set the menu title for this page.
2438
	 *
2439
	 * @param string $value
2440
	 */
2441
	public function setMenuTitle($value) {
2442
		if($value == $this->getField("Title")) {
2443
			$this->setField("MenuTitle", null);
2444
		} else {
2445
			$this->setField("MenuTitle", $value);
2446
		}
2447
	}
2448
2449
	/**
2450
	 * A flag provides the user with additional data about the current page status, for example a "removed from draft"
2451
	 * status. Each page can have more than one status flag. Returns a map of a unique key to a (localized) title for
2452
	 * the flag. The unique key can be reused as a CSS class. Use the 'updateStatusFlags' extension point to customize
2453
	 * the flags.
2454
	 *
2455
	 * Example (simple):
2456
	 *   "deletedonlive" => "Deleted"
2457
	 *
2458
	 * Example (with optional title attribute):
2459
	 *   "deletedonlive" => array('text' => "Deleted", 'title' => 'This page has been deleted')
2460
	 *
2461
	 * @param bool $cached Whether to serve the fields from cache; false regenerate them
2462
	 * @return array
2463
	 */
2464
	public function getStatusFlags($cached = true) {
2465
		if(!$this->_cache_statusFlags || !$cached) {
2466
			$flags = array();
2467
			if($this->getIsDeletedFromStage()) {
2468
				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...
2469
					$flags['removedfromdraft'] = array(
2470
						'text' => _t('SiteTree.REMOVEDFROMDRAFTSHORT', 'Removed from draft'),
2471
						'title' => _t('SiteTree.REMOVEDFROMDRAFTHELP', 'Page is published, but has been deleted from draft'),
2472
					);
2473
				} else {
2474
					$flags['archived'] = array(
2475
						'text' => _t('SiteTree.ARCHIVEDPAGESHORT', 'Archived'),
2476
						'title' => _t('SiteTree.ARCHIVEDPAGEHELP', 'Page is removed from draft and live'),
2477
					);
2478
				}
2479
			} else if($this->getIsAddedToStage()) {
2480
				$flags['addedtodraft'] = array(
2481
					'text' => _t('SiteTree.ADDEDTODRAFTSHORT', 'Draft'),
2482
					'title' => _t('SiteTree.ADDEDTODRAFTHELP', "Page has not been published yet")
2483
				);
2484
			} else if($this->getIsModifiedOnStage()) {
2485
				$flags['modified'] = array(
2486
					'text' => _t('SiteTree.MODIFIEDONDRAFTSHORT', 'Modified'),
2487
					'title' => _t('SiteTree.MODIFIEDONDRAFTHELP', 'Page has unpublished changes'),
2488
				);
2489
			}
2490
2491
			$this->extend('updateStatusFlags', $flags);
2492
2493
			$this->_cache_statusFlags = $flags;
2494
		}
2495
2496
		return $this->_cache_statusFlags;
2497
	}
2498
2499
	/**
2500
	 * getTreeTitle will return three <span> html DOM elements, an empty <span> with the class 'jstree-pageicon' in
2501
	 * front, following by a <span> wrapping around its MenutTitle, then following by a <span> indicating its
2502
	 * publication status.
2503
	 *
2504
	 * @return string An HTML string ready to be directly used in a template
2505
	 */
2506
	public function getTreeTitle() {
2507
		// Build the list of candidate children
2508
		$children = array();
2509
		$candidates = static::page_type_classes();
2510
		foreach($this->allowedChildren() as $childClass) {
2511
			if(!in_array($childClass, $candidates)) continue;
2512
			$child = singleton($childClass);
2513
			if($child->canCreate(null, array('Parent' => $this))) {
2514
				$children[$childClass] = $child->i18n_singular_name();
2515
			}
2516
		}
2517
		$flags = $this->getStatusFlags();
2518
		$treeTitle = sprintf(
2519
			"<span class=\"jstree-pageicon\"></span><span class=\"item\" data-allowedchildren=\"%s\">%s</span>",
2520
			Convert::raw2att(Convert::raw2json($children)),
2521
			Convert::raw2xml(str_replace(array("\n","\r"),"",$this->MenuTitle))
2522
		);
2523
		foreach($flags as $class => $data) {
2524
			if(is_string($data)) $data = array('text' => $data);
2525
			$treeTitle .= sprintf(
2526
				"<span class=\"badge %s\"%s>%s</span>",
2527
				'status-' . Convert::raw2xml($class),
2528
				(isset($data['title'])) ? sprintf(' title="%s"', Convert::raw2xml($data['title'])) : '',
2529
				Convert::raw2xml($data['text'])
2530
			);
2531
		}
2532
2533
		return $treeTitle;
2534
	}
2535
2536
	/**
2537
	 * Returns the page in the current page stack of the given level. Level(1) will return the main menu item that
2538
	 * we're currently inside, etc.
2539
	 *
2540
	 * @param int $level
2541
	 * @return SiteTree
2542
	 */
2543
	public function Level($level) {
2544
		$parent = $this;
2545
		$stack = array($parent);
2546
		while($parent = $parent->Parent) {
2547
			array_unshift($stack, $parent);
2548
		}
2549
2550
		return isset($stack[$level-1]) ? $stack[$level-1] : null;
2551
	}
2552
2553
	/**
2554
	 * Gets the depth of this page in the sitetree, where 1 is the root level
2555
	 *
2556
	 * @return int
2557
	 */
2558
	public function getPageLevel() {
2559
		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...
2560
			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...
2561
		}
2562
		return 1;
2563
	}
2564
2565
	/**
2566
	 * Return the CSS classes to apply to this node in the CMS tree.
2567
	 *
2568
	 * @param string $numChildrenMethod
2569
	 * @return string
2570
	 */
2571
	public function CMSTreeClasses($numChildrenMethod="numChildren") {
2572
		$classes = sprintf('class-%s', $this->class);
2573
		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...
2574
			$classes .= " BrokenLink";
2575
		}
2576
2577
		if(!$this->canAddChildren()) {
2578
			$classes .= " nochildren";
2579
		}
2580
2581
		if(!$this->canEdit() && !$this->canAddChildren()) {
2582
			if (!$this->canView()) {
2583
				$classes .= " disabled";
2584
			} else {
2585
				$classes .= " edit-disabled";
2586
			}
2587
		}
2588
2589
		if(!$this->ShowInMenus) {
2590
			$classes .= " notinmenu";
2591
		}
2592
2593
		//TODO: Add integration
2594
		/*
2595
		if($this->hasExtension('Translatable') && $controller->Locale != Translatable::default_locale() && !$this->isTranslation())
2596
			$classes .= " untranslated ";
2597
		*/
2598
		$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...
2599
2600
		return $classes;
2601
	}
2602
2603
	/**
2604
	 * Compares current draft with live version, and returns true if no draft version of this page exists  but the page
2605
	 * is still published (eg, after triggering "Delete from draft site" in the CMS).
2606
	 *
2607
	 * @return bool
2608
	 */
2609
	public function getIsDeletedFromStage() {
2610
		if(!$this->ID) return true;
2611
		if($this->isNew()) return false;
2612
2613
		$stageVersion = Versioned::get_versionnumber_by_stage('SiteTree', Versioned::DRAFT, $this->ID);
2614
2615
		// Return true for both completely deleted pages and for pages just deleted from stage
2616
		return !($stageVersion);
2617
	}
2618
2619
	/**
2620
	 * Return true if this page exists on the live site
2621
	 *
2622
	 * @return bool
2623
	 */
2624
	public function getExistsOnLive() {
2625
		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...
2626
	}
2627
2628
	/**
2629
	 * Compares current draft with live version, and returns true if these versions differ, meaning there have been
2630
	 * unpublished changes to the draft site.
2631
	 *
2632
	 * @return bool
2633
	 */
2634
	public function getIsModifiedOnStage() {
2635
		// New unsaved pages could be never be published
2636
		if($this->isNew()) return false;
2637
2638
		$stageVersion = Versioned::get_versionnumber_by_stage('SiteTree', 'Stage', $this->ID);
2639
		$liveVersion =	Versioned::get_versionnumber_by_stage('SiteTree', 'Live', $this->ID);
2640
2641
		$isModified = ($stageVersion && $stageVersion != $liveVersion);
2642
		$this->extend('getIsModifiedOnStage', $isModified);
2643
2644
		return $isModified;
2645
	}
2646
2647
	/**
2648
	 * Compares current draft with live version, and returns true if no live version exists, meaning the page was never
2649
	 * published.
2650
	 *
2651
	 * @return bool
2652
	 */
2653
	public function getIsAddedToStage() {
2654
		// New unsaved pages could be never be published
2655
		if($this->isNew()) return false;
2656
2657
		$stageVersion = Versioned::get_versionnumber_by_stage('SiteTree', 'Stage', $this->ID);
2658
		$liveVersion =	Versioned::get_versionnumber_by_stage('SiteTree', 'Live', $this->ID);
2659
2660
		return ($stageVersion && !$liveVersion);
2661
	}
2662
2663
	/**
2664
	 * Stops extendCMSFields() being called on getCMSFields(). This is useful when you need access to fields added by
2665
	 * subclasses of SiteTree in a extension. Call before calling parent::getCMSFields(), and reenable afterwards.
2666
	 */
2667
	static public function disableCMSFieldsExtensions() {
2668
		self::$runCMSFieldsExtensions = false;
2669
	}
2670
2671
	/**
2672
	 * Reenables extendCMSFields() being called on getCMSFields() after it has been disabled by
2673
	 * disableCMSFieldsExtensions().
2674
	 */
2675
	static public function enableCMSFieldsExtensions() {
2676
		self::$runCMSFieldsExtensions = true;
2677
	}
2678
2679
	public function providePermissions() {
2680
		return array(
2681
			'SITETREE_GRANT_ACCESS' => array(
2682
				'name' => _t('SiteTree.PERMISSION_GRANTACCESS_DESCRIPTION', 'Manage access rights for content'),
2683
				'help' => _t('SiteTree.PERMISSION_GRANTACCESS_HELP',  'Allow setting of page-specific access restrictions in the "Pages" section.'),
2684
				'category' => _t('Permissions.PERMISSIONS_CATEGORY', 'Roles and access permissions'),
2685
				'sort' => 100
2686
			),
2687
			'SITETREE_VIEW_ALL' => array(
2688
				'name' => _t('SiteTree.VIEW_ALL_DESCRIPTION', 'View any page'),
2689
				'category' => _t('Permissions.CONTENT_CATEGORY', 'Content permissions'),
2690
				'sort' => -100,
2691
				'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')
2692
			),
2693
			'SITETREE_EDIT_ALL' => array(
2694
				'name' => _t('SiteTree.EDIT_ALL_DESCRIPTION', 'Edit any page'),
2695
				'category' => _t('Permissions.CONTENT_CATEGORY', 'Content permissions'),
2696
				'sort' => -50,
2697
				'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')
2698
			),
2699
			'SITETREE_REORGANISE' => array(
2700
				'name' => _t('SiteTree.REORGANISE_DESCRIPTION', 'Change site structure'),
2701
				'category' => _t('Permissions.CONTENT_CATEGORY', 'Content permissions'),
2702
				'help' => _t('SiteTree.REORGANISE_HELP', 'Rearrange pages in the site tree through drag&drop.'),
2703
				'sort' => 100
2704
			),
2705
			'VIEW_DRAFT_CONTENT' => array(
2706
				'name' => _t('SiteTree.VIEW_DRAFT_CONTENT', 'View draft content'),
2707
				'category' => _t('Permissions.CONTENT_CATEGORY', 'Content permissions'),
2708
				'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.'),
2709
				'sort' => 100
2710
			)
2711
		);
2712
	}
2713
2714
	/**
2715
	 * Return the translated Singular name.
2716
	 *
2717
	 * @return string
2718
	 */
2719
	public function i18n_singular_name() {
2720
		// Convert 'Page' to 'SiteTree' for correct localization lookups
2721
		$class = ($this->class == 'Page') ? 'SiteTree' : $this->class;
2722
		return _t($class.'.SINGULARNAME', $this->singular_name());
2723
	}
2724
2725
	/**
2726
	 * Overloaded to also provide entities for 'Page' class which is usually located in custom code, hence textcollector
2727
	 * picks it up for the wrong folder.
2728
	 *
2729
	 * @return array
2730
	 */
2731
	public function provideI18nEntities() {
2732
		$entities = parent::provideI18nEntities();
2733
2734
		if(isset($entities['Page.SINGULARNAME'])) $entities['Page.SINGULARNAME'][3] = CMS_DIR;
2735
		if(isset($entities['Page.PLURALNAME'])) $entities['Page.PLURALNAME'][3] = CMS_DIR;
2736
2737
		$entities[$this->class . '.DESCRIPTION'] = array(
2738
			$this->stat('description'),
2739
			'Description of the page type (shown in the "add page" dialog)'
2740
		);
2741
2742
		$entities['SiteTree.SINGULARNAME'][0] = 'Page';
2743
		$entities['SiteTree.PLURALNAME'][0] = 'Pages';
2744
2745
		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...
2746
	}
2747
2748
	/**
2749
	 * Returns 'root' if the current page has no parent, or 'subpage' otherwise
2750
	 *
2751
	 * @return string
2752
	 */
2753
	public function getParentType() {
2754
		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...
2755
	}
2756
2757
	/**
2758
	 * Clear the permissions cache for SiteTree
2759
	 */
2760
	public static function reset() {
2761
		self::$cache_permissions = array();
2762
	}
2763
2764
	static public function on_db_reset() {
2765
		self::$cache_permissions = array();
2766
	}
2767
2768
}
2769