dev-think-one / nova-list-card

src/ListCard.php

<?php

namespace NovaListCard;

use Carbon\Carbon;
use Illuminate\Support\Str;
use Laravel\Nova\Card;
use Laravel\Nova\Nova;
use Laravel\Nova\Resource;
use NovaListCard\Http\Requests\CardRequest;

abstract class ListCard extends Card
{
    public ?string $name = null;

    public $width = '1/3';

    public ?string $resource = null;

    public ?string $relationship = null;

    public ?string $aggregate = null;

    public ?string $aggregateColumn = null;

    public ?int $limit = 5;

    public ?string $orderColumn = null;

    public ?string $orderDirection = null;

    public ?\Closure $queryCallback = null;

    public array $heading = [];

    public ?string $valueColumn = null;

    public ?string $valueFormat = null;

    public ?string $valueFormatter = null;

    public ?string $timestampColumn = null;

    public ?string $timestampFormat = null;

    public bool $noMaxHeight = false;

    public string $classes = '';

    public function component()
    {
        return 'nova-list-card';
    }

    public function cacheFor(): int|Carbon
    {
        return 0;
    }

    public function getCacheKey(CardRequest $request): string
    {
        return sprintf(
            'nova.metric.%s.%s.%s.%s.%s.%s',
            $this->uriKey(),
            $request->input('range', 'no-range'),
            $request->input('timezone', 'no-timezone'),
            $request->input('twelveHourTime', 'no-12-hour-time'),
            $this->onlyOnDetail ? $request->findModelOrFail()->getKey() : 'no-resource-id',
            md5($this->resource)

It seems like $this->resource can also be of type null; however, parameter $string of md5() does only seem to accept string, maybe add an additional type check?

        );
    }

    public function name(): string
    {
        return $this->name ?: Nova::humanize($this);
    }

    public function uriKey(): string
    {
        return Str::slug($this->name(), '-', null);
    }

    /**
     * @param class-string<Resource> $resource

The doc comment class-string<Resource> at position 0 could not be parsed: Unknown type name 'class-string' at position 0 in class-string<Resource>.

     * @return $this
     */
    public function resource(string $resource): static
    {
        $this->resource = $resource;
        $this->classes($resource::uriKey());

        return $this;
    }

    public function withAggregate(string $aggregate, string $relationship, ?string $column = null): static
    {
        $this->aggregate       = $aggregate;
        $this->relationship    = $relationship;
        $this->aggregateColumn = $column;

        return $this;
    }

    public function withCount(string $relationship): static
    {
        return $this->withAggregate('count', $relationship);
    }

    public function withSum(string $relationship, string $column): static
    {
        return $this->withAggregate('sum', $relationship, $column);
    }

    public function orderBy(string $column, string $direction = 'desc'): static
    {
        $this->orderColumn = $column;

        $direction = Str::lower($direction);
        if (!in_array($direction, ['asc', 'desc'])) {
            $direction = 'desc';
        }
        $this->orderDirection = $direction;

        return $this;
    }

    public function limit(?int $limit = 5): static
    {
        $this->limit = $limit;

        return $this;
    }

    public function queryCallback(?\Closure $queryCallback = null): static
    {
        $this->queryCallback = $queryCallback;

        return $this;
    }

    public function heading(string $left, ?string $right = null): static
    {
        $this->heading = ['left' => $left, 'right' => $right];
        $this->classes(Str::slug($left));

        return $this;
    }

    public function value(string $column, ?string $formatter = 'integer', ?string $format = null): static
    {
        $this->valueColumn    = $column;
        $this->valueFormat    = $format;
        $this->valueFormatter = $formatter;

        return $this;
    }

    public function timestamp(string $column = 'created_at', string $format = 'd/m/Y'): static
    {
        $this->timestampColumn = $column;
        $this->timestampFormat = $format;

        return $this;
    }

    public function noMaxHeight(bool $noMaxHeight = true): static
    {
        $this->noMaxHeight = $noMaxHeight;

        return $this;
    }

    public function classes(string $classes): static
    {
        $this->classes = "{$this->classes} {$classes}";

        return $this;
    }

    /**
     * @inheritDoc
     */
    public function jsonSerialize(): array
    {
        return array_merge([
            'uriKey'      => $this->uriKey(),
            'classes'     => trim($this->classes),
            'heading'     => $this->heading,
            'noMaxHeight' => $this->noMaxHeight,
            'url'         => route('nova-list-card.data', ['key' => $this->uriKey()]),
        ], parent::jsonSerialize());
    }
}