silverstripe-contentreview/src/Extensions/ContentReviewDefaultSettings.php

243 lines
6.9 KiB
PHP
Raw Normal View History

<?php
namespace SilverStripe\ContentReview\Extensions;
use SilverStripe\Core\Config\Config;
use SilverStripe\Control\Email\Email;
use SilverStripe\Forms\DropdownField;
use SilverStripe\Forms\FieldList;
use SilverStripe\Forms\ListboxField;
use SilverStripe\Forms\LiteralField;
use SilverStripe\Forms\TextareaField;
use SilverStripe\Forms\TextField;
use SilverStripe\ORM\DataExtension;
use SilverStripe\Security\Group;
use SilverStripe\Security\Member;
use SilverStripe\Security\Permission;
/**
2015-11-02 00:27:42 +01:00
* This extensions add a default schema for new pages and pages without a content
* review setting.
*
* @property int $ReviewPeriodDays
*/
2015-11-02 00:27:42 +01:00
class ContentReviewDefaultSettings extends DataExtension
{
/**
* @config
*
2015-11-02 00:27:42 +01:00
* @var array
*/
private static $db = array(
'ReviewPeriodDays' => 'Int',
'ReviewFrom' => 'Varchar(255)',
'ReviewSubject' => 'Varchar(255)',
'ReviewBody' => 'HTMLText',
);
/**
* @config
*
* @var array
*/
private static $defaults = array(
'ReviewSubject' => 'Page(s) are due for content review',
'ReviewBody' => '<h2>Page(s) due for review</h2>'
. '<p>There are $PagesCount pages that are due for review today by you.</p>',
2015-11-02 00:27:42 +01:00
);
/**
* @config
2015-11-02 00:27:42 +01:00
*
* @var array
*/
private static $many_many = [
'ContentReviewGroups' => Group::class,
'ContentReviewUsers' => Member::class,
];
2015-11-02 00:27:42 +01:00
/**
* Template to use for content review emails.
2015-11-02 00:27:42 +01:00
*
* This should contain an $EmailBody variable as a placeholder for the user-defined copy
*
* @config
*
* @var string
*/
private static $content_review_template = 'SilverStripe\\ContentReview\\ContentReviewEmail';
/**
2015-11-02 00:27:42 +01:00
* @return string
*/
public function getOwnerNames()
{
$names = [];
2015-11-02 00:27:42 +01:00
foreach ($this->OwnerGroups() as $group) {
$names[] = $group->getBreadcrumbs(' > ');
2015-11-02 00:27:42 +01:00
}
foreach ($this->OwnerUsers() as $group) {
$names[] = $group->getName();
}
return implode(', ', $names);
2015-11-02 00:27:42 +01:00
}
/**
* @return ManyManyList
*/
public function OwnerGroups()
{
return $this->owner->getManyManyComponents('ContentReviewGroups');
2015-11-02 00:27:42 +01:00
}
/**
* @return ManyManyList
*/
public function OwnerUsers()
{
return $this->owner->getManyManyComponents('ContentReviewUsers');
2015-11-02 00:27:42 +01:00
}
/**
* @param FieldList $fields
*/
public function updateCMSFields(FieldList $fields)
{
$helpText = LiteralField::create(
'ContentReviewHelp',
_t(
__CLASS__ . '.DEFAULTSETTINGSHELP',
'These settings will apply to all pages that do not have a specific Content Review schedule.'
)
);
$fields->addFieldToTab('Root.ContentReview', $helpText);
$reviewFrequency = DropdownField::create(
'ReviewPeriodDays',
_t(__CLASS__ . '.REVIEWFREQUENCY', 'Review frequency'),
SiteTreeContentReview::get_schedule()
)
->setDescription(_t(
__CLASS__ . '.REVIEWFREQUENCYDESCRIPTION',
'The review date will be set to this far in the future, whenever the page is published.'
));
$fields->addFieldToTab('Root.ContentReview', $reviewFrequency);
2015-11-02 00:27:42 +01:00
$users = Permission::get_members_by_permission([
'CMS_ACCESS_CMSMain',
'ADMIN',
]);
2015-11-02 00:27:42 +01:00
$usersMap = $users->map('ID', 'Title')->toArray();
2015-11-02 00:27:42 +01:00
asort($usersMap);
$userField = ListboxField::create('OwnerUsers', _t(__CLASS__ . '.PAGEOWNERUSERS', 'Users'), $usersMap)
->setAttribute('data-placeholder', _t(__CLASS__ . '.ADDUSERS', 'Add users'))
->setDescription(_t(__CLASS__ . '.OWNERUSERSDESCRIPTION', 'Page owners that are responsible for reviews'));
2015-11-02 00:27:42 +01:00
$fields->addFieldToTab('Root.ContentReview', $userField);
2015-11-02 00:27:42 +01:00
$groupsMap = [];
2015-11-02 00:27:42 +01:00
foreach (Group::get() as $group) {
// Listboxfield values are escaped, use ASCII char instead of &raquo;
$groupsMap[$group->ID] = $group->getBreadcrumbs(' > ');
2015-11-02 00:27:42 +01:00
}
asort($groupsMap);
$groupField = ListboxField::create('OwnerGroups', _t(__CLASS__ . '.PAGEOWNERGROUPS', 'Groups'), $groupsMap)
->setAttribute('data-placeholder', _t(__CLASS__ . '.ADDGROUP', 'Add groups'))
->setDescription(_t(__CLASS__ . '.OWNERGROUPSDESCRIPTION', 'Page owners that are responsible for reviews'));
$fields->addFieldToTab('Root.ContentReview', $groupField);
// Email content
$fields->addFieldsToTab(
'Root.ContentReview',
[
TextField::create('ReviewFrom', _t(__CLASS__ . '.EMAILFROM', 'From email address'))
->setDescription(_t(__CLASS__ . '.EMAILFROM_RIGHTTITLE', 'e.g: do-not-reply@site.com')),
TextField::create('ReviewSubject', _t(__CLASS__ . '.EMAILSUBJECT', 'Subject line')),
TextAreaField::create('ReviewBody', _t(__CLASS__ . '.EMAILTEMPLATE', 'Email template')),
LiteralField::create(
'TemplateHelp',
$this->owner->renderWith('SilverStripe\\ContentReview\\ContentReviewAdminHelp')
),
]
);
2015-11-02 00:27:42 +01:00
}
/**
* Get all Members that are default Content Owners. This includes checking group hierarchy
* and adding any direct users.
*
* @return ArrayList
*/
public function ContentReviewOwners()
{
2015-11-02 00:27:42 +01:00
return SiteTreeContentReview::merge_owners($this->OwnerGroups(), $this->OwnerUsers());
}
/**
* Get the review body, falling back to the default if left blank.
*
* @return string HTML text
*/
public function getReviewBody()
{
return $this->getWithDefault('ReviewBody');
}
/**
* Get the review subject line, falling back to the default if left blank.
*
* @return string plain text value
*/
public function getReviewSubject()
{
return $this->getWithDefault('ReviewSubject');
}
/**
* Get the "from" field for review emails.
*
* @return string
*/
public function getReviewFrom()
{
$from = $this->owner->getField('ReviewFrom');
if ($from) {
return $from;
}
// Fall back to admin email
return Config::inst()->get(Email::class, 'admin_email');
}
/**
* Get the value of a user-configured field, falling back to the default if left blank.
*
* @param string $field
*
* @return string
*/
protected function getWithDefault($field)
{
$value = $this->owner->getField($field);
if ($value) {
return $value;
}
// fallback to default value
$defaults = $this->owner->config()->get('defaults');
if (isset($defaults[$field])) {
return $defaults[$field];
}
}
}