← Back to branch summary

~xibo-maintainers/xibo/tempel

« back to all changes in this revision

Viewing changes to server/lib/pages/help.class.php

  • Committer: Dan Garner
  • Date: 2015-01-15 14:26:07 UTC
  • Revision ID: git-v1:0bf2226a1e1e343100602a625c79b0b71a23593d
Migrated from BZR and moved files to root folder.

Show diffs side-by-side

added added

removed removed

Lines of Context:
server/lib/pages/help.class.php
1
 
<?php
2
 
/*
3
 
 * Xibo - Digital Signage - http://www.xibo.org.uk
4
 
 * Copyright (C) 2009-2013 Daniel Garner
5
 
 *
6
 
 * This file is part of Xibo.
7
 
 *
8
 
 * Xibo is free software: you can redistribute it and/or modify
9
 
 * it under the terms of the GNU Affero General Public License as published by
10
 
 * the Free Software Foundation, either version 3 of the License, or
11
 
 * any later version.
12
 
 *
13
 
 * Xibo is distributed in the hope that it will be useful,
14
 
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
15
 
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
16
 
 * GNU Affero General Public License for more details.
17
 
 *
18
 
 * You should have received a copy of the GNU Affero General Public License
19
 
 * along with Xibo.  If not, see <http://www.gnu.org/licenses/>.
20
 
 */
21
 
defined('XIBO') or die("Sorry, you are not allowed to directly access this page.<br /> Please press the back button in your browser.");
22
 
 
23
 
class helpDAO extends baseDAO {
24
 
    private $helpLink;
25
 
 
26
 
    /**
27
 
     * No display page functionaility
28
 
     * @return
29
 
     */
30
 
    function displayPage()
31
 
    {
32
 
        // Configure the theme
33
 
        $id = uniqid();
34
 
        Theme::Set('id', $id);
35
 
        Theme::Set('form_meta', '<input type="hidden" name="p" value="help"><input type="hidden" name="q" value="Grid">');
36
 
        Theme::Set('pager', ResponseManager::Pager($id));
37
 
 
38
 
        // Call to render the template
39
 
        Theme::Set('header_text', __('Help Links'));
40
 
        Theme::Set('form_fields', array());
41
 
        Theme::Render('grid_render');
42
 
    }
43
 
 
44
 
    function actionMenu() {
45
 
 
46
 
        return array(
47
 
                array('title' => __('Add Help Link'),
48
 
                    'class' => 'XiboFormButton',
49
 
                    'selected' => false,
50
 
                    'link' => 'index.php?p=help&q=AddForm',
51
 
                    'help' => __('Add a new Help page'),
52
 
                    'onclick' => ''
53
 
                    )
54
 
            );
55
 
    }
56
 
 
57
 
    public function Grid()
58
 
    {
59
 
        $db =& $this->db;
60
 
        $user =& $this->user;
61
 
        $response = new ResponseManager();
62
 
 
63
 
        //display the display table
64
 
        $SQL = <<<SQL
65
 
        SELECT HelpID, Topic, Category, Link
66
 
          FROM `help`
67
 
        ORDER BY Topic, Category
68
 
SQL;
69
 
 
70
 
        // Load results into an array
71
 
        $helplinks = $db->GetArray($SQL);
72
 
 
73
 
        if (!is_array($helplinks)) 
74
 
        {
75
 
            trigger_error($db->error());
76
 
            trigger_error(__('Error getting list of helplinks'), E_USER_ERROR);
77
 
        }
78
 
 
79
 
        $cols = array(
80
 
                array('name' => 'topic', 'title' => __('Topic')),
81
 
                array('name' => 'category', 'title' => __('Category')),
82
 
                array('name' => 'link', 'title' => __('Link'))
83
 
            );
84
 
        Theme::Set('table_cols', $cols);
85
 
 
86
 
        $rows = array();
87
 
 
88
 
        foreach ($helplinks as $row) {
89
 
 
90
 
            $row['helpid'] = Kit::ValidateParam($row['HelpID'], _INT);
91
 
            $row['topic'] = Kit::ValidateParam($row['Topic'], _STRING);
92
 
            $row['category'] = Kit::ValidateParam($row['Category'], _STRING);
93
 
            $row['link'] = Kit::ValidateParam($row['Link'], _STRING);
94
 
 
95
 
            $row['buttons'] = array();
96
 
 
97
 
            // we only want to show certain buttons, depending on the user logged in
98
 
            if ($user->usertypeid == 1) {
99
 
                
100
 
                // Edit        
101
 
                $row['buttons'][] = array(
102
 
                        'id' => 'help_button_edit',
103
 
                        'url' => 'index.php?p=help&q=EditForm&HelpID=' . $row['helpid'],
104
 
                        'text' => __('Edit')
105
 
                    );
106
 
 
107
 
                // Delete        
108
 
                $row['buttons'][] = array(
109
 
                        'id' => 'help_button_delete',
110
 
                        'url' => 'index.php?p=help&q=DeleteForm&HelpID=' . $row['helpid'],
111
 
                        'text' => __('Delete')
112
 
                    );
113
 
 
114
 
                // Test
115
 
                $row['buttons'][] = array(
116
 
                        'id' => 'help_button_test',
117
 
                        'url' => HelpManager::Link($row['topic'], $row['category']),
118
 
                        'text' => __('Test')
119
 
                    );
120
 
            }
121
 
 
122
 
            $rows[] = $row;
123
 
        }
124
 
 
125
 
        Theme::Set('table_rows', $rows);
126
 
        
127
 
        $output = Theme::RenderReturn('table_render');
128
 
 
129
 
        $response->SetGridResponse($output);
130
 
        $response->Respond();
131
 
    }
132
 
 
133
 
