basic model scaffolding

2024-08-10 13:30:19 -05:00
parent a7acb2f346
commit 94c8850cd5
6 changed files with 732 additions and 0 deletions
@@ -0,0 +1,132 @@
+<?php
+
+namespace App\Models;
+
+use App\Models\Dividend;
+use Illuminate\Database\Eloquent\Model;
+use Illuminate\Database\Eloquent\Factories\HasFactory;
+
+class Holding extends Model
+{
+    use HasFactory;
+
+    protected $with = [];
+
+    /**
+     * The attributes that are mass assignable.
+     *
+     * @var array
+     */
+    protected $fillable = [
+        'portfolio_id',
+        'symbol',
+        'quantity',
+        'average_cost_basis',
+        'total_cost_basis',
+        'realized_gain_loss_dollars',
+        'dividends_earned',
+        'splits_synced_at',
+        'dividends_synced_at'
+    ];
+
+    /**
+     * The attributes that should be cast to native types.
+     *
+     * @var array
+     */
+    protected $casts = [
+        'splits_synced_at' => 'datetime',
+        'dividends_synced_at' => 'datetime',
+    ];
+
+    /**
+     * get market data for holding
+     *
+     * @return void
+     */
+    public function market_data() 
+    {
+        return $this->hasOne(MarketData::class, 'symbol', 'symbol');
+    }
+
+    /**
+     * get related transactions for holding
+     *
+     * @return void
+     */
+    public function transactions() 
+    {
+        return $this->hasMany(Transaction::class, 'symbol', 'symbol');
+    }
+
+    /**
+     * get related dividends for holding
+     *
+     * @return void
+     */
+    public function dividends() 
+    {
+        return $this->hasMany(Dividend::class, 'symbol', 'symbol');
+    }
+
+    /**
+     * get related portfolio for holding
+     *
+     * @return void
+     */
+    public function portfolio() 
+    {
+        return $this->belongsTo(Portfolio::class);
+    }
+
+    /**
+     * get related splits for holding
+     *
+     * @return void
+     */
+    public function splits() 
+    {
+        return $this->hasMany(Split::class, 'symbol', 'symbol');
+    }
+
+    public function scopePortfolio($query, $portfolio)
+    {
+        return $query->where('portfolio_id', $portfolio);
+    }
+
+    public function scopeWithoutWishlists($query) {
+        return $query->join('portfolios', 'portfolios.id', 'holdings.portfolio_id')
+            ->where('portfolios.wishlist', 0);
+    }
+
+    public function scopeMyHoldings($query)
+    {
+        return $query->whereHas('portfolio', function($query) {
+            $query->whereRelation('users', 'id', auth()->user()->id);
+        });
+    }
+
+    public function scopeGetPortfolioMetrics($query) 
+    {
+        $query->selectRaw('SUM(holdings.dividends_earned) AS total_dividends_earned')
+            ->selectRaw('SUM(holdings.realized_gain_loss_dollars) AS realized_gain_loss_dollars')
+            ->selectRaw('@total_market_value:=SUM(holdings.quantity * market_data.market_value) AS total_market_value')
+            ->selectRaw('@sum_total_cost_basis:=SUM(holdings.total_cost_basis) AS total_cost_basis')
+            ->selectRaw('@total_gain_loss_dollars:=(@total_market_value - @sum_total_cost_basis) AS total_gain_loss_dollars')
+            ->selectRaw('(@total_gain_loss_dollars / @sum_total_cost_basis) * 100 AS total_gain_loss_percent')
+            ->join('market_data', 'market_data.symbol', 'holdings.symbol');
+            // =(VLOOKUP(if(today or end of year),'Daily Change'!$A:$B,2,false) - VLOOKUP(first of year),'Daily Change'!$A:$C,3,false)) / (SUMIFS(transactions.cost_basis_lot,transactions.date,"<"&date(left(D19,4)+1,1,1),transactions.type,"Buy")-SUMIFS(transactions.cost_basis_lot,transactions.date,"<"&date(left(D19,4)+1,1,1),transactions.type,"Sell"))-1
+    }
+
+    public function scopeSymbol($query, $symbol)
+    {
+        return $query->where('symbol', $symbol);
+    }
+
+    public function refreshDividends() 
+    {
+        return Dividend::getDividendData($this->attributes['symbol']);
+    }
+}
+
+