App\Models\Depreciable Class Reference

Inheritance diagram for App\Models\Depreciable:

Public Member Functions
	depreciation ()
	Depreciation Relation, and associated helper methods. More...
	get_depreciation ()
	getDepreciatedValue ()
	time_until_depreciated ()
	depreciated_date ()

Detailed Description

Definition at line 7 of file Depreciable.php.

Member Function Documentation

App\Models\Depreciable::depreciated_date

(

)

Definition at line 77 of file Depreciable.php.

    {
        $date = date_create($this->purchase_date);
        date_add($date, date_interval_create_from_date_string($this->get_depreciation()->months . ' months'));
        return $date; //date_format($date, 'Y-m-d'); //don't bake-in format, for internationalization
    }

App\Models\Depreciable::depreciation

(

)

Depreciation Relation, and associated helper methods.

Definition at line 28 of file Depreciable.php.

    {
        return $this->belongsTo('\App\Models\Depreciation', 'depreciation_id');
    }

App\Models\Depreciable::get_depreciation

(

)

Definition at line 33 of file Depreciable.php.

    {
        return $this->depreciation;
    }

App\Models\Depreciable::getDepreciatedValue

(

)

Returns

float|int

Definition at line 42 of file Depreciable.php.

    {
        if (!$this->get_depreciation()) { // will never happen
            return $this->purchase_cost;
        }

        if ($this->get_depreciation()->months <= 0) {
            return $this->purchase_cost;
        }

        // fraction of value left
        $months_remaining = $this->time_until_depreciated()->m + 12*$this->time_until_depreciated()->y; //UGlY
        $current_value = round(($months_remaining/ $this->get_depreciation()->months) * $this->purchase_cost, 2);

        if ($current_value < 0) {
            $current_value = 0;
        }
        return $current_value;
    }

App\Models\Depreciable::time_until_depreciated

(

)

Definition at line 62 of file Depreciable.php.

    {
        // @link http://www.php.net/manual/en/class.datetime.php
        $d1 = new \DateTime();
        $d2 = $this->depreciated_date();

        // @link http://www.php.net/manual/en/class.dateinterval.php
        $interval = $d1->diff($d2);
        if (!$interval->invert) {
            return $interval;
        } else {
            return new \DateInterval("PT0S"); //null interval (zero seconds from now)
        }
    }

---

The documentation for this class was generated from the following file:

• Depreciable.php