$lr App\Core\Lib\Listing\ListRequest#82 (9)
  • Properties (9)
  • Methods (26)
  • Static methods (12)
  • private originalQuery -> array (0)
    private encryptedKey -> null
    private sort -> null
    private direction -> string (3) "asc"
    private page -> integer 1
    private perPage -> integer 25
    private filters -> array (0)
    private defaults -> array (5)
    sort => null
    direction => string (3) "asc"
    page => integer 1
    perPage => integer 25
    maxPerPage => integer 100
    private aliases -> array (9)
    s => string (4) "sort"
    sort => string (4) "sort"
    d => string (9) "direction"
    dir => string (9) "direction"
    direction => string (9) "direction"
    p => string (4) "page"
    page => string (4) "page"
    pp => string (7) "perPage"
    perPage => string (7) "perPage"
  • private __construct(?string $sort, string $direction, int $page, int $perPage, array $filters = array(), array $defaults = array(), array $aliases = array()) Private constructor, use fromArray() or fromEncryptedString()
    /**
 * Private constructor, use fromArray() or fromEncryptedString()
 * @param string|null $sort
 * @param string $direction
 * @param int $page
 * @param int $perPage
 * @param array<string, mixed> $filters
 * @param array<string, mixed> $defaults
 * @param array<string, string> $aliases
 */

Defined in .../app/Core/Lib/Listing/ListRequest.php:79
    public withSort(?string $sort): self Return immutable copy with new sort
    $lr->withSort()
    /**
 * Return immutable copy with new sort
 * @param string|null $sort
 * @return self
 */

Defined in .../app/Core/Lib/Listing/ListRequest.php:201
    public withDirection(string $direction): self Return immutable copy with new direction
    $lr->withDirection()
    /**
 * Return immutable copy with new direction
 * @param string $direction
 * @return self
 */

Defined in .../app/Core/Lib/Listing/ListRequest.php:214
    public withPage(int $page): self Return immutable copy with new page
    $lr->withPage()
    /**
 * Return immutable copy with new page
 * @param int $page
 * @return self
 */

Defined in .../app/Core/Lib/Listing/ListRequest.php:227
    public withPerPage(int $perPage): self Return immutable copy with new perPage
    $lr->withPerPage()
    /**
 * Return immutable copy with new perPage
 * @param int $perPage
 * @return self
 */

Defined in .../app/Core/Lib/Listing/ListRequest.php:239
    public withFilter(string $key, mixed $value): self Return immutable copy with added/updated filter
    $lr->withFilter()
    /**
 * Return immutable copy with added/updated filter
 * @param string $key
 * @param mixed $value
 * @return self
 */

Defined in .../app/Core/Lib/Listing/ListRequest.php:253
    public withSortToggle(string $column): self Toggle sort direction if same column, else set new column
    $lr->withSortToggle()
    /**
 * Toggle sort direction if same column, else set new column
 * @param string $column
 * @return self
 */

Defined in .../app/Core/Lib/Listing/ListRequest.php:266
    public toQuery(): array Convert to query array (s,d,p,pp + filters)
    $lr->toQuery()
    /**
 * Convert to query array (s,d,p,pp + filters)
 * @return array<string, mixed>
 */

Defined in .../app/Core/Lib/Listing/ListRequest.php:284
    public toEncryptedString(): string Encrypt query to URL-safe string
    $lr->toEncryptedString()
    /**
 * Encrypt query to URL-safe string
 * @return string
 */

Defined in .../app/Core/Lib/Listing/ListRequest.php:300
    public buildUrlQuery(bool $withOriginalQuery = true, bool $forceIncludeDefaults = false): string
    $lr->buildUrlQuery()
    Defined in .../app/Core/Lib/Listing/ListRequest.php:305
    public getOriginalQuery(): array Get original query
    $lr->getOriginalQuery()
    /**
 * Get original query
 * @return array<string, mixed>
 */

Defined in .../app/Core/Lib/Listing/ListRequest.php:405
    public setOriginalQuery(array $originalQuery): self Set original query
    $lr->setOriginalQuery()
    /**
 * Set original query
 * @param array<string, mixed> $originalQuery
 * @return self
 */

