mirror of
https://github.com/silverstripe/silverstripe-cms
synced 2024-10-22 08:05:56 +02:00
Added missing classes
git-svn-id: svn://svn.silverstripe.com/silverstripe/open/modules/cms/trunk@76876 467b73ca-7a2a-4603-9d3b-597d59a354a9
This commit is contained in:
Sean Harvey
parent
8362026b12
commit
46bf3ce2d2
178
code/CMSBatchAction.php
Normal file
178
code/CMSBatchAction.php
Normal file
@ -0,0 +1,178 @@
|
|||||||
|
<?php
|
||||||
|
|
||||||
|
/**
|
||||||
|
* A class representing back actions
|
||||||
|
*
|
||||||
|
* <code>
|
||||||
|
* CMSMain::register_batch_action('publishitems', new CMSBatchAction('doPublish',
|
||||||
|
_t('CMSBatchActions.PUBLISHED_PAGES', 'published %d pages')));
|
||||||
|
* </code>
|
||||||
|
*/
|
||||||
|
abstract class CMSBatchAction extends Object {
|
||||||
|
/**
|
||||||
|
* The the text to show in the dropdown for this action
|
||||||
|
*/
|
||||||
|
abstract function getActionTitle();
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Get text to be shown while the action is being processed, of the form
|
||||||
|
* "publishing pages".
|
||||||
|
*/
|
||||||
|
abstract function getDoingText();
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Run this action for the given set of pages.
|
||||||
|
* Return a set of status-updated JavaScript to return to the CMS.
|
||||||
|
*/
|
||||||
|
abstract function run(DataObjectSet $pages);
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Helper method for processing batch actions.
|
||||||
|
* Returns a set of status-updating JavaScript to return to the CMS.
|
||||||
|
*
|
||||||
|
* @param $pages The DataObjectSet of SiteTree objects to perform this batch action
|
||||||
|
* on.
|
||||||
|
* @param $helperMethod The method to call on each of those objects.
|
||||||
|
* @para
|
||||||
|
*/
|
||||||
|
public function batchaction(DataObjectSet $pages, $helperMethod, $successMessage) {
|
||||||
|
foreach($pages as $page) {
|
||||||
|
// Perform the action
|
||||||
|
$page->$helperMethod();
|
||||||
|
|
||||||
|
// Now make sure the tree title is appropriately updated
|
||||||
|
$publishedRecord = DataObject::get_by_id('SiteTree', $page->ID);
|
||||||
|
$JS_title = Convert::raw2js($publishedRecord->TreeTitle());
|
||||||
|
FormResponse::add("\$('sitetree').setNodeTitle($page->ID, '$JS_title');");
|
||||||
|
$page->destroy();
|
||||||
|
unset($page);
|
||||||
|
}
|
||||||
|
|
||||||
|
$message = sprintf($successMessage, $pages->Count());
|
||||||
|
FormResponse::add('statusMessage("'.$message.'","good");');
|
||||||
|
|
||||||
|
return FormResponse::respond();
|
||||||
|
}
|
||||||
|
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Publish items batch action.
|
||||||
|
*/
|
||||||
|
class CMSBatchAction_Publish extends CMSBatchAction {
|
||||||
|
function getActionTitle() {
|
||||||
|
return _t('CMSBatchActions.PUBLISH_PAGES', 'Publish');
|
||||||
|
}
|
||||||
|
function getDoingText() {
|
||||||
|
return _t('CMSBatchActions.PUBLISHING_PAGES', 'Publishing pages');
|
||||||
|
}
|
||||||
|
|
||||||
|
function run(DataObjectSet $pages) {
|
||||||
|
return $this->batchaction($pages, 'doPublish',
|
||||||
|
_t('CMSBatchActions.PUBLISHED_PAGES', 'Published %d pages')
|
||||||
|
);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Un-publish items batch action.
|
||||||
|
*/
|
||||||
|
class CMSBatchAction_Unpublish extends CMSBatchAction {
|
||||||
|
function getActionTitle() {
|
||||||
|
return _t('CMSBatchActions.UNPUBLISH_PAGES', 'Un-publish');
|
||||||
|
}
|
||||||
|
function getDoingText() {
|
||||||
|
return _t('CMSBatchActions.UNPUBLISHING_PAGES', 'Un-publishing pages');
|
||||||
|
}
|
||||||
|
|
||||||
|
function run(DataObjectSet $pages) {
|
||||||
|
return $this->batchaction($pages, 'doUnpublish',
|
||||||
|
_t('CMSBatchActions.UNPUBLISHED_PAGES', 'Un-published %d pages')
|
||||||
|
);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Delete items batch action.
|
||||||
|
*/
|
||||||
|
class CMSBatchAction_Delete extends CMSBatchAction {
|
||||||
|
function getActionTitle() {
|
||||||
|
return _t('CMSBatchActions.DELETE_PAGES', 'Delete from draft');
|
||||||
|
}
|
||||||
|
function getDoingText() {
|
||||||
|
return _t('CMSBatchActions.DELETING_PAGES', 'Deleting selected pages from draft');
|
||||||
|
}
|
||||||
|
|
||||||
|
function run(DataObjectSet $pages) {
|
||||||
|
foreach($pages as $page) {
|
||||||
|
$id = $page->ID;
|
||||||
|
|
||||||
|
// Perform the action
|
||||||
|
if($page->canDelete()) $page->delete();
|
||||||
|
|
||||||
|
// check to see if the record exists on the live site, if it doesn't remove the tree node
|
||||||
|
$liveRecord = Versioned::get_one_by_stage( 'SiteTree', 'Live', "`SiteTree`.`ID`=$id");
|
||||||
|
if($liveRecord) {
|
||||||
|
$liveRecord->IsDeletedFromStage = true;
|
||||||
|
$title = Convert::raw2js($liveRecord->TreeTitle());
|
||||||
|
FormResponse::add("$('sitetree').setNodeTitle($id, '$title');");
|
||||||
|
FormResponse::add("$('Form_EditForm').reloadIfSetTo($id);");
|
||||||
|
} else {
|
||||||
|
FormResponse::add("var node = $('sitetree').getTreeNodeByIdx('$id');");
|
||||||
|
FormResponse::add("if(node && node.parentTreeNode) node.parentTreeNode.removeTreeNode(node);");
|
||||||
|
FormResponse::add("$('Form_EditForm').reloadIfSetTo($id);");
|
||||||
|
}
|
||||||
|
|
||||||
|
$page->destroy();
|
||||||
|
unset($page);
|
||||||
|
}
|
||||||
|
|
||||||
|
$message = sprintf(_t('CMSBatchActions.DELETED_PAGES', 'Deleted %d pages from the draft site'), $pages->Count());
|
||||||
|
FormResponse::add('statusMessage("'.$message.'","good");');
|
||||||
|
|
||||||
|
return FormResponse::respond();
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Delete items batch action.
|
||||||
|
*/
|
||||||
|
class CMSBatchAction_DeleteFromLive extends CMSBatchAction {
|
||||||
|
function getActionTitle() {
|
||||||
|
return _t('CMSBatchActions.DELETE_PAGES', 'Delete from published site');
|
||||||
|
}
|
||||||
|
function getDoingText() {
|
||||||
|
return _t('CMSBatchActions.DELETING_PAGES', 'Deleting selected pages from the published site');
|
||||||
|
}
|
||||||
|
|
||||||
|
function run(DataObjectSet $pages) {
|
||||||
|
foreach($pages as $page) {
|
||||||
|
$id = $page->ID;
|
||||||
|
|
||||||
|
// Perform the action
|
||||||
|
if($page->canDelete()) $page->doDeleteFromLive();
|
||||||
|
|
||||||
|
// check to see if the record exists on the live site, if it doesn't remove the tree node
|
||||||
|
$stageRecord = Versioned::get_one_by_stage( 'SiteTree', 'Stage', "`SiteTree`.`ID`=$id");
|
||||||
|
if($stageRecord) {
|
||||||
|
$stageRecord->IsAddedToStage = true;
|
||||||
|
$title = Convert::raw2js($stageRecord->TreeTitle());
|
||||||
|
FormResponse::add("$('sitetree').setNodeTitle($id, '$title');");
|
||||||
|
FormResponse::add("$('Form_EditForm').reloadIfSetTo($id);");
|
||||||
|
} else {
|
||||||
|
FormResponse::add("var node = $('sitetree').getTreeNodeByIdx('$id');");
|
||||||
|
FormResponse::add("if(node && node.parentTreeNode) node.parentTreeNode.removeTreeNode(node);");
|
||||||
|
FormResponse::add("$('Form_EditForm').reloadIfSetTo($id);");
|
||||||
|
}
|
||||||
|
|
||||||
|
$page->destroy();
|
||||||
|
unset($page);
|
||||||
|
}
|
||||||
|
|
||||||
|
$message = sprintf(_t('CMSBatchActions.DELETED_PAGES', 'Deleted %d pages from the published site'), $pages->Count());
|
||||||
|
FormResponse::add('statusMessage("'.$message.'","good");');
|
||||||
|
|
||||||
|
return FormResponse::respond();
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
109
code/CMSBatchActionHandler.php
Normal file
109
code/CMSBatchActionHandler.php
Normal file
@ -0,0 +1,109 @@
|
|||||||
|
<?php
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Special request handler for admin/batchaction
|
||||||
|
*/
|
||||||
|
class CMSBatchActionHandler extends RequestHandler {
|
||||||
|
static $batch_actions = array(
|
||||||
|
'publish' => 'CMSBatchAction_Publish',
|
||||||
|
'unpublish' => 'CMSBatchAction_Unpublish',
|
||||||
|
'delete' => 'CMSBatchAction_Delete',
|
||||||
|
'deletefromlive' => 'CMSBatchAction_DeleteFromLive',
|
||||||
|
);
|
||||||
|
|
||||||
|
static $url_handlers = array(
|
||||||
|
'$BatchAction' => 'handleAction'
|
||||||
|
);
|
||||||
|
|
||||||
|
protected $parentController;
|
||||||
|
protected $urlSegment;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Register a new batch action. Each batch action needs to be represented by a subclass
|
||||||
|
* of
|
||||||
|
*
|
||||||
|
* @param $urlSegment The URL Segment of the batch action - the URL used to process this
|
||||||
|
* action will be admin/batchactions/(urlSegment)
|
||||||
|
* @param $batchActionClass The name of the CMSBatchAction subclass to register
|
||||||
|
*/
|
||||||
|
static function register($urlSegment, $batchActionClass) {
|
||||||
|
if(is_subclass_of($batchActionClass, 'CMSBatchAction')) {
|
||||||
|
self::$batch_actions[$urlSegment] = $batchActionClass;
|
||||||
|
} else {
|
||||||
|
user_error("CMSBatchActionHandler::regiser() - Bad class '$batchActionClass'", E_USER_ERROR);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
function __construct($parentController, $urlSegment) {
|
||||||
|
$this->parentController = $parentController;
|
||||||
|
$this->urlSegment = $urlSegment;
|
||||||
|
parent::__construct();
|
||||||
|
}
|
||||||
|
|
||||||
|
function Link() {
|
||||||
|
return Controller::join_links($this->parentController->Link(), $this->urlSegment);
|
||||||
|
}
|
||||||
|
|
||||||
|
function handleAction($request) {
|
||||||
|
// This method can't be called without ajax.
|
||||||
|
if(!Director::is_ajax()) {
|
||||||
|
Director::redirectBack();
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
|
||||||
|
$actions = Object::get_static($this->class, 'batch_actions');
|
||||||
|
$actionClass = $actions[$request->param('BatchAction')];
|
||||||
|
$actionHandler = new $actionClass();
|
||||||
|
|
||||||
|
// Sanitise ID list and query the database for apges
|
||||||
|
$ids = split(' *, *', trim($request->requestVar('csvIDs')));
|
||||||
|
foreach($ids as $k => $v) if(!is_numeric($v)) unset($ids[$k]);
|
||||||
|
|
||||||
|
if($ids) {
|
||||||
|
$pages = DataObject::get('SiteTree', "\"SiteTree\".\"ID\" IN (" . implode(", ", $ids) . ")");
|
||||||
|
|
||||||
|
// If we didn't query all the pages, then find the rest on the live site
|
||||||
|
if(!$pages || $pages->Count() < sizeof($ids)) {
|
||||||
|
foreach($ids as $id) $idsFromLive[$id] = true;
|
||||||
|
if($pages) foreach($pages as $page) unset($idsFromLive[$page->ID]);
|
||||||
|
$idsFromLive = array_keys($idsFromLive);
|
||||||
|
|
||||||
|
Debug::message("`SiteTree`.ID IN (" . implode(", ", $idsFromLive) . ")");
|
||||||
|
$livePages = Versioned::get_by_stage('SiteTree', 'Live', "`SiteTree`.ID IN (" . implode(", ", $idsFromLive) . ")");
|
||||||
|
if($pages) $pages->merge($livePages);
|
||||||
|
else $pages = $livePages;
|
||||||
|
}
|
||||||
|
} else {
|
||||||
|
$pages = new DataObjectSet();
|
||||||
|
}
|
||||||
|
|
||||||
|
return $actionHandler->run($pages);
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Return a DataObjectSet of ArrayData objects containing the following pieces of info
|
||||||
|
* about each batch action:
|
||||||
|
* - Link
|
||||||
|
* - Title
|
||||||
|
* - DoingText
|
||||||
|
*/
|
||||||
|
function batchActionList() {
|
||||||
|
$actions = Object::get_static($this->class, 'batch_actions');
|
||||||
|
$actionList = new DataObjectSet();
|
||||||
|
|
||||||
|
foreach($actions as $urlSegment => $actionClass) {
|
||||||
|
$actionObj = new $actionClass();
|
||||||
|
$actionDef = new ArrayData(array(
|
||||||
|
"Link" => Controller::join_links($this->Link(), $urlSegment),
|
||||||
|
"Title" => $actionObj->getActionTitle(),
|
||||||
|
"DoingText" => $actionObj->getDoingText(),
|
||||||
|
));
|
||||||
|
$actionList->push($actionDef);
|
||||||
|
}
|
||||||
|
|
||||||
|
return $actionList;
|
||||||
|
}
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
}
|
||||||
Loading…
Reference in New Issue
Block a user