kcal/app/Models/Recipe.php

125 lines
4.2 KiB
PHP

<?php
namespace App\Models;
use App\Models\Traits\HasIngredients;
use App\Models\Traits\Ingredient;
use App\Models\Traits\Journalable;
use App\Models\Traits\Sluggable;
use Illuminate\Database\Eloquent\Factories\HasFactory;
use Illuminate\Database\Eloquent\Model;
use Illuminate\Database\Eloquent\Relations\HasMany;
/**
* App\Models\Recipe
*
* @property int $id
* @property string $name
* @property string $slug
* @property int $servings
* @property \Illuminate\Support\Carbon|null $created_at
* @property \Illuminate\Support\Carbon|null $updated_at
* @property string|null $description
* @property string|null $source
* @property-read \Illuminate\Database\Eloquent\Collection|\App\Models\FoodAmount[] $foodAmounts
* @property-read int|null $food_amounts_count
* @property-read \Illuminate\Database\Eloquent\Collection|\App\Models\JournalEntry[] $journalEntries
* @property-read int|null $journal_entries_count
* @property-read \Illuminate\Database\Eloquent\Collection|\App\Models\RecipeStep[] $steps
* @property-read int|null $steps_count
* @method static \Illuminate\Database\Eloquent\Builder|Recipe findSimilarSlugs(string $attribute, array $config, string $slug)
* @method static \Illuminate\Database\Eloquent\Builder|Recipe newModelQuery()
* @method static \Illuminate\Database\Eloquent\Builder|Recipe newQuery()
* @method static \Illuminate\Database\Eloquent\Builder|Recipe query()
* @method static \Illuminate\Database\Eloquent\Builder|Recipe whereCreatedAt($value)
* @method static \Illuminate\Database\Eloquent\Builder|Recipe whereDescription($value)
* @method static \Illuminate\Database\Eloquent\Builder|Recipe whereId($value)
* @method static \Illuminate\Database\Eloquent\Builder|Recipe whereName($value)
* @method static \Illuminate\Database\Eloquent\Builder|Recipe whereServings($value)
* @method static \Illuminate\Database\Eloquent\Builder|Recipe whereSlug($value)
* @method static \Illuminate\Database\Eloquent\Builder|Recipe whereSource($value)
* @method static \Illuminate\Database\Eloquent\Builder|Recipe whereUpdatedAt($value)
* @mixin \Eloquent
* @property-read \Illuminate\Database\Eloquent\Collection|\App\Models\IngredientAmount[] $ingredientAmounts
* @property-read int|null $ingredient_amounts_count
* @property-read \Illuminate\Database\Eloquent\Collection|\App\Models\IngredientAmount[] $ingredients
* @property-read int|null $ingredients_count
*/
class Recipe extends Model
{
use HasFactory, HasIngredients, Ingredient, Journalable, Sluggable;
/**
* @inheritdoc
*/
protected $fillable = [
'name',
'description',
'source',
'servings',
];
/**
* @inheritdoc
*/
protected $casts = [
'servings' => 'int',
];
/**
* Nutrient per serving methods.
*/
private array $nutrientPerServingMethods = [
'caloriesPerServing',
'carbohydratesPerServing',
'cholesterolPerServing',
'fatPerServing',
'proteinPerServing',
'sodiumPerServing',
];
/**
* @inheritdoc
*/
protected $with = ['ingredientAmounts'];
/**
* Get the steps for this Recipe.
*/
public function steps(): HasMany {
return $this->hasMany(RecipeStep::class)->orderBy('number');
}
/**
* Add nutrient calculations handling to overloading.
*
* @param string $method
* @param array $parameters
*
* @return mixed
*
* @noinspection PhpMissingParamTypeInspection
*/
public function __call($method, $parameters): mixed {
if (in_array($method, $this->nutrientTotalMethods)) {
return $this->sumNutrient(substr($method, 0, -5));
}
elseif (in_array($method, $this->nutrientPerServingMethods)) {
$sum = $this->sumNutrient(substr($method, 0, -10)) / $this->servings;
// Per-serving calculations are rounded, though actual food label
// rounding standards are more complex.
if ($sum > 1) {
return round($sum);
}
else {
return round($sum, 2);
}
}
else {
return parent::__call($method, $parameters);
}
}
}