summaryrefslogtreecommitdiffstats
path: root/modules-available/sysconfig/addmodule.inc.php
blob: 30ca1d2ccc47070661584c52939dcb14663266bd (plain) (blame)
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
<?php

/**
 * Addmodule subpage base - makes sure
 * we have the two required methods preprocess and render
 */
abstract class AddModule_Base
{

	/**
	 * Holds the instance for the currently executing step
	 * @var \AddModule_Base
	 */
	private static $instance = false;
	
	/**
	 * Instance of ConfigModule we're editing. False if not editing but creating.
	 * @var \ConfigModule
	 */
	protected $edit = false;

	/**
	 * 
	 * @param type $step
	 * @return \AddModule_Base
	 */
	public static function setStep($step)
	{
		if (empty($step) || !class_exists($step) || get_parent_class($step) !== 'AddModule_Base') {
			Message::addError('invalid-action', $step);
			Util::redirect('?do=SysConfig');
		}
		self::$instance = new $step();
		if (Request::any('edit')) {
			self::$instance->edit = ConfigModule::get(Request::any('edit'));
			if (self::$instance->edit === false)
				Util::traceError('Invalid module id for editing');
			if (!preg_match('/^' . self::$instance->edit->moduleType() . '_/', $step))
				Util::traceError('Module to edit is of different type!');
			Util::addRedirectParam('edit', self::$instance->edit->id());
		}
	}

	protected function tmError()
	{
		Message::addError('main.taskmanager-error');
		Util::redirect('?do=SysConfig');
	}

	protected function taskError($status)
	{
		if (isset($status['data']['error'])) {
			$error = $status['data']['error'];
		} elseif (isset($status['statusCode'])) {
			$error = $status['statusCode'];
		} else {
			$error = Dictionary::translate('lang_unknwonTaskManager');
		}
		Message::addError('main.task-error', $error);
		Util::redirect('?do=SysConfig');
	}

	/**
	 * Called before any HTML rendering happens, so you can
	 * pepare stuff, validate input, and optionally redirect
	 * early if something is wrong, or you received post
	 * data etc.
	 */
	protected function preprocessInternal()
	{
		// void
	}

	/**
	 * Do page rendering.
	 */
	protected function renderInternal()
	{
		// void
	}
	
	/**
	 * Handle ajax stuff
	 */
	protected function ajaxInternal()
	{
		// void
	}
	
	public static function preprocess()
	{
		if (self::$instance === false) {
			Util::traceError('No step instance yet');
		}
		self::$instance->preprocessInternal();
	}
	
	public static function render()
	{
		if (self::$instance === false) {
			Util::traceError('No step instance yet');
		}
		if (self::$instance->edit !== false) {
			Message::addInfo('replacing-module', self::$instance->edit->title());
		}
		self::$instance->renderInternal();
	}
	
	public static function ajax()
	{
		if (self::$instance === false) {
			Util::traceError('No step instance yet');
		}
		self::$instance->ajaxInternal();
	}

}

/**
 * Start dialog for adding module. Here the user
 * selects which kind of module they want to add.
 */
class AddModule_Start extends AddModule_Base
{

	protected function renderInternal()
	{
		$title = $order = array();
		$mods = ConfigModule::getList();
		foreach ($mods as $module) {
			$title[] = $module['title'];
			$order[] = $module['sortOrder'];
		}
		array_multisort($order, SORT_ASC, $title, SORT_ASC, $mods);
		Render::addDialog(Dictionary::translate('lang_moduleAdd'), false, 'start', array('modules' => array_values($mods)));
	}

}

/*
 * Helper functions to set/get a batch of vars from/to post variables or a module
 */

/**
 * 
 * @param \ConfigModule $module
 * @param array $array
 * @param array $keys
 */
function moduleToArray($module, &$array, $keys)
{
	foreach ($keys as $key) {
		$array[$key] = $module->getData($key);
	}
}

/**
 * 
 * @param \ConfigModule $module
 * @param array $array
 * @param array $keys
 */
function arrayToModule($module, $array, $keys)
{
	foreach ($keys as $key) {
		$module->setData($key, $array[$key]);
	}
}
/**
 * 
 * @param array $array
 * @param array $keys
 */
function postToArray(&$array, $keys, $ignoreMissing = false)
{
	foreach ($keys as $key) {
		$val = Request::post($key, '--not-in-post');
		if ($ignoreMissing && $val === '--not-in-post') continue;
		$array[$key] = $val;
	}
}