/** * Bulk export: "spreadsheet" export: a simplified HTML export in which the date/time columns are split in two column: date AND time * * @copyright Copyright (C) 2015 Combodo SARL * @license http://opensource.org/licenses/AGPL-3.0 */ class SpreadsheetBulkExport extends TabularBulkExport { public function DisplayUsage(Page $oP) { $oP->p(" * spreadsheet format options:"); $oP->p(" *\tfields: (mandatory) the comma separated list of field codes to export (e.g: name,org_id,service_name...)."); $oP->p(" *\tno_localize: (optional) pass 1 to retrieve the raw (untranslated) values for enumerated fields. Default: 0."); } public function EnumFormParts() { return array_merge(parent::EnumFormParts(), array('spreadsheet_options' => array('no-localize') ,'interactive_fields_spreadsheet' => array('interactive_fields_spreadsheet'))); } public function DisplayFormPart(WebPage $oP, $sPartId) { switch($sPartId) { case 'interactive_fields_spreadsheet': $this->GetInteractiveFieldsWidget($oP, 'interactive_fields_spreadsheet'); break; case 'spreadsheet_options': $sChecked = (utils::ReadParam('no_localize', 0) == 1) ? ' checked ' : ''; $oP->add('
'.Dict::S('Core:BulkExport:SpreadsheetOptions').''); $oP->add(''); $oP->add(''); $oP->add(''); $oP->add(''); $oP->add('
'); $oP->add('
'); break; default: return parent:: DisplayFormPart($oP, $sPartId); } } public function ReadParameters() { parent::ReadParameters(); $this->aStatusInfo['localize'] = (utils::ReadParam('no_localize', 0) != 1); } protected function GetSampleData(DBObject $oObj, $sAttCode) { return $oObj->GetAsHTML($sAttCode); } public function GetHeader() { $oSet = new DBObjectSet($this->oSearch); $this->aStatusInfo['status'] = 'running'; $this->aStatusInfo['position'] = 0; $this->aStatusInfo['total'] = $oSet->Count(); $aSelectedClasses = $this->oSearch->GetSelectedClasses(); $aData = array(); foreach($this->aStatusInfo['fields'] as $sExtendedAttCode) { if (preg_match('/^([^\.]+)\.(.+)$/', $sExtendedAttCode, $aMatches)) { $sAlias = $aMatches[1]; $sAttCode = $aMatches[2]; } else { $sAlias = reset($aSelectedClasses); $sAttCode = $sExtendedAttCode; } if (!array_key_exists($sAlias, $aSelectedClasses)) { throw new Exception("Invalid alias '$sAlias' for the column '$sExtendedAttCode'. Availables aliases: '".implode("', '", array_keys($aSelectedClasses))."'"); } $sClass = $aSelectedClasses[$sAlias]; switch($sAttCode) { case 'id': if (count($aSelectedClasses) > 1) { $aData[] = $sAlias.'.id'; //@@@ } else { $aData[] = 'id'; //@@@ } break; default: $oAttDef = MetaModel::GetAttributeDef($sClass, $sAttCode); $sColLabel = $this->aStatusInfo['localize'] ? MetaModel::GetLabel($sClass, $sAttCode) : $sAttCode; $oFinalAttDef = $oAttDef->GetFinalAttDef(); if (get_class($oFinalAttDef) == 'AttributeDateTime') { if (count($aSelectedClasses) > 1) { $aData[] = $sAlias.'.'.$sColLabel.' ('.Dict::S('UI:SplitDateTime-Date').')'; $aData[] = $sAlias.'.'.$sColLabel.' ('.Dict::S('UI:SplitDateTime-Time').')'; } else { $aData[] = $sColLabel.' ('.Dict::S('UI:SplitDateTime-Date').')'; $aData[] = $sColLabel.' ('.Dict::S('UI:SplitDateTime-Time').')'; } } else { if (count($aSelectedClasses) > 1) { $aData[] = $sAlias.'.'.$sColLabel; } else { $aData[] = $sColLabel; } } } } $sData = "\n"; $sData .= "\n"; foreach($aData as $sLabel) { $sData .= "\n"; } $sData .= "\n"; return $sData; } public function GetNextChunk(&$aStatus) { $sRetCode = 'run'; $iPercentage = 0; $oSet = new DBObjectSet($this->oSearch); $aSelectedClasses = $this->oSearch->GetSelectedClasses(); $oSet->SetLimit($this->iChunkSize, $this->aStatusInfo['position']); $aAliasByField = array(); $aColumnsToLoad = array(); // Prepare the list of aliases / columns to load foreach($this->aStatusInfo['fields'] as $sExtendedAttCode) { if (preg_match('/^([^\.]+)\.(.+)$/', $sExtendedAttCode, $aMatches)) { $sAlias = $aMatches[1]; $sAttCode = $aMatches[2]; } else { $sAlias = reset($aSelectedClasses); $sAttCode = $sExtendedAttCode; } if (!array_key_exists($sAlias, $aSelectedClasses)) { throw new Exception("Invalid alias '$sAlias' for the column '$sExtendedAttCode'. Availables aliases: '".implode("', '", array_keys($aSelectedClasses))."'"); } if (!array_key_exists($sAlias, $aColumnsToLoad)) { $aColumnsToLoad[$sAlias] = array(); } if ($sAttCode != 'id') { // id is not a real attribute code and, moreover, is always loaded $aColumnsToLoad[$sAlias][] = $sAttCode; } $aAliasByField[$sExtendedAttCode] = array('alias' => $sAlias, 'attcode' => $sAttCode); } $iCount = 0; $sData = ''; $oSet->OptimizeColumnLoad($aColumnsToLoad); $iPreviousTimeLimit = ini_get('max_execution_time'); $iLoopTimeLimit = MetaModel::GetConfig()->Get('max_execution_time_per_loop'); while($aRow = $oSet->FetchAssoc()) { set_time_limit($iLoopTimeLimit); $sData .= ""; foreach($aAliasByField as $aAttCode) { $sField = ''; $oObj = $aRow[$aAttCode['alias']]; if ($oObj == null) { $sData .= ""; continue; } switch($aAttCode['attcode']) { case 'id': $sField = $oObj->GetName(); $sData .= ""; break; default: $oAttDef = MetaModel::GetAttributeDef(get_class($oObj), $aAttCode['attcode']); $oFinalAttDef = $oAttDef->GetFinalAttDef(); if (get_class($oFinalAttDef) == 'AttributeDateTime') { $iDate = AttributeDateTime::GetAsUnixSeconds($oObj->Get($aAttCode['attcode'])); $sData .= ''; // Add the first column directly $sField = date('H:i:s', $iDate); // Will add the second column below $sData .= ""; } else if($oAttDef instanceof AttributeCaseLog) { $rawValue = $oObj->Get($aAttCode['attcode']); $sField = str_replace("\n", "
", htmlentities($rawValue->__toString(), ENT_QUOTES, 'UTF-8')); // Trick for Excel: treat the content as text even if it begins with an equal sign $sData .= ""; } else { $rawValue = $oObj->Get($aAttCode['attcode']); // Due to custom formatting rules, empty friendlynames may be rendered as non-empty strings // let's fix this and make sure we render an empty string if the key == 0 if ($oAttDef instanceof AttributeFriendlyName) { $sKeyAttCode = $oAttDef->GetKeyAttCode(); if ($sKeyAttCode != 'id') { if ($oObj->Get($sKeyAttCode) == 0) { $sValue = ''; } } } if ($this->aStatusInfo['localize']) { $sField = htmlentities($oFinalAttDef->GetEditValue($rawValue), ENT_QUOTES, 'UTF-8'); } else { $sField = htmlentities($rawValue, ENT_QUOTES, 'UTF-8'); } $sData .= ""; } } } $sData .= ""; $iCount++; } set_time_limit($iPreviousTimeLimit); $this->aStatusInfo['position'] += $this->iChunkSize; if ($this->aStatusInfo['total'] == 0) { $iPercentage = 100; } else { $iPercentage = floor(min(100.0, 100.0*$this->aStatusInfo['position']/$this->aStatusInfo['total'])); } if ($iCount < $this->iChunkSize) { $sRetCode = 'done'; } $aStatus = array('code' => $sRetCode, 'message' => Dict::S('Core:BulkExport:RetrievingData'), 'percentage' => $iPercentage); return $sData; } public function GetFooter() { $sData = "
".$sLabel."
$sField$sField'.date('Y-m-d', $iDate).'$sField$sField$sField
\n"; return $sData; } public function GetSupportedFormats() { return array('spreadsheet' => Dict::S('Core:BulkExport:SpreadsheetFormat')); } public function GetMimeType() { return 'text/html'; } public function GetFileExtension() { return 'html'; } }