hackerESQ
212 lines
8.7 KiB
PHP
212 lines
8.7 KiB
PHP
<?php
|
|
|
|
namespace App\Models;
|
|
|
|
use App\Models\Split;
|
|
use App\Models\Dividend;
|
|
use App\Models\Portfolio;
|
|
use App\Models\MarketData;
|
|
use App\Models\Transaction;
|
|
use Illuminate\Database\Eloquent\Model;
|
|
use Illuminate\Database\Eloquent\Concerns\HasUuids;
|
|
use Illuminate\Database\Eloquent\Factories\HasFactory;
|
|
|
|
class Holding extends Model
|
|
{
|
|
use HasFactory;
|
|
use HasUuids;
|
|
|
|
protected $fillable = [
|
|
'portfolio_id',
|
|
'symbol',
|
|
'quantity',
|
|
'average_cost_basis',
|
|
'total_cost_basis',
|
|
'realized_gain_dollars',
|
|
'dividends_earned',
|
|
'splits_synced_at',
|
|
'dividends_synced_at'
|
|
];
|
|
|
|
protected $casts = [
|
|
'splits_synced_at' => 'datetime',
|
|
'dividends_synced_at' => 'datetime',
|
|
];
|
|
|
|
protected $attributes = [
|
|
'realized_gain_dollars' => 0,
|
|
'dividends_earned' => 0,
|
|
];
|
|
|
|
/**
|
|
* Market data for holding
|
|
*
|
|
* @return void
|
|
*/
|
|
public function market_data()
|
|
{
|
|
return $this->hasOne(MarketData::class, 'symbol', 'symbol');
|
|
}
|
|
|
|
/**
|
|
* Related transactions for holding
|
|
*
|
|
* @return void
|
|
*/
|
|
public function transactions()
|
|
{
|
|
return $this->hasManyThrough(Transaction::class, Portfolio::class, 'id', 'portfolio_id', 'portfolio_id', 'id')->orderBy('date', 'DESC');
|
|
}
|
|
|
|
/**
|
|
* Related dividends for holding
|
|
*
|
|
* @return void
|
|
*/
|
|
public function dividends()
|
|
{
|
|
return $this->hasMany(Dividend::class, 'symbol', 'symbol')
|
|
->select(['dividends.symbol','dividends.date','dividends.dividend_amount'])
|
|
->selectRaw("SUM(
|
|
CASE WHEN transaction_type = 'BUY'
|
|
AND transactions.symbol = dividends.symbol
|
|
AND transactions.portfolio_id = '$this->portfolio_id'
|
|
AND dividends.date >= transactions.date
|
|
THEN transactions.quantity
|
|
ELSE 0 END
|
|
) AS purchased")
|
|
->selectRaw("SUM(
|
|
CASE WHEN transaction_type = 'SELL'
|
|
AND transactions.symbol = dividends.symbol
|
|
AND transactions.portfolio_id = '$this->portfolio_id'
|
|
AND dividends.date >= transactions.date
|
|
THEN transactions.quantity
|
|
ELSE 0 END
|
|
) AS sold")
|
|
->join('transactions', 'transactions.symbol', 'dividends.symbol')
|
|
->groupBy(['dividends.symbol','dividends.date','dividends.dividend_amount'])
|
|
->orderBy('dividends.date', 'DESC')
|
|
->where('dividends.date', '>=', function ($query) {
|
|
$query->selectRaw('min(transactions.date)')
|
|
->from('transactions')
|
|
->whereRaw("transactions.portfolio_id = '$this->portfolio_id'")
|
|
->whereRaw("transactions.symbol = '$this->symbol'");
|
|
});
|
|
}
|
|
|
|
/**
|
|
* Related portfolio for holding
|
|
*
|
|
* @return void
|
|
*/
|
|
public function portfolio()
|
|
{
|
|
return $this->belongsTo(Portfolio::class);
|
|
}
|
|
|
|
/**
|
|
* Related splits for holding
|
|
*
|
|
* @return void
|
|
*/
|
|
public function splits()
|
|
{
|
|
return $this->hasMany(Split::class, 'symbol', 'symbol')
|
|
->orderBy('date', 'DESC');
|
|
}
|
|
|
|
public function scopeWithMarketData($query)
|
|
{
|
|
return $query->withAggregate('market_data', 'name')
|
|
->withAggregate('market_data', 'market_value')
|
|
->withAggregate('market_data', 'fifty_two_week_low')
|
|
->withAggregate('market_data', 'fifty_two_week_high')
|
|
->withAggregate('market_data', 'updated_at')
|
|
->join('market_data', 'holdings.symbol', 'market_data.symbol');
|
|
}
|
|
|
|
public function scopeWithPerformance($query)
|
|
{
|
|
return $query->selectRaw('COALESCE(market_data.market_value * holdings.quantity, 0) AS total_market_value')
|
|
->selectRaw('COALESCE((market_data.market_value - holdings.average_cost_basis) * holdings.quantity, 0) AS market_gain_dollars')
|
|
->selectRaw('COALESCE(((market_data.market_value - holdings.average_cost_basis) / holdings.average_cost_basis), 0) AS market_gain_percent');
|
|
}
|
|
|
|
public function scopePortfolio($query, $portfolio)
|
|
{
|
|
return $query->where('portfolio_id', $portfolio);
|
|
}
|
|
|
|
public function scopeSymbol($query, $symbol)
|
|
{
|
|
return $query->where('holdings.symbol', $symbol);
|
|
}
|
|
|
|
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 scopeWithPortfolioMetrics($query)
|
|
{
|
|
return $query->selectRaw('COALESCE(SUM(holdings.dividends_earned),0) AS total_dividends_earned')
|
|
->selectRaw('COALESCE(SUM(holdings.realized_gain_dollars),0) AS realized_gain_dollars')
|
|
->selectRaw('@total_market_value:=COALESCE(SUM(holdings.quantity * market_data.market_value),0) AS total_market_value')
|
|
->selectRaw('@sum_total_cost_basis:=COALESCE(SUM(holdings.total_cost_basis),0) AS total_cost_basis')
|
|
->selectRaw('@total_gain_dollars:=COALESCE((@total_market_value - @sum_total_cost_basis),0) AS total_gain_dollars')
|
|
// ->selectRaw('COALESCE((@total_gain_dollars / @sum_total_cost_basis) * 100,0) AS total_gain_percent')
|
|
->join('market_data', 'market_data.symbol', 'holdings.symbol');
|
|
}
|
|
|
|
public function syncTransactionsAndDividends()
|
|
{
|
|
// pull existing transaction data
|
|
$query = Transaction::where([
|
|
'portfolio_id' => $this->portfolio_id,
|
|
'symbol' => $this->symbol,
|
|
])->selectRaw('SUM(CASE WHEN transaction_type = "BUY" THEN quantity ELSE 0 END) AS `qty_purchases`')
|
|
->selectRaw('SUM(CASE WHEN transaction_type = "SELL" THEN quantity ELSE 0 END) AS `qty_sales`')
|
|
->selectRaw('SUM(CASE WHEN transaction_type = "BUY" THEN (quantity * cost_basis) ELSE 0 END) AS `cost_basis`')
|
|
->selectRaw('SUM(CASE WHEN transaction_type = "SELL" THEN ((sale_price - cost_basis) * quantity) ELSE 0 END) AS `realized_gains`')
|
|
->first();
|
|
|
|
$total_quantity = $query->qty_purchases - $query->qty_sales;
|
|
$average_cost_basis = $query->qty_purchases > 0
|
|
? $query->cost_basis / $query->qty_purchases
|
|
: 0;
|
|
|
|
// pull dividend data joined with holdings/transactions
|
|
$dividends = Dividend::where([
|
|
'dividends.symbol' => $this->symbol,
|
|
])
|
|
->select(['holdings.portfolio_id', 'dividends.date', 'dividends.symbol', 'dividends.dividend_amount'])
|
|
->selectRaw('@purchased:=(SELECT coalesce(SUM(quantity),0) FROM transactions WHERE transactions.transaction_type = "BUY" AND transactions.symbol = dividends.symbol AND date(transactions.date) <= date(dividends.date) AND holdings.portfolio_id = transactions.portfolio_id ) AS `purchased`')
|
|
->selectRaw('@sold:=(SELECT coalesce(SUM(quantity),0) FROM transactions WHERE transactions.transaction_type = "SELL" AND transactions.symbol = dividends.symbol AND date(transactions.date) <= date(dividends.date) AND holdings.portfolio_id = transactions.portfolio_id ) AS `sold`')
|
|
->selectRaw('@owned:=(@purchased - @sold) AS `owned`')
|
|
->selectRaw('@dividends_received:=(@owned * dividends.dividend_amount) AS `dividends_received`')
|
|
->join('transactions', 'transactions.symbol', 'dividends.symbol')
|
|
->join('holdings', 'transactions.portfolio_id', 'holdings.portfolio_id')
|
|
->groupBy(['holdings.portfolio_id', 'dividends.date', 'dividends.symbol', 'dividends.dividend_amount'])
|
|
->get();
|
|
|
|
// update holding
|
|
$this->fill([
|
|
'quantity' => $total_quantity,
|
|
'average_cost_basis' => $average_cost_basis,
|
|
'total_cost_basis' => $total_quantity * $average_cost_basis,
|
|
'realized_gain_dollars' => $query->realized_gains,
|
|
'dividends_earned' => $dividends->where('portfolio_id', $this->portfolio_id)->sum('dividends_received')
|
|
]);
|
|
|
|
$this->save();
|
|
}
|
|
}
|
|
|
|
|