Move budget outside of the core

The budget planning feature is now a plugin
See: https://github.com/kanboard/plugin-budget
This commit is contained in:
Frederic Guillot
2015-09-13 16:56:51 -04:00
parent d400f7c5be
commit 4b6672d0b3
47 changed files with 20 additions and 1596 deletions

View File

@@ -64,7 +64,6 @@ class Acl extends Base
'export' => '*',
'project' => array('edit', 'update', 'share', 'integration', 'users', 'alloweverybody', 'allow', 'setowner', 'revoke', 'duplicate', 'disable', 'enable'),
'swimlane' => '*',
'budget' => '*',
'gantt' => array('project', 'savetaskdate', 'task', 'savetask'),
);

View File

@@ -1,214 +0,0 @@
<?php
namespace Model;
use DateInterval;
use DateTime;
use SimpleValidator\Validator;
use SimpleValidator\Validators;
/**
* Budget
*
* @package model
* @author Frederic Guillot
*/
class Budget extends Base
{
/**
* SQL table name
*
* @var string
*/
const TABLE = 'budget_lines';
/**
* Get all budget lines for a project
*
* @access public
* @param integer $project_id
* @return array
*/
public function getAll($project_id)
{
return $this->db->table(self::TABLE)->eq('project_id', $project_id)->desc('date')->findAll();
}
/**
* Get the current total of the budget
*
* @access public
* @param integer $project_id
* @return float
*/
public function getTotal($project_id)
{
$result = $this->db->table(self::TABLE)->columns('SUM(amount) as total')->eq('project_id', $project_id)->findOne();
return isset($result['total']) ? (float) $result['total'] : 0;
}
/**
* Get breakdown by tasks/subtasks/users
*
* @access public
* @param integer $project_id
* @return \PicoDb\Table
*/
public function getSubtaskBreakdown($project_id)
{
return $this->db
->table(SubtaskTimeTracking::TABLE)
->columns(
SubtaskTimeTracking::TABLE.'.id',
SubtaskTimeTracking::TABLE.'.user_id',
SubtaskTimeTracking::TABLE.'.subtask_id',
SubtaskTimeTracking::TABLE.'.start',
SubtaskTimeTracking::TABLE.'.time_spent',
Subtask::TABLE.'.task_id',
Subtask::TABLE.'.title AS subtask_title',
Task::TABLE.'.title AS task_title',
Task::TABLE.'.project_id',
User::TABLE.'.username',
User::TABLE.'.name'
)
->join(Subtask::TABLE, 'id', 'subtask_id')
->join(Task::TABLE, 'id', 'task_id', Subtask::TABLE)
->join(User::TABLE, 'id', 'user_id')
->eq(Task::TABLE.'.project_id', $project_id)
->callback(array($this, 'applyUserRate'));
}
/**
* Gather necessary information to display the budget graph
*
* @access public
* @param integer $project_id
* @return array
*/
public function getDailyBudgetBreakdown($project_id)
{
$out = array();
$in = $this->db->hashtable(self::TABLE)->eq('project_id', $project_id)->gt('amount', 0)->asc('date')->getAll('date', 'amount');
$time_slots = $this->getSubtaskBreakdown($project_id)->findAll();
foreach ($time_slots as $slot) {
$date = date('Y-m-d', $slot['start']);
if (! isset($out[$date])) {
$out[$date] = 0;
}
$out[$date] += $slot['cost'];
}
$start = key($in) ?: key($out);
$end = new DateTime;
$left = 0;
$serie = array();
for ($today = new DateTime($start); $today <= $end; $today->add(new DateInterval('P1D'))) {
$date = $today->format('Y-m-d');
$today_in = isset($in[$date]) ? (int) $in[$date] : 0;
$today_out = isset($out[$date]) ? (int) $out[$date] : 0;
if ($today_in > 0 || $today_out > 0) {
$left += $today_in;
$left -= $today_out;
$serie[] = array(
'date' => $date,
'in' => $today_in,
'out' => -$today_out,
'left' => $left,
);
}
}
return $serie;
}
/**
* Filter callback to apply the rate according to the effective date
*
* @access public
* @param array $records
* @return array
*/
public function applyUserRate(array $records)
{
$rates = $this->hourlyRate->getAllByProject($records[0]['project_id']);
foreach ($records as &$record) {
$hourly_price = 0;
foreach ($rates as $rate) {
if ($rate['user_id'] == $record['user_id'] && date('Y-m-d', $rate['date_effective']) <= date('Y-m-d', $record['start'])) {
$hourly_price = $this->currency->getPrice($rate['currency'], $rate['rate']);
break;
}
}
$record['cost'] = $hourly_price * $record['time_spent'];
}
return $records;
}
/**
* Add a new budget line in the database
*
* @access public
* @param integer $project_id
* @param float $amount
* @param string $comment
* @param string $date
* @return boolean|integer
*/
public function create($project_id, $amount, $comment, $date = '')
{
$values = array(
'project_id' => $project_id,
'amount' => $amount,
'comment' => $comment,
'date' => $date ?: date('Y-m-d'),
);
return $this->persist(self::TABLE, $values);
}
/**
* Remove a specific budget line
*
* @access public
* @param integer $budget_id
* @return boolean
*/
public function remove($budget_id)
{
return $this->db->table(self::TABLE)->eq('id', $budget_id)->remove();
}
/**
* Validate creation
*
* @access public
* @param array $values Form values
* @return array $valid, $errors [0] = Success or not, [1] = List of errors
*/
public function validateCreation(array $values)
{
$v = new Validator($values, array(
new Validators\Required('project_id', t('Field required')),
new Validators\Required('amount', t('Field required')),
));
return array(
$v->execute(),
$v->getErrors()
);
}
}

