egroupware/infolog/inc/class.infolog_merge.inc.php

259 lines
7.0 KiB
PHP

<?php
/**
* Infolog - document merge
*
* @link http://www.egroupware.org
* @author Ralf Becker <RalfBecker-AT-outdoor-training.de>
* @author Nathan Gray
* @package infolog
* @copyright (c) 2007-16 by Ralf Becker <RalfBecker-AT-outdoor-training.de>
* @copyright 2011 Nathan Gray
* @license http://opensource.org/licenses/gpl-license.php GPL - GNU General Public License
* @version $Id$
*/
use EGroupware\Api;
use EGroupware\Api\Link;
/**
* Infolog - document merge object
*/
class infolog_merge extends Api\Storage\Merge
{
/**
* Functions that can be called via menuaction
*
* @var array
*/
var $public_functions = array(
'download_by_request' => true,
'show_replacements' => true,
'merge_entries' => true,
);
/**
* Business object to pull records from
*/
protected $bo = null;
/**
* Constructor
*
*/
function __construct()
{
parent::__construct();
$this->bo = new infolog_bo();
$this->date_fields += array(
'info_startdate',
'info_enddate',
'info_datecompleted',
'info_datemodified',
'info_created',
);
// switch of handling of Api\Html formated content, if Api\Html is not used
$this->parse_html_styles = Api\Storage\Customfields::use_html('infolog');
}
/**
* Get infolog replacements
*
* @param int $id id of entry
* @param string &$content=null content to create some replacements only if they are use
* @return array|boolean
*/
protected function get_replacements($id, &$content = null)
{
if(!($replacements = $this->infolog_replacements($id, '', $content)))
{
return false;
}
return $replacements;
}
/**
* Override contact filename placeholder to use info_contact
*
* @param $document
* @param $ids
* @return array|void
*/
public function get_filename_placeholders($document, $ids)
{
$placeholders = parent::get_filename_placeholders($document, $ids);
if(count($ids) == 1 && ($info = $this->bo->read($ids[0])))
{
$placeholders['$$contact_title$$'] = $info['info_contact']['title'] ??
(is_array($info['info_contact']) && Link::title($info['info_contact']['app'], $info['info_contact']['id'])) ??
'';
}
return $placeholders;
}
/**
* Get infolog replacements
*
* @param int $id id of entry
* @param string $prefix ='' prefix like eg. 'erole'
* @return array|boolean
*/
public function infolog_replacements($id, $prefix = '', &$content = '')
{
$record = new infolog_egw_record($id);
$info = array();
// Keep original value for further processing
$info_owner = $record->info_owner;
// Convert to human friendly values
$types = infolog_egw_record::$types;
// We have specific requirements for floats, we'll do them in Merge
unset($types['float']);
$_selects = $this->bo->enums + array('status' => $this->bo->status[$record->info_type]);
foreach($_selects as $name => $value)
{
$selects['info_'.$name] = $value;
if(!in_array('info_'.$name, $types['select'])) $types['select'][] = 'info_'.$name;
}
if($content && strpos($content, '$$#') !== FALSE)
{
$this->cf_link_to_expand($record->get_record_array(), $content, $info);
}
importexport_export_csv::convert($record, $types, 'infolog', $selects);
$array = $record->get_record_array();
foreach(array('info_price') as $key)
{
$array[$key] = self::number_format($array[$key],2,$this->mimetype);
}
if($record->info_contact)
{
$array['info_contact'] = $array['info_link']['title'];
}
// Set any missing custom fields, or the marker will stay
foreach($this->bo->customfields as $name => $field)
{
if (empty($array['#'.$name]))
{
$array['#'.$name] = '';
}
// Format date cfs per user Api\Preferences
if($array['#'.$name] && ($field['type'] == 'date' || $field['type'] == 'date-time'))
{
$this->date_fields[] = '#'.$name;
$array['#'.$name] = Api\DateTime::to($array['#'.$name], $field['type'] == 'date' ? true : '');
}
}
// Timesheet time
if(strpos($content, 'info_sum_timesheets'))
{
$links = Link::get_links('infolog',$id,'timesheet');
$sum = ExecMethod('timesheet.timesheet_bo.sum',$links);
$info['$$info_sum_timesheets$$'] = $sum['duration'];
}
// Check for linked project ID
$links = Link::get_links('infolog', $id, 'projectmanager');
foreach($links as $app_id)
{
$array['pm_id'] = $app_id;
$array['project'] = Link::title('projectmanager', $app_id);
break;
}
if (strpos($content, '$$project/') !== false && $array['pm_id'] && class_exists('projectmanager_merge'))
{
$pm_merge = new projectmanager_merge($array['pm_id']);
$info += $pm_merge->projectmanager_replacements($array['pm_id'],'project',$content);
}
// Add markers
foreach($array as $key => &$value)
{
if(!$value) $value = '';
$info['$$'.($prefix ? $prefix.'/':'').$key.'$$'] = $value;
}
// Links
$info += $this->get_all_links('infolog', $id, $prefix, $content);
// Add contact fields
if($array['info_link'] && is_array($array['info_link']) && $array['info_link']['app'] && $array['info_link']['id'])
{
$info += $this->get_app_replacements($array['info_link']['app'], $array['info_link']['id'], $content, 'info_contact');
}
// Add owner fields
$info += $this->contact_replacements(Api\Accounts::id2name($info_owner,'person_id'),'info_owner');
// Add parent
if($record->info_id_parent)
{
$info += $this->infolog_replacements($record->info_id_parent, 'info_id_parent', $content);
}
return $info;
}
public function get_placeholder_list($prefix = '')
{
$tracking = new infolog_tracking($this->bo);
$placeholders = array(
'infolog' => [],
lang('parent') => [],
lang($tracking->field2label['info_from']) => []
) + parent::get_placeholder_list($prefix);
$fields = array('info_id' => lang('Infolog ID'), 'pm_id' => lang('Project ID'),
'project' => lang('Project name')) + $tracking->field2label + array('info_sum_timesheets' => lang('Used time'));
Api\Translation::add_app('projectmanager');
$group = 'infolog';
foreach($fields as $name => $label)
{
if(in_array($name, array('custom')))
{
// dont show them
continue;
}
$marker = $this->prefix($prefix, $name, '{');
if(!array_filter($placeholders, function ($a) use ($marker)
{
return array_key_exists($marker, $a);
}))
{
$placeholders[$group][] = [
'value' => $marker,
'label' => $label
];
}
}
// Don't add any linked placeholders if we're not at the top level
// This avoids potential recursion
if(!$prefix)
{
// Add contact placeholders
$contact_merge = new Api\Contacts\Merge();
$contact = $contact_merge->get_placeholder_list($this->prefix($prefix, 'info_contact'));
$this->add_linked_placeholders($placeholders, lang($tracking->field2label['info_from']), $contact);
// Add parent placeholders
$this->add_linked_placeholders(
$placeholders,
lang('parent'),
$this->get_placeholder_list(($prefix ? $prefix . '/' : '') . 'info_id_parent')
);
}
else
{
unset($placeholders[lang('parent')]);
unset($placeholders[lang($tracking->field2label['info_from'])]);
}
return $placeholders;
}
}