Primordyx Framework Documentation

__construct()

Initialize pagination container with data and metadata calculation

Parameters

$data : array<string|int, mixed>

Current page data subset (arrays or objects)

$total : int

Total number of items across all pages

$perPage : int

Maximum items per page for pagination calculation

$currentPage : int

Current page number (1-based indexing)

$pages : int|null = null

Optional override for total pages (calculated if null)

Tags

since

1.0.0

example

Framework Integration (Typical)

// Called internally by Model::paginate()
[$rows, $total, $pages] = $queryBuilder->paginate(20, 2, $db);
$paginator = new Paginator($rows, $total, 20, 2, $pages);

example

Manual Construction for API Data

$apiResponse = [
    'items' => [['name' => 'Product 1'], ['name' => 'Product 2']],
    'total' => 150,
    'page_count' => 8
];

$paginator = new Paginator(
    $apiResponse['items'],    // Current page data
    $apiResponse['total'],    // Total items
    20,                       // Items per page
    2,                        // Current page
    $apiResponse['page_count'] // Explicit page count
);

example

Automatic Page Calculation

// Constructor calculates: ceil(47 / 10) = 5 pages
$paginator = new Paginator(
    $currentPageData,  // 10 items for current page
    47,               // Total items across all pages
    10,               // Items per page
    3                 // Current page (null for pages = auto-calculate)
);
// $paginator->pages === 5

hasMore()

Check if additional pages exist beyond the current page

Tags

since

1.0.0

example

Conditional Navigation Controls

echo "<div class='pagination-controls'>";

// Previous button with state management
if ($paginator->currentPage > 1) {
    echo "<button onclick=\"goToPage({$paginator->currentPage - 1})\">Previous</button>";
} else {
    echo "<button disabled>Previous</button>";
}

echo " Page {$paginator->currentPage} of {$paginator->pages} ";

// Next button with hasMore() check
if ($paginator->hasMore()) {
    echo "<button onclick=\"goToPage({$paginator->currentPage + 1})\">Next</button>";
} else {
    echo "<button disabled>Next</button>";
}

echo "</div>";

example

API Response Metadata

function paginationApiResponse(Paginator $p): array {
    return [
        'data' => $p->data,
        'pagination' => [
            'current_page' => $p->currentPage,
            'per_page' => $p->perPage,
            'total' => $p->total,
            'total_pages' => $p->pages,
            'has_more' => $p->hasMore(),
            'has_previous' => $p->currentPage > 1
        ]
    ];
}

example

Template Helper Integration

// In template helper or view component
class PaginationHelper {
    public static function renderLoadMoreButton(Paginator $p, string $targetUrl): string {
        if (!$p->hasMore()) {
            return '<p class="end-of-results">No more results to load</p>';
        }

        $nextPage = $p->currentPage + 1;
        return "<button class='load-more' data-page='$nextPage' data-url='$targetUrl'>
                   Load More Results ({$p->perPage} more items)
               </button>";
    }
}

example

Infinite Scroll Integration

// JavaScript integration data
$scrollConfig = [
    'hasMore' => $paginator->hasMore(),
    'nextPage' => $paginator->hasMore() ? $paginator->currentPage + 1 : null,
    'totalPages' => $paginator->pages,
    'loadUrl' => '/api/load-more'
];

echo "<script>window.paginationConfig = " . json_encode($scrollConfig) . ";</script>";

see

nextUrl()

For actual next page URL generation

see

prevUrl()

For previous page navigation

nextUrl()

Generate URL for next page with query parameter preservation

Parameters

$baseUrl : string

Base URL for pagination (without query parameters)

$params : array<string, mixed> = []

Additional query parameters to preserve

Tags

since

1.0.0

example

Basic Next Page Navigation

$nextUrl = $paginator->nextUrl('/products');
// Result: '/products?page=3&limit=20' (if on page 2)

if ($nextUrl) {
    echo "<a href='$nextUrl'>Next Page</a>";
}

example

Preserved Search Parameters

$searchParams = [
    'q' => 'laptop',
    'category' => 'electronics',
    'sort' => 'price_asc'
];

$nextUrl = $paginator->nextUrl('/search', $searchParams);
// Result: '/search?q=laptop&category=electronics&sort=price_asc&page=3&limit=20'

example

Navigation Menu with Boundary Handling

function renderNavigation(Paginator $p, string $baseUrl, array $params = []): string {
    $nav = "<nav class='pagination'>";

    // Previous link
    if ($prevUrl = $p->prevUrl($baseUrl, $params)) {
        $nav .= "<a href='$prevUrl' class='prev'>« Previous</a>";
    }

    // Page indicator
    $nav .= "<span class='info'>Page {$p->currentPage} of {$p->pages}</span>";

    // Next link
    if ($nextUrl = $p->nextUrl($baseUrl, $params)) {
        $nav .= "<a href='$nextUrl' class='next'>Next »</a>";
    }

    return $nav . "</nav>";
}

see

prevUrl()

For previous page navigation

see

hasMore()

For boolean next page availability

prevUrl()

Generate URL for previous page with query parameter preservation

Parameters

$baseUrl : string

Base URL for pagination (without query parameters)

$params : array<string, mixed> = []

Additional query parameters to preserve

Tags

since

1.0.0

example

Basic Previous Page Navigation

$prevUrl = $paginator->prevUrl('/users');
// Result: '/users?page=1&limit=25' (if on page 2)

if ($prevUrl) {
    echo "<a href='$prevUrl' class='btn-prev'>« Previous</a>";
} else {
    echo "<span class='btn-prev disabled'>« Previous</span>";
}

example

Complex Parameter Preservation

// Current URL: /reports?department=sales&date_from=2024-01-01&status=active&page=5
$filterParams = [
    'department' => $_GET['department'],
    'date_from' => $_GET['date_from'],
    'status' => $_GET['status']
];

$prevUrl = $paginator->prevUrl('/reports', $filterParams);
// Result: '/reports?department=sales&date_from=2024-01-01&status=active&page=4&limit=20'

example

Complete Pagination Controls

function buildPaginationLinks(Paginator $p, string $url, array $params): array {
    return [
        'first' => $p->currentPage > 1 ? $url . '?' . http_build_query(array_merge($params, ['page' => 1, 'limit' => $p->perPage])) : null,
        'prev' => $p->prevUrl($url, $params),
        'current' => $p->currentPage,
        'next' => $p->nextUrl($url, $params),
        'last' => $p->currentPage < $p->pages ? $url . '?' . http_build_query(array_merge($params, ['page' => $p->pages, 'limit' => $p->perPage])) : null,
        'total_pages' => $p->pages
    ];
}

see

nextUrl()

For next page navigation

see

hasMore()

For checking additional page availability