background.php
3.05 KB
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
<?php
/**
* $Id:$
*
* The contents of this file are subject to the KnowledgeTree Public
* License Version 1.1.2 ("License"); You may not use this file except in
* compliance with the License. You may obtain a copy of the License at
* http://www.knowledgetree.com/KPL
*
* Software distributed under the License is distributed on an "AS IS"
* basis, WITHOUT WARRANTY OF ANY KIND, either express or implied.
* See the License for the specific language governing rights and
* limitations under the License.
*
* All copies of the Covered Code must include on each user interface screen:
* (i) the "Powered by KnowledgeTree" logo and
* (ii) the KnowledgeTree copyright notice
* in the same form as they appear in the distribution. See the License for
* requirements.
*
* The Original Code is: KnowledgeTree Open Source
*
* The Initial Developer of the Original Code is The Jam Warehouse Software
* (Pty) Ltd, trading as KnowledgeTree.
* Portions created by The Jam Warehouse Software (Pty) Ltd are Copyright
* (C) 2007 The Jam Warehouse Software (Pty) Ltd;
* All Rights Reserved.
* Contributor( s): ______________________________________
*
*/
/**
* Class to keep a script running in the background.
*
* Example:
* $bg = new background();
* $bg->checkConnection();
* $bg->keepConnectionAlive();
* $bg->setCallbackParams('admin@knowledgetree.com', 'BG task completed', 'The requested background task has completed');
* $bg->setCallbackFunction($bg, 'callBackFunc');
*
*/
class Background
{
var $connection = FALSE;
var $address = '';
var $subject = 'Task completed';
var $message = '';
function Background() {
}
/**
* Check the status of the users connection
*/
function checkConnection() {
$status = connection_status();
if($status != 0){
$this->connection = FALSE;
return FALSE;
}else{
$this->connection = TRUE;
return TRUE;
}
}
/**
* Keep the script alive
*/
function keepConnectionAlive() {
// prevent the script timing out
set_time_limit(0);
// prevent the user from aborting the script
ignore_user_abort(TRUE);
while($this->connection == FALSE) {
print "\n";
flush();
sleep(1);
}
}
/**
* Set the parameters of the callback function
*/
function setCallbackParams($address, $subject, $message)
{
//set the properties
$this->address = $address;
$this->subject = $subject;
$this->message = $message;
//register the callback method
//register_shutdown_function(array(&$this, "callBackFunc"));
}
/**
* Set the callback function to be run on completion of the script.
*/
function setCallbackFunction(&$class, $function){
register_shutdown_function(array(&$class, "$function"));
}
/**
* Call back function to be called on completion of the background task
*/
function callBackFunc() {
@mail($this->address, $this->subject ,$this->message);
}
}
?>