Abstract Class Yiisoft\Yii\DataView\BaseListView

                public function __construct(
    ?TranslatorInterface $translator = null,
    protected readonly string $translationCategory = self::DEFAULT_TRANSLATION_CATEGORY,
) {
    $this->translator = $translator ?? $this->createDefaultTranslator();
    $this->urlConfig = new UrlConfig();
    $this->urlParameterProvider = new NullUrlParameterProvider();
}

            

                public function addContainerClass(BackedEnum|string|null ...$class): static
{
    $new = clone $this;
    Html::addCssClass($new->containerAttributes, $class);
    return $new;
}

            

                public function addHeaderClass(BackedEnum|string|null ...$class): static
{
    $new = clone $this;
    Html::addCssClass($new->headerAttributes, $class);
    return $new;
}

            

                final public function append(string|Stringable ...$append): static
{
    $new = clone $this;
    $new->append = implode('', $append);
    return $new;
}

            

                final public function containerAttributes(array $attributes): static
{
    $new = clone $this;
    $new->containerAttributes = $attributes;
    return $new;
}

            

                public function containerClass(BackedEnum|string|null ...$class): static
{
    $new = clone $this;
    $new->containerAttributes['class'] = [];
    Html::addCssClass($new->containerAttributes, $class);
    return $new;
}

            

                final public function containerTag(?string $tag): static
{
    if ($tag === '') {
        throw new InvalidArgumentException('Tag name cannot be empty.');
    }
    $new = clone $this;
    $new->containerTag = $tag;
    return $new;
}

            

                final public function dataReader(ReadableDataInterface $dataReader): static
{
    $new = clone $this;
    $new->dataReader = $dataReader;
    return $new;
}

            

                final public function encodeHeader(bool $encode): static
{
    $new = clone $this;
    $new->encodeHeader = $encode;
    return $new;
}

            

                final protected function getDataReader(): ReadableDataInterface
{
    if ($this->dataReader === null) {
        throw new DataReaderNotSetException();
    }
    return $this->dataReader;
}

            

                final protected function getDefaultPageSize(): int
{
    $dataReader = $this->getDataReader();
    $pageSize = $dataReader instanceof PaginatorInterface
        ? $dataReader->getPageSize()
        : PaginatorInterface::DEFAULT_PAGE_SIZE;
    if (is_int($this->pageSizeConstraint)) {
        return $pageSize <= $this->pageSizeConstraint
            ? $pageSize
            : $this->pageSizeConstraint;
    }
    if (is_array($this->pageSizeConstraint)) {
        return in_array($pageSize, $this->pageSizeConstraint, true)
            ? $pageSize
            : $this->pageSizeConstraint[0];
    }
    return $pageSize;
}

            

                final protected function getNoResultsContent(): string
{
    $text = $this->translator->translate(
        $this->noResultsText,
        category: $this->translationCategory,
    );
    return str_replace('{text}', $text, $this->noResultsTemplate);
}

            

                final public function header(string $content): static
{
    $new = clone $this;
    $new->header = $content;
    return $new;
}

            

                final public function headerAttributes(array $attributes): static
{
    $new = clone $this;
    $new->headerAttributes = $attributes;
    return $new;
}

            

                public function headerClass(BackedEnum|string|null ...$class): static
{
    $new = clone $this;
    $new->headerAttributes['class'] = [];
    Html::addCssClass($new->headerAttributes, $class);
    return $new;
}

            

                final public function headerTag(?string $tag): static
{
    if ($tag === '') {
        throw new InvalidArgumentException('Tag name cannot be empty.');
    }
    $new = clone $this;
    $new->headerTag = $tag;
    return $new;
}

            

                final public function id(string $id): static
{
    $new = clone $this;
    $new->containerAttributes['id'] = $id;
    return $new;
}

            

                final public function ignoreMissingPage(bool $enabled): static
{
    $new = clone $this;
    $new->ignoreMissingPage = $enabled;
    return $new;
}

            

                final public function keysetPaginationConfig(array $config): static
{
    $new = clone $this;
    $new->keysetPaginationConfig = $config;
    return $new;
}

            

                final public function layout(string $view): static
{
    $new = clone $this;
    $new->layout = $view;
    return $new;
}

            

                abstract protected function makeFilters(): array;

            

                final public function multiSort(bool $enable = true): static
{
    $new = clone $this;
    $new->multiSort = $enable;
    return $new;
}

            

                final public function noResultsTemplate(string $template): static
{
    $new = clone $this;
    $new->noResultsTemplate = $template;
    return $new;
}

            

                final public function noResultsText(string $text): static
{
    $new = clone $this;
    $new->noResultsText = $text;
    return $new;
}

            

                final public function offsetPaginationConfig(array $config): static
{
    $new = clone $this;
    $new->offsetPaginationConfig = $config;
    return $new;
}

            

                final public function pageNotFoundExceptionCallback(?callable $callback): static
{
    $new = clone $this;
    $new->pageNotFoundExceptionCallback = $callback;
    return $new;
}

            

                final public function pageParameterName(string $name): static
{
    $new = clone $this;
    $new->urlConfig = $this->urlConfig->withPageParameterName($name);
    return $new;
}

            

                final public function pageParameterType(UrlParameterType $type): static
{
    $new = clone $this;
    $new->urlConfig = $this->urlConfig->withPageParameterType($type);
    return $new;
}

            

                final public function pageSizeAttributes(array $attributes): static
{
    $new = clone $this;
    $new->pageSizeAttributes = $attributes;
    return $new;
}

            

                final public function pageSizeConstraint(array|int|bool $pageSizeConstraint): static
{
    $new = clone $this;
    $new->pageSizeConstraint = $pageSizeConstraint;
    return $new;
}

            

                final public function pageSizeParameterName(string $name): static
{
    $new = clone $this;
    $new->urlConfig = $this->urlConfig->withPageSizeParameterName($name);
    return $new;
}

            

                final public function pageSizeParameterType(UrlParameterType $type): static
{
    $new = clone $this;
    $new->urlConfig = $this->urlConfig->withPageSizeParameterType($type);
    return $new;
}

            

                final public function pageSizeTag(?string $tag): static
{
    if ($tag === '') {
        throw new InvalidArgumentException('Tag name cannot be empty.');
    }
    $new = clone $this;
    $new->pageSizeTag = $tag;
    return $new;
}

            

                final public function pageSizeTemplate(?string $template): static
{
    $new = clone $this;
    $new->pageSizeTemplate = $template;
    return $new;
}

            

                final public function pageSizeWidget(?PageSizeWidgetInterface $widget): static
{
    $new = clone $this;
    $new->pageSizeWidget = $widget;
    return $new;
}

            

                final public function paginationWidget(?PaginationWidgetInterface $widget): static
{
    $new = clone $this;
    $new->paginationWidget = $widget;
    return $new;
}

            

                abstract protected function prepareOrder(array $order): array;

            

                final public function prepend(string|Stringable ...$prepend): static
{
    $new = clone $this;
    $new->prepend = implode('', $prepend);
    return $new;
}

            

                final public function previousPageParameterName(string $name): static
{
    $new = clone $this;
    $new->urlConfig = $this->urlConfig->withPreviousPageParameterName($name);
    return $new;
}

            

                final public function previousPageParameterType(UrlParameterType $type): static
{
    $new = clone $this;
    $new->urlConfig = $this->urlConfig->withPreviousPageParameterType($type);
    return $new;
}

            

                final public function render(): string
{
    [$filters, $filterValidationResult] = $this->makeFilters();
    [$preparedDataReader, $items] = $filters === null
        ? [null, []]
        : $this->prepareDataReaderAndItems($filters);
    $content = trim(
        strtr(
            $this->layout,
            [
                '{header}' => $this->renderHeader(),
                '{toolbar}' => $this->toolbar,
                '{items}' => $this->renderItems($items, $filterValidationResult, $preparedDataReader),
                '{summary}' => $this->renderSummary($preparedDataReader),
                '{pager}' => $this->renderPagination($preparedDataReader),
                '{pageSize}' => $this->renderPageSize($preparedDataReader),
            ],
        ),
    );
    if ($this->prepend !== '') {
        $content = $this->prepend . "\n" . $content;
    }
    if ($this->append !== '') {
        $content .= "\n" . $this->append;
    }
    return $this->containerTag === null
        ? $content
        : Html::tag($this->containerTag, "\n" . $content . "\n", $this->containerAttributes)
            ->encode(false)
            ->render();
}

            

                abstract protected function renderItems(
    array $items,
    ValidationResult $filterValidationResult,
    ?ReadableDataInterface $preparedDataReader,
): string;

            

                final public function sortParameterName(string $name): static
{
    $new = clone $this;
    $new->urlConfig = $this->urlConfig->withSortParameterName($name);
    return $new;
}

            

                final public function sortParameterType(UrlParameterType $type): static
{
    $new = clone $this;
    $new->urlConfig = $this->urlConfig->withSortParameterType($type);
    return $new;
}

            

                final public function summaryAttributes(array $attributes): static
{
    $new = clone $this;
    $new->summaryAttributes = $attributes;
    return $new;
}

            

                final public function summaryTag(?string $tag): static
{
    if ($tag === '') {
        throw new InvalidArgumentException('Tag name cannot be empty.');
    }
    $new = clone $this;
    $new->summaryTag = $tag;
    return $new;
}

            

                final public function summaryTemplate(?string $template): static
{
    $new = clone $this;
    $new->summaryTemplate = $template;
    return $new;
}

            

                final public function toolbar(string $content): static
{
    $new = clone $this;
    $new->toolbar = $content;
    return $new;
}

            

                final public function urlArguments(array $arguments): static
{
    $new = clone $this;
    $new->urlConfig = $this->urlConfig->withArguments($arguments);
    return $new;
}

            

                final public function urlCreator(?callable $urlCreator): static
{
    $new = clone $this;
    $new->urlCreator = $urlCreator;
    return $new;
}

            

                final public function urlParameterProvider(UrlParameterProviderInterface $provider): static
{
    $new = clone $this;
    $new->urlParameterProvider = $provider;
    return $new;
}

            

                final public function urlQueryParameters(array $parameters): static
{
    $new = clone $this;
    $new->urlConfig = $this->urlConfig->withQueryParameters($parameters);
    return $new;
}