egroupware/timesheet/inc/class.timesheet_hooks.inc.php

278 lines
8.5 KiB
PHP
Raw Normal View History

2005-12-19 05:23:14 +01:00
<?php
/**
* TimeSheet - diverse hooks: Admin-, Preferences- and SideboxMenu-Hooks
*
* @link http://www.egroupware.org
* @author Ralf Becker <RalfBecker-AT-outdoor-training.de>
* @package timesheet
2016-04-24 15:48:45 +02:00
* @copyright (c) 2005-16 by Ralf Becker <RalfBecker-AT-outdoor-training.de>
* @license http://opensource.org/licenses/gpl-license.php GPL - GNU General Public License
* @version $Id$
*/
2005-12-19 05:23:14 +01:00
use EGroupware\Api;
use EGroupware\Api\Link;
use EGroupware\Api\Framework;
use EGroupware\Api\Egw;
use EGroupware\Api\Acl;
2005-12-19 05:23:14 +01:00
if (!defined('TIMESHEET_APP'))
{
define('TIMESHEET_APP','timesheet');
}
/**
* diverse hooks as static methods
*
*/
class timesheet_hooks
2005-12-19 05:23:14 +01:00
{
/**
* Instance of timesheet_bo class
*
* @var timesheet_bo
*/
static $timesheet_bo;
/**
* Hook called by link-class to include timesheet in the appregistry of the linkage
*
* @param array/string $location location and other parameters (not used)
* @return array with method-names
*/
static function search_link($location)
{
2016-04-24 15:48:45 +02:00
unset($location); // not used, but required by function signature
return array(
'query' => TIMESHEET_APP.'.timesheet_bo.link_query',
'title' => TIMESHEET_APP.'.timesheet_bo.link_title',
'titles'=> TIMESHEET_APP.'.timesheet_bo.link_titles',
'view' => array(
'menuaction' => TIMESHEET_APP.'.timesheet_ui.edit',
),
'view_id' => 'ts_id',
'view_popup' => '630x480',
'edit_popup' => '630x480',
'index' => array(
'menuaction' => 'timesheet.timesheet_ui.index',
),
'add' => array(
'menuaction' => TIMESHEET_APP.'.timesheet_ui.edit',
),
'add_app' => 'link_app',
'add_id' => 'link_id',
'add_popup' => '630x480',
'file_access'=> TIMESHEET_APP.'.timesheet_bo.file_access',
'file_access_user' => true, // file_access supports 4th parameter $user
'notify' => TIMESHEET_APP.'.timesheet_bo.notify',
'merge' => true,
);
}
2005-12-19 05:23:14 +01:00
/**
* Return the timesheets linked with given project(s) AND with entries of other apps, which are also linked to the same project
*
* Projectmanager will cumulate them in the other apps entries.
*
* @param array $param int/array $param['pm_id'] project-id(s)
* @return array with pm_id, pe_id, pe_app('timesheet'), pe_app_id(ts_id), other_id, other_app, other_app_id
*/
static function cumulate($param)
2005-12-19 05:23:14 +01:00
{
$links = Link::get_3links(TIMESHEET_APP,'projectmanager',$param['pm_id']);
$rows = array();
foreach($links as $link)
{
$rows[$link['id']] = array(
'pm_id' => $link['id2'],
'pe_id' => $link['id'],
'pe_app' => $link['app1'],
'pe_app_id' => $link['id1'],
'other_id' => $link['link3'],
'other_app' => $link['app3'],
'other_app_id'=> $link['id3'],
);
}
return $rows;
2005-12-19 05:23:14 +01:00
}
/**
* hooks to build projectmanager's sidebox-menu plus the admin and Api\Preferences sections
2005-12-19 05:23:14 +01:00
*
* @param string/array $args hook args
*/
static function all_hooks($args)
2005-12-19 05:23:14 +01:00
{
$appname = TIMESHEET_APP;
$location = is_array($args) ? $args['location'] : $args;
//echo "<p>ts_admin_prefs_sidebox_hooks::all_hooks(".print_r($args,True).") appname='$appname', location='$location'</p>\n";
if ($location == 'sidebox_menu')
{
// Magic etemplate2 favorites menu (from nextmatch widget)
display_sidebox($appname, lang('Favorites'), Framework\Favorites::list_favorites($appname));
2005-12-19 05:23:14 +01:00
$file = array(
'Timesheet list' => Egw::link('/index.php',array(
'menuaction' => 'timesheet.timesheet_ui.index',
'ajax' => 'true')),
array(
'text' => lang('Add %1',lang(Link::get_registry($appname, 'entry'))),
'no_lang' => true,
'link' => "javascript:egw.open('','$appname','add')"
),
2005-12-19 05:23:14 +01:00
);
$file['Placeholders'] = Egw::link('/index.php','menuaction=timesheet.timesheet_merge.show_replacements');
2005-12-19 05:23:14 +01:00
display_sidebox($appname,$GLOBALS['egw_info']['apps'][$appname]['title'].' '.lang('Menu'),$file);
}
if ($GLOBALS['egw_info']['user']['apps']['admin'])
2005-12-19 05:23:14 +01:00
{
$file = Array(
'Site Configuration' => Egw::link('/index.php','menuaction=admin.admin_config.index&appname=' . $appname,'&ajax=true'),
'Custom fields' => Egw::link('/index.php','menuaction=admin.customfields.index&appname='.$appname.'&use_private=1&ajax=true'),
'Global Categories' => Egw::link('/index.php',array(
2011-06-21 23:14:51 +02:00
'menuaction' => 'admin.admin_categories.index',
2005-12-19 05:23:14 +01:00
'appname' => $appname,
'global_cats'=> True,
'ajax' => 'true',
)),
'Edit Status' => Egw::link('/index.php','menuaction=timesheet.timesheet_ui.editstatus&ajax=true'),
2005-12-19 05:23:14 +01:00
);
if ($location == 'admin')
{
display_section($appname,$file);
}
else
{
display_sidebox($appname,lang('Admin'),$file);
}
}
}
2005-12-19 05:23:14 +01:00
/**
* populates $GLOBALS['settings'] for the Api\Preferences
2005-12-19 05:23:14 +01:00
*/
static function settings()
2005-12-19 05:23:14 +01:00
{
2011-02-04 21:03:42 +01:00
$settings = array();
if (is_null(self::$timesheet_bo)) self::$timesheet_bo = new timesheet_bo();
2011-02-04 21:03:42 +01:00
if (self::$timesheet_bo->status_labels)
{
$settings['predefined_status'] = array(
'type' => 'select',
'label' => 'Status of created timesheets',
'name' => 'predefined_status',
'values' => self::$timesheet_bo->status_labels,
'help' => 'Select the predefined status, when creating a new timesheet ',
'xmlrpc' => True,
'admin' => False,
2011-02-04 21:03:42 +01:00
);
}
// Merge print
if ($GLOBALS['egw_info']['user']['apps']['filemanager'])
{
$settings['default_document'] = array(
'type' => 'vfs_file',
2011-02-04 21:03:42 +01:00
'size' => 60,
'label' => 'Default document to insert entries',
'name' => 'default_document',
'help' => lang('If you specify a document (full vfs path) here, %1 displays an extra document icon for each entry. That icon allows to download the specified document with the data inserted.',lang('timesheet')).' '.
lang('The document can contain placeholder like {{%1}}, to be replaced with the data.', 'ts_title').' '.
lang('The following document-types are supported:'). implode(',',Api\Storage\Merge::get_file_extensions()),
2011-02-04 21:03:42 +01:00
'run_lang' => false,
'xmlrpc' => True,
'admin' => False,
);
$settings['document_dir'] = array(
'type' => 'vfs_dirs',
2011-02-04 21:03:42 +01:00
'size' => 60,
'label' => 'Directory with documents to insert entries',
'name' => 'document_dir',
'help' => lang('If you specify a directory (full vfs path) here, %1 displays an action for each document. That action allows to download the specified document with the %1 data inserted.', lang('timesheet')).' '.
lang('The document can contain placeholder like {{%1}}, to be replaced with the data.','ts_title').' '.
lang('The following document-types are supported:'). implode(',',Api\Storage\Merge::get_file_extensions()),
2011-02-04 21:03:42 +01:00
'run_lang' => false,
'xmlrpc' => True,
'admin' => False,
'default' => '/templates/timesheet',
2011-02-04 21:03:42 +01:00
);
}
// Import / Export for nextmatch
if ($GLOBALS['egw_info']['user']['apps']['importexport'])
{
$definitions = new importexport_definitions_bo(array(
'type' => 'export',
'application' => 'timesheet'
));
$options = array(
'~nextmatch~' => lang('Old fixed definition')
);
2011-03-21 17:19:52 +01:00
foreach ((array)$definitions->get_definitions() as $identifier)
{
try
{
$definition = new importexport_definition($identifier);
2011-03-21 17:19:52 +01:00
}
catch (Exception $e)
{
2016-04-24 15:48:45 +02:00
unset($e);
// permission error
continue;
}
2016-04-24 15:48:45 +02:00
if (($title = $definition->get_title()))
2011-03-21 17:19:52 +01:00
{
$options[$title] = $title;
}
unset($definition);
}
2011-03-21 17:19:52 +01:00
$default_def = 'export-timesheet';
$settings['nextmatch-export-definition'] = array(
'type' => 'select',
'values' => $options,
2011-07-04 22:00:26 +02:00
'label' => 'Export definition to use for nextmatch export',
'name' => 'nextmatch-export-definition',
'help' => lang('If you specify an export definition, it will be used when you export'),
'run_lang' => false,
'xmlrpc' => True,
'admin' => False,
2011-03-21 17:19:52 +01:00
'default'=> isset($options[$default_def]) ? $default_def : false,
);
}
2011-02-04 21:03:42 +01:00
return $settings;
2005-12-19 05:23:14 +01:00
}
2013-08-26 20:25:43 +02:00
/**
* ACL rights and labels used by Calendar
*
* @param string|array string with location or array with parameters incl. "location", specially "owner" for selected acl owner
*/
public static function acl_rights($params)
{
2016-04-24 15:48:45 +02:00
unset($params); // not used, but required by function signature
2013-08-26 20:25:43 +02:00
return array(
Acl::READ => 'read',
Acl::EDIT => 'edit',
Acl::DELETE => 'delete',
2013-08-26 20:25:43 +02:00
);
}
/**
* Hook to tell framework we use standard categories method
*
* @param string|array $data hook-data or location
* @return boolean
*/
public static function categories($data)
{
2016-04-24 15:48:45 +02:00
unset($data); // not used, but required by function signature
return true;
}
}