silverstripe-cms/code/Controllers/SilverStripeNavigator.php

119 lines
3.6 KiB
PHP
Raw Normal View History

<?php
2016-07-22 01:32:32 +02:00
namespace SilverStripe\CMS\Controllers;
2017-03-10 04:33:32 +01:00
use SilverStripe\ORM\CMSPreviewable;
use SilverStripe\Core\ClassInfo;
use SilverStripe\Dev\Deprecation;
use SilverStripe\ORM\ArrayList;
use SilverStripe\ORM\DataObject;
use SilverStripe\ORM\SS_List;
use SilverStripe\View\ViewableData;
/**
* Utility class representing links to different views of a record
* for CMS authors, usually for {@link SiteTree} objects with "stage" and "live" links.
* Useful both in the CMS and alongside the page template (for logged in authors).
* The class can be used for any {@link DataObject} subclass implementing the {@link CMSPreviewable} interface.
2016-03-08 21:50:55 +01:00
*
* New item types can be defined by extending the {@link SilverStripeNavigatorItem} class,
* for example the "cmsworkflow" module defines a new "future state" item with a date selector
* to view embargoed data at a future point in time. So the item doesn't always have to be a simple link.
*
* Class will be moved from `silverstripe/cms` to `silverstripe/admin`
* @deprecated 4.13.0 Will be renamed SilverStripe\Admin\Navigator\SilverStripeNavigator
*/
2017-01-25 21:59:25 +01:00
class SilverStripeNavigator extends ViewableData
{
2016-03-08 21:50:55 +01:00
2017-01-25 21:59:25 +01:00
/**
2017-03-10 04:33:32 +01:00
* @var DataObject|\SilverStripe\ORM\CMSPreviewable
2017-01-25 21:59:25 +01:00
*/
protected $record;
2016-03-08 21:50:55 +01:00
2017-01-25 21:59:25 +01:00
/**
2017-03-10 04:33:32 +01:00
* @param DataObject|\SilverStripe\ORM\CMSPreviewable $record
2017-01-25 21:59:25 +01:00
*/
public function __construct(CMSPreviewable $record)
{
Deprecation::withNoReplacement(function () {
Deprecation::notice(
'4.13.0',
'Will be renamed SilverStripe\Admin\Navigator\SilverStripeNavigator',
Deprecation::SCOPE_CLASS
);
});
2017-01-25 21:59:25 +01:00
parent::__construct();
$this->record = $record;
}
2017-01-25 21:59:25 +01:00
/**
* @return SS_List of SilverStripeNavigatorItem
*/
public function getItems()
{
$items = [];
2016-03-08 21:50:55 +01:00
$classes = ClassInfo::subclassesFor(SilverStripeNavigatorItem::class);
array_shift($classes);
2016-03-08 21:50:55 +01:00
2017-01-25 21:59:25 +01:00
// Sort menu items according to priority
foreach ($classes as $class) {
/** @var SilverStripeNavigatorItem $item */
$item = new $class($this->record);
if (!$item->canView()) {
continue;
}
2016-03-08 21:50:55 +01:00
2017-01-25 21:59:25 +01:00
// This funny litle formula ensures that the first item added with the same priority will be left-most.
$priority = $item->getPriority() * 100 - 1;
2016-03-08 21:50:55 +01:00
2017-01-25 21:59:25 +01:00
// Ensure that we can have duplicates with the same (default) priority
while (isset($items[$priority])) {
$priority++;
}
2016-03-08 21:50:55 +01:00
2017-01-25 21:59:25 +01:00
$items[$priority] = $item;
}
ksort($items);
2022-11-16 03:39:13 +01:00
// Drop the keys and let the ArrayList handle the numbering, so $IsFirst, $IsLast and others work properly.
2022-04-13 07:07:59 +02:00
return new ArrayList(array_values($items ?? []));
2017-01-25 21:59:25 +01:00
}
2016-03-08 21:50:55 +01:00
2017-01-25 21:59:25 +01:00
/**
2017-03-10 04:33:32 +01:00
* @return DataObject|\SilverStripe\ORM\CMSPreviewable
2017-01-25 21:59:25 +01:00
*/
public function getRecord()
{
return $this->record;
}
2017-01-25 21:59:25 +01:00
/**
* @param DataObject|CMSPreviewable $record
* @return array template data
*/
public static function get_for_record($record)
{
$html = '';
$message = '';
$navigator = new SilverStripeNavigator($record);
$items = $navigator->getItems();
foreach ($items as $item) {
$text = $item->getHTML();
if ($text) {
$html .= $text;
}
$newMessage = $item->getMessage();
if ($newMessage && $item->isActive()) {
$message = $newMessage;
}
}
2016-03-08 21:50:55 +01:00
return [
2017-01-25 21:59:25 +01:00
'items' => $html,
'message' => $message
];
2017-01-25 21:59:25 +01:00
}
}