Duplicate code is one of the most pungent code smells. A rule that is often used is to re-structure code once it is duplicated in three or more places.
Common duplication problems, and corresponding solutions are:
Complex classes like SiteTree often do a lot of different things. To break such a class down, we need to identify a cohesive component within that class. A common approach to find such a component is to look for fields/methods that share the same prefixes, or suffixes. You can also have a look at the cohesion graph to spot any un-connected, or weakly-connected components.
Once you have determined the fields that belong together, you can apply the Extract Class refactoring. If the component makes sense as a sub-class, Extract Subclass is also a candidate, and is often faster.
While breaking up the class, it is a good idea to analyze how other classes use SiteTree, and based on these observations, apply Extract Interface, too.
| 1 | <?php |
||
| 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"; |
||
|
|
|||
| 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( |
||
| 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( |
||
| 127 | "URLSegment" => true, |
||
| 128 | ); |
||
| 129 | |||
| 130 | private static $many_many = array( |
||
| 131 | "ViewerGroups" => "Group", |
||
| 132 | "EditorGroups" => "Group", |
||
| 133 | ); |
||
| 134 | |||
| 135 | private static $has_many = array( |
||
| 136 | "VirtualPages" => "VirtualPage.CopyContentFrom" |
||
| 137 | ); |
||
| 138 | |||
| 139 | private static $owned_by = array( |
||
| 140 | "VirtualPages" |
||
| 141 | ); |
||
| 142 | |||
| 143 | private static $casting = array( |
||
| 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( |
||
| 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\""; |
||
| 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( |
||
| 191 | "Hierarchy", |
||
| 192 | "Versioned('Stage', 'Live')", |
||
| 193 | "SiteTreeLinkTracking" |
||
| 194 | ); |
||
| 195 | |||
| 196 | private static $searchable_fields = array( |
||
| 197 | 'Title', |
||
| 198 | 'Content', |
||
| 199 | ); |
||
| 200 | |||
| 201 | private static $field_labels = array( |
||
| 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 | * Determines if the system should avoid orphaned pages |
||
| 246 | * by deleting all children when the their parent is deleted (TRUE), |
||
| 247 | * or rather preserve this data even if its not reachable through any navigation path (FALSE). |
||
| 248 | * |
||
| 249 | * @deprecated 4.0 Use the "SiteTree.enforce_strict_hierarchy" config setting instead |
||
| 250 | * @param boolean |
||
| 251 | */ |
||
| 252 | static public function set_enforce_strict_hierarchy($to) { |
||
| 256 | |||
| 257 | /** |
||
| 258 | * @deprecated 4.0 Use the "SiteTree.enforce_strict_hierarchy" config setting instead |
||
| 259 | * @return boolean |
||
| 260 | */ |
||
| 261 | static public function get_enforce_strict_hierarchy() { |
||
| 265 | |||
| 266 | /** |
||
| 267 | * Returns TRUE if nested URLs (e.g. page/sub-page/) are currently enabled on this site. |
||
| 268 | * |
||
| 269 | * @deprecated 4.0 Use the "SiteTree.nested_urls" config setting instead |
||
| 270 | * @return bool |
||
| 271 | */ |
||
| 272 | static public function nested_urls() { |
||
| 276 | |||
| 277 | /** |
||
| 278 | * @deprecated 4.0 Use the "SiteTree.nested_urls" config setting instead |
||
| 279 | */ |
||
| 280 | static public function enable_nested_urls() { |
||
| 284 | |||
| 285 | /** |
||
| 286 | * @deprecated 4.0 Use the "SiteTree.nested_urls" config setting instead |
||
| 287 | */ |
||
| 288 | static public function disable_nested_urls() { |
||
| 292 | |||
| 293 | /** |
||
| 294 | * Set the (re)creation of default pages on /dev/build |
||
| 295 | * |
||
| 296 | * @deprecated 4.0 Use the "SiteTree.create_default_pages" config setting instead |
||
| 297 | * @param bool $option |
||
| 298 | */ |
||
| 299 | static public function set_create_default_pages($option = true) { |
||
| 303 | |||
| 304 | /** |
||
| 305 | * Return true if default pages should be created on /dev/build. |
||
| 306 | * |
||
| 307 | * @deprecated 4.0 Use the "SiteTree.create_default_pages" config setting instead |
||
| 308 | * @return bool |
||
| 309 | */ |
||
| 310 | static public function get_create_default_pages() { |
||
| 314 | |||
| 315 | /** |
||
| 316 | * Fetches the {@link SiteTree} object that maps to a link. |
||
| 317 | * |
||
| 318 | * If you have enabled {@link SiteTree::config()->nested_urls} on this site, then you can use a nested link such as |
||
| 319 | * "about-us/staff/", and this function will traverse down the URL chain and grab the appropriate link. |
||
| 320 | * |
||
| 321 | * Note that if no model can be found, this method will fall over to a extended alternateGetByLink method provided |
||
| 322 | * by a extension attached to {@link SiteTree} |
||
| 323 | * |
||
| 324 | * @param string $link The link of the page to search for |
||
| 325 | * @param bool $cache True (default) to use caching, false to force a fresh search from the database |
||
| 326 | * @return SiteTree |
||
| 327 | */ |
||
| 328 | static public function get_by_link($link, $cache = true) { |
||
| 394 | |||
| 395 | /** |
||
| 396 | * Return a subclass map of SiteTree that shouldn't be hidden through {@link SiteTree::$hide_ancestor} |
||
| 397 | * |
||
| 398 | * @return array |
||
| 399 | */ |
||
| 400 | public static function page_type_classes() { |
||
| 401 | $classes = ClassInfo::getValidSubClasses(); |
||
| 402 | |||
| 403 | $baseClassIndex = array_search('SiteTree', $classes); |
||
| 404 | if($baseClassIndex !== FALSE) unset($classes[$baseClassIndex]); |
||
| 405 | |||
| 406 | $kill_ancestors = array(); |
||
| 407 | |||
| 408 | // figure out if there are any classes we don't want to appear |
||
| 409 | foreach($classes as $class) { |
||
| 410 | $instance = singleton($class); |
||
| 411 | |||
| 412 | // do any of the progeny want to hide an ancestor? |
||
| 413 | if($ancestor_to_hide = $instance->stat('hide_ancestor')) { |
||
| 414 | // note for killing later |
||
| 415 | $kill_ancestors[] = $ancestor_to_hide; |
||
| 416 | } |
||
| 417 | } |
||
| 418 | |||
| 419 | // If any of the descendents don't want any of the elders to show up, cruelly render the elders surplus to |
||
| 420 | // requirements |
||
| 421 | if($kill_ancestors) { |
||
| 422 | $kill_ancestors = array_unique($kill_ancestors); |
||
| 423 | foreach($kill_ancestors as $mark) { |
||
| 424 | // unset from $classes |
||
| 425 | $idx = array_search($mark, $classes, true); |
||
| 426 | if ($idx !== false) { |
||
| 427 | unset($classes[$idx]); |
||
| 428 | } |
||
| 429 | } |
||
| 430 | } |
||
| 431 | |||
| 432 | return $classes; |
||
| 433 | } |
||
| 434 | |||
| 435 | /** |
||
| 436 | * Replace a "[sitetree_link id=n]" shortcode with a link to the page with the corresponding ID. |
||
| 437 | * |
||
| 438 | * @param array $arguments |
||
| 439 | * @param string $content |
||
| 440 | * @param TextParser $parser |
||
| 441 | * @return string |
||
| 442 | */ |
||
| 443 | static public function link_shortcode_handler($arguments, $content = null, $parser = null) { |
||
| 461 | |||
| 462 | /** |
||
| 463 | * Return the link for this {@link SiteTree} object, with the {@link Director::baseURL()} included. |
||
| 464 | * |
||
| 465 | * @param string $action Optional controller action (method). |
||
| 466 | * Note: URI encoding of this parameter is applied automatically through template casting, |
||
| 467 | * don't encode the passed parameter. Please use {@link Controller::join_links()} instead to |
||
| 468 | * append GET parameters. |
||
| 469 | * @return string |
||
| 470 | */ |
||
| 471 | public function Link($action = null) { |
||
| 474 | |||
| 475 | /** |
||
| 476 | * Get the absolute URL for this page, including protocol and host. |
||
| 477 | * |
||
| 478 | * @param string $action See {@link Link()} |
||
| 479 | * @return string |
||
| 480 | */ |
||
| 481 | public function AbsoluteLink($action = null) { |
||
| 488 | |||
| 489 | /** |
||
| 490 | * Base link used for previewing. Defaults to absolute URL, in order to account for domain changes, e.g. on multi |
||
| 491 | * site setups. Does not contain hints about the stage, see {@link SilverStripeNavigator} for details. |
||
| 492 | * |
||
| 493 | * @param string $action See {@link Link()} |
||
| 494 | * @return string |
||
| 495 | */ |
||
| 496 | public function PreviewLink($action = null) { |
||
| 503 | |||
| 504 | /** |
||
| 505 | * Return the link for this {@link SiteTree} object relative to the SilverStripe root. |
||
| 506 | * |
||
| 507 | * By default, if this page is the current home page, and there is no action specified then this will return a link |
||
| 508 | * to the root of the site. However, if you set the $action parameter to TRUE then the link will not be rewritten |
||
| 509 | * and returned in its full form. |
||
| 510 | * |
||
| 511 | * @uses RootURLController::get_homepage_link() |
||
| 512 | * |
||
| 513 | * @param string $action See {@link Link()} |
||
| 514 | * @return string |
||
| 515 | */ |
||
| 516 | public function RelativeLink($action = null) { |
||
| 541 | |||
| 542 | /** |
||
| 543 | * Get the absolute URL for this page on the Live site. |
||
| 544 | * |
||
| 545 | * @param bool $includeStageEqualsLive Whether to append the URL with ?stage=Live to force Live mode |
||
| 546 | * @return string |
||
| 547 | */ |
||
| 548 | public function getAbsoluteLiveLink($includeStageEqualsLive = true) { |
||
| 564 | |||
| 565 | /** |
||
| 566 | * Generates a link to edit this page in the CMS. |
||
| 567 | * |
||
| 568 | * @return string |
||
| 569 | */ |
||
| 570 | public function CMSEditLink() { |
||
| 573 | |||
| 574 | |||
| 575 | /** |
||
| 576 | * Return a CSS identifier generated from this page's link. |
||
| 577 | * |
||
| 578 | * @return string The URL segment |
||
| 579 | */ |
||
| 580 | public function ElementName() { |
||
| 583 | |||
| 584 | /** |
||
| 585 | * Returns true if this is the currently active page being used to handle this request. |
||
| 586 | * |
||
| 587 | * @return bool |
||
| 588 | */ |
||
| 589 | public function isCurrent() { |
||
| 592 | |||
| 593 | /** |
||
| 594 | * Check if this page is in the currently active section (e.g. it is either current or one of its children is |
||
| 595 | * currently being viewed). |
||
| 596 | * |
||
| 597 | * @return bool |
||
| 598 | */ |
||
| 599 | public function isSection() { |
||
| 604 | |||
| 605 | /** |
||
| 606 | * Check if the parent of this page has been removed (or made otherwise unavailable), and is still referenced by |
||
| 607 | * this child. Any such orphaned page may still require access via the CMS, but should not be shown as accessible |
||
| 608 | * to external users. |
||
| 609 | * |
||
| 610 | * @return bool |
||
| 611 | */ |
||
| 612 | public function isOrphaned() { |
||
| 620 | |||
| 621 | /** |
||
| 622 | * Return "link" or "current" depending on if this is the {@link SiteTree::isCurrent()} current page. |
||
| 623 | * |
||
| 624 | * @return string |
||
| 625 | */ |
||
| 626 | public function LinkOrCurrent() { |
||
| 629 | |||
| 630 | /** |
||
| 631 | * Return "link" or "section" depending on if this is the {@link SiteTree::isSeciton()} current section. |
||
| 632 | * |
||
| 633 | * @return string |
||
| 634 | */ |
||
| 635 | public function LinkOrSection() { |
||
| 638 | |||
| 639 | /** |
||
| 640 | * Return "link", "current" or "section" depending on if this page is the current page, or not on the current page |
||
| 641 | * but in the current section. |
||
| 642 | * |
||
| 643 | * @return string |
||
| 644 | */ |
||
| 645 | public function LinkingMode() { |
||
| 646 | if($this->isCurrent()) { |
||
| 647 | return 'current'; |
||
| 648 | } elseif($this->isSection()) { |
||
| 649 | return 'section'; |
||
| 650 | } else { |
||
| 651 | return 'link'; |
||
| 652 | } |
||
| 653 | } |
||
| 654 | |||
| 655 | /** |
||
| 656 | * Check if this page is in the given current section. |
||
| 657 | * |
||
| 658 | * @param string $sectionName Name of the section to check |
||
| 659 | * @return bool True if we are in the given section |
||
| 660 | */ |
||
| 661 | public function InSection($sectionName) { |
||
| 670 | |||
| 671 | /** |
||
| 672 | * Create a duplicate of this node. Doesn't affect joined data - create a custom overloading of this if you need |
||
| 673 | * such behaviour. |
||
| 674 | * |
||
| 675 | * @param bool $doWrite Whether to write the new object before returning it |
||
| 676 | * @return self The duplicated object |
||
| 677 | */ |
||
| 678 | public function duplicate($doWrite = true) { |
||
| 693 | |||
| 694 | /** |
||
| 695 | * Duplicates each child of this node recursively and returns the top-level duplicate node. |
||
| 696 | * |
||
| 697 | * @return self The duplicated object |
||
| 698 | */ |
||
| 699 | public function duplicateWithChildren() { |
||
| 715 | |||
| 716 | /** |
||
| 717 | * Duplicate this node and its children as a child of the node with the given ID |
||
| 718 | * |
||
| 719 | * @param int $id ID of the new node's new parent |
||
| 720 | */ |
||
| 721 | public function duplicateAsChild($id) { |
||
| 727 | |||
| 728 | /** |
||
| 729 | * Return a breadcrumb trail to this page. Excludes "hidden" pages (with ShowInMenus=0) by default. |
||
| 730 | * |
||
| 731 | * @param int $maxDepth The maximum depth to traverse. |
||
| 732 | * @param boolean $unlinked Whether to link page titles. |
||
| 733 | * @param boolean|string $stopAtPageType ClassName of a page to stop the upwards traversal. |
||
| 734 | * @param boolean $showHidden Include pages marked with the attribute ShowInMenus = 0 |
||
| 735 | * @return HTMLText The breadcrumb trail. |
||
| 736 | */ |
||
| 737 | public function Breadcrumbs($maxDepth = 20, $unlinked = false, $stopAtPageType = false, $showHidden = false) { |
||
| 745 | |||
| 746 | |||
| 747 | /** |
||
| 748 | * Returns a list of breadcrumbs for the current page. |
||
| 749 | * |
||
| 750 | * @param int $maxDepth The maximum depth to traverse. |
||
| 751 | * @param boolean|string $stopAtPageType ClassName of a page to stop the upwards traversal. |
||
| 752 | * @param boolean $showHidden Include pages marked with the attribute ShowInMenus = 0 |
||
| 753 | * |
||
| 754 | * @return ArrayList |
||
| 755 | */ |
||
| 756 | public function getBreadcrumbItems($maxDepth = 20, $stopAtPageType = false, $showHidden = false) { |
||
| 774 | |||
| 775 | |||
| 776 | /** |
||
| 777 | * Make this page a child of another page. |
||
| 778 | * |
||
| 779 | * If the parent page does not exist, resolve it to a valid ID before updating this page's reference. |
||
| 780 | * |
||
| 781 | * @param SiteTree|int $item Either the parent object, or the parent ID |
||
| 782 | */ |
||
| 783 | public function setParent($item) { |
||
| 784 | if(is_object($item)) { |
||
| 785 | if (!$item->exists()) $item->write(); |
||
| 786 | $this->setField("ParentID", $item->ID); |
||
| 787 | } else { |
||
| 788 | $this->setField("ParentID", $item); |
||
| 789 | } |
||
| 790 | } |
||
| 791 | |||
| 792 | /** |
||
| 793 | * Get the parent of this page. |
||
| 794 | * |
||
| 795 | * @return SiteTree Parent of this page |
||
| 796 | */ |
||
| 797 | public function getParent() { |
||
| 802 | |||
| 803 | /** |
||
| 804 | * Return a string of the form "parent - page" or "grandparent - parent - page" using page titles |
||
| 805 | * |
||
| 806 | * @param int $level The maximum amount of levels to traverse. |
||
| 807 | * @param string $separator Seperating string |
||
| 808 | * @return string The resulting string |
||
| 809 | */ |
||
| 810 | public function NestedTitle($level = 2, $separator = " - ") { |
||
| 819 | |||
| 820 | /** |
||
| 821 | * This function should return true if the current user can execute this action. It can be overloaded to customise |
||
| 822 | * the security model for an application. |
||
| 823 | * |
||
| 824 | * Slightly altered from parent behaviour in {@link DataObject->can()}: |
||
| 825 | * - Checks for existence of a method named "can<$perm>()" on the object |
||
| 826 | * - Calls decorators and only returns for FALSE "vetoes" |
||
| 827 | * - Falls back to {@link Permission::check()} |
||
| 828 | * - Does NOT check for many-many relations named "Can<$perm>" |
||
| 829 | * |
||
| 830 | * @uses DataObjectDecorator->can() |
||
| 831 | * |
||
| 832 | * @param string $perm The permission to be checked, such as 'View' |
||
| 833 | * @param Member $member The member whose permissions need checking. Defaults to the currently logged in user. |
||
| 834 | * @return bool True if the the member is allowed to do the given action |
||
| 835 | */ |
||
| 836 | public function can($perm, $member = null) { |
||
| 853 | |||
| 854 | /** |
||
| 855 | * This function should return true if the current user can add children to this page. It can be overloaded to |
||
| 856 | * customise the security model for an application. |
||
| 857 | * |
||
| 858 | * Denies permission if any of the following conditions is true: |
||
| 859 | * - alternateCanAddChildren() on a extension returns false |
||
| 860 | * - canEdit() is not granted |
||
| 861 | * - There are no classes defined in {@link $allowed_children} |
||
| 862 | * |
||
| 863 | * @uses SiteTreeExtension->canAddChildren() |
||
| 864 | * @uses canEdit() |
||
| 865 | * @uses $allowed_children |
||
| 866 | * |
||
| 867 | * @param Member|int $member |
||
| 868 | * @return bool True if the current user can add children |
||
| 869 | */ |
||
| 870 | public function canAddChildren($member = null) { |
||
| 888 | |||
| 889 | /** |
||
| 890 | * This function should return true if the current user can view this page. It can be overloaded to customise the |
||
| 891 | * security model for an application. |
||
| 892 | * |
||
| 893 | * Denies permission if any of the following conditions is true: |
||
| 894 | * - canView() on any extension returns false |
||
| 895 | * - "CanViewType" directive is set to "Inherit" and any parent page return false for canView() |
||
| 896 | * - "CanViewType" directive is set to "LoggedInUsers" and no user is logged in |
||
| 897 | * - "CanViewType" directive is set to "OnlyTheseUsers" and user is not in the given groups |
||
| 898 | * |
||
| 899 | * @uses DataExtension->canView() |
||
| 900 | * @uses ViewerGroups() |
||
| 901 | * |
||
| 902 | * @param Member|int $member |
||
| 903 | * @return bool True if the current user can view this page |
||
| 904 | */ |
||
| 905 | public function canView($member = null) { |
||
| 944 | |||
| 945 | /** |
||
| 946 | * This function should return true if the current user can delete this page. It can be overloaded to customise the |
||
| 947 | * security model for an application. |
||
| 948 | * |
||
| 949 | * Denies permission if any of the following conditions is true: |
||
| 950 | * - canDelete() returns false on any extension |
||
| 951 | * - canEdit() returns false |
||
| 952 | * - any descendant page returns false for canDelete() |
||
| 953 | * |
||
| 954 | * @uses canDelete() |
||
| 955 | * @uses SiteTreeExtension->canDelete() |
||
| 956 | * @uses canEdit() |
||
| 957 | * |
||
| 958 | * @param Member $member |
||
| 959 | * @return bool True if the current user can delete this page |
||
| 960 | */ |
||
| 961 | public function canDelete($member = null) { |
||
| 981 | |||
| 982 | /** |
||
| 983 | * This function should return true if the current user can create new pages of this class, regardless of class. It |
||
| 984 | * can be overloaded to customise the security model for an application. |
||
| 985 | * |
||
| 986 | * By default, permission to create at the root level is based on the SiteConfig configuration, and permission to |
||
| 987 | * create beneath a parent is based on the ability to edit that parent page. |
||
| 988 | * |
||
| 989 | * Use {@link canAddChildren()} to control behaviour of creating children under this page. |
||
| 990 | * |
||
| 991 | * @uses $can_create |
||
| 992 | * @uses DataExtension->canCreate() |
||
| 993 | * |
||
| 994 | * @param Member $member |
||
| 995 | * @param array $context Optional array which may contain array('Parent' => $parentObj) |
||
| 996 | * If a parent page is known, it will be checked for validity. |
||
| 997 | * If omitted, it will be assumed this is to be created as a top level page. |
||
| 998 | * @return bool True if the current user can create pages on this class. |
||
| 999 | */ |
||
| 1000 | public function canCreate($member = null, $context = array()) { |
||
| 1032 | |||
| 1033 | /** |
||
| 1034 | * This function should return true if the current user can edit this page. It can be overloaded to customise the |
||
| 1035 | * security model for an application. |
||
| 1036 | * |
||
| 1037 | * Denies permission if any of the following conditions is true: |
||
| 1038 | * - canEdit() on any extension returns false |
||
| 1039 | * - canView() return false |
||
| 1040 | * - "CanEditType" directive is set to "Inherit" and any parent page return false for canEdit() |
||
| 1041 | * - "CanEditType" directive is set to "LoggedInUsers" and no user is logged in or doesn't have the |
||
| 1042 | * CMS_Access_CMSMAIN permission code |
||
| 1043 | * - "CanEditType" directive is set to "OnlyTheseUsers" and user is not in the given groups |
||
| 1044 | * |
||
| 1045 | * @uses canView() |
||
| 1046 | * @uses EditorGroups() |
||
| 1047 | * @uses DataExtension->canEdit() |
||
| 1048 | * |
||
| 1049 | * @param Member $member Set to false if you want to explicitly test permissions without a valid user (useful for |
||
| 1050 | * unit tests) |
||
| 1051 | * @return bool True if the current user can edit this page |
||
| 1052 | */ |
||
| 1053 | public function canEdit($member = null) { |
||
| 1077 | |||
| 1078 | /** |
||
| 1079 | * @deprecated |
||
| 1080 | */ |
||
| 1081 | public function canDeleteFromLive($member = null) { |
||
| 1082 | Deprecation::notice('4.0', 'Use canUnpublish'); |
||
| 1083 | |||
| 1084 | // Deprecated extension |
||
| 1085 | $extended = $this->extendedCan('canDeleteFromLive', $member); |
||
| 1086 | if($extended !== null) { |
||
| 1087 | Deprecation::notice('4.0', 'Use canUnpublish in your extension instead'); |
||
| 1088 | return $extended; |
||
| 1089 | } |
||
| 1090 | |||
| 1091 | return $this->canUnpublish($member); |
||
| 1092 | } |
||
| 1093 | |||
| 1094 | /** |
||
| 1095 | * Stub method to get the site config, unless the current class can provide an alternate. |
||
| 1096 | * |
||
| 1097 | * @return SiteConfig |
||
| 1098 | */ |
||
| 1099 | public function getSiteConfig() { |
||
| 1108 | |||
| 1109 | /** |
||
| 1110 | * Pre-populate the cache of canEdit, canView, canDelete, canPublish permissions. This method will use the static |
||
| 1111 | * can_(perm)_multiple method for efficiency. |
||
| 1112 | * |
||
| 1113 | * @param string $permission The permission: edit, view, publish, approve, etc. |
||
| 1114 | * @param array $ids An array of page IDs |
||
| 1115 | * @param callable|string $batchCallback The function/static method to call to calculate permissions. Defaults |
||
| 1116 | * to 'SiteTree::can_(permission)_multiple' |
||
| 1117 | */ |
||
| 1118 | static public function prepopulate_permission_cache($permission = 'CanEditType', $ids, $batchCallback = null) { |
||
| 1119 | if(!$batchCallback) $batchCallback = "SiteTree::can_{$permission}_multiple"; |
||
| 1120 | |||
| 1121 | if(is_callable($batchCallback)) { |
||
| 1122 | call_user_func($batchCallback, $ids, Member::currentUserID(), false); |
||
| 1123 | } else { |
||
| 1124 | user_error("SiteTree::prepopulate_permission_cache can't calculate '$permission' " |
||
| 1125 | . "with callback '$batchCallback'", E_USER_WARNING); |
||
| 1126 | } |
||
| 1127 | } |
||
| 1128 | |||
| 1129 | /** |
||
| 1130 | * This method is NOT a full replacement for the individual can*() methods, e.g. {@link canEdit()}. Rather than |
||
| 1131 | * checking (potentially slow) PHP logic, it relies on the database group associations, e.g. the "CanEditType" field |
||
| 1132 | * plus the "SiteTree_EditorGroups" many-many table. By batch checking multiple records, we can combine the queries |
||
| 1133 | * efficiently. |
||
| 1134 | * |
||
| 1135 | * Caches based on $typeField data. To invalidate the cache, use {@link SiteTree::reset()} or set the $useCached |
||
| 1136 | * property to FALSE. |
||
| 1137 | * |
||
| 1138 | * @param array $ids Of {@link SiteTree} IDs |
||
| 1139 | * @param int $memberID Member ID |
||
| 1140 | * @param string $typeField A property on the data record, e.g. "CanEditType". |
||
| 1141 | * @param string $groupJoinTable A many-many table name on this record, e.g. "SiteTree_EditorGroups" |
||
| 1142 | * @param string $siteConfigMethod Method to call on {@link SiteConfig} for toplevel items, e.g. "canEdit" |
||
| 1143 | * @param string $globalPermission If the member doesn't have this permission code, don't bother iterating deeper |
||
| 1144 | * @param bool $useCached |
||
| 1145 | * @return array An map of {@link SiteTree} ID keys to boolean values |
||
| 1146 | */ |
||
| 1147 | public static function batch_permission_check($ids, $memberID, $typeField, $groupJoinTable, $siteConfigMethod, |
||
| 1270 | |||
| 1271 | /** |
||
| 1272 | * Get the 'can edit' information for a number of SiteTree pages. |
||
| 1273 | * |
||
| 1274 | * @param array $ids An array of IDs of the SiteTree pages to look up |
||
| 1275 | * @param int $memberID ID of member |
||
| 1276 | * @param bool $useCached Return values from the permission cache if they exist |
||
| 1277 | * @return array A map where the IDs are keys and the values are booleans stating whether the given page can be |
||
| 1278 | * edited |
||
| 1279 | */ |
||
| 1280 | static public function can_edit_multiple($ids, $memberID, $useCached = true) { |
||
| 1283 | |||
| 1284 | /** |
||
| 1285 | * Get the 'can edit' information for a number of SiteTree pages. |
||
| 1286 | * |
||
| 1287 | * @param array $ids An array of IDs of the SiteTree pages to look up |
||
| 1288 | * @param int $memberID ID of member |
||
| 1289 | * @param bool $useCached Return values from the permission cache if they exist |
||
| 1290 | * @return array |
||
| 1291 | */ |
||
| 1292 | static public function can_delete_multiple($ids, $memberID, $useCached = true) { |
||
| 1351 | |||
| 1352 | /** |
||
| 1353 | * Collate selected descendants of this page. |
||
| 1354 | * |
||
| 1355 | * {@link $condition} will be evaluated on each descendant, and if it is succeeds, that item will be added to the |
||
| 1356 | * $collator array. |
||
| 1357 | * |
||
| 1358 | * @param string $condition The PHP condition to be evaluated. The page will be called $item |
||
| 1359 | * @param array $collator An array, passed by reference, to collect all of the matching descendants. |
||
| 1360 | * @return bool |
||
| 1361 | */ |
||
| 1362 | public function collateDescendants($condition, &$collator) { |
||
| 1371 | |||
| 1372 | /** |
||
| 1373 | * Return the title, description, keywords and language metatags. |
||
| 1374 | * |
||
| 1375 | * @todo Move <title> tag in separate getter for easier customization and more obvious usage |
||
| 1376 | * |
||
| 1377 | * @param bool $includeTitle Show default <title>-tag, set to false for custom templating |
||
| 1378 | * @return string The XHTML metatags |
||
| 1379 | */ |
||
| 1380 | public function MetaTags($includeTitle = true) { |
||
| 1413 | |||
| 1414 | /** |
||
| 1415 | * Returns the object that contains the content that a user would associate with this page. |
||
| 1416 | * |
||
| 1417 | * Ordinarily, this is just the page itself, but for example on RedirectorPages or VirtualPages ContentSource() will |
||
| 1418 | * return the page that is linked to. |
||
| 1419 | * |
||
| 1420 | * @return $this |
||
| 1421 | */ |
||
| 1422 | public function ContentSource() { |
||
| 1425 | |||
| 1426 | /** |
||
| 1427 | * Add default records to database. |
||
| 1428 | * |
||
| 1429 | * This function is called whenever the database is built, after the database tables have all been created. Overload |
||
| 1430 | * this to add default records when the database is built, but make sure you call parent::requireDefaultRecords(). |
||
| 1431 | */ |
||
| 1432 | public function requireDefaultRecords() { |
||
| 1481 | |||
| 1482 | protected function onBeforeWrite() { |
||
| 1532 | |||
| 1533 | /** |
||
| 1534 | * Trigger synchronisation of link tracking |
||
| 1535 | * |
||
| 1536 | * {@see SiteTreeLinkTracking::augmentSyncLinkTracking} |
||
| 1537 | */ |
||
| 1538 | public function syncLinkTracking() { |
||
| 1541 | |||
| 1542 | public function onBeforeDelete() { |
||
| 1552 | |||
| 1553 | public function onAfterDelete() { |
||
| 1554 | // Need to flush cache to avoid outdated versionnumber references |
||
| 1555 | $this->flushCache(); |
||
| 1556 | |||
| 1557 | // Need to mark pages depending to this one as broken |
||
| 1558 | $dependentPages = $this->DependentPages(); |
||
| 1559 | if($dependentPages) foreach($dependentPages as $page) { |
||
| 1560 | // $page->write() calls syncLinkTracking, which does all the hard work for us. |
||
| 1561 | $page->write(); |
||
| 1562 | } |
||
| 1563 | |||
| 1564 | parent::onAfterDelete(); |
||
| 1565 | } |
||
| 1566 | |||
| 1567 | public function flushCache($persistent = true) { |
||
| 1568 | parent::flushCache($persistent); |
||
| 1569 | $this->_cache_statusFlags = null; |
||
| 1570 | } |
||
| 1571 | |||
| 1572 | public function validate() { |
||
| 1609 | |||
| 1610 | /** |
||
| 1611 | * Returns true if this object has a URLSegment value that does not conflict with any other objects. This method |
||
| 1612 | * checks for: |
||
| 1613 | * - A page with the same URLSegment that has a conflict |
||
| 1614 | * - Conflicts with actions on the parent page |
||
| 1615 | * - A conflict caused by a root page having the same URLSegment as a class name |
||
| 1616 | * |
||
| 1617 | * @return bool |
||
| 1618 | */ |
||
| 1619 | public function validURLSegment() { |
||
| 1653 | |||
| 1654 | /** |
||
| 1655 | * Generate a URL segment based on the title provided. |
||
| 1656 | * |
||
| 1657 | * If {@link Extension}s wish to alter URL segment generation, they can do so by defining |
||
| 1658 | * updateURLSegment(&$url, $title). $url will be passed by reference and should be modified. $title will contain |
||
| 1659 | * the title that was originally used as the source of this generated URL. This lets extensions either start from |
||
| 1660 | * scratch, or incrementally modify the generated URL. |
||
| 1661 | * |
||
| 1662 | * @param string $title Page title |
||
| 1663 | * @return string Generated url segment |
||
| 1664 | */ |
||
| 1665 | public function generateURLSegment($title){ |
||
| 1677 | |||
| 1678 | /** |
||
| 1679 | * Gets the URL segment for the latest draft version of this page. |
||
| 1680 | * |
||
| 1681 | * @return string |
||
| 1682 | */ |
||
| 1683 | public function getStageURLSegment() { |
||
| 1684 | $stageRecord = Versioned::get_one_by_stage('SiteTree', 'Stage', array( |
||
| 1685 | '"SiteTree"."ID"' => $this->ID |
||
| 1686 | )); |
||
| 1687 | return ($stageRecord) ? $stageRecord->URLSegment : null; |
||
| 1688 | } |
||
| 1689 | |||
| 1690 | /** |
||
| 1691 | * Gets the URL segment for the currently published version of this page. |
||
| 1692 | * |
||
| 1693 | * @return string |
||
| 1694 | */ |
||
| 1695 | public function getLiveURLSegment() { |
||
| 1701 | |||
| 1702 | /** |
||
| 1703 | * Rewrites any linked images on this page without creating a new version record. |
||
| 1704 | * Non-image files should be linked via shortcodes |
||
| 1705 | * Triggers the onRenameLinkedAsset action on extensions. |
||
| 1706 | * |
||
| 1707 | * @todo Implement image shortcodes and remove this feature |
||
| 1708 | */ |
||
| 1709 | public function rewriteFileLinks() { |
||
| 1710 | // Skip live stage |
||
| 1711 | if(\Versioned::get_stage() === \Versioned::LIVE_STAGE) { |
||
| 1712 | return; |
||
| 1713 | } |
||
| 1714 | |||
| 1715 | // Update the content without actually creating a new version |
||
| 1716 | foreach($this->db() as $fieldName => $fieldType) { |
||
| 1717 | // Skip if non HTML or if empty |
||
| 1718 | if ($fieldType !== 'HTMLText') { |
||
| 1719 | continue; |
||
| 1720 | } |
||
| 1721 | $fieldValue = $this->{$fieldName}; |
||
| 1722 | if(empty($fieldValue)) { |
||
| 1723 | continue; |
||
| 1724 | } |
||
| 1725 | |||
| 1726 | // Regenerate content |
||
| 1727 | $content = Image::regenerate_html_links($fieldValue); |
||
| 1728 | if($content === $fieldValue) { |
||
| 1729 | continue; |
||
| 1730 | } |
||
| 1731 | |||
| 1732 | // Write content directly without updating linked assets |
||
| 1733 | $table = ClassInfo::table_for_object_field($this, $fieldName); |
||
| 1734 | $query = sprintf('UPDATE "%s" SET "%s" = ? WHERE "ID" = ?', $table, $fieldName); |
||
| 1735 | DB::prepared_query($query, array($content, $this->ID)); |
||
| 1736 | |||
| 1737 | // Update linked assets |
||
| 1738 | $this->invokeWithExtensions('onRenameLinkedAsset'); |
||
| 1739 | } |
||
| 1740 | } |
||
| 1741 | |||
| 1742 | /** |
||
| 1743 | * Returns the pages that depend on this page. This includes virtual pages, pages that link to it, etc. |
||
| 1744 | * |
||
| 1745 | * @param bool $includeVirtuals Set to false to exlcude virtual pages. |
||
| 1746 | * @return ArrayList |
||
| 1747 | */ |
||
| 1748 | public function DependentPages($includeVirtuals = true) { |
||
| 1798 | |||
| 1799 | /** |
||
| 1800 | * Return all virtual pages that link to this page. |
||
| 1801 | * |
||
| 1802 | * @return DataList |
||
| 1803 | */ |
||
| 1804 | public function VirtualPages() { |
||
| 1805 | $pages = parent::VirtualPages(); |
||
| 1806 | |||
| 1807 | // Disable subsite filter for these pages |
||
| 1808 | if($pages instanceof DataList) { |
||
| 1809 | return $pages->setDataQueryParam('Subsite.filter', false); |
||
| 1810 | } else { |
||
| 1811 | return $pages; |
||
| 1812 | } |
||
| 1813 | } |
||
| 1814 | |||
| 1815 | /** |
||
| 1816 | * Returns a FieldList with which to create the main editing form. |
||
| 1817 | * |
||
| 1818 | * You can override this in your child classes to add extra fields - first get the parent fields using |
||
| 1819 | * parent::getCMSFields(), then use addFieldToTab() on the FieldList. |
||
| 1820 | * |
||
| 1821 | * See {@link getSettingsFields()} for a different set of fields concerned with configuration aspects on the record, |
||
| 1822 | * e.g. access control. |
||
| 1823 | * |
||
| 1824 | * @return FieldList The fields to be displayed in the CMS |
||
| 1825 | */ |
||
| 1826 | public function getCMSFields() { |
||
| 1827 | require_once("forms/Form.php"); |
||
| 1828 | // Status / message |
||
| 1829 | // Create a status message for multiple parents |
||
| 1830 | if($this->ID && is_numeric($this->ID)) { |
||
| 1831 | $linkedPages = $this->VirtualPages(); |
||
| 1832 | |||
| 1833 | $parentPageLinks = array(); |
||
| 1834 | |||
| 1835 | if($linkedPages->Count() > 0) { |
||
| 1836 | foreach($linkedPages as $linkedPage) { |
||
| 1837 | $parentPage = $linkedPage->Parent; |
||
| 1838 | if($parentPage) { |
||
| 1839 | if($parentPage->ID) { |
||
| 1840 | $parentPageLinks[] = "<a class=\"cmsEditlink\" href=\"admin/pages/edit/show/$linkedPage->ID\">{$parentPage->Title}</a>"; |
||
| 1841 | } else { |
||
| 1842 | $parentPageLinks[] = "<a class=\"cmsEditlink\" href=\"admin/pages/edit/show/$linkedPage->ID\">" . |
||
| 1843 | _t('SiteTree.TOPLEVEL', 'Site Content (Top Level)') . |
||
| 1844 | "</a>"; |
||
| 1845 | } |
||
| 1846 | } |
||
| 1847 | } |
||
| 1848 | |||
| 1849 | $lastParent = array_pop($parentPageLinks); |
||
| 1850 | $parentList = "'$lastParent'"; |
||
| 1851 | |||
| 1852 | if(count($parentPageLinks) > 0) { |
||
| 1853 | $parentList = "'" . implode("', '", $parentPageLinks) . "' and " |
||
| 1854 | . $parentList; |
||
| 1855 | } |
||
| 1856 | |||
| 1857 | $statusMessage[] = _t( |
||
| 1858 | 'SiteTree.APPEARSVIRTUALPAGES', |
||
| 1859 | "This content also appears on the virtual pages in the {title} sections.", |
||
| 1860 | array('title' => $parentList) |
||
| 1861 | ); |
||
| 1862 | } |
||
| 1863 | } |
||
| 1864 | |||
| 1865 | if($this->HasBrokenLink || $this->HasBrokenFile) { |
||
| 1866 | $statusMessage[] = _t('SiteTree.HASBROKENLINKS', "This page has broken links."); |
||
| 1867 | } |
||
| 1868 | |||
| 1869 | $dependentNote = ''; |
||
| 1870 | $dependentTable = new LiteralField('DependentNote', '<p></p>'); |
||
| 1871 | |||
| 1872 | // Create a table for showing pages linked to this one |
||
| 1873 | $dependentPages = $this->DependentPages(); |
||
| 1874 | $dependentPagesCount = $dependentPages->Count(); |
||
| 1875 | if($dependentPagesCount) { |
||
| 1876 | $dependentColumns = array( |
||
| 1877 | 'Title' => $this->fieldLabel('Title'), |
||
| 1878 | 'AbsoluteLink' => _t('SiteTree.DependtPageColumnURL', 'URL'), |
||
| 1879 | 'DependentLinkType' => _t('SiteTree.DependtPageColumnLinkType', 'Link type'), |
||
| 1880 | ); |
||
| 1881 | if(class_exists('Subsite')) $dependentColumns['Subsite.Title'] = singleton('Subsite')->i18n_singular_name(); |
||
| 1882 | |||
| 1883 | $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>'); |
||
| 1884 | $dependentTable = GridField::create( |
||
| 1885 | 'DependentPages', |
||
| 1886 | false, |
||
| 1887 | $dependentPages |
||
| 1888 | ); |
||
| 1889 | $dependentTable->getConfig()->getComponentByType('GridFieldDataColumns') |
||
| 1890 | ->setDisplayFields($dependentColumns) |
||
| 1891 | ->setFieldFormatting(array( |
||
| 1892 | 'Title' => function($value, &$item) { |
||
| 1893 | return sprintf( |
||
| 1894 | '<a href="admin/pages/edit/show/%d">%s</a>', |
||
| 1895 | (int)$item->ID, |
||
| 1896 | Convert::raw2xml($item->Title) |
||
| 1897 | ); |
||
| 1898 | }, |
||
| 1899 | 'AbsoluteLink' => function($value, &$item) { |
||
| 1900 | return sprintf( |
||
| 1901 | '<a href="%s" target="_blank">%s</a>', |
||
| 1902 | Convert::raw2xml($value), |
||
| 1903 | Convert::raw2xml($value) |
||
| 1904 | ); |
||
| 1905 | } |
||
| 1906 | )); |
||
| 1907 | } |
||
| 1908 | |||
| 1909 | $baseLink = Controller::join_links ( |
||
| 1910 | Director::absoluteBaseURL(), |
||
| 1911 | (self::config()->nested_urls && $this->ParentID ? $this->Parent()->RelativeLink(true) : null) |
||
| 1912 | ); |
||
| 1913 | |||
| 1914 | $urlsegment = SiteTreeURLSegmentField::create("URLSegment", $this->fieldLabel('URLSegment')) |
||
| 1915 | ->setURLPrefix($baseLink) |
||
| 1916 | ->setDefaultURL($this->generateURLSegment(_t( |
||
| 1917 | 'CMSMain.NEWPAGE', |
||
| 1918 | array('pagetype' => $this->i18n_singular_name()) |
||
| 1919 | ))); |
||
| 1920 | $helpText = (self::config()->nested_urls && count($this->Children())) ? $this->fieldLabel('LinkChangeNote') : ''; |
||
| 1921 | if(!Config::inst()->get('URLSegmentFilter', 'default_allow_multibyte')) { |
||
| 1922 | $helpText .= $helpText ? '<br />' : ''; |
||
| 1923 | $helpText .= _t('SiteTreeURLSegmentField.HelpChars', ' Special characters are automatically converted or removed.'); |
||
| 1924 | } |
||
| 1925 | $urlsegment->setHelpText($helpText); |
||
| 1926 | |||
| 1927 | $fields = new FieldList( |
||
| 1928 | $rootTab = new TabSet("Root", |
||
| 1929 | $tabMain = new Tab('Main', |
||
| 1930 | new TextField("Title", $this->fieldLabel('Title')), |
||
| 1931 | $urlsegment, |
||
| 1932 | new TextField("MenuTitle", $this->fieldLabel('MenuTitle')), |
||
| 1933 | $htmlField = new HtmlEditorField("Content", _t('SiteTree.HTMLEDITORTITLE', "Content", 'HTML editor title')), |
||
| 1934 | ToggleCompositeField::create('Metadata', _t('SiteTree.MetadataToggle', 'Metadata'), |
||
| 1935 | array( |
||
| 1936 | $metaFieldDesc = new TextareaField("MetaDescription", $this->fieldLabel('MetaDescription')), |
||
| 1937 | $metaFieldExtra = new TextareaField("ExtraMeta",$this->fieldLabel('ExtraMeta')) |
||
| 1938 | ) |
||
| 1939 | )->setHeadingLevel(4) |
||
| 1940 | ), |
||
| 1941 | $tabDependent = new Tab('Dependent', |
||
| 1942 | $dependentNote, |
||
| 1943 | $dependentTable |
||
| 1944 | ) |
||
| 1945 | ) |
||
| 1946 | ); |
||
| 1947 | $htmlField->addExtraClass('stacked'); |
||
| 1948 | |||
| 1949 | // Help text for MetaData on page content editor |
||
| 1950 | $metaFieldDesc |
||
| 1951 | ->setRightTitle( |
||
| 1952 | _t( |
||
| 1953 | 'SiteTree.METADESCHELP', |
||
| 1954 | "Search engines use this content for displaying search results (although it will not influence their ranking)." |
||
| 1955 | ) |
||
| 1956 | ) |
||
| 1957 | ->addExtraClass('help'); |
||
| 1958 | $metaFieldExtra |
||
| 1959 | ->setRightTitle( |
||
| 1960 | _t( |
||
| 1961 | 'SiteTree.METAEXTRAHELP', |
||
| 1962 | "HTML tags for additional meta information. For example <meta name=\"customName\" content=\"your custom content here\" />" |
||
| 1963 | ) |
||
| 1964 | ) |
||
| 1965 | ->addExtraClass('help'); |
||
| 1966 | |||
| 1967 | // Conditional dependent pages tab |
||
| 1968 | if($dependentPagesCount) $tabDependent->setTitle(_t('SiteTree.TABDEPENDENT', "Dependent pages") . " ($dependentPagesCount)"); |
||
| 1969 | else $fields->removeFieldFromTab('Root', 'Dependent'); |
||
| 1970 | |||
| 1971 | $tabMain->setTitle(_t('SiteTree.TABCONTENT', "Main Content")); |
||
| 1972 | |||
| 1973 | if($this->ObsoleteClassName) { |
||
| 1974 | $obsoleteWarning = _t( |
||
| 1975 | 'SiteTree.OBSOLETECLASS', |
||
| 1976 | "This page is of obsolete type {type}. Saving will reset its type and you may lose data", |
||
| 1977 | array('type' => $this->ObsoleteClassName) |
||
| 1978 | ); |
||
| 1979 | |||
| 1980 | $fields->addFieldToTab( |
||
| 1981 | "Root.Main", |
||
| 1982 | new LiteralField("ObsoleteWarningHeader", "<p class=\"message warning\">$obsoleteWarning</p>"), |
||
| 1983 | "Title" |
||
| 1984 | ); |
||
| 1985 | } |
||
| 1986 | |||
| 1987 | if(file_exists(BASE_PATH . '/install.php')) { |
||
| 1988 | $fields->addFieldToTab("Root.Main", new LiteralField("InstallWarningHeader", |
||
| 1989 | "<p class=\"message warning\">" . _t("SiteTree.REMOVE_INSTALL_WARNING", |
||
| 1990 | "Warning: You should remove install.php from this SilverStripe install for security reasons.") |
||
| 1991 | . "</p>"), "Title"); |
||
| 1992 | } |
||
| 1993 | |||
| 1994 | // Backwards compat: Rewrite nested "Content" tabs to toplevel |
||
| 1995 | $fields->setTabPathRewrites(array( |
||
| 1996 | '/^Root\.Content\.Main$/' => 'Root.Main', |
||
| 1997 | '/^Root\.Content\.([^.]+)$/' => 'Root.\\1', |
||
| 1998 | )); |
||
| 1999 | |||
| 2000 | if(self::$runCMSFieldsExtensions) { |
||
| 2001 | $this->extend('updateCMSFields', $fields); |
||
| 2002 | } |
||
| 2003 | |||
| 2004 | return $fields; |
||
| 2005 | } |
||
| 2006 | |||
| 2007 | |||
| 2008 | /** |
||
| 2009 | * Returns fields related to configuration aspects on this record, e.g. access control. See {@link getCMSFields()} |
||
| 2010 | * for content-related fields. |
||
| 2011 | * |
||
| 2012 | * @return FieldList |
||
| 2013 | */ |
||
| 2014 | public function getSettingsFields() { |
||
| 2120 | |||
| 2121 | /** |
||
| 2122 | * @param bool $includerelations A boolean value to indicate if the labels returned should include relation fields |
||
| 2123 | * @return array |
||
| 2124 | */ |
||
| 2125 | public function fieldLabels($includerelations = true) { |
||
| 2126 | $cacheKey = $this->class . '_' . $includerelations; |
||
| 2127 | if(!isset(self::$_cache_field_labels[$cacheKey])) { |
||
| 2128 | $labels = parent::fieldLabels($includerelations); |
||
| 2129 | $labels['Title'] = _t('SiteTree.PAGETITLE', "Page name"); |
||
| 2130 | $labels['MenuTitle'] = _t('SiteTree.MENUTITLE', "Navigation label"); |
||
| 2131 | $labels['MetaDescription'] = _t('SiteTree.METADESC', "Meta Description"); |
||
| 2132 | $labels['ExtraMeta'] = _t('SiteTree.METAEXTRA', "Custom Meta Tags"); |
||
| 2133 | $labels['ClassName'] = _t('SiteTree.PAGETYPE', "Page type", 'Classname of a page object'); |
||
| 2134 | $labels['ParentType'] = _t('SiteTree.PARENTTYPE', "Page location"); |
||
| 2135 | $labels['ParentID'] = _t('SiteTree.PARENTID', "Parent page"); |
||
| 2136 | $labels['ShowInMenus'] =_t('SiteTree.SHOWINMENUS', "Show in menus?"); |
||
| 2137 | $labels['ShowInSearch'] = _t('SiteTree.SHOWINSEARCH', "Show in search?"); |
||
| 2138 | $labels['ProvideComments'] = _t('SiteTree.ALLOWCOMMENTS', "Allow comments on this page?"); |
||
| 2139 | $labels['ViewerGroups'] = _t('SiteTree.VIEWERGROUPS', "Viewer Groups"); |
||
| 2140 | $labels['EditorGroups'] = _t('SiteTree.EDITORGROUPS', "Editor Groups"); |
||
| 2141 | $labels['URLSegment'] = _t('SiteTree.URLSegment', 'URL Segment', 'URL for this page'); |
||
| 2142 | $labels['Content'] = _t('SiteTree.Content', 'Content', 'Main HTML Content for a page'); |
||
| 2143 | $labels['CanViewType'] = _t('SiteTree.Viewers', 'Viewers Groups'); |
||
| 2144 | $labels['CanEditType'] = _t('SiteTree.Editors', 'Editors Groups'); |
||
| 2145 | $labels['Comments'] = _t('SiteTree.Comments', 'Comments'); |
||
| 2146 | $labels['Visibility'] = _t('SiteTree.Visibility', 'Visibility'); |
||
| 2147 | $labels['LinkChangeNote'] = _t ( |
||
| 2148 | 'SiteTree.LINKCHANGENOTE', 'Changing this page\'s link will also affect the links of all child pages.' |
||
| 2149 | ); |
||
| 2150 | |||
| 2151 | if($includerelations){ |
||
| 2152 | $labels['Parent'] = _t('SiteTree.has_one_Parent', 'Parent Page', 'The parent page in the site hierarchy'); |
||
| 2153 | $labels['LinkTracking'] = _t('SiteTree.many_many_LinkTracking', 'Link Tracking'); |
||
| 2154 | $labels['ImageTracking'] = _t('SiteTree.many_many_ImageTracking', 'Image Tracking'); |
||
| 2155 | $labels['BackLinkTracking'] = _t('SiteTree.many_many_BackLinkTracking', 'Backlink Tracking'); |
||
| 2156 | } |
||
| 2157 | |||
| 2158 | self::$_cache_field_labels[$cacheKey] = $labels; |
||
| 2159 | } |
||
| 2160 | |||
| 2161 | return self::$_cache_field_labels[$cacheKey]; |
||
| 2162 | } |
||
| 2163 | |||
| 2164 | /** |
||
| 2165 | * Get the actions available in the CMS for this page - eg Save, Publish. |
||
| 2166 | * |
||
| 2167 | * Frontend scripts and styles know how to handle the following FormFields: |
||
| 2168 | * - top-level FormActions appear as standalone buttons |
||
| 2169 | * - top-level CompositeField with FormActions within appear as grouped buttons |
||
| 2170 | * - TabSet & Tabs appear as a drop ups |
||
| 2171 | * - FormActions within the Tab are restyled as links |
||
| 2172 | * - major actions can provide alternate states for richer presentation (see ssui.button widget extension) |
||
| 2173 | * |
||
| 2174 | * @return FieldList The available actions for this page. |
||
| 2175 | */ |
||
| 2176 | public function getCMSActions() { |
||
| 2327 | |||
| 2328 | public function onAfterPublish() { |
||
| 2336 | |||
| 2337 | /** |
||
| 2338 | * Unpublish this page - remove it from the live site |
||
| 2339 | * |
||
| 2340 | * Overrides {@see Versioned::doUnpublish()} |
||
| 2341 | * |
||
| 2342 | * @uses SiteTreeExtension->onBeforeUnpublish() |
||
| 2343 | * @uses SiteTreeExtension->onAfterUnpublish() |
||
| 2344 | */ |
||
| 2345 | public function doUnpublish() { |
||
| 2346 | if(!$this->canUnpublish()) return false; |
||
| 2347 | if(!$this->ID) return false; |
||
| 2348 | |||
| 2349 | $this->invokeWithExtensions('onBeforeUnpublish', $this); |
||
| 2350 | |||
| 2351 | $origStage = Versioned::get_stage(); |
||
| 2352 | Versioned::set_stage(Versioned::LIVE_STAGE); |
||
| 2353 | |||
| 2354 | // We should only unpublish virtualpages that exist on live |
||
| 2355 | $virtualPages = $this->VirtualPages(); |
||
| 2356 | |||
| 2357 | // This way our ID won't be unset |
||
| 2358 | $clone = clone $this; |
||
| 2359 | $clone->delete(); |
||
| 2360 | |||
| 2361 | // Rewrite backlinks |
||
| 2362 | $dependentPages = $this->DependentPages(false); |
||
| 2363 | if($dependentPages) foreach($dependentPages as $page) { |
||
| 2364 | // $page->write() calls syncLinkTracking, which does all the hard work for us. |
||
| 2365 | $page->write(); |
||
| 2366 | } |
||
| 2367 | Versioned::set_stage($origStage); |
||
| 2368 | |||
| 2369 | // Unpublish any published virtual pages |
||
| 2370 | if ($virtualPages) foreach($virtualPages as $vp) { |
||
| 2371 | $vp->doUnpublish(); |
||
| 2372 | } |
||
| 2373 | |||
| 2374 | // If we're on the draft site, then we can update the status. |
||
| 2375 | // Otherwise, these lines will resurrect an inappropriate record |
||
| 2376 | if(DB::prepared_query("SELECT \"ID\" FROM \"SiteTree\" WHERE \"ID\" = ?", array($this->ID))->value() |
||
| 2377 | && Versioned::get_stage() != 'Live') { |
||
| 2378 | $this->write(); |
||
| 2379 | } |
||
| 2380 | |||
| 2381 | $this->invokeWithExtensions('onAfterUnpublish', $this); |
||
| 2382 | |||
| 2383 | return true; |
||
| 2384 | } |
||
| 2385 | |||
| 2386 | /** |
||
| 2387 | * Revert the draft changes: replace the draft content with the content on live |
||
| 2388 | */ |
||
| 2389 | public function doRevertToLive() { |
||
| 2407 | |||
| 2408 | /** |
||
| 2409 | * Determine if this page references a parent which is archived, and not available in stage |
||
| 2410 | * |
||
| 2411 | * @return bool True if there is an archived parent |
||
| 2412 | */ |
||
| 2413 | protected function isParentArchived() { |
||
| 2422 | |||
| 2423 | /** |
||
| 2424 | * Restore the content in the active copy of this SiteTree page to the stage site. |
||
| 2425 | * |
||
| 2426 | * @return self |
||
| 2427 | */ |
||
| 2428 | public function doRestoreToStage() { |
||
| 2429 | $this->invokeWithExtensions('onBeforeRestoreToStage', $this); |
||
| 2430 | |||
| 2431 | // Ensure that the parent page is restored, otherwise restore to root |
||
| 2432 | if($this->isParentArchived()) { |
||
| 2433 | $this->ParentID = 0; |
||
| 2434 | } |
||
| 2435 | |||
| 2436 | // if no record can be found on draft stage (meaning it has been "deleted from draft" before), |
||
| 2437 | // create an empty record |
||
| 2438 | if(!DB::prepared_query("SELECT \"ID\" FROM \"SiteTree\" WHERE \"ID\" = ?", array($this->ID))->value()) { |
||
| 2439 | $conn = DB::get_conn(); |
||
| 2440 | if(method_exists($conn, 'allowPrimaryKeyEditing')) $conn->allowPrimaryKeyEditing('SiteTree', true); |
||
| 2441 | DB::prepared_query("INSERT INTO \"SiteTree\" (\"ID\") VALUES (?)", array($this->ID)); |
||
| 2442 | if(method_exists($conn, 'allowPrimaryKeyEditing')) $conn->allowPrimaryKeyEditing('SiteTree', false); |
||
| 2443 | } |
||
| 2444 | |||
| 2445 | $oldStage = Versioned::get_stage(); |
||
| 2446 | Versioned::set_stage(Versioned::DRAFT_STAGE); |
||
| 2447 | $this->forceChange(); |
||
| 2448 | $this->write(); |
||
| 2449 | |||
| 2450 | $result = DataObject::get_by_id($this->class, $this->ID); |
||
| 2451 | |||
| 2452 | // Need to update pages linking to this one as no longer broken |
||
| 2453 | foreach($result->DependentPages(false) as $page) { |
||
| 2454 | // $page->write() calls syncLinkTracking, which does all the hard work for us. |
||
| 2455 | $page->write(); |
||
| 2456 | } |
||
| 2457 | |||
| 2458 | Versioned::set_stage($oldStage); |
||
| 2459 | |||
| 2460 | $this->invokeWithExtensions('onAfterRestoreToStage', $this); |
||
| 2461 | |||
| 2462 | return $result; |
||
| 2463 | } |
||
| 2464 | |||
| 2465 | /** |
||
| 2466 | * @deprecated |
||
| 2467 | */ |
||
| 2468 | public function doDeleteFromLive() { |
||
| 2472 | |||
| 2473 | /** |
||
| 2474 | * Check if this page is new - that is, if it has yet to have been written to the database. |
||
| 2475 | * |
||
| 2476 | * @return bool |
||
| 2477 | */ |
||
| 2478 | public function isNew() { |
||
| 2479 | /** |
||
| 2480 | * This check was a problem for a self-hosted site, and may indicate a bug in the interpreter on their server, |
||
| 2481 | * or a bug here. Changing the condition from empty($this->ID) to !$this->ID && !$this->record['ID'] fixed this. |
||
| 2482 | */ |
||
| 2483 | if(empty($this->ID)) return true; |
||
| 2484 | |||
| 2485 | if(is_numeric($this->ID)) return false; |
||
| 2486 | |||
| 2487 | return stripos($this->ID, 'new') === 0; |
||
| 2488 | } |
||
| 2489 | |||
| 2490 | /** |
||
| 2491 | * Get the class dropdown used in the CMS to change the class of a page. This returns the list of options in the |
||
| 2492 | * dropdown as a Map from class name to singular name. Filters by {@link SiteTree->canCreate()}, as well as |
||
| 2493 | * {@link SiteTree::$needs_permission}. |
||
| 2494 | * |
||
| 2495 | * @return array |
||
| 2496 | */ |
||
| 2497 | protected function getClassDropdown() { |
||
| 2498 | $classes = self::page_type_classes(); |
||
| 2499 | $currentClass = null; |
||
| 2500 | $result = array(); |
||
| 2501 | |||
| 2502 | $result = array(); |
||
| 2503 | foreach($classes as $class) { |
||
| 2504 | $instance = singleton($class); |
||
| 2505 | |||
| 2506 | // if the current page type is this the same as the class type always show the page type in the list |
||
| 2507 | if ($this->ClassName != $instance->ClassName) { |
||
| 2508 | if($instance instanceof HiddenClass) continue; |
||
| 2509 | if(!$instance->canCreate(null, array('Parent' => $this->ParentID ? $this->Parent() : null))) continue; |
||
| 2510 | } |
||
| 2511 | |||
| 2512 | if($perms = $instance->stat('need_permission')) { |
||
| 2513 | if(!$this->can($perms)) continue; |
||
| 2514 | } |
||
| 2515 | |||
| 2516 | $pageTypeName = $instance->i18n_singular_name(); |
||
| 2517 | |||
| 2518 | $currentClass = $class; |
||
| 2519 | $result[$class] = $pageTypeName; |
||
| 2520 | |||
| 2521 | // If we're in translation mode, the link between the translated pagetype title and the actual classname |
||
| 2522 | // might not be obvious, so we add it in parantheses. Example: class "RedirectorPage" has the title |
||
| 2523 | // "Weiterleitung" in German, so it shows up as "Weiterleitung (RedirectorPage)" |
||
| 2524 | if(i18n::get_lang_from_locale(i18n::get_locale()) != 'en') { |
||
| 2525 | $result[$class] = $result[$class] . " ({$class})"; |
||
| 2526 | } |
||
| 2527 | } |
||
| 2528 | |||
| 2529 | // sort alphabetically, and put current on top |
||
| 2530 | asort($result); |
||
| 2531 | if($currentClass) { |
||
| 2532 | $currentPageTypeName = $result[$currentClass]; |
||
| 2533 | unset($result[$currentClass]); |
||
| 2534 | $result = array_reverse($result); |
||
| 2535 | $result[$currentClass] = $currentPageTypeName; |
||
| 2536 | $result = array_reverse($result); |
||
| 2537 | } |
||
| 2538 | |||
| 2539 | return $result; |
||
| 2540 | } |
||
| 2541 | |||
| 2542 | /** |
||
| 2543 | * Returns an array of the class names of classes that are allowed to be children of this class. |
||
| 2544 | * |
||
| 2545 | * @return string[] |
||
| 2546 | */ |
||
| 2547 | public function allowedChildren() { |
||
| 2567 | |||
| 2568 | /** |
||
| 2569 | * Returns the class name of the default class for children of this page. |
||
| 2570 | * |
||
| 2571 | * @return string |
||
| 2572 | */ |
||
| 2573 | public function defaultChild() { |
||
| 2574 | $default = $this->stat('default_child'); |
||
| 2575 | $allowed = $this->allowedChildren(); |
||
| 2576 | if($allowed) { |
||
| 2577 | if(!$default || !in_array($default, $allowed)) |
||
| 2578 | $default = reset($allowed); |
||
| 2579 | return $default; |
||
| 2580 | } |
||
| 2581 | } |
||
| 2582 | |||
| 2583 | /** |
||
| 2584 | * Returns the class name of the default class for the parent of this page. |
||
| 2585 | * |
||
| 2586 | * @return string |
||
| 2587 | */ |
||
| 2588 | public function defaultParent() { |
||
| 2591 | |||
| 2592 | /** |
||
| 2593 | * Get the title for use in menus for this page. If the MenuTitle field is set it returns that, else it returns the |
||
| 2594 | * Title field. |
||
| 2595 | * |
||
| 2596 | * @return string |
||
| 2597 | */ |
||
| 2598 | public function getMenuTitle(){ |
||
| 2599 | if($value = $this->getField("MenuTitle")) { |
||
| 2600 | return $value; |
||
| 2601 | } else { |
||
| 2602 | return $this->getField("Title"); |
||
| 2603 | } |
||
| 2604 | } |
||
| 2605 | |||
| 2606 | |||
| 2607 | /** |
||
| 2608 | * Set the menu title for this page. |
||
| 2609 | * |
||
| 2610 | * @param string $value |
||
| 2611 | */ |
||
| 2612 | public function setMenuTitle($value) { |
||
| 2619 | |||
| 2620 | /** |
||
| 2621 | * A flag provides the user with additional data about the current page status, for example a "removed from draft" |
||
| 2622 | * status. Each page can have more than one status flag. Returns a map of a unique key to a (localized) title for |
||
| 2623 | * the flag. The unique key can be reused as a CSS class. Use the 'updateStatusFlags' extension point to customize |
||
| 2624 | * the flags. |
||
| 2625 | * |
||
| 2626 | * Example (simple): |
||
| 2627 | * "deletedonlive" => "Deleted" |
||
| 2628 | * |
||
| 2629 | * Example (with optional title attribute): |
||
| 2630 | * "deletedonlive" => array('text' => "Deleted", 'title' => 'This page has been deleted') |
||
| 2631 | * |
||
| 2632 | * @param bool $cached Whether to serve the fields from cache; false regenerate them |
||
| 2633 | * @return array |
||
| 2634 | */ |
||
| 2635 | public function getStatusFlags($cached = true) { |
||
| 2636 | if(!$this->_cache_statusFlags || !$cached) { |
||
| 2637 | $flags = array(); |
||
| 2638 | if($this->getIsDeletedFromStage()) { |
||
| 2639 | if($this->getExistsOnLive()) { |
||
| 2640 | $flags['removedfromdraft'] = array( |
||
| 2641 | 'text' => _t('SiteTree.REMOVEDFROMDRAFTSHORT', 'Removed from draft'), |
||
| 2642 | 'title' => _t('SiteTree.REMOVEDFROMDRAFTHELP', 'Page is published, but has been deleted from draft'), |
||
| 2643 | ); |
||
| 2644 | } else { |
||
| 2645 | $flags['archived'] = array( |
||
| 2646 | 'text' => _t('SiteTree.ARCHIVEDPAGESHORT', 'Archived'), |
||
| 2647 | 'title' => _t('SiteTree.ARCHIVEDPAGEHELP', 'Page is removed from draft and live'), |
||
| 2648 | ); |
||
| 2649 | } |
||
| 2650 | } else if($this->getIsAddedToStage()) { |
||
| 2651 | $flags['addedtodraft'] = array( |
||
| 2652 | 'text' => _t('SiteTree.ADDEDTODRAFTSHORT', 'Draft'), |
||
| 2653 | 'title' => _t('SiteTree.ADDEDTODRAFTHELP', "Page has not been published yet") |
||
| 2654 | ); |
||
| 2655 | } else if($this->getIsModifiedOnStage()) { |
||
| 2656 | $flags['modified'] = array( |
||
| 2657 | 'text' => _t('SiteTree.MODIFIEDONDRAFTSHORT', 'Modified'), |
||
| 2658 | 'title' => _t('SiteTree.MODIFIEDONDRAFTHELP', 'Page has unpublished changes'), |
||
| 2659 | ); |
||
| 2660 | } |
||
| 2661 | |||
| 2662 | $this->extend('updateStatusFlags', $flags); |
||
| 2663 | |||
| 2664 | $this->_cache_statusFlags = $flags; |
||
| 2665 | } |
||
| 2666 | |||
| 2667 | return $this->_cache_statusFlags; |
||
| 2668 | } |
||
| 2669 | |||
| 2670 | /** |
||
| 2671 | * getTreeTitle will return three <span> html DOM elements, an empty <span> with the class 'jstree-pageicon' in |
||
| 2672 | * front, following by a <span> wrapping around its MenutTitle, then following by a <span> indicating its |
||
| 2673 | * publication status. |
||
| 2674 | * |
||
| 2675 | * @return string An HTML string ready to be directly used in a template |
||
| 2676 | */ |
||
| 2677 | public function getTreeTitle() { |
||
| 2706 | |||
| 2707 | /** |
||
| 2708 | * Returns the page in the current page stack of the given level. Level(1) will return the main menu item that |
||
| 2709 | * we're currently inside, etc. |
||
| 2710 | * |
||
| 2711 | * @param int $level |
||
| 2712 | * @return SiteTree |
||
| 2713 | */ |
||
| 2714 | public function Level($level) { |
||
| 2723 | |||
| 2724 | /** |
||
| 2725 | * Gets the depth of this page in the sitetree, where 1 is the root level |
||
| 2726 | * |
||
| 2727 | * @return int |
||
| 2728 | */ |
||
| 2729 | public function getPageLevel() { |
||
| 2730 | if($this->ParentID) { |
||
| 2731 | return 1 + $this->Parent()->getPageLevel(); |
||
| 2732 | } |
||
| 2733 | return 1; |
||
| 2734 | } |
||
| 2735 | |||
| 2736 | /** |
||
| 2737 | * Return the CSS classes to apply to this node in the CMS tree. |
||
| 2738 | * |
||
| 2739 | * @param string $numChildrenMethod |
||
| 2740 | * @return string |
||
| 2741 | */ |
||
| 2742 | public function CMSTreeClasses($numChildrenMethod="numChildren") { |
||
| 2773 | |||
| 2774 | /** |
||
| 2775 | * Compares current draft with live version, and returns true if no draft version of this page exists but the page |
||
| 2776 | * is still published (eg, after triggering "Delete from draft site" in the CMS). |
||
| 2777 | * |
||
| 2778 | * @return bool |
||
| 2779 | */ |
||
| 2780 | public function getIsDeletedFromStage() { |
||
| 2789 | |||
| 2790 | /** |
||
| 2791 | * Return true if this page exists on the live site |
||
| 2792 | * |
||
| 2793 | * @return bool |
||
| 2794 | */ |
||
| 2795 | public function getExistsOnLive() { |
||
| 2798 | |||
| 2799 | /** |
||
| 2800 | * Compares current draft with live version, and returns true if these versions differ, meaning there have been |
||
| 2801 | * unpublished changes to the draft site. |
||
| 2802 | * |
||
| 2803 | * @return bool |
||
| 2804 | */ |
||
| 2805 | public function getIsModifiedOnStage() { |
||
| 2817 | |||
| 2818 | /** |
||
| 2819 | * Compares current draft with live version, and returns true if no live version exists, meaning the page was never |
||
| 2820 | * published. |
||
| 2821 | * |
||
| 2822 | * @return bool |
||
| 2823 | */ |
||
| 2824 | public function getIsAddedToStage() { |
||
| 2833 | |||
| 2834 | /** |
||
| 2835 | * Stops extendCMSFields() being called on getCMSFields(). This is useful when you need access to fields added by |
||
| 2836 | * subclasses of SiteTree in a extension. Call before calling parent::getCMSFields(), and reenable afterwards. |
||
| 2837 | */ |
||
| 2838 | static public function disableCMSFieldsExtensions() { |
||
| 2841 | |||
| 2842 | /** |
||
| 2843 | * Reenables extendCMSFields() being called on getCMSFields() after it has been disabled by |
||
| 2844 | * disableCMSFieldsExtensions(). |
||
| 2845 | */ |
||
| 2846 | static public function enableCMSFieldsExtensions() { |
||
| 2849 | |||
| 2850 | public function providePermissions() { |
||
| 2851 | return array( |
||
| 2852 | 'SITETREE_GRANT_ACCESS' => array( |
||
| 2853 | 'name' => _t('SiteTree.PERMISSION_GRANTACCESS_DESCRIPTION', 'Manage access rights for content'), |
||
| 2854 | 'help' => _t('SiteTree.PERMISSION_GRANTACCESS_HELP', 'Allow setting of page-specific access restrictions in the "Pages" section.'), |
||
| 2855 | 'category' => _t('Permissions.PERMISSIONS_CATEGORY', 'Roles and access permissions'), |
||
| 2856 | 'sort' => 100 |
||
| 2857 | ), |
||
| 2858 | 'SITETREE_VIEW_ALL' => array( |
||
| 2859 | 'name' => _t('SiteTree.VIEW_ALL_DESCRIPTION', 'View any page'), |
||
| 2860 | 'category' => _t('Permissions.CONTENT_CATEGORY', 'Content permissions'), |
||
| 2861 | 'sort' => -100, |
||
| 2862 | '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') |
||
| 2863 | ), |
||
| 2864 | 'SITETREE_EDIT_ALL' => array( |
||
| 2865 | 'name' => _t('SiteTree.EDIT_ALL_DESCRIPTION', 'Edit any page'), |
||
| 2866 | 'category' => _t('Permissions.CONTENT_CATEGORY', 'Content permissions'), |
||
| 2867 | 'sort' => -50, |
||
| 2868 | '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') |
||
| 2869 | ), |
||
| 2870 | 'SITETREE_REORGANISE' => array( |
||
| 2871 | 'name' => _t('SiteTree.REORGANISE_DESCRIPTION', 'Change site structure'), |
||
| 2872 | 'category' => _t('Permissions.CONTENT_CATEGORY', 'Content permissions'), |
||
| 2873 | 'help' => _t('SiteTree.REORGANISE_HELP', 'Rearrange pages in the site tree through drag&drop.'), |
||
| 2874 | 'sort' => 100 |
||
| 2875 | ), |
||
| 2876 | 'VIEW_DRAFT_CONTENT' => array( |
||
| 2877 | 'name' => _t('SiteTree.VIEW_DRAFT_CONTENT', 'View draft content'), |
||
| 2878 | 'category' => _t('Permissions.CONTENT_CATEGORY', 'Content permissions'), |
||
| 2879 | '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.'), |
||
| 2880 | 'sort' => 100 |
||
| 2881 | ) |
||
| 2882 | ); |
||
| 2883 | } |
||
| 2884 | |||
| 2885 | /** |
||
| 2886 | * Return the translated Singular name. |
||
| 2887 | * |
||
| 2888 | * @return string |
||
| 2889 | */ |
||
| 2890 | public function i18n_singular_name() { |
||
| 2891 | // Convert 'Page' to 'SiteTree' for correct localization lookups |
||
| 2892 | $class = ($this->class == 'Page') ? 'SiteTree' : $this->class; |
||
| 2893 | return _t($class.'.SINGULARNAME', $this->singular_name()); |
||
| 2894 | } |
||
| 2895 | |||
| 2896 | /** |
||
| 2897 | * Overloaded to also provide entities for 'Page' class which is usually located in custom code, hence textcollector |
||
| 2898 | * picks it up for the wrong folder. |
||
| 2899 | * |
||
| 2900 | * @return array |
||
| 2901 | */ |
||
| 2902 | public function provideI18nEntities() { |
||
| 2918 | |||
| 2919 | /** |
||
| 2920 | * Returns 'root' if the current page has no parent, or 'subpage' otherwise |
||
| 2921 | * |
||
| 2922 | * @return string |
||
| 2923 | */ |
||
| 2924 | public function getParentType() { |
||
| 2927 | |||
| 2928 | /** |
||
| 2929 | * Clear the permissions cache for SiteTree |
||
| 2930 | */ |
||
| 2931 | public static function reset() { |
||
| 2934 | |||
| 2935 | static public function on_db_reset() { |
||
| 2938 | |||
| 2939 | } |
||
| 2940 |