<?php

/**
 * Vvveb
 *
 * Copyright (C) 2022  Ziadin Givan
 *
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Affero General Public License as
 * published by the Free Software Foundation, either version 3 of the
 * License, or (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU Affero General Public License for more details.
 *
 * You should have received a copy of the GNU Affero General Public License
 * along with this program.  If not, see <https://www.gnu.org/licenses/>.
 *
 */

namespace Vvveb\System;

abstract class ShippingMethod {
	/** @var object Cart instance. */
	protected object $cart;

	/**
	 * @param object $cart Cart instance.
	 */
	public function __construct(object $cart) {
		$this->cart = $cart;
	}

	/**
	 * Initialize the shipping method.
	 *
	 * @return void
	 */
	abstract public function init(): void;

	/**
	 * Get shipping method details and options.
	 *
	 * @param array<string, mixed> &$checkoutInfo Checkout information passed by reference.
	 * @param array<string, mixed> $options        Method-specific options.
	 *
	 * @return array<string, mixed>|false Method data or false if unavailable.
	 */
	abstract public function getMethod(array &$checkoutInfo = [], array $options = []): array|false;

	/**
	 * Set the active shipping method.
	 *
	 * @return void
	 */
	abstract public function setMethod(): void;

	/**
	 * Process the shipment.
	 *
	 * @param array<string, mixed> &$checkoutInfo Checkout information passed by reference.
	 *
	 * @return void
	 */
	abstract public function ship(array &$checkoutInfo = []): bool;
}