    public function AddForm()
134
 
    {
135
 
        $response = new ResponseManager();
136
 
        
137
 
        // Set some information about the form
138
 
        Theme::Set('form_id', 'HelpAddForm');
139
 
        Theme::Set('form_action', 'index.php?p=help&q=Add');
140
 
 
141
 
        $formFields = array();
142
 
        $formFields[] = FormManager::AddText('Topic', __('Topic'), NULL, 
143
 
            __('The Topic for this Help Link'), 't', 'maxlength="254" required');
144
 
 
145
 
        $formFields[] = FormManager::AddText('Category', __('Category'), NULL, 
146
 
            __('The Category for this Help Link'), 'c', 'maxlength="254" required');
147
 
 
148
 
        $formFields[] = FormManager::AddText('Link', __('Link'), NULL, 
149
 
            __('The Link to open for this help topic and category'), 'c', 'maxlength="254" required');
150
 
 
151
 
        Theme::Set('form_fields', $formFields);
152
 
 
153
 
        $response->SetFormRequestResponse(NULL, __('Add Help Link'), '350px', '325px');
154
 
        $response->AddButton(__('Cancel'), 'XiboDialogClose()');
155
 
        $response->AddButton(__('Save'), '$("#HelpAddForm").submit()');
156
 
        $response->Respond();
157
 
    }
158
 
 
159
 
    /**
160
 
     * Help Edit form
161
 
     */
162
 
    public function EditForm()
163
 
    {
164
 
        $db =& $this->db;
165
 
        $user =& $this->user;
166
 
        $response = new ResponseManager();
167
 
 
168
 
        $helpId = Kit::GetParam('HelpID', _REQUEST, _INT);
169
 
 
170
 
        // Pull the currently known info from the DB
171
 
        $SQL = "SELECT HelpID, Topic, Category, Link FROM `help` WHERE HelpID = %d ";
172
 
        $SQL = sprintf($SQL, $helpId);
173
 
 
174
 
        if (!$row = $db->GetSingleRow($SQL))
175
 
        {
176
 
            trigger_error($db->error());
177
 
            trigger_error(__('Error getting Help Link'));
178
 
        }
179
 
 
180
 
        // Set some information about the form
181
 
        Theme::Set('form_id', 'HelpEditForm');
182
 
        Theme::Set('form_action', 'index.php?p=help&q=Edit');
183
 
        Theme::Set('form_meta', '<input type="hidden" name="HelpID" value="' . $helpId . '" />');
184
 
 
185
 
        $formFields = array();
186
 
        $formFields[] = FormManager::AddText('Topic', __('Topic'), Kit::ValidateParam($row['Topic'], _STRING), 
187
 
            __('The Topic for this Help Link'), 't', 'maxlength="254" required');
188
 
 
189
 
        $formFields[] = FormManager::AddText('Category', __('Category'), Kit::ValidateParam($row['Category'], _STRING), 
190
 
            __('The Category for this Help Link'), 'c', 'maxlength="254" required');
191
 
 
192
 
        $formFields[] = FormManager::AddText('Link', __('Link'), Kit::ValidateParam($row['Link'], _STRING), 
193
 
            __('The Link to open for this help topic and category'), 'c', 'maxlength="254" required');
194
 
 
195
 
        Theme::Set('form_fields', $formFields);
196
 
 
197
 
        $response->SetFormRequestResponse(NULL, __('Edit Help Link'), '350px', '325px');
198
 
        $response->AddButton(__('Cancel'), 'XiboDialogClose()');
199
 
        $response->AddButton(__('Save'), '$("#HelpEditForm").submit()');
200
 
        $response->Respond();
201
 
    }
202
 
 
203
 
