- md5
- 82e05bcc2a1272a8ba39006c58fa9bed
- sha1
- 3815fe956e80ee6f61650bc0ce75f7fd82773006
- sha256
- 38aa14f67771fcfc7eebe3fe036553b5737ebfaaf7c03b31423a00184ddd99a1
123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389
<?php
/**
* Joomla! Content Management System
*
* @copyright Copyright (C) 2005 - 2019 Open Source Matters, Inc. All rights reserved.
* @license GNU General Public License version 2 or later; see LICENSE.txt
*/
namespace Joomla\CMS\Workflow;
defined('JPATH_PLATFORM') or die;
use Joomla\CMS\Factory;
use Joomla\Utilities\ArrayHelper;
/**
* Workflow Class.
*
* @since 4.0.0
*/
class Workflow
{
/**
* The booted component
*
* @var \Joomla\CMS\Extension\ComponentInterface
*/
protected $component = null;
/**
* Name of the extension the workflow belong to
*
* @var string
* @since 4.0.0
*/
protected $extension = null;
/**
* Workflow options
*
* @var array
*/
protected $options = [];
/**
* @var \Joomla\Database\DatabaseDriver
*/
protected $db;
/**
* Condition to names mapping
*
* @since 4.0.0
*/
const CONDITION_NAMES = [
self::CONDITION_PUBLISHED => 'JPUBLISHED',
self::CONDITION_UNPUBLISHED => 'JUNPUBLISHED',
self::CONDITION_TRASHED => 'JTRASHED',
self::CONDITION_ARCHIVED => 'JARCHIVED',
];
/**
* Every item with a state which has the condition PUBLISHED is visible/active on the page
*/
const CONDITION_PUBLISHED = 1;
/**
* Every item with a state which has the condition UNPUBLISHED is not visible/inactive on the page
*/
const CONDITION_UNPUBLISHED = 0;
/**
* Every item with a state which has the condition TRASHED is trashed
*/
const CONDITION_TRASHED = -2;
/**
* Every item with a state which has the condition ARCHIVED is archived
*/
const CONDITION_ARCHIVED = 2;
/**
* Class constructor
*
* @param array $options Array of options
*
* @since 4.0.0
*/
public function __construct($options)
{
// Required options
$this->extension = $options['extension'];
// Default some optional options
$this->options['access'] = 'true';
$this->options['published'] = 1;
$this->options['countItems'] = 0;
$this->setOptions($options);
}
/**
* Returns the translated condition name, based on the given number
*
* @param int $value The condition ID
*
* @return string
*
* @since 4.0.0
*/
public function getConditionName($value)
{
$component = $this->getComponent();
if ($component instanceof WorkflowServiceInterface)
{
$conditions = $component->getConditions($this->extension);
}
else
{
$conditions = self::CONDITION_NAMES;
}
return ArrayHelper::getValue($conditions, $value, '', 'string');
}
/**
* Returns the booted component
*
* @return \Joomla\CMS\Extension\ComponentInterface
*
* @since 4.0.0
*/
protected function getComponent()
{
if (is_null($this->component))
{
$parts = explode('.', $this->extension);
$this->component = Factory::getApplication()->bootComponent($parts[0]);
}
return $this->component;
}
/**
* Executes a transition to change the current state in the association table
*
* @param array|int $pks The item IDs, which should use the transition
* @param int $transition_id The transition which should be executed
*
* @return boolean
*/
public function executeTransition($pks, $transition_id)
{
if (!is_array($pks))
{
$pks = [(int) $pks];
}
$pks = ArrayHelper::toInteger($pks);
$pks = array_filter($pks);
if (!count($pks))
{
return true;
}
$db = Factory::getDbo();
$query = $db->getQuery(true);
$select = $db->quoteName(
[
't.id',
't.to_stage_id',
't.from_stage_id',
's.condition',
]
);
$query->select($select)
->from($db->quoteName('#__workflow_transitions', 't'))
->leftJoin($db->quoteName('#__workflow_stages', 's') . ' ON ' . $db->quoteName('s.id') . ' = ' . $db->quoteName('t.to_stage_id'))
->where($db->quoteName('t.id') . ' = ' . (int) $transition_id);
if (!empty($this->options['published']))
{
$query->where($db->quoteName('t.published') . ' = 1');
}
$transition = $db->setQuery($query)->loadObject();
// Check if the items can execute this transition
foreach ($pks as $pk)
{
$assoc = $this->getAssociation($pk);
if (!in_array($transition->from_stage_id, [-1, $assoc->stage_id]))
{
return false;
}
}
$component = $this->getComponent();
if ($component instanceof WorkflowServiceInterface)
{
$component->updateContentState($pks, $transition->condition);
}
$success = $this->updateAssociations($pks, $transition->to_stage_id);
if ($success)
{
$app = Factory::getApplication();
$app->triggerEvent(
'onWorkflowAfterTransition',
[
'pks' => $pks,
'extension' => $this->extension,
'user' => $app->getIdentity(),
'transition' => $transition,
]
);
}
return $success;
}
/**
* Creates an association for the workflow_associations table
*
* @param int $pk ID of the item
* @param int $state ID of state
*
* @return boolean
*
* @since 4.0.0
*/
public function createAssociation($pk, $state)
{
try
{
$db = Factory::getDbo();
$query = $db->getQuery(true);
$query->insert($db->quoteName('#__workflow_associations'))
->columns($db->quoteName(array('item_id', 'stage_id', 'extension')))
->values((int) $pk . ', ' . (int) $state . ', ' . $db->quote($this->extension));
$db->setQuery($query)->execute();
}
catch (\Exception $e)
{
return false;
}
return true;
}
/**
* Update an existing association with a new state
*
* @param array $pks An Array of item IDs which should be changed
* @param int $state The new state ID
*
* @return boolean
*
* @since 4.0.0
*/
public function updateAssociations($pks, $state)
{
if (!is_array($pks))
{
$pks = [$pks];
}
$pks = ArrayHelper::toInteger($pks);
try
{
$db = Factory::getDbo();
$query = $db->getQuery(true);
$query->update($db->quoteName('#__workflow_associations'))
->set($db->quoteName('stage_id') . '=' . (int) $state)
->whereIn($db->quoteName('item_id'), $pks)
->where($db->quoteName('extension') . '=' . $db->quote($this->extension));
$db->setQuery($query)->execute();
}
catch (\Exception $e)
{
return false;
}
return true;
}
/**
* Removes associations form the workflow_associations table
*
* @param int $pks ID of content
*
* @return boolean
*
* @since 4.0.0
*/
public function deleteAssociation($pks)
{
$pks = ArrayHelper::toInteger($pks);
try
{
$db = Factory::getDbo();
$query = $db->getQuery(true);
$query
->delete($db->quoteName('#__workflow_associations'))
->whereIn($db->quoteName('item_id'), $pks)
->andWhere($db->quoteName('extension') . '=' . $db->quote($this->extension));
$db->setQuery($query)->execute();
}
catch (\Exception $e)
{
return false;
}
return true;
}
/**
* Loads an existing association item with state and item ID
*
* @param int $item_id The item ID to load
*
* @return object
*
* @since 4.0.0
*/
public function getAssociation($item_id)
{
$db = Factory::getDbo();
$query = $db->getQuery(true);
$select = $db->quoteName(
[
'item_id',
'stage_id'
]
);
$query->select($select)
->from($db->quoteName('#__workflow_associations'))
->where($db->quoteName('item_id') . ' = ' . (int) $item_id)
->where($db->quoteName('extension') . ' = ' . $db->quote($this->extension));
return $db->setQuery($query)->loadObject();
}
/**
* Allows to set some optional options, eg. if the access level should be considered.
*
* @param array $options The new options
*
* @return void
*
* @since 4.0.0
*/
public function setOptions(array $options)
{
if (isset($options['access']))
{
$this->options['access'] = $options['access'];
}
if (isset($options['published']))
{
$this->options['published'] = $options['published'];
}
if (isset($options['countItems']))
{
$this->options['countItems'] = $options['countItems'];
}
}
}
The same content is in 3 releases, Joomla 4.0.0-alpha7 to 4.0.0-alpha9. See them all, or every version of this file.