Function listPlanCharter

·  هدف:

این متد برای واکشی و نمایش لیست پلن‌های اتاق‌بندی (plan) مرتبط با یک چارتر اقامتی طراحی شده است. هدف اصلی آن، ارائه یک نمای کلی از تخصیص اتاق‌ها به مسافران بر اساس یک پلن از پیش تعریف‌شده است. متد ابتدا چارتر را بر اساس شناسه پیدا کرده و بررسی می‌کند که آیا چارتری از نوع اقامتی و دارای پلن است یا خیر. سپس، با استفاده از ReservationController::getPlanDetails, جزئیات کامل پلن (شامل لیست اتاق‌ها و مسافران تخصیص‌یافته به هر کدام) را واکشی می‌کند. در نهایت، با فراخوانی ReservationController::getPlanPassengers, لیست تمام مسافران مرتبط با آن پلن را نیز استخراج کرده و هر دو لیست (جزئیات پلن و لیست مسافران) را در خروجی بازمی‌گرداند.

·     ورودی‌ها (پارامتر‌ها):

·     خروجی (Return):

·  مثال استفاده / سناریو:

سناریو: مشاهده پلن اتاق‌بندی چارتر هتل با شناسه ۶۲۰

• Request URL: /api/panel/v2/charter/620/plan/list
• Action:

1. متد چارتر ۶۲۰ را از دیتابیس می‌خواند. فرضاً type='accommodation' و plan=5 است.
2. ReservationController::getPlanDetails(5, 620) فراخوانی می‌شود تا جزئیات تخصیص اتاق‌ها را برگرداند.
3. ReservationController::getPlanPassengers(5) فراخوانی می‌شود تا لیست تمام مسافران آن پلن را برگرداند.
4. نتایج در یک آبجکت payload ترکیب می‌شوند.

• Response:
• HTTP Status: 200 OK
• Body:

        {
            "payload": {
                "details": [ { "room_number": "101", "passengers": [ {...} ] }, ... ],
                "passengers": [ {...passenger_1...}, {...passenger_2...} ]
            },
            "meta": { "timestamp": ... }
        }