Skip to content

Commit

Permalink
API Update API to reflect changes in silverstripe/framework
Browse files Browse the repository at this point in the history
  • Loading branch information
@GuySartorelli
GuySartorelli committed Nov 11, 2024
1 parent a7e5891 commit 5b11b53
Show file tree
Hide file tree
Showing 3 changed files with 131 additions and 75 deletions.
38 changes: 38 additions & 0 deletions src/Versioned.php
View file
Original file line number Diff line number Diff line change
Expand Up @@ -2981,4 +2981,42 @@ public function Publisher()
$member = DataObject::get_by_id(Member::class, $this->owner->PublisherID);
return $member;
}

protected function updateStatusFlags(array &$flags): void
{
if ($this->isOnLiveOnly()) {
$flags['removedfromdraft'] = [
'text' => _t(__CLASS__ . '.FLAG_ONLIVEONLY_SHORT', 'On live only'),
'title' => _t(
__CLASS__ . '.FLAG_ONLIVEONLYSHORT_HELP',
'Item is published, but has been deleted from draft'
),
];
return;
}

if ($this->isArchived()) {
$flags['archived'] = [
'text' => _t(__CLASS__ . '.FLAG_ARCHIVED_SHORT', 'Archived'),
'title' => _t(__CLASS__ . '.FLAG_ARCHIVED_HELP', 'Item is removed from draft and live'),
];
return;
}

if ($this->isOnDraftOnly()) {
$flags['addedtodraft'] = [
'text' => _t(__CLASS__ . '.FLAG_ADDEDTODRAFT_SHORT', 'Draft'),
'title' => _t(__CLASS__ . '.FLAG_ADDEDTODRAFT_HELP', 'Item has not been published yet')
];
return;
}

if ($this->isModifiedOnDraft()) {
$flags['modified'] = [
'text' => _t(__CLASS__ . '.FLAG_MODIFIEDONDRAFT_SHORT', 'Modified'),
'title' => _t(__CLASS__ . '.FLAG_MODIFIEDONDRAFT_HELP', 'Item has unpublished changes'),
];
return;
}
}
}
76 changes: 1 addition & 75 deletions src/VersionedGridFieldState/VersionedGridFieldState.php
View file
Original file line number Diff line number Diff line change
Expand Up @@ -124,7 +124,7 @@ public function getColumnsHandled($gridField)
public function getColumnContent($gridField, $record, $columnName)
{
$flagContent = '';
$flags = $this->getStatusFlags($record);
$flags = $record->getStatusFlags();
foreach ($flags as $class => $data) {
$flagAttributes = [
'class' => "ss-gridfield-badge badge status-{$class}",
Expand Down Expand Up @@ -162,78 +162,4 @@ public function getColumnMetadata($gridField, $columnName)
{
return [];
}


/**
* A flag provides the user with additional data about the current item
* status, for example a "removed from draft" status. Each item can have
* more than one status flag. Returns a map of a unique key to a
* (localized) title for the flag. The unique key can be reused as a CSS
* class.
*
* Example (simple):
*
* ```php
* "deletedonlive" => "Deleted"
* ```
*
* Example (with optional title attribute):
*
* ```php
* "deletedonlive" => array(
* 'text' => "Deleted",
* 'title' => 'This page has been deleted'
* )
* ```
*
* @param Versioned|DataObject $record - the record to check status for
* @return array
*/
protected function getStatusFlags($record)
{
if (!$record->hasExtension(Versioned::class)) {
return [];
}

if ($record->isOnLiveOnly()) {
return [
'removedfromdraft' => [
'text' => _t(__CLASS__ . '.ONLIVEONLYSHORT', 'On live only'),
'title' => _t(
__CLASS__ . '.ONLIVEONLYSHORTHELP',
'Item is published, but has been deleted from draft'
),
]
];
}

if ($record->isArchived()) {
return [
'archived' => [
'text' => _t(__CLASS__ . '.ARCHIVEDPAGESHORT', 'Archived'),
'title' => _t(__CLASS__ . '.ARCHIVEDPAGEHELP', 'Item is removed from draft and live'),
]
];
}

if ($record->isOnDraftOnly()) {
return [
'addedtodraft' => [
'text' => _t(__CLASS__ . '.ADDEDTODRAFTSHORT', 'Draft'),
'title' => _t(__CLASS__ . '.ADDEDTODRAFTHELP', "Item has not been published yet")
]
];
}

if ($record->isModifiedOnDraft()) {
return [
'modified' => [
'text' => _t(__CLASS__ . '.MODIFIEDONDRAFTSHORT', 'Modified'),
'title' => _t(__CLASS__ . '.MODIFIEDONDRAFTHELP', 'Item has unpublished changes'),
]
];
}

return [];
}
}
92 changes: 92 additions & 0 deletions tests/php/VersionedTest.php
View file
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,8 @@
use InvalidArgumentException;
use ReflectionMethod;
use DMS\PHPUnitExtensions\ArraySubset\ArraySubsetAsserts;
use LogicException;
use PHPUnit\Framework\Attributes\DataProvider;
use SilverStripe\Control\Controller;
use SilverStripe\Control\Director;
use SilverStripe\Control\HTTPRequest;
Expand Down Expand Up @@ -1700,4 +1702,94 @@ public function testLiveObjectDeletedOnUnpublish()
$obj->doUnpublish();
$this->assertEquals('First name', VersionedTest\TestObject::$nameValueOfObjectJustDeleted);
}

public static function provideUpdateStatusFlags(): array
{
return [
'new record no status' => [
'status' => 'new',
'expected' => [],
],
'saved to draft' => [
'status' => 'draft',
'expected' => [
'addedtodraft' => [
'text' => 'Draft',
'title' => 'Item has not been published yet',
],
],
],
'saved and published' => [
'status' => 'published',
'expected' => [],
],
'published but deleted on draft' => [
'status' => 'published only',
'expected' => [
'removedfromdraft' => [
'text' => 'On live only',
'title' => 'Item is published, but has been deleted from draft',
],
],
],
'published but modified on draft' => [
'status' => 'modified',
'expected' => [
'modified' => [
'text' => 'Modified',
'title' => 'Item has unpublished changes',
],
],
],
'archived' => [
'status' => 'archived',
'expected' => [
'archived' => [
'text' => 'Archived',
'title' => 'Item is removed from draft and live',
],
],
],
];
}

#[DataProvider('provideUpdateStatusFlags')]
public function testUpdateStatusFlags(string $status, array $expected): void
{
/** @var VersionedTest\TestObject&Versioned */
$record = new VersionedTest\TestObject();

switch ($status) {
case 'new':
// no-op
break;
case 'draft':
$record->write();
break;
case 'published':
$record->write();
$record->publishSingle();
break;
case 'published only':
$record->write();
$record->publishSingle();
$record->deleteFromStage(Versioned::DRAFT);
break;
case 'modified':
$record->write();
$record->publishSingle();
$record->Name = 'modified record';
$record->write();
break;
case 'archived':
$record->write();
$record->publishSingle();
$record->doArchive();
break;
default:
throw new LogicException("Status $status not accounted for");
}

$this->assertSame($expected, $record->getStatusFlags());
}
}

0 comments on commit 5b11b53

Please sign in to comment.