dev-think-one / laravel-cashier-subscription-pause

src/Eloquent/UsesPauseCollection.php

<?php

namespace CashierSubscriptionPause\Eloquent;

use Carbon\Carbon;
use Illuminate\Database\Eloquent\Builder;
use LogicException;

/**
 * @property array|null $pause_collection
 * @extends WithPauseCollection
 */
trait UsesPauseCollection
{
    /**
     * @inerhitDoc
     */
    public function pause(string $behavior, ?Carbon $resumesAt = null): static
    {
        if ($this->canceled()) {

It seems like canceled() must be provided by classes using this trait. How about adding it as abstract method to this trait?

            throw new LogicException('Unable to pause subscription that is canceled.');
        }

        $payload = [ 'behavior' => $behavior ];
        if ($resumesAt) {
            $payload['resumes_at'] = $resumesAt->timestamp;
        }
        $stripeSubscription = $this->updateStripeSubscription([ 'pause_collection' => $payload, ]);

It seems like updateStripeSubscription() must be provided by classes using this trait. How about adding it as abstract method to this trait?

        $this->fill([

It seems like fill() must be provided by classes using this trait. How about adding it as abstract method to this trait?

            'pause_collection' => $stripeSubscription->pause_collection,
        ])->save();

        return $this;
    }

    /**
     * @inerhitDoc
     */
    public function pauseBehaviorMarkUncollectible(?Carbon $resumesAt = null): static
    {
        return $this->pause(WithPauseCollection::BEHAVIOR_MARK_UNCOLLECTIBLE, $resumesAt);
    }

    /**
     * @inerhitDoc
     */
    public function pauseBehaviorKeepAsDraft(?Carbon $resumesAt = null): static
    {
        return $this->pause(WithPauseCollection::BEHAVIOR_KEEP_AS_DRAFT, $resumesAt);
    }

    /**
     * @inerhitDoc
     */
    public function pauseBehaviorVoid(?Carbon $resumesAt = null): static
    {
        return $this->pause(WithPauseCollection::BEHAVIOR_VOID, $resumesAt);
    }

    /**
     * @inerhitDoc
     */
    public function unpause(): static
    {
        if (!$this->paused()) {
            throw new LogicException('Unable to unpause subscription that is not paused.');
        }

        $stripeSubscription = $this->updateStripeSubscription([ 'pause_collection' => '', ]);

        $this->fill([
            'pause_collection' => $stripeSubscription->pause_collection,
        ])->save();

        return $this;
    }

    /**
     * @inerhitDoc
     */
    public function syncStripePauseCollection(): static
    {
        if($this->owner) {
            $subscription = $this->asStripeSubscription();

It seems like asStripeSubscription() must be provided by classes using this trait. How about adding it as abstract method to this trait?

            $this->pause_collection = $subscription->pause_collection?->toArray();
            $this->save();

It seems like save() must be provided by classes using this trait. How about adding it as abstract method to this trait?

        }

        return $this;
    }

    /**
     * @inerhitDoc
     */
    public function paused(?string $behavior = null): bool
    {
        $hasBehavior = is_array($this->pause_collection) && !empty($this->pause_collection['behavior']);
        if ($behavior) {
            return $hasBehavior && $this->pause_collection['behavior'] === $behavior;
        }

        return $hasBehavior;
    }

    /**
     * Filter query by pause_collection behavior.
     *
     * @param Builder $query
     * @param string|null $behavior
     *
     * @return Builder
     */
    public function scopePaused($query, ?string $behavior = null): Builder
    {
        if (!$behavior) {
            return $query->whereNotNull('pause_collection')
                         ->where('pause_collection->behavior', '!=', '')
                         ->whereNotNull('pause_collection->behavior');
        }

        return $query->where('pause_collection->behavior', '=', $behavior);
    }

    /**
     * @inerhitDoc
     */
    public function notPaused(?string $behavior = null): bool
    {
        return !$this->paused($behavior);
    }

    /**
     * Filter query by not paused payment collection.
     *
     * @param Builder $query
     * @param string|null $behavior
     *
     * @return Builder
     */
    public function scopeNotPaused($query, ?string $behavior = null): Builder
    {
        if (!$behavior) {
            return $query->where(function ($query) {
                $query->whereNull('pause_collection')
                      ->orWhere('pause_collection->behavior', '=', '')
                      ->orWhereNull('pause_collection->behavior');
            });
        }

        return $query->where(function ($query) use ($behavior) {
            $query->where('pause_collection->behavior', '!=', $behavior)
                  ->orWhereNull('pause_collection')
                  ->orWhereNull('pause_collection->behavior');
        });
    }

    /**
     * @inerhitDoc
     */
    public function pauseResumesAtTimestamp(?string $behavior = null): ?string
    {
        if (!$this->paused($behavior) || empty($this->pause_collection['resumes_at'])) {
            return null;
        }

        return $this->pause_collection['resumes_at'];
    }

    /**
     * @inerhitDoc
     */
    public function pauseResumesAt(?string $behavior = null): ?Carbon
    {
        if ($timestamp = $this->pauseResumesAtTimestamp($behavior)) {
            return Carbon::createFromTimestamp($timestamp);
        }

        return null;
    }
}