/**
* Gets budgeted cost for all quarters of specified year
*
* @param int $year The year
* @param string $ccId optional The identifier of the cost centre or parent cost centre
* @param string $projectId optional The identifier of the project
* @throws InvalidArgumentException
*/
protected function getBudgetInfo($year, $ccId = null, $projectId = null)
{
if (!empty($projectId)) {
$subjectId = $projectId;
$subjectType = QuarterlyBudgetEntity::SUBJECT_TYPE_PROJECT;
$subjectEntity = ProjectEntity::findPk($projectId);
} else {
if (!empty($ccId)) {
$subjectId = $ccId;
$subjectType = QuarterlyBudgetEntity::SUBJECT_TYPE_CC;
$subjectEntity = CostCentreEntity::findPk($ccId);
}
}
if ($subjectEntity->accountId !== $this->user->getAccountId()) {
//throw new Scalr_Exception_InsufficientPermissions();
}
if (empty($subjectId) || !preg_match('/^[[:xdigit:]-]{36}$/', $subjectId)) {
throw new InvalidArgumentException(sprintf("Invalid identifier of the project or cost center."));
}
if (!preg_match('/^\\d{4}$/', $year)) {
throw new InvalidArgumentException(sprintf("Invalid year."));
}
if ($subjectType == QuarterlyBudgetEntity::SUBJECT_TYPE_CC) {
$collection = QuarterlyBudgetEntity::getCcBudget($year, $subjectId);
$prevCollection = QuarterlyBudgetEntity::getCcBudget($year - 1, $subjectId);
} else {
$collection = QuarterlyBudgetEntity::getProjectBudget($year, $subjectId);
$prevCollection = QuarterlyBudgetEntity::getProjectBudget($year - 1, $subjectId);
}
$quarters = new Quarters(SettingEntity::getQuarters(true));
$today = new DateTime('now', new DateTimeZone('UTC'));
//Start dates for an each quarter
$startDates = $quarters->getDays();
$budgets = [];
for ($quarter = 1; $quarter <= 4; ++$quarter) {
$period = $quarters->getPeriodForQuarter($quarter, $year);
$prevPeriod = $quarters->getPeriodForQuarter($quarter, $year - 1);
//Finds budget for specified quarter in the collection
$entity = current($collection->filterByQuarter($quarter));
//Previous Year entity
$prevEntity = current($prevCollection->filterByQuarter($quarter));
if ($entity instanceof QuarterlyBudgetEntity) {
$budget = ['budget' => round($entity->budget), 'budgetFinalSpent' => round($entity->cumulativespend), 'spentondate' => $entity->spentondate instanceof DateTime ? $entity->spentondate->format('Y-m-d') : null, 'budgetSpent' => round($entity->cumulativespend)];
if ($budget['budget']) {
$budget['budgetOverspend'] = max(round($entity->cumulativespend - $entity->budget), 0);
$budget['budgetOverspendPct'] = round($budget['budgetOverspend'] / $budget['budget'] * 100);
}
} else {
//Budget has not been set yet.
$budget = ['budget' => 0, 'budgetFinalSpent' => 0, 'spentondate' => null, 'budgetSpent' => 0, 'budgetOverspend' => 0, 'budgetOverspendPct' => 0];
}
$budget['year'] = $year;
$budget['quarter'] = $quarter;
$budget['startDate'] = $startDates[$quarter - 1];
//Whether this quarter has been closed or not
$budget['closed'] = $period->end->format('Y-m-d') < gmdate('Y-m-d');
//The number of the days in the current quarter
$daysInQuarter = $period->start->diff($period->end, true)->days + 1;
//In case quarter is closed projection should be calculated
if (!$budget['closed']) {
$daysPassed = $period->start->diff($today, true)->days + 1;
$budget['dailyAverage'] = $daysPassed == 0 ? 0 : round($budget['budgetSpent'] / $daysPassed, 2);
$budget['projection'] = round($daysInQuarter * $budget['dailyAverage']);
} else {
$budget['dailyAverage'] = $daysInQuarter == 0 ? 0 : round($budget['budgetFinalSpent'] / $daysInQuarter, 2);
}
$budget['costVariance'] = round((isset($budget['projection']) ? $budget['projection'] : $budget['budgetSpent']) - $budget['budget'], 2);
$budget['costVariancePct'] = $budget['budget'] == 0 ? null : round(abs($budget['costVariance']) / $budget['budget'] * 100);
$budget['monthlyAverage'] = round($budget['dailyAverage'] * 30);
if ($prevEntity instanceof QuarterlyBudgetEntity) {
$budget['prev'] = ['budget' => $prevEntity->budget, 'budgetFinalSpent' => $prevEntity->cumulativespend, 'spentondate' => $prevEntity->spentondate instanceof DateTime ? $prevEntity->spentondate->format('Y-m-d') : null, 'closed' => $prevPeriod->end->format('Y-m-d') < gmdate('Y-m-d'), 'costVariance' => $prevEntity->cumulativespend - $prevEntity->budget, 'costVariancePct' => $prevEntity->budget == 0 ? null : round(abs($prevEntity->cumulativespend - $prevEntity->budget) / $prevEntity->budget * 100)];
} else {
$budget['prev'] = ['budget' => null, 'budgetFinalSpent' => 0, 'spentondate' => null, 'closed' => $prevPeriod->end->format('Y-m-d') < gmdate('Y-m-d'), 'budgetSpent' => 0, 'costVariance' => 0, 'costVariancePct' => 0];
}
$budgets[] = $budget;
}
$result = ['budgets' => $budgets, 'ccId' => $ccId, 'projectId' => $projectId, 'quarter' => $quarters->getQuarterForDate(), 'year' => $year];
if (!empty($projectId)) {
$result['shared'] = $subjectEntity->shared;
}
return $result;
}
