egroupware_official/timesheet/inc/class.timesheet_datasource.inc.php

<?php
/**
 * TimeSheet - Projectmanager datasource
 *
 * @link http://www.egroupware.org
 * @author Ralf Becker <RalfBecker-AT-outdoor-training.de>
 * @package timesheet
 * @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$
 */
use EGroupware\Api\Link;
use EGroupware\Api\Acl;

include_once(EGW_INCLUDE_ROOT.'/projectmanager/inc/class.datasource.inc.php');

/**
 * Projectmanager DataSource for the TimeSheet
 */
class timesheet_datasource extends datasource
{
	/**
	 * Constructor
	 */
	function __construct()
	{
		parent::__construct(TIMESHEET_APP);

		$this->valid = PM_REAL_START|PM_REAL_END|PM_USED_TIME|PM_USED_BUDGET|PM_USED_QUANTITY|
			PM_PRICELIST_ID|PM_UNITPRICE|PM_RESOURCES|PM_DETAILS|PM_COMPLETION|PM_CAT_ID;
	}

	/**
	 * get an entry from the underlaying app (if not given) and convert it into a datasource array
	 *
	 * @param mixed $data_id id as used in the link-class for that app, or complete entry as array
	 * @return array/boolean array with the data supported by that source or false on error (eg. not found, not availible)
	 */
	function get($data_id)
	{
		// we use $GLOBALS['timesheet_bo'] as an already running instance is availible there
		if (!is_object($GLOBALS['timesheet_bo']))
		{
			$GLOBALS['timesheet_bo'] = new timesheet_bo();
		}
		if (!is_array($data_id))
		{
			if (!(int) $data_id || !($data = $GLOBALS['timesheet_bo']->read((int) $data_id)))
			{
				return false;
			}
		}
		else
		{
			$data =& $data_id;
		}
		$status = null;
		switch($data['ts_status'])
		{
			case timesheet_bo::DELETED_STATUS:
				$status = 'deleted';
				break;
			case '':
			default:
				$status = 'ignore';
				break;
		}
		$ds = array(
			'pe_title'       => $GLOBALS['timesheet_bo']->link_title($data),
			'pe_status'      => $status,
			'pe_real_start'  => $data['ts_start'],
			'pe_resources'   => array($data['ts_owner']),
			'pe_details'     => $data['ts_description'] ? nl2br($data['ts_description']) : '',
			'pl_id'          => $data['pl_id'],
			'pe_unitprice'   => $data['ts_unitprice'],
			'pe_used_quantity' => $data['ts_quantity'],
			'pe_used_budget' => $data['ts_quantity'] * $data['ts_unitprice'],
			'pe_completion'  => 100,
			'cat_id'         => $data['cat_id'],
		);
		if ($data['ts_duration'])
		{
			$ds['pe_real_end'] = $data['ts_start'] + 60*$data['ts_duration'];
			$ds['pe_used_time'] = $data['ts_duration'];
		}
		if ($this->debug)
		{
			echo "datasource_timesheet($data_id) data="; _debug_array($data);
			echo "datasource="; _debug_array($ds);
		}
		return $ds;
	}

	/**
	 * Copy method (usally copies a projectelement) returns only false to prevent copying
	 *
	 * @param array $element source project element representing an InfoLog entry, $element['pe_app_id'] = info_id
	 * @param int $target target project id
	 * @param array $extra =null data of target-project, atm not used by the infolog datasource
	 * @return array|boolean array(info_id,link_id) on success, false otherwise
	 */
	function copy($element,$target,$extra=null)
	{
		unset($element,$target,$extra);	// not used, but required by function signature

		return false;
	}

	/**
	 * Delete the datasource of a project element
	 *
	 * @param int $id
	 * @return boolean true on success, false on error
	 */
	function delete($id)
	{
		if (!is_object($GLOBALS['timesheet_bo']))
		{
			$GLOBALS['timesheet_bo'] = new timesheet_bo();
		}
		// dont delete entries which are linked to elements other than their project
		if (count(Link::get_links('timesheet',$id)) > 1)
		{
			return false;
		}
		return $GLOBALS['timesheet_bo']->delete($id);
	}

	/**
	 * Change the status of an entry according to the project status
	 *
	 * @param int $id
	 * @param string $status
	 * @return boolean true if status changed, false otherwise
	 */
	function change_status($id,$status)
	{
		if (!is_object($GLOBALS['timesheet_bo']))
		{
			$GLOBALS['timesheet_bo'] = new timesheet_bo();
		}
		if (($entry = $GLOBALS['timesheet_bo']->read($id)) && (
				$GLOBALS['timesheet_bo']->check_acl(Acl::EDIT,$entry)
		))
		{
			if (in_array($status, $GLOBALS['timesheet_bo']->status_labels))
			{
				$GLOBALS['timesheet_bo']->set_status($id, $status);
				return true;
			}
			// Restore from deleted
			else if ($status == 'active' && $entry['ts_status'] == timesheet_bo::DELETED_STATUS)
			{
				$GLOBALS['timesheet_bo']->set_status($id, '');
				return true;
			}
		}
		return false;
	}
}