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
118
119
120
121
122
123
124
125
126
127
128
129
130
|
<?php
/**
* Results - display status table for actions
*
* This file is part of Zoph.
*
* Zoph is free software; you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation; either version 2 of the License, or
* (at your option) any later version.
*
* Zoph 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 General Public License for more details.
* You should have received a copy of the GNU General Public License
* along with Zoph; if not, write to the Free Software
* Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
*
* @package Zoph
* @author Jeroen Roos
*/
namespace template;
use conf\conf;
/**
* Result template
*
* @package Zoph
* @author Jeroen Roos
*/
class result {
/** @var int result::TODO - this action is pending */
public const TODO=-1;
/** @var int result::SUCCESS - this action was executed succesfully */
public const SUCCESS=0;
/** @var int result::INFO - this action was executed succesfully, but gave some log info */
public const INFO=1;
/** @var int result::WARNING - this action was executed succesfully, but gave a warning */
public const WARNING=2;
/** @var int result::ERROR - this action encountered an error */
public const ERROR=3;
/** @var int result::UNDEFINED - this action's status is unknown */
public const UNDEFINED=99;
/** @var int store result */
private $result=99;
/** @var string store result message */
private $msg = "";
/** @var string store result error */
private $error = "";
/** @var string store result icon */
private $icon = "";
/** @var string store result status */
private $status = "unknown";
/**
* Create result object
* @param int result: result::TODO, result::SUCCESS, result::INFO, result::WARNING or result::ERROR
* @param string result message
* @param string|null result error
*/
public function __construct(int $result, string $msg, string $error=null) {
$this->result = $result;
$this->msg = $msg;
$this->error = $error;
$this->processResult();
}
/**
* Set icon
* override standard icon
* @param string icon path - recommend to use template::getImage() for this
*/
public function setIcon(string $icon) : void {
$this->icon = $icon;
}
/**
* Display result object
* @return string template output
*/
public function __toString() : string {
return (string) new block("result", array(
"status"=> $this->status,
"icon" => $this->icon,
"msg" => $this->msg,
"error" => $this->error
));
}
/**
* Process results, set status and icon
*/
private function processResult() : void {
switch ($this->result) {
case self::TODO:
$this->status = "todo";
$this->icon = template::getImage("icons/todo.png");
break;
case self::SUCCESS:
$this->status = "ok";
$this->icon = template::getImage("icons/ok.png");
break;
case self::INFO:
$this->status = "info";
$this->icon = template::getImage("icons/info.png");
break;
case self::WARNING:
$this->status = "warning";
$this->icon = template::getImage("icons/warning.png");
break;
case self::ERROR:
$this->status = "error";
$this->icon = template::getImage("icons/error.png");
break;
default:
$this->status = "unknown";
$this->icon = template::getImage("icons/unknown.png");
break;
}
}
public function getResult() {
return $this->result;
}
}
|
