firefly-iii/app/models/LimitRepetition.php

<?php

use FireflyIII\Exception\FireflyException;
use LaravelBook\Ardent\Ardent as Ardent;


/**
 * LimitRepetition
 *
 * @property integer        $id
 * @property \Carbon\Carbon $created_at
 * @property \Carbon\Carbon $updated_at
 * @property integer        $limit_id
 * @property \Carbon\Carbon $startdate
 * @property \Carbon\Carbon $enddate
 * @property float          $amount
 * @property-read \Limit    $limit
 * @method static \Illuminate\Database\Query\Builder|\LimitRepetition whereId($value)
 * @method static \Illuminate\Database\Query\Builder|\LimitRepetition whereCreatedAt($value)
 * @method static \Illuminate\Database\Query\Builder|\LimitRepetition whereUpdatedAt($value)
 * @method static \Illuminate\Database\Query\Builder|\LimitRepetition whereLimitId($value)
 * @method static \Illuminate\Database\Query\Builder|\LimitRepetition whereStartdate($value)
 * @method static \Illuminate\Database\Query\Builder|\LimitRepetition whereEnddate($value)
 * @method static \Illuminate\Database\Query\Builder|\LimitRepetition whereAmount($value)
 */
class LimitRepetition extends Ardent
{
    public static $rules
        = [
            'limit_id'  => 'required|exists:limits,id',
            'startdate' => 'required|date',
            'enddate'   => 'required|date',
            'amount'    => 'numeric|required|min:0.01',
        ];

    /**
     * @return array
     */
    public function getDates()
    {
        return ['created_at', 'updated_at', 'startdate', 'enddate'];
    }

    /**
     * TODO see if this scope is still used.
     *
     * How much money is left in this?
     */
    public function leftInRepetition()
    {
        return floatval($this->amount - $this->spentInRepetition());

    }

    /**
     * TODO remove this method in favour of something in the FireflyIII libraries.
     *
     * @return float
     */
    public function spentInRepetition()
    {
        $sum = \DB::table('transactions')->leftJoin('transaction_journals', 'transaction_journals.id', '=', 'transactions.transaction_journal_id')->leftJoin(
            'component_transaction_journal', 'component_transaction_journal.transaction_journal_id', '=', 'transaction_journals.id'
        )->leftJoin('components', 'components.id', '=', 'component_transaction_journal.component_id')->leftJoin(
            'limits', 'limits.component_id', '=', 'components.id'
        )->leftJoin('limit_repetitions', 'limit_repetitions.limit_id', '=', 'limits.id')->where(
            'transaction_journals.date', '>=', $this->startdate->format('Y-m-d')
        )->where('transaction_journals.date', '<=', $this->enddate->format('Y-m-d'))->where('transactions.amount', '>', 0)->where(
            'limit_repetitions.id', '=', $this->id
        )->sum('transactions.amount');

        return floatval($sum);
    }

    /**
     * @return \Illuminate\Database\Eloquent\Relations\BelongsTo
     */
    public function limit()
    {
        return $this->belongsTo('Limit');
    }


    /**
     * TODO remove this method in favour of something in the FireflyIII libraries.
     *
     * Returns a string used to sort this particular repetition
     * based on the date and period it falls into. Ie. the limit
     * repeats monthly and the start date is 12 dec 2012, this will
     * return 2012-12.
     */
    public function periodOrder()
    {
        if (is_null($this->repeat_freq)) {
            $this->repeat_freq = $this->limit->repeat_freq;
        }
        switch ($this->repeat_freq) {
            default:
                throw new FireflyException('No date formats for frequency "' . $this->repeat_freq . '"!');
                break;
            case 'daily':
                return $this->startdate->format('Ymd') . '-5';
                break;
            case 'weekly':
                return $this->startdate->format('Ymd') . '-4';
                break;
            case 'monthly':
                return $this->startdate->format('Ymd') . '-3';
                break;
            case 'quarterly':
                return $this->startdate->format('Ymd') . '-2';
                break;
            case 'half-year':
                return $this->startdate->format('Ymd') . '-1';
                break;
            case 'yearly':
                return $this->startdate->format('Ymd') . '-0';
                break;
        }
    }

    /**
     * TODO remove this method in favour of something in the FireflyIII libraries.
     *
     * Same as above, just with a more natural view. So "March 2012".
     */
    public function periodShow()
    {
        if (is_null($this->repeat_freq)) {
            $this->repeat_freq = $this->limit->repeat_freq;
        }
        switch ($this->repeat_freq) {
            default:
                throw new FireflyException('No date formats for frequency "' . $this->repeat_freq . '"!');
                break;
            case 'daily':
                return $this->startdate->format('j F Y');
                break;
            case 'weekly':
                return $this->startdate->format('\W\e\e\k W, Y');
                break;
            case 'monthly':
                return $this->startdate->format('F Y');
                break;
            case 'half-year':
            case 'quarterly':
                return $this->startdate->format('M Y') . ' - ' . $this->enddate->format('M Y');
                break;
            case 'yearly':
                return $this->startdate->format('Y');
                break;
        }
    }


}