/usr/share/phoronix-test-suite/pts-core/objects/client/pts_module_interface.php is in phoronix-test-suite 4.8.3-1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
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 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 | <?php
/*
Phoronix Test Suite
URLs: http://www.phoronix.com, http://www.phoronix-test-suite.com/
Copyright (C) 2008 - 2012, Phoronix Media
Copyright (C) 2008 - 2012, Michael Larabel
pts_module_interface.php: The generic Phoronix Test Suite module object that is extended by the specific modules/plug-ins
This program 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 3 of the License, or
(at your option) any later version.
This program 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 this program. If not, see <http://www.gnu.org/licenses/>.
*/
class pts_module_interface
{
const module_name = "Generic Module";
const module_version = "1.0.0";
const module_description = "A description of the module.";
const module_author = "Module Creator";
public static $module_store_vars = array();
public static function module_info()
{
}
public static function module_setup()
{
return array();
}
public static function module_setup_validate($module_options_array)
{
return $module_options_array;
}
public static function module_environmental_variables()
{
return array();
}
public static function user_commands()
{
return array();
}
//
// The below methods are optional and can be implemented by any module
//
/*
//
// General Functions
//
public static function __startup($obj = null)
{
return;
}
public static function __shutdown($obj = null)
{
return;
}
//
// Option Functions
//
public static function __pre_option_process($obj = null)
{
// Passed is a string containing the name of the option command about to be run
return;
}
public static function __post_option_process($obj = null)
{
// Passed is a string containing the name of the option after it has run
return;
}
//
// Installation Functions
//
public static function __pre_install_process($obj = null)
{
// Passed is the pts_test_install_manager
return;
}
public static function __pre_test_download($obj = null)
{
// Passed is an array where as the first element is the test identifier for the name of the test about to have its files downloaded
// The second element in this array is an additional array containing the pts_test_file_download objects that will be downloaded
return;
}
public static function __interim_test_download($obj = null)
{
// Passed is an array where as the first element is the test identifier for the name of the test about to have its files downloaded
// The second element in this array is an additional array containing the pts_test_file_download objects that will be downloaded
return;
}
public static function __post_test_download($obj = null)
{
// Passed as the first argument to this function is the test identifier for the name of the test where the file(s) were just downloaded
return;
}
public static function __pre_test_install($obj = null)
{
// Passed as the first argument to this function is the test identifier for the name of the test about to be installed
return;
}
public static function __post_test_install($obj = null)
{
// Passed as the first argument to this function is the test identifier for the name of the test just installed
return;
}
public static function __post_install_process($obj = null)
{
// Passed is the pts_test_install_manager
return;
}
//
// Run Functions
//
public static function __run_manager_setup($obj = null)
{
// Passed is the current pts_test_run_manager
return;
}
public static function __pre_run_process($obj = null)
{
// Passed is the current pts_test_run_manager, where accessible is an array of pts_test_result objects for all tests scheduled to run
return;
}
public static function __pre_test_run($obj = null)
{
// Passed is a read-only copy of the current pts_test_result for the given test
return;
}
public static function __interim_test_run($obj = null)
{
// Passed is a read-only copy of the current pts_test_result for the given test
return;
}
public static function __post_test_run($obj = null)
{
// Passed is a read-only copy of the current pts_test_result for the given test
return;
}
public static function __post_test_run_success($obj = null)
{
// Passed is a copy of the pts_test_result when the run was successful
return;
}
public static function __post_test_run_process($obj = null)
{
// Passed is a copy of the pts_result_file_writer
return;
}
public static function __post_run_process($obj = null)
{
// Passed is the current pts_test_run_manager, where accessible is an array of pts_test_result objects for all tests scheduled to run
return;
}
//
// Event-driven Functions
//
public static function __event_openbenchmarking_upload($obj = null)
{
// Passed is the decoded JSON response from OpenBenchmarking.org
return;
}
public static function __event_results_process($obj = null)
{
// Passed is the pts_test_run_manager
return;
}
public static function __event_results_saved($obj = null)
{
// Passed is a copy of the pts_test_run_manager
return;
}
public static function __event_user_error($obj = null)
{
// TODO use __event_user_error
return;
}
*/
}
?>
|