    /**
204
 
     * Delete Help Link Form
205
 
     */
206
 
    public function DeleteForm()
207
 
    {
208
 
        $db =& $this->db;
209
 
        $response = new ResponseManager();
210
 
        $helpId = Kit::GetParam('HelpID', _REQUEST, _INT);
211
 
 
212
 
        // Set some information about the form
213
 
        Theme::Set('form_id', 'HelpDeleteForm');
214
 
        Theme::Set('form_action', 'index.php?p=help&q=Delete');
215
 
        Theme::Set('form_meta', '<input type="hidden" name="HelpID" value="' . $helpId . '" />');
216
 
 
217
 
        Theme::Set('form_fields', array(FormManager::AddMessage(__('Are you sure you want to delete?'))));
218
 
 
219
 
        $response->SetFormRequestResponse(NULL, __('Delete Help Link'), '350px', '175px');
220
 
        $response->AddButton(__('No'), 'XiboDialogClose()');
221
 
        $response->AddButton(__('Yes'), '$("#HelpDeleteForm").submit()');
222
 
        $response->Respond();
223
 
    }
224
 
 
225
 
    /**
226
 
     * Adds a help link
227
 
     */
228
 
    public function Add()
229
 
    {
230
 
        // Check the token
231
 
        if (!Kit::CheckToken())
232
 
            trigger_error(__('Sorry the form has expired. Please refresh.'), E_USER_ERROR);
233
 
        
234
 
        $db =& $this->db;
235
 
        $response = new ResponseManager();
236
 
 
237
 
        $topic = Kit::GetParam('Topic', _POST, _STRING);
238
 
        $category = Kit::GetParam('Category', _POST, _STRING);
239
 
        $link = Kit::GetParam('Link', _POST, _STRING);
240
 
 
241
 
        // Deal with the Edit
242
 
        Kit::ClassLoader('help');
243
 
        $helpObject = new Help($db);
244
 
 
245
 
        if (!$helpObject->Add($topic, $category, $link))
246
 
            trigger_error($helpObject->GetErrorMessage(), E_USER_ERROR);
247
 
 
248
 
        $response->SetFormSubmitResponse(__('Help Link Added'), false);
249
 
        $response->Respond();
250
 
    }
251
 
 
252
 
    /**
253
 
     * Edits a help link
254
 
     */
255
 
    public function Edit()
256
 
    {
257
 
        // Check the token
258
 
        if (!Kit::CheckToken())
259
 
            trigger_error(__('Sorry the form has expired. Please refresh.'), E_USER_ERROR);
260
 
        
261
 
        $db =& $this->db;
262
 
        $response = new ResponseManager();
263
 
 
264
 
        $helpId = Kit::GetParam('HelpID', _POST, _INT);
265
 
        $topic = Kit::GetParam('Topic', _POST, _STRING);
266
 
        $category = Kit::GetParam('Category', _POST, _STRING);
267
 
        $link = Kit::GetParam('Link', _POST, _STRING);
268
 
 
269
 
        // Deal with the Edit
270
 
        Kit::ClassLoader('help');
271
 
        $helpObject = new Help($db);
272
 
 
273
 
        if (!$helpObject->Edit($helpId, $topic, $category, $link))
274
 
            trigger_error($helpObject->GetErrorMessage(), E_USER_ERROR);
275
 
 
276
 
        $response->SetFormSubmitResponse(__('Help Link Edited'), false);
277
 
        $response->Respond();
278
 
    }
279
 
 
280
 
    public function Delete()
281
 
    {
282
 
        // Check the token
283
 
        if (!Kit::CheckToken())
284
 
            trigger_error(__('Sorry the form has expired. Please refresh.'), E_USER_ERROR);
285
 
        
286
 
        $db =& $this->db;
287
 
        $response = new ResponseManager();
288
 
 
289
 
        $helpId = Kit::GetParam('HelpID', _POST, _INT);
290
 
 
291
 
        // Deal with the Edit
292
 
        Kit::ClassLoader('help');
293
 
        $helpObject = new Help($db);
294
 
 
295
 
        if (!$helpObject->Delete($helpId))
296
 
            trigger_error($helpObject->GetErrorMessage(), E_USER_ERROR);
297
 
 
298
 
        $response->SetFormSubmitResponse(__('Help Link Deleted'), false);
299
 
        $response->Respond();
300
 
    }
301
 
}
302
 
?>