/**
* Deactivate a Workflow State, moving existing nodes to a given State.
*
* @param int $new_sid
* The state ID, to which all affected entities must be moved.
*
* D7.x-2.x: deprecated workflow_delete_workflow_states_by_sid() --> WorkflowState->deactivate() + delete()
*/
public function deactivate($new_sid)
{
global $user;
// We can use global, since deactivate() is a UI-only function.
$current_sid = $this->sid;
$force = TRUE;
// Notify interested modules. We notify first to allow access to data before we zap it.
// E.g., Node API (@todo Field API):
// - re-parents any nodes that we don't want to orphan, whilst deactivating a State.
// - delete any lingering node to state values.
module_invoke_all('workflow', 'state delete', $current_sid, $new_sid, NULL, $force);
// Re-parent any nodes that we don't want to orphan, whilst deactivating a State.
// This is called in WorkflowState::deactivate().
// @todo: re-parent Workflow Field, whilst deactivating a state.
if ($new_sid) {
// A candidate for the batch API.
// @TODO: Future updates should seriously consider setting this with batch.
$comment = t('Previous state deleted');
foreach (workflow_get_workflow_node_by_sid($current_sid) as $workflow_node) {
// @todo: add Field support in 'state delete', by using workflow_node_history or reading current field.
$entity_type = 'node';
$entity = entity_load_single('node', $workflow_node->nid);
$field_name = '';
$transition = new WorkflowTransition();
$transition->setValues($entity_type, $entity, $field_name, $current_sid, $new_sid, $user->uid, REQUEST_TIME, $comment);
$transition->force($force);
// Execute Transition, invoke 'pre' and 'post' events, save new state in workflow_node, save also in workflow_node_history.
// For Workflow Node, only {workflow_node} and {workflow_node_history} are updated. For Field, also the Entity itself.
$new_sid = workflow_execute_transition($entity_type, $entity, $field_name, $transition, $force);
}
}
// Delete any lingering node to state values.
workflow_delete_workflow_node_by_sid($current_sid);
// Delete the transitions this state is involved in.
$workflow = workflow_load_single($this->wid);
/* @var $transition WorkflowTransition */
foreach ($workflow->getTransitionsBySid($current_sid, 'ALL') as $transition) {
$transition->delete();
}
foreach ($workflow->getTransitionsByTargetSid($current_sid, 'ALL') as $transition) {
$transition->delete();
}
// Delete the state. -- We don't actually delete, just deactivate.
// This is a matter up for some debate, to delete or not to delete, since this
// causes name conflicts for states. In the meantime, we just stick with what we know.
// If you really want to delete the states, use workflow_cleanup module, or delete().
$this->status = FALSE;
$this->save();
// Clear the cache.
self::getStates(0, TRUE);
}
