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 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 <?php
/**
***********************************************************************************************
* Class manages access to database table adm_user_fields
*
* @copyright 2004-2016 The Admidio Team
* @see http://www.admidio.org/
* @license https://www.gnu.org/licenses/gpl-2.0.html GNU General Public License v2.0 only
***********************************************************************************************
*/
/**
* @class TableUserField
*
* Diese Klasse dient dazu einen Benutzerdefiniertes Feldobjekt zu erstellen.
* Eine Benutzerdefiniertes Feldobjekt kann ueber diese Klasse in der Datenbank
* verwaltet werden
*
* Es stehen die Methoden der Elternklasse TableAccess zur Verfuegung
*/
class TableUserField extends TableAccess
{
/**
* Constructor that will create an object of a recordset of the table adm_user_fields.
* If the id is set than the specific user field will be loaded.
* @param \Database $database Object of the class Database. This should be the default global object @b $gDb.
* @param int $usf_id The recordset of the user field with this id will be loaded. If id isn't set than an empty object of the table is created.
*/
public function __construct(&$database, $usf_id = 0)
{
// read also data of assigned category
$this->connectAdditionalTable(TBL_CATEGORIES, 'cat_id', 'usf_cat_id');
parent::__construct($database, TBL_USER_FIELDS, 'usf', $usf_id);
}
/**
* Deletes the selected field and all references in other tables.
* Also the gap in sequence will be closed. After that the class will be initialize.
* @return void|true true if no error occurred
*/
public function delete()
{
global $gCurrentSession;
$this->db->startTransaction();
// close gap in sequence
$sql = 'UPDATE '.TBL_USER_FIELDS.' SET usf_sequence = usf_sequence - 1
WHERE usf_cat_id = '.$this->getValue('usf_cat_id'). '
AND usf_sequence > '.$this->getValue('usf_sequence');
$this->db->query($sql);
// close gap in sequence of saved lists
$sql = 'SELECT lsc_lst_id, lsc_number
FROM '.TBL_LIST_COLUMNS.'
WHERE lsc_usf_id = '.$this->getValue('usf_id');
$listsStatement = $this->db->query($sql);
while($row_lst = $listsStatement->fetch())
{
$sql = 'UPDATE '.TBL_LIST_COLUMNS.' SET lsc_number = lsc_number - 1
WHERE lsc_lst_id = '.$row_lst['lsc_lst_id']. '
AND lsc_number > '.$row_lst['lsc_number'];
$this->db->query($sql);
}
// delete all dependencies in other tables
$sql = 'DELETE FROM '.TBL_USER_LOG.'
WHERE usl_usf_id = '.$this->getValue('usf_id');
$this->db->query($sql);
$sql = 'DELETE FROM '.TBL_USER_DATA.'
WHERE usd_usf_id = '.$this->getValue('usf_id');
$this->db->query($sql);
$sql = 'DELETE FROM '.TBL_LIST_COLUMNS.'
WHERE lsc_usf_id = '.$this->getValue('usf_id');
$this->db->query($sql);
// all active users must renew their user data because the user field structure has been changed
$gCurrentSession->renewUserObject();
$return = parent::delete();
$this->db->endTransaction();
return $return;
}
/**
* diese rekursive Methode ermittelt fuer den uebergebenen Namen einen eindeutigen Namen
* dieser bildet sich aus dem Namen in Grossbuchstaben und der naechsten freien Nummer (index)
* Beispiel: 'Mitgliedsnummer' => 'MITGLIEDSNUMMER_2'
* @param string $name
* @param int $index
* @return string
*/
private function getNewNameIntern($name, $index)
{
$newNameIntern = strtoupper(str_replace(' ', '_', $name));
if($index > 1)
{
$newNameIntern = $newNameIntern.'_'.$index;
}
$sql = 'SELECT usf_id
FROM '.TBL_USER_FIELDS.'
WHERE usf_name_intern = \''.$newNameIntern.'\'';
$userFieldsStatement = $this->db->query($sql);
if($userFieldsStatement->rowCount() > 0)
{
++$index;
$newNameIntern = $this->getNewNameIntern($name, $index);
}
return $newNameIntern;
}
/**
* Get the value of a column of the database table.
* If the value was manipulated before with @b setValue than the manipulated value is returned.
* @param string $columnName The name of the database column whose value should be read
* @param string $format For column @c usf_value_list the following format is accepted: @n
* @b database returns database value of usf_value_list; @n
* @b text extract only text from usf_value_list, image infos will be ignored @n
* For date or timestamp columns the format should be the date/time format e.g. @b d.m.Y = '02.04.2011' @n
* For text columns the format can be @b database that would be the database value without any transformations
* @return mixed Returns the value of the database column.
* If the value was manipulated before with @b setValue than the manipulated value is returned.
*/
public function getValue($columnName, $format = '')
{
global $gL10n;
if($columnName === 'usf_description')
{
if(!isset($this->dbColumns['usf_description']))
{
$value = '';
}
elseif($format === 'database')
{
$value = html_entity_decode(strStripTags($this->dbColumns['usf_description']), ENT_QUOTES, 'UTF-8');
}
else
{
$value = $this->dbColumns['usf_description'];
}
}
elseif($columnName === 'usf_name_intern')
{
// internal name should be read with no conversion
$value = parent::getValue($columnName, 'database');
}
else
{
$value = parent::getValue($columnName, $format);
}
if(($columnName === 'usf_name' || $columnName === 'cat_name') && $format !== 'database')
{
// if text is a translation-id then translate it
if(strpos($value, '_') === 3)
{
$value = $gL10n->get(admStrToUpper($value));
}
}
elseif($columnName === 'usf_value_list' && $format !== 'database')
{
if($this->dbColumns['usf_type'] === 'DROPDOWN' || $this->dbColumns['usf_type'] === 'RADIO_BUTTON')
{
$arrListValuesWithKeys = array(); // array with list values and keys that represents the internal value
// first replace windows new line with unix new line and then create an array
$valueFormated = str_replace("\r\n", "\n", $value);
$arrListValues = explode("\n", $valueFormated);
foreach($arrListValues as $key => &$listValue)
{
if($this->dbColumns['usf_type'] === 'RADIO_BUTTON')
{
// if value is imagefile or imageurl then show image
if(strpos(admStrToLower($listValue), '.png') > 0 || strpos(admStrToLower($listValue), '.jpg') > 0)
{
// if there is imagefile and text separated by | then explode them
if(strpos($listValue, '|') > 0)
{
$listValueImage = substr($listValue, 0, strpos($listValue, '|'));
$listValueText = substr($listValue, strpos($listValue, '|') + 1);
}
else
{
$listValueImage = $listValue;
$listValueText = $this->getValue('usf_name');
}
// if text is a translation-id then translate it
if(strpos($listValueText, '_') === 3)
{
$listValueText = $gL10n->get(admStrToUpper($listValueText));
}
if($format === 'text')
{
// if no image is wanted then return the text part or only the position of the entry
if(strpos($listValue, '|') > 0)
{
$listValue = $listValueText;
}
else
{
$listValue = $key + 1;
}
}
else
{
try
{
// create html for optionbox entry
if(strpos(admStrToLower($listValueImage), 'http') === 0 && strValidCharacters($listValueImage, 'url'))
{
$listValue = '<img class="admidio-icon-info" src="'.$listValueImage.'" title="'.$listValueText.'" alt="'.$listValueText.'" />';
}
elseif(admStrIsValidFileName($listValueImage, true))
{
$listValue = '<img class="admidio-icon-info" src="'.THEME_PATH.'/icons/'.$listValueImage.'" title="'.$listValueText.'" alt="'.$listValueText.'" />';
}
}
catch(AdmException $e)
{
$e->showText();
// => EXIT
}
}
}
}
// if text is a translation-id then translate it
if(strpos($listValue, '_') === 3)
{
$listValue = $gL10n->get(admStrToUpper($listValue));
}
// save values in new array that starts with key = 1
$arrListValuesWithKeys[++$key] = $listValue;
}
unset($listValue);
$value = $arrListValuesWithKeys;
}
}
elseif($columnName === 'usf_icon' && $format !== 'database')
{
// if value is imagefile or imageurl then show image
if(strpos(admStrToLower($value), '.png') > 0 || strpos(admStrToLower($value), '.jpg') > 0)
{
try
{
// create html for icon
if(strpos(admStrToLower($value), 'http') === 0 && strValidCharacters($value, 'url'))
{
$value = '<img src="'.$value.'" style="vertical-align: middle;" title="'.$this->getValue('usf_name').'" alt="'.$this->getValue('usf_name').'" />';
}
elseif(admStrIsValidFileName($value, true))
{
$value = '<img src="'.THEME_PATH.'/icons/'.$value.'" style="vertical-align: middle;" title="'.$this->getValue('usf_name').'" alt="'.$this->getValue('usf_name').'" />';
}
}
catch(AdmException $e)
{
$e->showText();
// => EXIT
}
}
}
if($value === null)
{
return '';
}
return $value;
}
/**
* das Feld wird um eine Position in der Reihenfolge verschoben
* @param string $mode
*/
public function moveSequence($mode)
{
global $gCurrentOrganization;
// die Kategorie wird um eine Nummer gesenkt und wird somit in der Liste weiter nach oben geschoben
if(admStrToUpper($mode) === 'UP')
{
$sql = 'UPDATE '.TBL_USER_FIELDS.' SET usf_sequence = '.$this->getValue('usf_sequence').'
WHERE usf_cat_id = '.$this->getValue('usf_cat_id').'
AND usf_sequence = '.$this->getValue('usf_sequence').' - 1 ';
$this->db->query($sql);
$this->setValue('usf_sequence', $this->getValue('usf_sequence')-1);
$this->save();
}
// die Kategorie wird um eine Nummer erhoeht und wird somit in der Liste weiter nach unten geschoben
elseif(admStrToUpper($mode) === 'DOWN')
{
$sql = 'UPDATE '.TBL_USER_FIELDS.' SET usf_sequence = '.$this->getValue('usf_sequence').'
WHERE usf_cat_id = '.$this->getValue('usf_cat_id').'
AND usf_sequence = '.$this->getValue('usf_sequence').' + 1 ';
$this->db->query($sql);
$this->setValue('usf_sequence', $this->getValue('usf_sequence')+1);
$this->save();
}
}
/**
* Save all changed columns of the recordset in table of database. Therefore the class remembers if it's
* a new record or if only an update is necessary. The update statement will only update
* the changed columns. If the table has columns for creator or editor than these column
* with their timestamp will be updated.
* For new records the name intern will be set per default.
* @param bool $updateFingerPrint Default @b true. Will update the creator or editor of the recordset if table has columns like @b usr_id_create or @b usr_id_changed
* @return bool If an update or insert into the database was done then return true, otherwise false.
*/
public function save($updateFingerPrint = true)
{
global $gCurrentSession;
$fields_changed = $this->columnsValueChanged;
// if new field than generate new name intern, otherwise no change will be made
if($this->new_record)
{
$this->setValue('usf_name_intern', $this->getNewNameIntern($this->getValue('usf_name', 'database'), 1));
}
$returnValue = parent::save($updateFingerPrint);
if($fields_changed && is_object($gCurrentSession))
{
// all active users must renew their user data because the user field structure has been changed
$gCurrentSession->renewUserObject();
}
return $returnValue;
}
/**
* Set a new value for a column of the database table.
* The value is only saved in the object. You must call the method @b save to store the new value to the database
* @param string $columnName The name of the database column whose value should get a new value
* @param mixed $newValue The new value that should be stored in the database field
* @param bool $checkValue The value will be checked if it's valid. If set to @b false than the value will not be checked.
* @return bool Returns @b true if the value is stored in the current object and @b false if a check failed
*/
public function setValue($columnName, $newValue, $checkValue = true)
{
// name, category and type couldn't be edited if it's a system field
if(($columnName === 'usf_cat_id' || $columnName === 'usf_type' || $columnName === 'usf_name')
&& $this->getValue('usf_system') == 1)
{
return false;
}
elseif($columnName === 'usf_cat_id' && $this->getValue($columnName) !== $newValue)
{
// erst einmal die hoechste Reihenfolgennummer der Kategorie ermitteln
$sql = 'SELECT COUNT(*) AS count
FROM '.TBL_USER_FIELDS.'
WHERE usf_cat_id = '.$newValue;
$countUserFieldsStatement = $this->db->query($sql);
$this->setValue('usf_sequence', $countUserFieldsStatement->fetchColumn() + 1);
}
elseif($columnName === 'usf_description')
{
return parent::setValue($columnName, $newValue, false);
}
elseif($columnName === 'usf_url' && $newValue !== '')
{
// Homepage noch mit http vorbelegen
if(strpos(admStrToLower($newValue), 'http://') === false
&& strpos(admStrToLower($newValue), 'https://') === false)
{
$newValue = 'http://'.$newValue;
}
// Homepage darf nur gueltige Zeichen enthalten
if(!strValidCharacters($newValue, 'url'))
{
return false;
}
}
return parent::setValue($columnName, $newValue, $checkValue);
}
}