EscolaLMS/Cart

<?php

namespace EscolaLms\Cart\Services\Contracts;

use EscolaLms\Cart\Contracts\Productable;
use EscolaLms\Cart\Dtos\PageDto;
use EscolaLms\Cart\Dtos\ProductSearchMyCriteriaDto;
use EscolaLms\Cart\Dtos\ProductsSearchDto;
use EscolaLms\Cart\Models\Product;
use EscolaLms\Cart\Models\ProductProductable;
use EscolaLms\Cart\Models\ProductUser;
use EscolaLms\Core\Dtos\OrderDto;
use EscolaLms\Core\Models\User;
use Illuminate\Contracts\Pagination\LengthAwarePaginator;
use Illuminate\Http\Resources\Json\JsonResource;
use Illuminate\Support\Carbon;
use Illuminate\Support\Collection;

interface ProductServiceContract
{
    public function registerProductableClass(string $productableClass): void;
    public function isProductableClassRegistered(string $productableClass): bool;
    public function listRegisteredProductableClasses(): array;
    public function listRegisteredMorphClasses(): array;
    public function listAllProductables(): Collection;
    public function canonicalProductableClass(string $productableClass): ?string;

    public function findSingleProductForProductable(Productable $productable): ?Product;
    public function findProductable(string $productableClass, $productId): ?Productable;

    public function mapProductProductableToJsonResource(ProductProductable $productProductable): JsonResource;

    public function searchAndPaginateProducts(ProductsSearchDto $searchDto, ?OrderDto $orderDto = null): LengthAwarePaginator;

    public function productIsPurchasableOrOwnedByUser(Product $product, User $user): bool;
    public function productIsBuyableByUser(Product $product, User $user, bool $check_productables = false, int $quantity = 1);
    public function productIsOwnedByUser(Product $product, User $user, bool $check_productables = false);
    public function productProductablesAllOwnedByUser(Product $product, User $user): bool;
    public function productProductablesAllBuyableByUser(Product $product, User $user): bool;

    public function create(array $data): Product;
    public function update(Product $product, array $data): Product;

    public function attachProductToUser(Product $product, User $user, int $quantity = 1): void;
    public function detachProductFromUser(Product $product, User $user, int $quantity = 1): void;
    public function attachProductableToUser(Productable $productable, User $user, int $quantity = 1, ?Product $product = null): void;
    public function detachProductableFromUser(Productable $productable, User $user, int $quantity = 1, ?Product $product = null): void;

    public function productableIsOwnedByUserThroughProduct(Productable $productable, User $user): bool;
    public function canDetachProductableFromUser(Productable $productable, User $user): bool;
    public function searchMy(ProductSearchMyCriteriaDto $dto, PageDto $pageDto, OrderDto $orderDto): LengthAwarePaginator;

    public function hasActiveSubscriptionAllIn(User $user): ?Product;

    public function getRecursiveProductUserBeforeExpiredEndDate(Carbon $start, Carbon $end): Collection;

    public function cancelActiveRecursiveProduct(Product $product, User $user): void;
}