README

Laravel пакет для планирования блюд по календарю. Позволяет пользователям создавать планы готовки на определенные даты, связывая их с рецептами из вашей кулинарной книги.

Требования

• PHP >= 8.2
• Laravel >= 11.0 или >= 12.0
• Vue.js 3 (для использования Vue компонента)

Установка

Через Composer

composer require greekasoft/plan_cooking_calendar

Публикация миграций

php artisan vendor:publish --tag=plan-cooking-calendar-migrations

Публикация конфигурации (опционально)

php artisan vendor:publish --tag=plan-cooking-calendar-config

Публикация Vue компонентов (опционально)

php artisan vendor:publish --tag=plan-cooking-calendar-assets

Выполнение миграций

php artisan migrate

Конфигурация

После публикации конфигурации, вы можете настроить пакет в файле config/plan-cooking-calendar.php:

return [
    'route_prefix' => 'api/cooking-calendar',
    'middleware' => ['web', 'auth'],
    'recipe_model' => 'App\Models\Recipe',
    'user_model' => 'App\Models\User',
];

Использование

API Endpoints

Пакет автоматически регистрирует следующие маршруты:

• GET /api/cooking-calendar - Получить список планов (поддерживает параметры start_date, end_date, month, year)
• GET /api/cooking-calendar/date/{date} - Получить планы на конкретную дату
• POST /api/cooking-calendar - Создать новый план
• GET /api/cooking-calendar/{id} - Получить конкретный план
• PUT /api/cooking-calendar/{id} - Обновить план
• DELETE /api/cooking-calendar/{id} - Удалить план
• PATCH /api/cooking-calendar/{id}/toggle-complete - Переключить статус выполнения

Использование модели

use Greekasoft\PlanCookingCalendar\Models\CookingPlan;

// Создать план
$plan = CookingPlan::create([
    'user_id' => auth()->id(),
    'recipe_id' => 1,
    'planned_date' => '2024-01-15',
    'planned_time' => '18:00',
    'servings' => 4,
    'notes' => 'Ужин для семьи',
]);

// Получить планы на дату
$plans = CookingPlan::forDate('2024-01-15')->get();

// Получить планы за период
$plans = CookingPlan::forDateRange('2024-01-01', '2024-01-31')->get();

// Получить только выполненные планы
$completed = CookingPlan::completed()->get();

// Получить только невыполненные планы
$pending = CookingPlan::pending()->get();

Использование Vue компонента

После публикации Vue компонента, импортируйте его в ваше приложение:

import CookingCalendar from './vendor/plan-cooking-calendar/CookingCalendar.vue';

// В вашем компоненте или app.js
app.component('CookingCalendar', CookingCalendar);

Затем используйте в шаблоне:

<template>
    <div>
        <CookingCalendar />
    </div>
</template>

Или в Blade шаблоне:

<div id="cooking-calendar">
    <cooking-calendar></cooking-calendar>
</div>

@vite(['resources/js/app.js'])

Важно: Убедитесь, что у вас настроен API endpoint для получения списка рецептов. Компонент ожидает ответ от /api/recipes или /recipe-list. При необходимости измените метод loadRecipes() в компоненте.

Структура базы данных

Пакет создает таблицу cooking_plans со следующими полями:

• id - ID плана
• user_id - ID пользователя (связь с таблицей users)
• recipe_id - ID рецепта (связь с таблицей recipes)
• planned_date - Запланированная дата
• planned_time - Запланированное время (опционально)
• servings - Количество порций
• notes - Заметки
• is_completed - Статус выполнения
• created_at, updated_at - Временные метки

Минимальные требования

Пакет требует следующие зависимости:

• php >= 8.2
• illuminate/support ^11.0|^12.0
• illuminate/database ^11.0|^12.0
• illuminate/routing ^11.0|^12.0
• illuminate/http ^11.0|^12.0

Публикация на Packagist

1. Создайте репозиторий на GitHub
2. Добавьте теги версий (например, v1.0.0)
3. Зарегистрируйте пакет на packagist.org
4. Укажите URL вашего репозитория

Лицензия

MIT

Автор

Igor Morozov (GreekIgor87@gmail.com)