/**
* The actual legacy defs converter. For list it is simply taking the old
* def array, looping over it, lowercasing the field names, adding that to
* each iteration and saving that into a 'fields' array inside of the panels
* array.
*/
public function convertLegacyViewDefsToSidecar()
{
$this->logUpgradeStatus('Converting ' . $this->client . ' list view defs for ' . $this->module);
if (empty($this->legacyViewdefs)) {
$this->logUpgradeStatus('Empty metadata, doing nothing');
return false;
}
// Get the default defs so that data can be merged as needed
$defaults = $this->loadDefaultMetadata();
$defaults = $this->setDefaultsByKey($defaults);
// Now get to the converting
$newdefs = array();
foreach ($this->legacyViewdefs as $field => $def) {
if (!$this->isValidField($field)) {
continue;
}
$defs = array();
$defs['name'] = strtolower($field);
unset($def['name']);
// Prevents old defs from overriding the new
// Bug 57414 - Available fields of mobile listview shown under
// default fields list after upgrade
// For portal upgrades:
// - Default should be true by virtue of the field being in the viewdefs
// For mobile upgrades:
// - Default is true if default was set truthy before
// For both platforms:
// - enabled is true if it was not set before, or if it was set to true
if ($this->client == 'portal') {
$defs['default'] = true;
} else {
if (isset($def['default'])) {
// If it was set in the mobile metadata, use that (bool) value
$defs['default'] = AbstractMetaDataParser::isTruthy($def['default']);
unset($def['default']);
// remove to prevent overriding in merge
} else {
// Was not set, so it is not default. This allows a field to
// be available without being default
$defs['default'] = false;
}
}
// Enabled is almost always true by virtue of this field being in the defs
if (!isset($def['enabled'])) {
$defs['enabled'] = true;
} else {
// This will more than likely never run, but you never know
// If somehow the field was marked enabled in a non truthy way...
$defs['enabled'] = AbstractMetaDataParser::isTruthy($def['enabled']);
unset($def['enabled']);
// unsetting to prevent clash in merge
}
// Merge the rest of the defs
$defs = array_merge($defs, $def);
// Merge the new defs into the defaults
if (isset($defaults[$defs['name']])) {
$defs = array_merge($defaults[$defs['name']], $defs);
}
// Remove module from the defs since the app doesn't like that
unset($defs['module']);
// Some MergeTemplate merges leave type for fields like team_name as relate
// ignoring custom_type. We can't fix it there so we fix it here.
// Since list takes def from vardef anyway, we can delete type if it matches vardef
// See BR-1402
if (!empty($defs['type']) && !empty($this->field_defs) && !empty($this->field_defs[$field]['type']) && $defs['type'] == $this->field_defs[$field]['type']) {
unset($defs['type']);
}
$newdefs[] = $defs;
}
$this->logUpgradeStatus("view defs converted, getting normalized module name");
// This is the structure of the sidecar list meta
$module = $this->getNormalizedModuleName();
$this->logUpgradeStatus("module name normalized to: {$module}");
// Clean up client to mobile for wireless clients
$client = $this->client == 'wireless' ? 'mobile' : $this->client;
$this->logUpgradeStatus("Setting new {$client} {$this->type} view defs internally for {$module}");
$this->sidecarViewdefs[$module][$client]['view']['list'] = array('panels' => array(array('label' => 'LBL_PANEL_DEFAULT', 'fields' => $newdefs)));
}
