Newer
Older
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
foreach(['has_many', 'belongs_to', 'has_one', 'has_and_belongs_to_many'] as $type) {
foreach (array_keys($this->{$type}) as $one) {
$this->relations[$one] = null;
}
}
//begun the clone war has... hmpf
}
/**
* try to determine all needed options for a relationship from
* configured options
*
* @param string $type
* @param string $name
* @param array $options
* @throws Exception if options for thru_table could not be determined
* @return array
*/
protected function parseRelationOptions($type, $name, $options) {
if (!$options['class_name']) {
throw new Exception('Option class_name not set for relation ' . $name);
}
if (!$options['assoc_foreign_key']) {
if ($type === 'has_many' || $type === 'has_one') {
$options['assoc_foreign_key'] = $this->pk[0];
} else if ($type === 'belongs_to') {
$options['assoc_foreign_key'] = 'id';
}
}
if ($type === 'has_and_belongs_to_many') {
$thru_table = $options['thru_table'];
if (!$options['thru_key']) {
$options['thru_key'] = $this->pk[0];
}
if (!$options['thru_assoc_key'] || !$options['assoc_foreign_key']) {
$class = $options['class_name'];
$record = new $class();
$meta = $record->getTableMetadata();
if (!$options['thru_assoc_key'] ) {
$options['thru_assoc_key'] = $meta['pk'][0];
}
if (!$options['assoc_foreign_key']) {
$options['assoc_foreign_key']= $meta['pk'][0];
}
}
static::tableScheme($thru_table);
if (is_array(self::$schemes[$thru_table])) {
$thru_key_ok = isset(self::$schemes[$thru_table]['db_fields'][$options['thru_key']]);
$thru_assoc_key_ok = isset(self::$schemes[$thru_table]['db_fields'][$options['thru_assoc_key']]);
}
if (!$thru_assoc_key_ok || !$thru_key_ok) {
throw new Exception("Could not determine keys for relation " . $name . " through table " . $thru_table);
}
if ($options['assoc_foreign_key'] instanceof Closure) {
throw new Exception("For relation " . $name . " assoc_foreign_key must be a name of a column");
}
}
if (!$options['assoc_func']) {
if ($type !== 'has_and_belongs_to_many') {
$options['assoc_func'] = $options['assoc_foreign_key'] === 'id' ? 'find' : 'findBy' . $options['assoc_foreign_key'];
} else {
$options['assoc_func'] = 'findThru';
}
}
if (!$options['foreign_key']) {
$options['foreign_key'] = 'id';
}
if ($options['foreign_key'] instanceof Closure) {
$options['assoc_func_params_func'] = function($record) use ($name, $options) { return call_user_func($options['foreign_key'], $record, $name, $options);};
} else {
$options['assoc_func_params_func'] = function($record) use ($name, $options) { return $options['foreign_key'] === 'id' ? $record->getId() : $record->getValue($options['foreign_key']);};
}
if ($options['assoc_foreign_key'] instanceof Closure) {
if ($type === 'belongs_to') {
$options['assoc_foreign_key_getter'] = function($record, $that) use ($name, $options) { return call_user_func($options['assoc_foreign_key'], $record, $name, $options, $that);};
} else {
$options['assoc_foreign_key_setter'] = function($record, $params) use ($name, $options) { return call_user_func($options['assoc_foreign_key'], $record, $params, $name, $options);};
}
} elseif ($options['assoc_foreign_key']) {
if ($type === 'belongs_to') {
$options['assoc_foreign_key_getter'] = function($record, $that) use ($name, $options) { return $record->getValue($options['assoc_foreign_key']);};
} else {
$options['assoc_foreign_key_setter'] = function($record, $value) use ($name, $options) { return $record->setValue($options['assoc_foreign_key'], $value);};
}
} else {
throw new Exception("Could not determine assoc_foreign_key for relation " . $name);
}
return $options;
}
/**
* returns array with option for given relation
* available options:
* 'type': relation type, on of 'has_many', 'belongs_to', 'has_one', 'has_and_belongs_to_many'
* 'class_name': name of class for related records
* 'foreign_key': name of column with foreign key
* or callback to retrieve foreign key value
* 'assoc_foreign_key': name of foreign key column in related class
* 'assoc_func': name of static method to call on related class to find related records
* 'assoc_func_params_func': callback to retrieve params for assoc_func
* 'thru_table': name of relation table for n:m relation
* 'thru_key': name of column holding foreign key in relation table
* 'thru_assoc_key': name of column holding foreign key from related class in relation table
* 'on_delete': contains simply 'delete' to indicate that related records should be deleted
* or callback to invoke before record gets deleted
* 'on_store': contains simply 'store' to indicate that related records should be stored
* or callback to invoke after record gets stored
*
* @param string $relation name of relation
* @return array assoc array containing options
*/
function getRelationOptions($relation)
{
$options = [];
foreach(['has_many', 'belongs_to', 'has_one', 'has_and_belongs_to_many'] as $type) {
if (isset($this->{$type}[$relation])) {
$options = self::$config[get_class($this)][$type][$relation] ?: $this->{$type}[$relation];
if (!isset($options['type'])) {
$options = $this->parseRelationOptions($type, $relation, $options, $this->db_table);
$options['type'] = $type;
self::$config[get_class($this)][$type][$relation] = $options;
$this->{$type}[$relation] = $options;
}
break;
}
}
return $options;
}
/**
* returns table and columns metadata
*
* @return array assoc array with columns, primary keys and name of table
*/
function getTableMetadata()
{
return ['fields' => $this->db_fields,
'pk' => $this->pk,
'table' => $this->db_table,
'additional_fields' => $this->additional_fields,
'alias_fields' => $this->alias_fields,
'relations' => array_keys($this->relations)];
}
/**
* returns true, if table has an auto_increment column
*
* @return boolean
*/
function hasAutoIncrementColumn()
{
return $this->db_fields[$this->pk[0]]['extra'] == 'auto_increment';
}
/**
* set primary key for entry, combined keys must be passed as array
* @param string|array primary key
* @throws InvalidArgumentException if given key is not complete
* @return boolean
*/
public function setId($id)
{
if (!is_array($id)){
$id = [$id];
}
if (count($this->pk) != count($id)){
throw new InvalidArgumentException("Invalid ID, Primary Key {$this->db_table} is " .join(",",$this->pk));
} else {
foreach ($this->pk as $count => $key){
$this->content[$key] = $id[$count];
}
return true;
}
return false;
}
/**
* returns primary key, multiple keys as array
* @return string|array current primary key, null if not set
*/
function getId()
{
if (count($this->pk) == 1) {
return $this->content[$this->pk[0]];
} else {
$id = [];
foreach ($this->pk as $key) {
if ($this->content[$key] !== null) {
$id[] = $this->content[$key];
}
}
return (count($this->pk) == count($id) ? $id : null);
}
}
/**
* create new unique pk as md5 hash
* if pk consists of multiple columns, false is returned
* @return boolean|string
*/
function getNewId()
{
$id = false;
if (count($this->pk) == 1) {
do {
$id = md5(uniqid($this->db_table,1));
$db = DBManager::get()->query("SELECT `{$this->pk[0]}` FROM `{$this->db_table}` "
. "WHERE `{$this->pk[0]}` = '$id'");
} while($db->fetch());
}
return $id;
}
/**
* returns data of table row as assoc array
* pass array of fieldnames or ws separated string to limit
* fields
*
* @param mixed $only_these_fields limit returned fields
* @return array
*/
function toArray($only_these_fields = null)
{
$ret = [];
if (is_string($only_these_fields)) {
$only_these_fields = words($only_these_fields);
}
$fields = array_diff($this->known_slots, array_keys($this->relations));
if (is_array($only_these_fields)) {
$only_these_fields = array_filter(array_map(function($s) {
return is_string($s) ? strtolower($s) : null;
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
}, $only_these_fields));
$fields = array_intersect($only_these_fields, $fields);
}
foreach ($fields as $field) {
$ret[$field] = $this->getValue($field);
if ($ret[$field] instanceof StudipArrayObject) {
$ret[$field] = $ret[$field]->getArrayCopy();
}
}
return $ret;
}
/**
* Returns data of table row as assoc array with raw contents like
* they are in the database.
* Pass array of fieldnames or ws separated string to limit
* fields.
*
* @param mixed $only_these_fields
* @return array
*/
function toRawArray($only_these_fields = null)
{
$ret = [];
if (is_string($only_these_fields)) {
$only_these_fields = words($only_these_fields);
}
$fields = array_keys($this->db_fields);
if (is_array($only_these_fields)) {
$only_these_fields = array_filter(array_map(function ($s) {
return is_string($s) ? strtolower($s) : null;
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
}, $only_these_fields));
$fields = array_intersect($only_these_fields, $fields);
}
foreach ($fields as $field) {
if ($this->content[$field] instanceof I18NString) {
$ret[$field] = $this->content[$field]->original();
} elseif ($this->content[$field] === null) {
$ret[$field] = null;
} else {
$ret[$field] = (string)$this->content[$field];
}
}
return $ret;
}
/**
* returns data of table row as assoc array
* including related records with a 'has*' relationship
* recurses one level without param
*
* $only_these_fields limits output for relationships in this way:
* $only_these_fields = array('field_1',
* 'field_2',
* 'relation1',
* 'relation2' => array('rel2_f1',
* 'rel2_f2',
* 'rel2_rel11' => array(
* rel2_rel1_f1)
* )
* )
* Here all fields of relation1 will be returned.
*
* @param mixed $only_these_fields limit returned fields
* @return array
*/
function toArrayRecursive($only_these_fields = null)
{
if (is_string($only_these_fields)) {
$only_these_fields = words($only_these_fields);
}
if (is_null($only_these_fields)) {
$only_these_fields = $this->known_slots;
}
$ret = $this->toArray($only_these_fields);
$relations = [];
if (is_array($only_these_fields)) {
foreach ($only_these_fields as $key => $value) {
if (!is_array($value) &&
array_key_exists(strtolower($value), $this->relations)
) {
$relations[strtolower($value)] = 0; //not null|array|string to stop recursion
if (array_key_exists(strtolower($key), $this->relations)) {
$relations[strtolower($key)] = $value;
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
}
}
}
if (count($relations)) {
foreach ($relations as $relation_name => $relation_only_these_fields) {
$options = $this->getRelationOptions($relation_name);
if ($options['type'] === 'has_one' ||
$options['type'] === 'belongs_to') {
$ret[$relation_name] =
$this->{$relation_name}->
toArrayRecursive($relation_only_these_fields);
}
if ($options['type'] === 'has_many' ||
$options['type'] === 'has_and_belongs_to_many') {
$ret[$relation_name] =
$this->{$relation_name}->
sendMessage('toArrayRecursive',
[$relation_only_these_fields]);
}
}
}
return $ret;
}
/**
* returns value of a column
*
* @throws InvalidArgumentException if column could not be found
* @throws BadMethodCallException if getter for additional field could not be found
* @param string $field
* @return null|string|SimpleORMapCollection
*/
public function getValue($field)
{
$field = strtolower($field);
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
// No value defined, throw exception
if (!in_array($field, $this->known_slots)) {
throw new InvalidArgumentException(static::class . '::'.$field . ' not found.');
}
// Get value by getter
if (isset($this->getter_setter_map[$field]['get'])) {
return call_user_func([$this, $this->getter_setter_map[$field]['get']]);
}
// Get value from content
if (array_key_exists($field, $this->content)) {
return $this->content[$field];
}
// Get value from relation
if (array_key_exists($field, $this->relations)) {
$this->initRelation($field);
return $this->relations[$field];
}
// Get value from additional_field
if (isset($this->additional_fields[$field]['get'])) {
// Getter is defined as a closure
if ($this->additional_fields[$field]['get'] instanceof Closure) {
return call_user_func_array($this->additional_fields[$field]['get'], [$this, $field]);
}
// Getter is defined as a method of this object
return call_user_func([$this, $this->additional_fields[$field]['get']], $field);
}
// No value found, throw exception
throw new RuntimeException('No value could be found for ' . static::class . '::' . $field);
}
/**
* gets a value from a related object
* only possible, if the relation has cardinality 1
* e.g. 'has_one' or 'belongs_to'
*
* @param string $relation name of relation
* @param string $field name of column
* @throws InvalidArgumentException if no relation with given name is found
* @return mixed the value from the related object
*/
function getRelationValue($relation, $field)
{
$field = strtolower($field);
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
1424
$options = $this->getRelationOptions($relation);
if ($options['type'] === 'has_one' || $options['type'] === 'belongs_to') {
return $this->{$relation}->{$field};
} else {
throw new InvalidArgumentException('Relation ' . $relation . ' not found or not applicable.');
}
}
/**
* returns default value for column
*
* @param string $field name of column
* @return mixed the default value
*/
function getDefaultValue($field)
{
$default_value = null;
if (!isset($this->default_values[$field])) {
if (!in_array($field, $this->pk)) {
$meta = $this->db_fields[$field];
if (isset($meta['default'])) {
$default_value = $meta['default'];
} elseif ($meta['null'] == 'NO') {
if (strpos($meta['type'], 'text') !== false || strpos($meta['type'], 'char') !== false) {
if (strpos($meta['type'], 'int') !== false) {
1429
1430
1431
1432
1433
1434
1435
1436
1437
1438
1439
1440
1441
1442
1443
1444
1445
1446
1447
1448
1449
$default_value = '0';
}
}
}
} else {
$default_value = $this->default_values[$field];
}
return $default_value;
}
/**
* sets value of a column
*
* @throws InvalidArgumentException if column could not be found
* @throws BadMethodCallException if setter for additional field could not be found
* @param string $field
* @param string $value
* @return string
*/
function setValue($field, $value)
{
$field = strtolower($field);
1451
1452
1453
1454
1455
1456
1457
1458
1459
1460
1461
1462
1463
1464
1465
1466
1467
1468
1469
1470
1471
1472
1473
1474
1475
1476
1477
1478
1479
1480
1481
1482
1483
1484
1485
1486
1487
1488
1489
1490
1491
1492
1493
1494
1495
1496
1497
1498
1499
1500
1501
1502
1503
1504
1505
1506
1507
1508
1509
1510
1511
1512
1513
1514
1515
1516
1517
1518
1519
1520
1521
1522
1523
1524
1525
1526
1527
1528
1529
1530
1531
1532
1533
1534
1535
1536
1537
1538
1539
1540
1541
1542
1543
1544
1545
$ret = false;
if (in_array($field, $this->known_slots)) {
if (isset($this->getter_setter_map[$field]['set'])) {
return call_user_func([$this, $this->getter_setter_map[$field]['set']], $value);
}
if (array_key_exists($field, $this->content)) {
if (array_key_exists($field, $this->serialized_fields)) {
$ret = $this->setSerializedValue($field, $value);
} elseif ($this->isI18nField($field)) {
$ret = $this->setI18nValue($field, $value);
} else {
$ret = ($this->content[$field] = $value);
}
} elseif (isset($this->additional_fields[$field]['set'])) {
if ($this->additional_fields[$field]['set'] instanceof Closure) {
return call_user_func_array($this->additional_fields[$field]['set'], [$this, $field, $value]);
} else {
return call_user_func([$this, $this->additional_fields[$field]['set']], $field, $value);
}
} elseif (array_key_exists($field, $this->relations)) {
$options = $this->getRelationOptions($field);
if ($options['type'] === 'has_one' || $options['type'] === 'belongs_to') {
if (is_a($value, $options['class_name'])) {
$this->relations[$field] = $value;
if ($options['type'] == 'has_one') {
$foreign_key_value = call_user_func($options['assoc_func_params_func'], $this);
call_user_func($options['assoc_foreign_key_setter'], $value, $foreign_key_value);
} else {
$assoc_foreign_key_value = call_user_func($options['assoc_foreign_key_getter'], $value, $this);
if ($assoc_foreign_key_value === null) {
throw new InvalidArgumentException(sprintf('trying to set belongs_to object of type: %s, but assoc_foreign_key: %s is null', get_class($value), $options['assoc_foreign_key']));
}
$this->setValue($options['foreign_key'], $assoc_foreign_key_value);
}
} else {
throw new InvalidArgumentException(sprintf('relation %s expects object of type: %s', $field, $options['class_name']));
}
}
if ($options['type'] == 'has_many' || $options['type'] == 'has_and_belongs_to_many') {
if (is_array($value) || $value instanceof Traversable) {
$new_ids = [];
$old_ids = $this->{$field}->pluck('id');
foreach ($value as $current) {
if (!is_a($current, $options['class_name'])) {
throw new InvalidArgumentException(sprintf('relation %s expects object of type: %s', $field, $options['class_name']));
}
if ($options['type'] == 'has_many') {
$foreign_key_value = call_user_func($options['assoc_func_params_func'], $this);
call_user_func($options['assoc_foreign_key_setter'], $current, $foreign_key_value);
}
if ($current->id !== null) {
$new_ids[] = $current->id;
$existing = $this->{$field}->find($current->id);
if ($existing) {
$existing->setData($current);
} else {
$this->{$field}->append($current);
}
} else {
$this->{$field}->append($current);
}
}
foreach (array_diff($old_ids, $new_ids) as $to_delete) {
$this->{$field}->unsetByPK($to_delete);
}
} else {
throw new InvalidArgumentException(sprintf('relation %s expects collection or array of objects of type: %s', $field, $options['class_name']));
}
}
}
} else {
throw new InvalidArgumentException(get_class($this) . '::'. $field . ' not found.');
}
return $ret;
}
/**
* magic method for dynamic properties
*/
function __get($field)
{
return $this->getValue($field);
}
/**
* magic method for dynamic properties
*/
function __set($field, $value)
{
return $this->setValue($field, $value);
}
/**
* magic method for dynamic properties
*/
function __isset($field)
{
$field = strtolower($field);
1547
1548
1549
1550
1551
1552
1553
1554
1555
1556
1557
1558
1559
1560
1561
1562
1563
1564
1565
1566
1567
1568
1569
1570
1571
1572
1573
1574
1575
1576
1577
1578
1579
1580
1581
1582
1583
1584
1585
1586
1587
1588
1589
1590
1591
1592
1593
1594
1595
1596
1597
1598
1599
1600
1601
1602
1603
1604
1605
if (in_array($field, $this->known_slots)) {
$value = $this->getValue($field);
return $value instanceOf SimpleORMapCollection ? (bool)count($value) : !is_null($value);
} else {
return false;
}
}
/**
* ArrayAccess: Check whether the given offset exists.
*/
public function offsetExists($offset)
{
return $this->__isset($offset);
}
/**
* ArrayAccess: Get the value at the given offset.
*/
public function offsetGet($offset)
{
return $this->getValue($offset);
}
/**
* ArrayAccess: Set the value at the given offset.
*/
public function offsetSet($offset, $value)
{
$this->setValue($offset, $value);
}
/**
* ArrayAccess: unset the value at the given offset (not applicable)
*/
public function offsetUnset($offset)
{
}
/**
* IteratorAggregate
*/
public function getIterator()
{
return new ArrayIterator($this->toArray());
}
/**
* Countable
*/
public function count()
{
return count($this->known_slots) - count($this->relations);
}
/**
* check if given column exists in table
* @param string $field
* @return boolean
*/
function isField($field)
{
$field = strtolower($field);
return isset($this->db_fields[$field]);
}
/**
* check if given column is additional
* @param string $field
* @return boolean
*/
function isAdditionalField($field)
{
$field = strtolower($field);
return isset($this->additional_fields[$field]);
}
/**
* check if given column is an alias
* @param string $field
* @return boolean
*/
function isAliasField($field)
{
$field = strtolower($field);
return isset($this->alias_fields[$field]);
}
/**
* check if given column is a multi-language field
* @param string $field
* @return boolean
*/
function isI18nField($field)
{
$field = strtolower($field);
1640
1641
1642
1643
1644
1645
1646
1647
1648
1649
1650
1651
1652
1653
1654
1655
1656
1657
1658
1659
1660
1661
1662
1663
return isset($this->i18n_fields[$field]);
}
/**
* set multiple column values
* if second param is set, existing data in object will be
* discarded and dirty state is cleared,
* else new data overrides old data
*
* @param array $data assoc array
* @param boolean $reset existing data in object will be discarded
* @return number of columns changed
*/
function setData($data, $reset = false)
{
$count = 0;
if ($reset) {
if ($this->applyCallbacks('before_initialize') === false) {
return false;
}
$this->initializeContent();
}
if (is_array($data) || $data instanceof Traversable) {
foreach($data as $key => $value) {
$key = strtolower($key);
if (isset($this->db_fields[$key])
|| isset($this->alias_fields[$key])
|| isset($this->additional_fields[$key]['set'])
) {
1669
1670
1671
1672
1673
1674
1675
1676
1677
1678
1679
1680
1681
1682
1683
1684
1685
1686
1687
1688
1689
1690
1691
1692
1693
1694
1695
1696
1697
1698
1699
1700
1701
1702
1703
1704
1705
1706
1707
1708
1709
1710
1711
1712
1713
1714
1715
1716
1717
1718
1719
1720
1721
1722
1723
1724
1725
1726
1727
1728
1729
1730
1731
1732
1733
1734
1735
1736
1737
1738
1739
1740
1741
1742
1743
1744
1745
1746
1747
1748
1749
1750
1751
1752
1753
1754
1755
1756
1757
1758
1759
1760
1761
1762
1763
1764
1765
1766
1767
1768
1769
1770
1771
1772
1773
1774
1775
1776
1777
1778
1779
1780
1781
1782
1783
1784
1785
1786
1787
1788
1789
1790
1791
1792
1793
1794
1795
1796
1797
1798
1799
1800
1801
1802
1803
1804
1805
1806
1807
1808
1809
1810
1811
1812
1813
1814
1815
1816
1817
1818
1819
1820
1821
1822
1823
1824
1825
1826
1827
1828
1829
1830
1831
1832
1833
1834
1835
1836
1837
1838
1839
1840
1841
1842
1843
1844
1845
1846
1847
1848
1849
$this->setValue($key, $value);
++$count;
}
}
}
if ($reset) {
$this->applyCallbacks('after_initialize');
}
return $count;
}
/**
* check if object exists in database
* @return boolean
*/
function isNew()
{
return $this->is_new;
}
/**
* check if object was deleted
*
* @return boolean
*/
function isDeleted()
{
return $this->is_deleted;
}
/**
* set object to new state
* @param boolean $is_new
* @return boolean
*/
function setNew($is_new)
{
return $this->is_new = $is_new;
}
/**
* returns sql clause with current table and pk
* @return boolean|string
*/
function getWhereQuery()
{
$where_query = null;
$pk_not_set = [];
foreach ($this->pk as $key) {
$pk = $this->content_db[$key] ?: $this->content[$key];
if (isset($pk)) {
$where_query[] = "`{$this->db_table}`.`{$key}` = " . DBManager::get()->quote($pk);
} else {
$pk_not_set[] = $key;
}
}
if (!$where_query || count($pk_not_set)){
if ($this->isNew()) {
return false;
} else {
throw new UnexpectedValueException(sprintf("primary key incomplete: %s must not be null", join(',',$pk_not_set)));
}
}
return $where_query;
}
/**
* restore entry from database
* @return boolean
*/
function restore()
{
$where_query = $this->getWhereQuery();
if ($where_query) {
if ($this->applyCallbacks('before_initialize') === false) {
return false;
}
$id = $this->getId();
$this->initializeContent();
$query = "SELECT * FROM `{$this->db_table}` WHERE "
. join(" AND ", $where_query);
$st = DBManager::get()->prepare($query);
$st->execute();
$st->setFetchMode(PDO::FETCH_INTO , $this);
if ($st->fetch()) {
$this->setNew(false);
$this->applyCallbacks('after_initialize');
return true;
}
}
$this->setData([], true);
$this->setNew(true);
if (isset($id)) {
$this->setId($id);
}
return false;
}
/**
* store entry in database
*
* @throws UnexpectedValueException if there are forbidden NULL values
* @return number|boolean
*/
function store()
{
if ($this->applyCallbacks('before_store') === false) {
return false;
}
if (!$this->isDeleted() && ($this->isDirty() || $this->isNew())) {
if ($this->isNew()) {
if ($this->applyCallbacks('before_create') === false) {
return false;
}
} else {
if ($this->applyCallbacks('before_update') === false) {
return false;
}
}
foreach ($this->db_fields as $field => $meta) {
$value = $this->content[$field];
if ($field == 'chdate' && !$this->isFieldDirty($field) && $this->isDirty()) {
$value = time();
}
if ($field == 'mkdate') {
if ($this->isNew()) {
if (!$this->isFieldDirty($field)) {
$value = time();
}
} else {
continue;
}
}
if ($value === null && $meta['null'] == 'NO') {
throw new UnexpectedValueException($this->db_table . '.' . $field . ' must not be null.');
}
if (is_float($value)) {
$value = str_replace(',', '.', $value);
}
$this->content[$field] = $value;
$query_part[] = "`$field` = " . DBManager::get()->quote($value) . " ";
}
if (!$this->isNew()) {
$where_query = $this->getWhereQuery();
$query = "UPDATE `{$this->db_table}` SET "
. implode(',', $query_part);
$query .= " WHERE " . join(" AND ", $where_query);
} else {
$query = "INSERT INTO `{$this->db_table}` SET "
. implode(',', $query_part);
}
$ret = DBManager::get()->exec($query);
if ($this->isNew()) {
$this->applyCallbacks('after_create');
} else {
$this->applyCallbacks('after_update');
}
}
$rel_ret = $this->storeRelations();
$this->applyCallbacks('after_store');
if ($ret || $rel_ret) {
$this->restore();
}
return $ret + $rel_ret;
}
/**
* sends a store message to all initialized related objects
* if a relation has a callback for 'on_store' configured, the callback
* is instead invoked
*
* @return number addition of all return values, false if none was called
*/
protected function storeRelations($only_these = null)
{
$ret = false;
if (is_string($only_these)) {
$only_these = words($only_these);
}
$relations = array_keys($this->relations);
if (is_array($only_these)) {
$only_these = array_filter(array_map(function ($s) {
return is_string($s) ? strtolower($s) : null;
1852
1853
1854
1855
1856
1857
1858
1859
1860
1861
1862
1863
1864
1865
1866
1867
1868
1869
1870
1871
1872
1873
1874
1875
1876
1877
1878
1879
1880
1881
1882
1883
1884
1885
1886
1887
1888
1889
1890
1891
1892
1893
1894
1895
1896
1897
1898
1899
1900
1901
1902
1903
1904
1905
1906
1907
1908
1909
1910
1911
1912
1913
1914
1915
1916
1917
1918
1919
1920
1921
1922
1923
1924
1925
1926
1927
1928
1929
1930
1931
1932
1933
1934
1935
1936
1937
1938
1939
1940
1941
1942
1943
1944
1945
1946
1947
1948
1949
1950
1951
1952
1953
1954
1955
1956
1957
1958
1959
1960
1961
1962
1963
1964
1965
1966
1967
1968
1969
1970
1971
1972
1973
1974
1975
1976
1977
1978
1979
1980
1981
1982
1983
1984
1985
1986
1987
1988
1989
1990
1991
1992
1993
1994
1995
1996
1997
1998
1999
2000
}, $only_these));
$relations = array_intersect($only_these, $relations);
}
foreach ($relations as $relation) {
$options = $this->getRelationOptions($relation);
if (isset($options['on_store']) &&
($options['type'] === 'has_one' ||
$options['type'] === 'has_many' ||
$options['type'] === 'has_and_belongs_to_many')) {
if ($options['on_store'] instanceof Closure) {
$ret += call_user_func($options['on_store'], $this, $relation);
} elseif (isset($this->relations[$relation])) {
$foreign_key_value = call_user_func($options['assoc_func_params_func'], $this);
if ($options['type'] === 'has_one') {
call_user_func($options['assoc_foreign_key_setter'], $this->{$relation}, $foreign_key_value);
$ret = call_user_func([$this->{$relation}, 'store']);
} elseif ($options['type'] === 'has_many') {
foreach ($this->{$relation} as $r) {
call_user_func($options['assoc_foreign_key_setter'], $r, $foreign_key_value);
}
$ret += array_sum(call_user_func([$this->{$relation}, 'sendMessage'], 'store'));
$ret += array_sum(call_user_func([$this->{$relation}->getDeleted(), 'sendMessage'], 'delete'));
} else {
call_user_func([$this->{$relation}, 'sendMessage'], 'store');
$to_delete = array_filter($this->{$relation}->getDeleted()->pluck($options['assoc_foreign_key']));
$to_insert = array_filter($this->{$relation}->pluck($options['assoc_foreign_key']));
$sql = "DELETE FROM `" . $options['thru_table'] ."` WHERE `" . $options['thru_key'] ."` = ? AND `" . $options['thru_assoc_key'] . "` = ?";
$st = DBManager::get()->prepare($sql);
foreach ($to_delete as $one_value) {
$st->execute([$foreign_key_value, $one_value]);
$ret += $st->rowCount();
}
$sql = "INSERT IGNORE INTO `" . $options['thru_table'] ."` SET `" . $options['thru_key'] ."` = ?, `" . $options['thru_assoc_key'] . "` = ?";
$st = DBManager::get()->prepare($sql);
foreach ($to_insert as $one_value) {
$st->execute([$foreign_key_value, $one_value]);
$ret += $st->rowCount();
}
}
}
}
}
return $ret;
}
/**
* set chdate column to current timestamp
* @return boolean
*/
function triggerChdate()
{
if ($this->db_fields['chdate']) {
$this->content['chdate'] = time();
if ($where_query = $this->getWhereQuery()) {
DBManager::get()->exec("UPDATE `{$this->db_table}` SET chdate={$this->content['chdate']}
WHERE ". join(" AND ", $where_query));
return true;
}
} else {
return false;
}
}
/**
* delete entry from database
* the object is cleared, but is not(!) turned to new state
* @return int number of deleted rows
*/
function delete()
{
$ret = false;
if (!$this->isDeleted() && !$this->isNew()) {
if ($this->applyCallbacks('before_delete') === false) {
return false;
}
$ret = $this->deleteRelations();
$where_query = $this->getWhereQuery();
if ($where_query) {
$query = "DELETE FROM `{$this->db_table}` WHERE "
. join(" AND ", $where_query);
$ret += DBManager::get()->exec($query);
}
$this->is_deleted = true;
$this->applyCallbacks('after_delete');
}
$this->setData([], true);
return $ret;
}
/**
* sends a delete message to all related objects
* if a relation has a callback for 'on_delete' configured, the callback
* is invoked instead
*
* @return number addition of all return values, false if none was called
*/
protected function deleteRelations()
{
$ret = false;
foreach (array_keys($this->relations) as $relation) {
$options = $this->getRelationOptions($relation);
if (isset($options['on_delete']) &&
($options['type'] === 'has_one' ||
$options['type'] === 'has_many' ||
$options['type'] === 'has_and_belongs_to_many')) {
if ($options['on_delete'] instanceof Closure) {
$ret += call_user_func($options['on_delete'], $this, $relation);
} else {
if ($options['type'] === 'has_one' || $options['type'] === 'has_many') {
$this->initRelation($relation);
if (isset($this->relations[$relation])) {
if ($options['type'] === 'has_one') {
$ret += call_user_func([$this->{$relation}, 'delete']);
} elseif ($options['type'] === 'has_many') {
$ret += array_sum(call_user_func([$this->{$relation}, 'sendMessage'], 'delete'));
}
}
} else {
$foreign_key_value = call_user_func($options['assoc_func_params_func'], $this);
$sql = "DELETE FROM `" . $options['thru_table'] ."` WHERE `" . $options['thru_key'] ."` = ?";
$st = DBManager::get()->prepare($sql);
$st->execute([$foreign_key_value]);
$ret += $st->rowCount();
}
}
$this->relations[$relation] = null;
}
}
return $ret;
}
/**
* init internal content arrays with nulls or defaults
*
* @throws UnexpectedValueException if there is an unmatched alias
*/
protected function initializeContent()
{
$this->content = [];
foreach (array_keys($this->db_fields) as $field) {
$this->content[$field] = null;
$this->content_db[$field] = null;
$this->setValue($field, $this->getDefaultValue($field));
}
foreach ($this->alias_fields as $alias => $field) {
if (isset($this->db_fields[$field])) {
$this->content[$alias] =& $this->content[$field];
$this->content_db[$alias] =& $this->content_db[$field];
} else {