[ Index ]

PHP Cross Reference of Joomla 4.2.2 documentation

title

Body

[close]

/administrator/components/com_scheduler/src/Event/ -> ExecuteTaskEvent.php (summary)

(no description)

Copyright: (C) 2021 Open Source Matters, Inc.
License: GNU General Public License version 2 or later; see LICENSE.txt
File Size: 96 lines (2 kb)
Included or required:0 times
Referenced: 0 times
Includes or requires: 0 files

Defines 1 class

ExecuteTaskEvent:: (5 methods):
  __construct()
  setResult()
  getTaskId()
  getRoutineId()
  getResultSnapshot()


Class: ExecuteTaskEvent  - X-Ref

Event class for onExecuteTask event.

__construct($name, array $arguments = array()   X-Ref
Constructor.

param: string  $name       The event name.
param: array   $arguments  The event arguments.

setResult(array $snapshot = [])   X-Ref
Sets the task result snapshot and stops event propagation.

param: array  $snapshot  The task snapshot.
return: void

getTaskId()   X-Ref

return: integer  The task's taskId.

getRoutineId()   X-Ref

return: string  The task's 'type'.

getResultSnapshot()   X-Ref
Returns the snapshot of the triggered task if available, else an empty array

return: array  The task snapshot if available, else null



Generated: Wed Sep 7 05:41:13 2022 Chilli.vc Blog - For Webmaster,Blog-Writer,System Admin and Domainer