metadatautil.inc.php
16.4 KB
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
/**
* $Id$
*
* Utility functions for retrieving information from and managing
* fieldsets with conditions.
*
* Copyright (c) 2005 Jam Warehouse http://www.jamwarehouse.com
*
* This program is free software; you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation; either version 2 of the License, or
* (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program; if not, write to the Free Software
* Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
*
* @version $Revision$
* @author Neil Blakey-Milner, Jam Warehouse (Pty) Ltd, South Africa
*/
require_once(KT_LIB_DIR . "/ktentity.inc");
require_once(KT_LIB_DIR . '/documentmanagement/MetaData.inc');
require_once(KT_LIB_DIR . '/documentmanagement/DocumentField.inc');
require_once(KT_LIB_DIR . '/metadata/valueinstance.inc.php');
require_once(KT_LIB_DIR . '/metadata/fieldset.inc.php');
require_once(KT_LIB_DIR . '/metadata/fieldbehaviour.inc.php');
class KTMetadataUtil {
function _getNextForBehaviour($oBehaviour, $aCurrentSelections) {
$oBehaviour =& KTUtil::getObject('KTFieldBehaviour', $oBehaviour);
$GLOBALS['default']->log->debug('KTMetadataUtil::_getNextForBehaviour, behaviour is ' . $oBehaviour->getId());
$aValues = KTMetadataUtil::getNextValuesForBehaviour($oBehaviour);
$iFieldId = $oBehaviour->getFieldId();
$aNextFields = KTMetadataUtil::getChildFieldIds($iFieldId);
$GLOBALS['default']->log->debug('KTMetadataUtil::_getNextForBehaviour, next fields for ' . $iFieldId . ' are: ' . print_r($aNextFields, true));
foreach ($aNextFields as $iThisFieldId) {
if (!in_array($iThisFieldId, array_keys($aCurrentSelections))) {
$GLOBALS['default']->log->debug('KTMetadataUtil::_getNextForBehaviour, field ' . $iThisFieldId . ' is not selected');
} else {
$GLOBALS['default']->log->debug('KTMetadataUtil::_getNextForBehaviour, field ' . $iThisFieldId . ' is selected');
unset($aValues[$iThisFieldId]);
$oInstance = KTValueInstance::getByLookupAndParentBehaviour($aCurrentSelections[$iThisFieldId], $oBehaviour);
$GLOBALS['default']->log->debug('KTMetadataUtil::_getNextForBehaviour, instance is ' . print_r($oInstance, true));
$oChildBehaviour =& KTFieldBehaviour::get($oInstance->getBehaviourId());
$GLOBALS['default']->log->debug('KTMetadataUtil::_getNextForBehaviour, field ' . $iThisFieldId . ' is not selected');
$aMyValues = KTMetadataUtil::_getNextForBehaviour($oChildBehaviour, $aCurrentSelections);
$GLOBALS['default']->log->debug('KTMetadataUtil::_getNextForBehaviour, values are ' . print_r($aMyValues, true));
foreach ($aMyValues as $k => $v) {
$aValues[$k] = $v;
}
}
}
$GLOBALS['default']->log->debug('KTMetadataUtil::_getNextForBehaviour, final values are ' . print_r($aValues, true));
return $aValues;
}
// {{{ getNext
/**
* Given a set of selected values (aCurrentSelections) for a given
* field set (iFieldSet), returns an array (possibly empty) with the
* keys set to newly uncovered fields, and the contents an array of
* the value instances that are available to choose in those fields.
*/
function getNext($oFieldset, $aCurrentSelections) {
$oFieldset =& KTUtil::getObject('KTFieldset', $oFieldset);
$GLOBALS['default']->log->debug('KTMetadataUtil::getNext, selections are: ' . print_r($aCurrentSelections, true));
if (empty($aCurrentSelections)) {
$oField =& DocumentField::get($oFieldset->getMasterFieldId());
return array($oField->getId() => array('field' => $oField, 'values' => $oField->getValues()));
}
$oMasterField =& DocumentField::get($oFieldset->getMasterFieldId());
$aSelectedFields = array_keys($aCurrentSelections);
$oValueInstance = KTValueInstance::getByLookupSingle($aCurrentSelections[$oMasterField->getId()]);
$aValues = KTMetadataUtil::_getNextForBehaviour($oValueInstance->getBehaviourId(), $aCurrentSelections);
$GLOBALS['default']->log->debug('KTMetadataUtil::getNext, values are ' . print_r($aValues, true));
$aReturn = array();
foreach ($aValues as $iFieldId => $aValueIds) {
$aTheseValues = array();
foreach ($aValueIds as $iLookupId) {
$aTheseValues[$iLookupId] = MetaData::get($iLookupId);
}
$aReturn[$iFieldId] = array(
'field' => DocumentField::get($iFieldId),
'values' => $aTheseValues,
);
}
return $aReturn;
}
// }}}
// {{{ getStartFields
function getMasterField($oFieldset) {
$oFieldset =& KTUtil::getObject('KTFieldset', $oFieldset);
if ($oFieldset->getMasterField()) {
return DocumentField::get($oFieldset->getMasterField());
}
}
// }}}
// {{{ removeSetsFromDocumentType
function removeSetsFromDocumentType($oDocumentType, $aFieldsets) {
if (is_object($oDocumentType)) {
$iDocumentTypeId = $oDocumentType->getId();
} else {
$iDocumentTypeId = $oDocumentType;
}
if (!is_array($aFieldsets)) {
$aFieldsets = array($aFieldsets);
}
if (empty($aFieldsets)) {
return true;
}
$aIds = array();
foreach ($aFieldsets as $oFieldset) {
if (is_object($oFieldset)) {
$iFieldsetId = $oFieldset->getId();
} else {
$iFieldsetId = $oFieldset;
}
$aIds[] = $iFieldsetId;
}
// Converts to (?, ?, ?) for query
$sParam = DBUtil::paramArray($aIds);
$aWhere = KTUtil::whereToString(array(
array('document_type_id = ?', array($iDocumentTypeId)),
array("fieldset_id IN ($sParam)", $aIds),
));
$sTable = KTUtil::getTableName('document_type_fieldsets');
$aQuery = array(
"DELETE FROM $sTable WHERE {$aWhere[0]}",
$aWhere[1],
);
return DBUtil::runQuery($aQuery);
}
// }}}
// {{{ addSetsToDocumentType
function addSetsToDocumentType($oDocumentType, $aFieldsets) {
if (is_object($oDocumentType)) {
$iDocumentTypeId = $oDocumentType->getId();
} else {
$iDocumentTypeId = $oDocumentType;
}
if (!is_array($aFieldsets)) {
$aFieldsets = array($aFieldsets);
}
$aIds = array();
foreach ($aFieldsets as $oFieldset) {
if (is_object($oFieldset)) {
$iFieldsetId = $oFieldset->getId();
} else {
$iFieldsetId = $oFieldset;
}
$aIds[] = $iFieldsetId;
}
$sTable = KTUtil::getTableName('document_type_fieldsets');
foreach ($aIds as $iId) {
$res = DBUtil::autoInsert($sTable, array(
'document_type_id' => $iDocumentTypeId,
'fieldset_id' => $iId,
));
if (PEAR::isError($res)) {
return $res;
}
}
return true;
}
// }}}
// {{{ addFieldOrder
function addFieldOrder($oParentField, $oChildField, $oFieldset) {
$iParentFieldId = KTUtil::getId($oParentField);
$iChildFieldId = KTUtil::getId($oChildField);
$iFieldsetId = KTUtil::getId($oFieldset);
$aOptions = array('noid' => true);
$sTable = KTUtil::getTableName('field_orders');
$aValues = array(
'parent_field_id' => $iParentFieldId,
'child_field_id' => $iChildFieldId,
'fieldset_id' => $iFieldsetId,
);
return DBUtil::autoInsert($sTable, $aValues, $aOptions);
}
// }}}
// {{{ removeFieldOrdering
function removeFieldOrdering($oFieldset) {
$iFieldsetId = KTUtil::getId($oFieldset);
$sTable = KTUtil::getTableName('field_orders');
$aQuery = array(
"DELETE FROM $sTable WHERE fieldset_id = ?",
array($iFieldsetId),
);
return DBUtil::runQuery($aQuery);
}
// }}}
// {{{ getParentFieldId
function getParentFieldId($oField) {
$sTable = KTUtil::getTableName('field_orders');
$aQuery = array("SELECT parent_field_id FROM $sTable WHERE child_field_id = ?",
array($oField->getId()),
);
return DBUtil::getOneResultKey($aQuery, 'parent_field_id');
}
// }}}
// {{{ getChildFieldIds
function getChildFieldIds($oField) {
$iFieldId = KTUtil::getId($oField);
$sTable = KTUtil::getTableName('field_orders');
$aQuery = array("SELECT child_field_id FROM $sTable WHERE parent_field_id = ?",
array($iFieldId),
);
return DBUtil::getResultArrayKey($aQuery, 'child_field_id');
}
// }}}
function &getOrCreateValueInstanceForLookup(&$oLookup) {
$oLookup =& KTUtil::getObject('MetaData', $oLookup);
$oValueInstance =& KTValueInstance::getByLookupSingle($oLookup);
if (PEAR::isError($oValueInstance)) {
return $oValueInstance;
}
// If we got a value instance, return it.
if (!is_null($oValueInstance)) {
return $oValueInstance;
}
return KTValueInstance::createFromArray(array(
'fieldid' => $oLookup->getDocFieldId(),
'fieldvalueid' => $oLookup->getId(),
));
}
function getNextValuesForLookup($oLookup) {
$oLookup =& KTUtil::getObject('MetaData', $oLookup);
$oInstance =& KTValueInstance::getByLookupSingle($oLookup);
if (PEAR::isError($oInstance)) {
$GLOBALS['default']->log->error('KTMetadataUtil::getNextValuesForLookup, got dud instance id, returned: ' . print_r($oInstance, true));
return $oInstance;
}
if (!is_null($oInstance) && $oInstance->getBehaviourId()) {
// if we have an instance, and we have a behaviour, return
// the actual values for that behaviour.
$oBehaviour =& KTFieldBehaviour::get($oInstance->getBehaviourId());
if (PEAR::isError($oBehaviour)) {
$GLOBALS['default']->log->error('KTMetadataUtil::getNextValuesForLookup, got dud behaviour id, returned: ' . print_r($oBehaviour, true));
return $res;
}
return KTMetadataUtil::getNextValuesForBehaviour($oBehaviour);
}
// No instance or no behaviour, so send an empty array for each
// field that we affect.
$aChildFieldIds = KTMetadataUtil::getChildFieldIds($oLookup->getDocFieldId());
if (PEAR::isError($aChildFieldIds)) {
$GLOBALS['default']->log->error('KTMetadataUtil::getNextValuesForLookup, getChildFieldIds returned: ' . print_r($aChildFieldIds, true));
return $res;
}
foreach ($aChildFieldIds as $iFieldId) {
$aValues[$iFieldId] = array();
}
return $aValues;
}
function getNextValuesForBehaviour($oBehaviour) {
$oBehaviour =& KTUtil::getObject('KTFieldBehaviour', $oBehaviour);
$aValues = array();
$sTable = KTUtil::getTableName('field_behaviour_options');
$aChildFieldIds = KTMetadataUtil::getChildFieldIds($oBehaviour->getFieldId());
foreach ($aChildFieldIds as $iFieldId) {
$aValues[$iFieldId] = array();
}
$aQuery = array(
"SELECT field_id, instance_id FROM $sTable WHERE behaviour_id = ?",
array($oBehaviour->getId()),
);
$aRows = DBUtil::getResultArray($aQuery);
if (PEAR::isError($aRows)) {
return $aRows;
}
foreach ($aRows as $aRow) {
$oInstance =& KTValueInstance::get($aRow['instance_id']);
$aValues[$aRow['field_id']][] = $oInstance->getFieldValueId();
}
return $aValues;
}
// {{{ checkConditionalFieldsetCompleteness
/**
* Checks whether a conditional fieldset has the necessary
* relationships set up to be usable - this means that for each
* field, no matter how it is reached, there is at least one option
* available to choose.
*/
function checkConditionalFieldsetCompleteness($oFieldset) {
$oFieldset =& KTUtil::getObject('KTFieldset', $oFieldset);
if ($oFieldset->getIsConditional() == false) {
// If we're not conditional, we are fine.
return true;
}
/*
* First, ensure at least one master field item has a behaviour
* assigned to it. That allows at least one item in the master
* field to be chosen.
*/
$iMasterFieldId = $oFieldset->getMasterFieldId();
$sTable = KTUtil::getTableName('field_value_instances');
$aQuery = array(
"SELECT COUNT(id) AS cnt FROM $sTable WHERE field_id = ?",
array($iMasterFieldId),
);
$iCount = DBUtil::getOneResultKey($aQuery, 'cnt');
if (PEAR::isError($iCount)) {
return $iCount;
}
$GLOBALS['default']->log->debug("Number of value instances for master field: $iCount");
if ($iCount == 0) {
$GLOBALS['default']->log->debug("Number of value instances for master field is zero, failing");
return PEAR::raiseError("Master field has no selectable values");
}
$GLOBALS['default']->log->debug("Number of value instances for master field is positive, continuing");
/*
* Plan: For each behaviour that is assigned on the system,
* ensure that it allows at least one value instance in each of
* the fields that it needs to affect.
*/
$sTable = KTUtil::getTableName('field_value_instances');
$sFieldTable = KTUtil::getTableName('document_fields');
$aQuery = array(
"SELECT DISTINCT FV.behaviour_id AS behaviour_id FROM $sTable AS FV INNER JOIN $sFieldTable AS F ON FV.field_id = F.id WHERE F.parent_fieldset = ? AND FV.behaviour_id IS NOT NULL",
array($oFieldset->getId()),
);
$aBehaviourIds = DBUtil::getResultArrayKey($aQuery, 'behaviour_id');
if (PEAR::isError($aBehaviourIds)) {
return $aBehaviourIds;
}
foreach ($aBehaviourIds as $iBehaviourId) {
$GLOBALS['default']->log->debug("Checking behaviour id: " . $iBehaviourId);
$oBehaviour =& KTFieldBehaviour::get($iBehaviourId);
$sBehaviourName = $oBehaviour->getName();
$sBehaviourHumanName = $oBehaviour->getHumanName();
$iParentFieldId = $oBehaviour->getFieldId();
$GLOBALS['default']->log->debug(" field is " . $iParentFieldId);
$aNextFields = KTMetadataUtil::getChildFieldIds($iParentFieldId);
$oParentField =& DocumentField::get($iParentFieldId);
$sParentFieldName = $oParentField->getName();
$GLOBALS['default']->log->debug(" next fields must include " . print_r($aNextFields, true));
$sTable = KTUtil::getTableName('field_behaviour_options');
$aQuery = array(
"SELECT DISTINCT field_id FROM $sTable WHERE behaviour_id = ?",
array($iBehaviourId),
);
$aFields = DBUtil::getResultArrayKey($aQuery, 'field_id');
$GLOBALS['default']->log->debug(" actual fields are " . print_r($aNextFields, true));
foreach ($aNextFields as $iFieldId) {
if (!in_array($iFieldId, $aFields)) {
$GLOBALS['default']->log->debug(" field $iFieldId is not included, failing");
$oChildField =& DocumentField::get($iFieldId);
$sChildFieldName = $oChildField->getName();
return PEAR::raiseError("Child field $sChildFieldName of parent field $sParentFieldName has no selectable values in behaviour $sBehaviourHumanName ($sBehaviourName)");
}
}
}
$GLOBALS['default']->log->debug("Got through: passed!");
return true;
}
// }}}
}
?>