1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
|
<?php
/**
* ownCloud
*
* @author Jakob Sack
* @copyright 2012 Jakob Sack owncloud@jakobsack.de
*
* This library is free software; you can redistribute it and/or
* modify it under the terms of the GNU AFFERO GENERAL PUBLIC LICENSE
* License as published by the Free Software Foundation; either
* version 3 of the License, or any later version.
*
* This library is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU AFFERO GENERAL PUBLIC LICENSE for more details.
*
* You should have received a copy of the GNU Affero General Public
* License along with this library. If not, see <http://www.gnu.org/licenses/>.
*
*/
/**
* Public interface of ownCloud forbackground jobs.
*/
// use OCP namespace for all classes that are considered public.
// This means that they should be used by apps instead of the internal ownCloud classes
namespace OCP;
/**
* This class provides functions to manage backgroundjobs in ownCloud
*
* There are two kind of background jobs in ownCloud: regular tasks and
* queued tasks.
*
* Regular tasks have to be registered in appinfo.php and
* will run on a regular base. Fetching news could be a task that should run
* frequently.
*
* Queued tasks have to be registered each time you want to execute them.
* An example of the queued task would be the creation of the thumbnail. As
* soon as the user uploads a picture the gallery app registers the queued
* task "create thumbnail" and saves the path in the parameter instead of doing
* the work right away. This makes the app more responsive. As soon as the task
* is done it will be deleted from the list.
*/
class BackgroundJob {
/**
* @brief creates a regular task
* @param $klass class name
* @param $method method name
* @return true
*/
public static function addRegularTask( $klass, $method ){
return \OC_BackgroundJob_RegularTask::register( $klass, $method );
}
/**
* @brief gets all regular tasks
* @return associative array
*
* key is string "$klass-$method", value is array( $klass, $method )
*/
static public function allRegularTasks(){
return \OC_BackgroundJob_RegularTask::all();
}
/**
* @brief Gets one queued task
* @param $id ID of the task
* @return associative array
*/
public static function findQueuedTask( $id ){
return \OC_BackgroundJob_QueuedTask::find( $id );
}
/**
* @brief Gets all queued tasks
* @return array with associative arrays
*/
public static function allQueuedTasks(){
return \OC_BackgroundJob_QueuedTask::all();
}
/**
* @brief Gets all queued tasks of a specific app
* @param $app app name
* @return array with associative arrays
*/
public static function queuedTaskWhereAppIs( $app ){
return \OC_BackgroundJob_QueuedTask::whereAppIs( $app );
}
/**
* @brief queues a task
* @param $app app name
* @param $klass class name
* @param $method method name
* @param $parameters all useful data as text
* @return id of task
*/
public static function addQueuedTask( $app, $klass, $method, $parameters ){
return \OC_BackgroundJob_QueuedTask::add( $app, $klass, $method, $parameters );
}
/**
* @brief deletes a queued task
* @param $id id of task
* @return true/false
*
* Deletes a report
*/
public static function deleteQueuedTask( $id ){
return \OC_BackgroundJob_QueuedTask::delete( $id );
}
}
|
