- md5
- ff1af05bc914512a60e33a2da1d4d6ee
- sha1
- 7c7bc676c8e2407f47923b9872ddc091edf10a45
- sha256
- 53014aca640ae13e8e1b2033cb0d9a74ebc1e1ba40a7ac11060d3ea2ff44c243
12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697
<?php
/**
* @package Joomla.Administrator
* @subpackage com_scheduler
*
* @copyright (C) 2021 Open Source Matters, Inc. <https://www.joomla.org>
* @license GNU General Public License version 2 or later; see LICENSE.txt
*/
namespace Joomla\Component\Scheduler\Administrator\Event;
// Restrict direct access
\defined('_JEXEC') or die;
use Joomla\CMS\Event\AbstractEvent;
use Joomla\Component\Scheduler\Administrator\Task\Task;
/**
* Event class for onExecuteTask event.
*
* @since 4.1.0
*/
class ExecuteTaskEvent extends AbstractEvent
{
/**
* Constructor.
*
* @param string $name The event name.
* @param array $arguments The event arguments.
*
* @since 4.1.0
* @throws \BadMethodCallException
*/
public function __construct($name, array $arguments = array())
{
parent::__construct($name, $arguments);
$arguments['resultSnapshot'] = null;
if (!($arguments['subject'] ?? null) instanceof Task)
{
throw new \BadMethodCallException("The subject given for $name event must be an instance of " . Task::class);
}
}
/**
* Sets the task result snapshot and stops event propagation.
*
* @param array $snapshot The task snapshot.
*
* @return void
*
* @since 4.1.0
*/
public function setResult(array $snapshot = []): void
{
$this->arguments['resultSnapshot'] = $snapshot;
if (!empty($snapshot))
{
$this->stopPropagation();
}
}
/**
* @return integer The task's taskId.
*
* @since 4.1.0
*/
public function getTaskId(): int
{
return $this->arguments['subject']->get('id');
}
/**
* @return string The task's 'type'.
*
* @since 4.1.0
*/
public function getRoutineId(): string
{
return $this->arguments['subject']->get('type');
}
/**
* Returns the snapshot of the triggered task if available, else an empty array
*
* @return array The task snapshot if available, else null
*
* @since 4.1.0
*/
public function getResultSnapshot(): array
{
return $this->arguments['resultSnapshot'] ?? [];
}
}
The same content is in 24 releases, Joomla 4.1.0-beta1 to 4.2.0-beta2. See them all, or every version of this file.