Defined in .../app/Core/Lib/Listing/ListRequest.php:415
    public getEncryptedKey(): ?string Get encrypted key
    $lr->getEncryptedKey()
    /**
 * Get encrypted key
 * @return string|null
 */

Defined in .../app/Core/Lib/Listing/ListRequest.php:425
    public setEncryptedKey(?string $encryptedKey): self Set encrypted key
    $lr->setEncryptedKey()
    /**
 * Set encrypted key
 * @param string $encryptedKey
 * @return self
 */

Defined in .../app/Core/Lib/Listing/ListRequest.php:435
    public getSort(): ?string Get sort column
    $lr->getSort()
    /**
 * Get sort column
 * @return string|null
 */

Defined in .../app/Core/Lib/Listing/ListRequest.php:445
    public setSort(string $sort): self Set sort column
    $lr->setSort()
    /**
 * Set sort column
 * @param string $sort
 * @return self
 */

Defined in .../app/Core/Lib/Listing/ListRequest.php:455
    public getDirection(): string Get sort direction
    $lr->getDirection()
    /**
 * Get sort direction
 * @return string
 */

Defined in .../app/Core/Lib/Listing/ListRequest.php:465
    public setDirection(string $direction): self Set sort direction
    $lr->setDirection()
    /**
 * Set sort direction
 * @param string $direction
 * @return self
 */

Defined in .../app/Core/Lib/Listing/ListRequest.php:475
    public getPage(): int Get current page
    $lr->getPage()
    /**
 * Get current page
 * @return int
 */

Defined in .../app/Core/Lib/Listing/ListRequest.php:485
    public setPage(int $page): self Set current page
    $lr->setPage()
    /**
 * Set current page
 * @param int $page
 * @return self
 */

Defined in .../app/Core/Lib/Listing/ListRequest.php:495
    public getPerPage(): int Get items per page
    $lr->getPerPage()
    /**
 * Get items per page
 * @return int
 */

Defined in .../app/Core/Lib/Listing/ListRequest.php:505
    public getOffset(): int Calculate offset for pagination queries. Useful for SQL LIMIT/OFFSET.
    $lr->getOffset()
    /**
 * Calculate offset for pagination queries.
 * Useful for SQL LIMIT/OFFSET.
 * @return int Offset calculated as (page - 1) * perPage
 */

Defined in .../app/Core/Lib/Listing/ListRequest.php:515
    public setPerPage(int $perPage): self Set items per page
    $lr->setPerPage()
    /**
 * Set items per page
 * @param int $perPage
 * @return self
 */

Defined in .../app/Core/Lib/Listing/ListRequest.php:525
    public getFilter(string $key, mixed $default = null): mixed Get filter value by key
    $lr->getFilter()
    /**
 * Get filter value by key
 * @param string $key
 * @param mixed|null $default
 * @return mixed
 */

Defined in .../app/Core/Lib/Listing/ListRequest.php:537
    public setFilter(string $key, mixed $value): self Set filter value by key
    $lr->setFilter()
    /**
 * Set filter value by key
 * @param string $key
 * @param mixed $value
 * @return self
 */

Defined in .../app/Core/Lib/Listing/ListRequest.php:548
    public getFilters(): array Get all filters
    $lr->getFilters()
    /**
 * Get all filters
 * @return array<string, mixed>
 */

Defined in .../app/Core/Lib/Listing/ListRequest.php:558
  • public static App\Core\Lib\Listing\ListRequest::defaultDefaults(): array Default parameter values
    /**
 * Default parameter values
 * @return array<string, mixed>
 */

Defined in .../app/Core/Lib/Listing/ListRequest.php:102
    public static App\Core\Lib\Listing\ListRequest::defaultAliases(): array Default input aliases
    /**
 * Default input aliases
 * @return array<string, string>
 */

Defined in .../app/Core/Lib/Listing/ListRequest.php:117
    public static App\Core\Lib\Listing\ListRequest::fromArray(array $data, array $defaults = array(), array $aliases = array()): self Create ListRequest from array (e.g. $_GET)
    /**
 * Create ListRequest from array (e.g. $_GET)
 * @param array<string, mixed> $data
 * @param array<string, mixed> $defaults
 * @param array<string, string> $aliases
 * @return self
 */