View File

@@ -1,121 +0,0 @@
<?php
namespace Model;
use SimpleValidator\Validator;
use SimpleValidator\Validators;
/**
* Hourly Rate
*
* @package model
* @author Frederic Guillot
*/
class HourlyRate extends Base
{
/**
* SQL table name
*
* @var string
*/
const TABLE = 'hourly_rates';
/**
* Get all user rates for a given project
*
* @access public
* @param integer $project_id
* @return array
*/
public function getAllByProject($project_id)
{
$members = $this->projectPermission->getMembers($project_id);
if (empty($members)) {
return array();
}
return $this->db->table(self::TABLE)->in('user_id', array_keys($members))->desc('date_effective')->findAll();
}
/**
* Get all rates for a given user
*
* @access public
* @param integer $user_id User id
* @return array
*/
public function getAllByUser($user_id)
{
return $this->db->table(self::TABLE)->eq('user_id', $user_id)->desc('date_effective')->findAll();
}
/**
* Get current rate for a given user
*
* @access public
* @param integer $user_id User id
* @return float
*/
public function getCurrentRate($user_id)
{
return $this->db->table(self::TABLE)->eq('user_id', $user_id)->desc('date_effective')->findOneColumn('rate') ?: 0;
}
/**
* Add a new rate in the database
*
* @access public
* @param integer $user_id User id
* @param float $rate Hourly rate
* @param string $currency Currency code
* @param string $date ISO8601 date format
* @return boolean|integer
*/
public function create($user_id, $rate, $currency, $date)
{
$values = array(
'user_id' => $user_id,
'rate' => $rate,
'currency' => $currency,
'date_effective' => $this->dateParser->removeTimeFromTimestamp($this->dateParser->getTimestamp($date)),
);
return $this->persist(self::TABLE, $values);
}
/**
* Remove a specific rate
*
* @access public
* @param integer $rate_id
* @return boolean
*/
public function remove($rate_id)
{
return $this->db->table(self::TABLE)->eq('id', $rate_id)->remove();
}
/**
* Validate creation
*
* @access public
* @param array $values Form values
* @return array $valid, $errors [0] = Success or not, [1] = List of errors
*/
public function validateCreation(array $values)
{
$v = new Validator($values, array(
new Validators\Required('user_id', t('Field required')),
new Validators\Required('rate', t('Field required')),
new Validators\Numeric('rate', t('This value must be numeric')),
new Validators\Required('date_effective', t('Field required')),
new Validators\Required('currency', t('Field required')),
));
return array(
$v->execute(),
$v->getErrors()
);
}
}