ILIAS  release_5-1 Revision 5.0.0-5477-g43f3e3fab5f
pgt-main.php
Go to the documentation of this file.
1<?php
2/*
3 * Copyright © 2003-2010, The ESUP-Portail consortium & the JA-SIG Collaborative.
4 * All rights reserved.
5 *
6 * Redistribution and use in source and binary forms, with or without
7 * modification, are permitted provided that the following conditions are met:
8 *
9 * * Redistributions of source code must retain the above copyright notice,
10 * this list of conditions and the following disclaimer.
11 * * Redistributions in binary form must reproduce the above copyright notice,
12 * this list of conditions and the following disclaimer in the documentation
13 * and/or other materials provided with the distribution.
14 * * Neither the name of the ESUP-Portail consortium & the JA-SIG
15 * Collaborative nor the names of its contributors may be used to endorse or
16 * promote products derived from this software without specific prior
17 * written permission.
18
19 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
20 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
21 * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
22 * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR
23 * ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
24 * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
25 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
26 * ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
27 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
28 * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
29 */
46{
52 // ########################################################################
53 // CONSTRUCTOR
54 // ########################################################################
55
63 function PGTStorage($cas_parent)
64 {
66 if ( !$cas_parent->isProxy() ) {
67 phpCAS::error('defining PGT storage makes no sense when not using a CAS proxy');
68 }
70 }
71
72 // ########################################################################
73 // DEBUGGING
74 // ########################################################################
75
82 function getStorageType()
83 {
84 phpCAS::error(__CLASS__.'::'.__FUNCTION__.'() should never be called');
85 }
86
93 function getStorageInfo()
94 {
95 phpCAS::error(__CLASS__.'::'.__FUNCTION__.'() should never be called');
96 }
97
98 // ########################################################################
99 // ERROR HANDLING
100 // ########################################################################
101
111
121 function setErrorMessage($error_message)
122 {
123 $this->_error_message = $error_message;
124 }
125
136 {
138 }
139
140 // ########################################################################
141 // INITIALIZATION
142 // ########################################################################
143
151 var $_initialized = FALSE;
152
160 function isInitialized()
161 {
162 return $this->_initialized;
163 }
164
170 function init()
171 {
172 $this->_initialized = TRUE;
173 }
174
175 // ########################################################################
176 // PGT I/O
177 // ########################################################################
178
188 function write($pgt,$pgt_iou)
189 {
190 phpCAS::error(__CLASS__.'::'.__FUNCTION__.'() should never be called');
191 }
192
202 function read($pgt_iou)
203 {
204 phpCAS::error(__CLASS__.'::'.__FUNCTION__.'() should never be called');
205 }
206
209}
210
211// include specific PGT storage classes
212include_once(dirname(__FILE__).'/pgt-file.php');
213include_once(dirname(__FILE__).'/pgt-db.php');
214
215?>
The PGTStorage class is a generic class for PGT storage.
Definition: pgt-main.php:46
error($msg)
This method is used by interface methods to print an error and where the function was originally call...
Definition: CAS.php:544
traceBegin()
This method is used to indicate the start of the execution of a function in debug mode.
Definition: CAS.php:577
traceEnd($res='')
This method is used to indicate the end of the execution of a function in debug mode.
Definition: CAS.php:604
setErrorMessage($error_message)
This method sets en error message, which can be read later by PGTStorage::getErrorMessage().
Definition: pgt-main.php:121
write($pgt, $pgt_iou)
This virtual method stores a PGT and its corresponding PGT Iuo.
Definition: pgt-main.php:188
read($pgt_iou)
This virtual method reads a PGT corresponding to a PGT Iou and deletes the corresponding storage entr...
Definition: pgt-main.php:202
getStorageInfo()
This virtual method returns an informational string giving informations on the parameters of the stor...
Definition: pgt-main.php:93
isInitialized()
This method tells if the storage has already been intialized.
Definition: pgt-main.php:160
getStorageType()
This virtual method returns an informational string giving the type of storage used by the object (us...
Definition: pgt-main.php:82
getErrorMessage()
This method returns an error message set by PGTStorage::setErrorMessage().
Definition: pgt-main.php:135
PGTStorage($cas_parent)
The constructor of the class, should be called only by inherited classes.
Definition: pgt-main.php:63
init()
This virtual method initializes the object.
Definition: pgt-main.php:170
$_error_message
string used to store an error message.
Definition: pgt-main.php:110
$_initialized
a boolean telling if the storage has already been initialized.
Definition: pgt-main.php:151