Defined in .../app/Core/Lib/Listing/ListRequest.php:139
    public static App\Core\Lib\Listing\ListRequest::fromEncryptedString(?string $encrypted, array $defaults = array(), array $aliases = array()): self Create ListRequest from encrypted string
    /**
 * Create ListRequest from encrypted string
 * @param string|null $encrypted
 * @param array<string, mixed> $defaults
 * @param array<string, string> $aliases
 * @return self
 */

Defined in .../app/Core/Lib/Listing/ListRequest.php:171
    public static App\Core\Lib\Listing\ListRequest::fromRequest(array $query, ?string $encryptedKey = null, array $defaults = array(), array $aliases = array()): self
    Defined in .../app/Core/Lib/Listing/ListRequest.php:178
    public static App\Core\Lib\Listing\ListRequest::fromGet(?string $encryptedKey = null, array $defaults = array(), array $aliases = array()): self
    Defined in .../app/Core/Lib/Listing/ListRequest.php:190
    private static App\Core\Lib\Listing\ListRequest::encrypt(array $data): string Encrypt array using Encryption service
    /**
 * Encrypt array using Encryption service
 * @param array<string, mixed> $data
 * @return string
 */

Defined in .../app/Core/Lib/Listing/ListRequest.php:328
    private static App\Core\Lib\Listing\ListRequest::decrypt(string $encrypted): array Decrypt string to array using Encryption service
    /**
 * Decrypt string to array using Encryption service
 * @param string $encrypted
 * @return array<string, mixed>
 */

Defined in .../app/Core/Lib/Listing/ListRequest.php:338
    private static App\Core\Lib\Listing\ListRequest::normalizeSortValue(?string $value): ?string Normalize sort value Trims the string and converts empty to null
    /**
 * Normalize sort value
 * Trims the string and converts empty to null
 * @param string|null $value
 * @return string|null
 */

Defined in .../app/Core/Lib/Listing/ListRequest.php:349
    private static App\Core\Lib\Listing\ListRequest::normalizeDirectionValue(string $value, string $default = 'asc'): string Normalize sort direction Converts to lowercase, validates 'asc' or 'desc', re...
    /**
 * Normalize sort direction
 * Converts to lowercase, validates 'asc' or 'desc', returns default if invalid
 * @param string $value
 * @param string $default Default value if input invalid
 * @return string
 */

Defined in .../app/Core/Lib/Listing/ListRequest.php:362
    private static App\Core\Lib\Listing\ListRequest::normalizePageValue(string|int $value, int $default = 1): int Normalize page value Converts to integer, ensures minimum 1, returns default ...
    /**
 * Normalize page value
 * Converts to integer, ensures minimum 1, returns default if invalid
 * @param int|string $value
 * @param int $default Default page if input invalid
 * @return int
 */

Defined in .../app/Core/Lib/Listing/ListRequest.php:378
    private static App\Core\Lib\Listing\ListRequest::normalizePerPageValue(string|int $value, int $max = 100): int Normalize items per page Converts to integer, applies min 1 and max limit
    /**
 * Normalize items per page
 * Converts to integer, applies min 1 and max limit
 * @param int|string $value
 * @param int $max Maximum allowed perPage
 * @return int
 */

Defined in .../app/Core/Lib/Listing/ListRequest.php:391
$lr->toEncryptedString() string (102) "m4bm0z53DkQ-swBLf6ot2is4C0y9ILJIebxGbgjI2LTzY9BJc9Oq2juHQ4R3vLVAlNV_QpaYZr_t...
m4bm0z53DkQ-swBLf6ot2is4C0y9ILJIebxGbgjI2LTzY9BJc9Oq2juHQ4R3vLVAlNV_QpaYZr_t0GrsCxxXtgIdsHnamngWd8RRNw
https://appstarter3.testownia.kluz.eu/test/lib/listing/list-request?l=kOQrgtdwElv9yk6Dwhavbhs4Reo_desEf9Af8Ax2fazCCx8D2G8v0nq5q4_0egIP7svvOY54HpUO4qv1neFrSlWZr-3p9OuY1tb8ow