@@ -45,175 +45,175 @@ |
||
| 45 | 45 | |
| 46 | 46 | class PGTStorageDB extends PGTStorage |
| 47 | 47 | {
|
| 48 | - /** |
|
| 49 | - * @addtogroup internalPGTStorageDB |
|
| 50 | - * @{
|
|
| 51 | - */ |
|
| 52 | - |
|
| 53 | - /** |
|
| 54 | - * a string representing a PEAR DB URL to connect to the database. Written by |
|
| 55 | - * PGTStorageDB::PGTStorageDB(), read by getURL(). |
|
| 56 | - * |
|
| 57 | - * @hideinitializer |
|
| 58 | - * @private |
|
| 59 | - */ |
|
| 60 | - var $_url=''; |
|
| 61 | - |
|
| 62 | - /** |
|
| 63 | - * This method returns the PEAR DB URL to use to connect to the database. |
|
| 64 | - * |
|
| 65 | - * @return a PEAR DB URL |
|
| 66 | - * |
|
| 67 | - * @private |
|
| 68 | - */ |
|
| 69 | - function getURL() |
|
| 48 | + /** |
|
| 49 | + * @addtogroup internalPGTStorageDB |
|
| 50 | + * @{
|
|
| 51 | + */ |
|
| 52 | + |
|
| 53 | + /** |
|
| 54 | + * a string representing a PEAR DB URL to connect to the database. Written by |
|
| 55 | + * PGTStorageDB::PGTStorageDB(), read by getURL(). |
|
| 56 | + * |
|
| 57 | + * @hideinitializer |
|
| 58 | + * @private |
|
| 59 | + */ |
|
| 60 | + var $_url=''; |
|
| 61 | + |
|
| 62 | + /** |
|
| 63 | + * This method returns the PEAR DB URL to use to connect to the database. |
|
| 64 | + * |
|
| 65 | + * @return a PEAR DB URL |
|
| 66 | + * |
|
| 67 | + * @private |
|
| 68 | + */ |
|
| 69 | + function getURL() |
|
| 70 | 70 | {
|
| 71 | - return $this->_url; |
|
| 71 | + return $this->_url; |
|
| 72 | 72 | } |
| 73 | 73 | |
| 74 | - /** |
|
| 75 | - * The handle of the connection to the database where PGT's are stored. Written by |
|
| 76 | - * PGTStorageDB::init(), read by getLink(). |
|
| 77 | - * |
|
| 78 | - * @hideinitializer |
|
| 79 | - * @private |
|
| 80 | - */ |
|
| 81 | - var $_link = null; |
|
| 82 | - |
|
| 83 | - /** |
|
| 84 | - * This method returns the handle of the connection to the database where PGT's are |
|
| 85 | - * stored. |
|
| 86 | - * |
|
| 87 | - * @return a handle of connection. |
|
| 88 | - * |
|
| 89 | - * @private |
|
| 90 | - */ |
|
| 91 | - function getLink() |
|
| 74 | + /** |
|
| 75 | + * The handle of the connection to the database where PGT's are stored. Written by |
|
| 76 | + * PGTStorageDB::init(), read by getLink(). |
|
| 77 | + * |
|
| 78 | + * @hideinitializer |
|
| 79 | + * @private |
|
| 80 | + */ |
|
| 81 | + var $_link = null; |
|
| 82 | + |
|
| 83 | + /** |
|
| 84 | + * This method returns the handle of the connection to the database where PGT's are |
|
| 85 | + * stored. |
|
| 86 | + * |
|
| 87 | + * @return a handle of connection. |
|
| 88 | + * |
|
| 89 | + * @private |
|
| 90 | + */ |
|
| 91 | + function getLink() |
|
| 92 | 92 | {
|
| 93 | - return $this->_link; |
|
| 93 | + return $this->_link; |
|
| 94 | 94 | } |
| 95 | 95 | |
| 96 | - /** |
|
| 97 | - * The name of the table where PGT's are stored. Written by |
|
| 98 | - * PGTStorageDB::PGTStorageDB(), read by getTable(). |
|
| 99 | - * |
|
| 100 | - * @hideinitializer |
|
| 101 | - * @private |
|
| 102 | - */ |
|
| 103 | - var $_table = ''; |
|
| 104 | - |
|
| 105 | - /** |
|
| 106 | - * This method returns the name of the table where PGT's are stored. |
|
| 107 | - * |
|
| 108 | - * @return the name of a table. |
|
| 109 | - * |
|
| 110 | - * @private |
|
| 111 | - */ |
|
| 112 | - function getTable() |
|
| 96 | + /** |
|
| 97 | + * The name of the table where PGT's are stored. Written by |
|
| 98 | + * PGTStorageDB::PGTStorageDB(), read by getTable(). |
|
| 99 | + * |
|
| 100 | + * @hideinitializer |
|
| 101 | + * @private |
|
| 102 | + */ |
|
| 103 | + var $_table = ''; |
|
| 104 | + |
|
| 105 | + /** |
|
| 106 | + * This method returns the name of the table where PGT's are stored. |
|
| 107 | + * |
|
| 108 | + * @return the name of a table. |
|
| 109 | + * |
|
| 110 | + * @private |
|
| 111 | + */ |
|
| 112 | + function getTable() |
|
| 113 | 113 | {
|
| 114 | - return $this->_table; |
|
| 114 | + return $this->_table; |
|
| 115 | 115 | } |
| 116 | 116 | |
| 117 | - // ######################################################################## |
|
| 118 | - // DEBUGGING |
|
| 119 | - // ######################################################################## |
|
| 117 | + // ######################################################################## |
|
| 118 | + // DEBUGGING |
|
| 119 | + // ######################################################################## |
|
| 120 | 120 | |
| 121 | - /** |
|
| 122 | - * This method returns an informational string giving the type of storage |
|
| 123 | - * used by the object (used for debugging purposes). |
|
| 124 | - * |
|
| 125 | - * @return an informational string. |
|
| 126 | - * @public |
|
| 127 | - */ |
|
| 128 | - function getStorageType() |
|
| 121 | + /** |
|
| 122 | + * This method returns an informational string giving the type of storage |
|
| 123 | + * used by the object (used for debugging purposes). |
|
| 124 | + * |
|
| 125 | + * @return an informational string. |
|
| 126 | + * @public |
|
| 127 | + */ |
|
| 128 | + function getStorageType() |
|
| 129 | 129 | {
|
| 130 | - return "database"; |
|
| 130 | + return "database"; |
|
| 131 | 131 | } |
| 132 | 132 | |
| 133 | - /** |
|
| 134 | - * This method returns an informational string giving informations on the |
|
| 135 | - * parameters of the storage.(used for debugging purposes). |
|
| 136 | - * |
|
| 137 | - * @public |
|
| 138 | - */ |
|
| 139 | - function getStorageInfo() |
|
| 133 | + /** |
|
| 134 | + * This method returns an informational string giving informations on the |
|
| 135 | + * parameters of the storage.(used for debugging purposes). |
|
| 136 | + * |
|
| 137 | + * @public |
|
| 138 | + */ |
|
| 139 | + function getStorageInfo() |
|
| 140 | 140 | {
|
| 141 | - return 'url=`'.$this->getURL().'\', table=`'.$this->getTable().'\''; |
|
| 141 | + return 'url=`'.$this->getURL().'\', table=`'.$this->getTable().'\''; |
|
| 142 | 142 | } |
| 143 | 143 | |
| 144 | - // ######################################################################## |
|
| 145 | - // CONSTRUCTOR |
|
| 146 | - // ######################################################################## |
|
| 144 | + // ######################################################################## |
|
| 145 | + // CONSTRUCTOR |
|
| 146 | + // ######################################################################## |
|
| 147 | 147 | |
| 148 | - /** |
|
| 149 | - * The class constructor, called by CASClient::SetPGTStorageDB(). |
|
| 150 | - * |
|
| 151 | - * @param $cas_parent the CASClient instance that creates the object. |
|
| 152 | - * @param $user the user to access the data with |
|
| 153 | - * @param $password the user's password |
|
| 154 | - * @param $database_type the type of the database hosting the data |
|
| 155 | - * @param $hostname the server hosting the database |
|
| 156 | - * @param $port the port the server is listening on |
|
| 157 | - * @param $database the name of the database |
|
| 158 | - * @param $table the name of the table storing the data |
|
| 159 | - * |
|
| 160 | - * @public |
|
| 161 | - */ |
|
| 162 | - function PGTStorageDB($cas_parent,$user,$password,$database_type,$hostname,$port,$database,$table) |
|
| 148 | + /** |
|
| 149 | + * The class constructor, called by CASClient::SetPGTStorageDB(). |
|
| 150 | + * |
|
| 151 | + * @param $cas_parent the CASClient instance that creates the object. |
|
| 152 | + * @param $user the user to access the data with |
|
| 153 | + * @param $password the user's password |
|
| 154 | + * @param $database_type the type of the database hosting the data |
|
| 155 | + * @param $hostname the server hosting the database |
|
| 156 | + * @param $port the port the server is listening on |
|
| 157 | + * @param $database the name of the database |
|
| 158 | + * @param $table the name of the table storing the data |
|
| 159 | + * |
|
| 160 | + * @public |
|
| 161 | + */ |
|
| 162 | + function PGTStorageDB($cas_parent,$user,$password,$database_type,$hostname,$port,$database,$table) |
|
| 163 | 163 | {
|
| 164 | - phpCAS::traceBegin(); |
|
| 164 | + phpCAS::traceBegin(); |
|
| 165 | 165 | |
| 166 | - // call the ancestor's constructor |
|
| 167 | - $this->PGTStorage($cas_parent); |
|
| 166 | + // call the ancestor's constructor |
|
| 167 | + $this->PGTStorage($cas_parent); |
|
| 168 | 168 | |
| 169 | - if ( empty($database_type) ) $database_type = CAS_PGT_STORAGE_DB_DEFAULT_DATABASE_TYPE; |
|
| 170 | - if ( empty($hostname) ) $hostname = CAS_PGT_STORAGE_DB_DEFAULT_HOSTNAME; |
|
| 171 | - if ( $port==0 ) $port = CAS_PGT_STORAGE_DB_DEFAULT_PORT; |
|
| 172 | - if ( empty($database) ) $database = CAS_PGT_STORAGE_DB_DEFAULT_DATABASE; |
|
| 173 | - if ( empty($table) ) $table = CAS_PGT_STORAGE_DB_DEFAULT_TABLE; |
|
| 169 | + if ( empty($database_type) ) $database_type = CAS_PGT_STORAGE_DB_DEFAULT_DATABASE_TYPE; |
|
| 170 | + if ( empty($hostname) ) $hostname = CAS_PGT_STORAGE_DB_DEFAULT_HOSTNAME; |
|
| 171 | + if ( $port==0 ) $port = CAS_PGT_STORAGE_DB_DEFAULT_PORT; |
|
| 172 | + if ( empty($database) ) $database = CAS_PGT_STORAGE_DB_DEFAULT_DATABASE; |
|
| 173 | + if ( empty($table) ) $table = CAS_PGT_STORAGE_DB_DEFAULT_TABLE; |
|
| 174 | 174 | |
| 175 | - // build and store the PEAR DB URL |
|
| 176 | - $this->_url = $database_type.':'.'//'.$user.':'.$password.'@'.$hostname.':'.$port.'/'.$database; |
|
| 175 | + // build and store the PEAR DB URL |
|
| 176 | + $this->_url = $database_type.':'.'//'.$user.':'.$password.'@'.$hostname.':'.$port.'/'.$database; |
|
| 177 | 177 | |
| 178 | - // XXX should use setURL and setTable |
|
| 179 | - phpCAS::traceEnd(); |
|
| 178 | + // XXX should use setURL and setTable |
|
| 179 | + phpCAS::traceEnd(); |
|
| 180 | 180 | } |
| 181 | 181 | |
| 182 | - // ######################################################################## |
|
| 183 | - // INITIALIZATION |
|
| 184 | - // ######################################################################## |
|
| 182 | + // ######################################################################## |
|
| 183 | + // INITIALIZATION |
|
| 184 | + // ######################################################################## |
|
| 185 | 185 | |
| 186 | - /** |
|
| 187 | - * This method is used to initialize the storage. Halts on error. |
|
| 188 | - * |
|
| 189 | - * @public |
|
| 190 | - */ |
|
| 191 | - function init() |
|
| 186 | + /** |
|
| 187 | + * This method is used to initialize the storage. Halts on error. |
|
| 188 | + * |
|
| 189 | + * @public |
|
| 190 | + */ |
|
| 191 | + function init() |
|
| 192 | 192 | {
|
| 193 | - phpCAS::traceBegin(); |
|
| 194 | - // if the storage has already been initialized, return immediatly |
|
| 195 | - if ( $this->isInitialized() ) |
|
| 196 | - return; |
|
| 197 | - // call the ancestor's method (mark as initialized) |
|
| 198 | - parent::init(); |
|
| 193 | + phpCAS::traceBegin(); |
|
| 194 | + // if the storage has already been initialized, return immediatly |
|
| 195 | + if ( $this->isInitialized() ) |
|
| 196 | + return; |
|
| 197 | + // call the ancestor's method (mark as initialized) |
|
| 198 | + parent::init(); |
|
| 199 | 199 | |
| 200 | - //include phpDB library (the test was introduced in release 0.4.8 for |
|
| 201 | - //the integration into Tikiwiki). |
|
| 202 | - if (!class_exists('DB')) {
|
|
| 203 | - include_once('DB.php');
|
|
| 204 | - } |
|
| 205 | - |
|
| 206 | - // try to connect to the database |
|
| 207 | - $this->_link = DB::connect($this->getURL()); |
|
| 208 | - if ( DB::isError($this->_link) ) {
|
|
| 209 | - phpCAS::error('could not connect to database ('.DB::errorMessage($this->_link).')');
|
|
| 210 | - } |
|
| 211 | - // Dump into trace |
|
| 212 | - var_dump($this->_link); |
|
| 213 | - phpCAS::traceBEnd(); |
|
| 200 | + //include phpDB library (the test was introduced in release 0.4.8 for |
|
| 201 | + //the integration into Tikiwiki). |
|
| 202 | + if (!class_exists('DB')) {
|
|
| 203 | + include_once('DB.php');
|
|
| 204 | + } |
|
| 205 | + |
|
| 206 | + // try to connect to the database |
|
| 207 | + $this->_link = DB::connect($this->getURL()); |
|
| 208 | + if ( DB::isError($this->_link) ) {
|
|
| 209 | + phpCAS::error('could not connect to database ('.DB::errorMessage($this->_link).')');
|
|
| 210 | + } |
|
| 211 | + // Dump into trace |
|
| 212 | + var_dump($this->_link); |
|
| 213 | + phpCAS::traceBEnd(); |
|
| 214 | 214 | } |
| 215 | 215 | |
| 216 | - /** @} */ |
|
| 216 | + /** @} */ |
|
| 217 | 217 | } |
| 218 | 218 | |
| 219 | 219 | ?> |
| 220 | 220 | \ No newline at end of file |