1. class
  2. Poweradmin
  3. \
  4. Application
  5. \
  6. Service
  7. \
  8. Zone
  9. \
  10. ZoneSortingService

ZoneSortingService

class ZoneSortingService (View source)

Resolves the zone list's sort column, direction and reverse-zone filter from submitted values and the session.

Methods

__construct(ReverseZoneSorterInterface $reverseZoneSorting, UserContextService $userContextService)

No description

array
getZoneSortOrder(array $allowedValues, string $sessionKey = SessionKeys::LIST_ZONE_SORT_BY, string $defaultSortBy = 'name', mixed $submittedSortBy = null, mixed $submittedDirection = null)

Get zone sort order from session/submitted values. Callers pass distinct $sessionKey values (see {SessionKeys}) to keep buckets isolated.

array
applySortingToZones(array $zones, string $sortBy, string $sortType)

Apply client-side sorting to reverse zones when sorting by name

string
getReverseZoneTypeFilter(mixed $submittedType = null)

Get reverse zone type filter from a submitted value, falling back to session.

Details

at line 39
__construct(ReverseZoneSorterInterface $reverseZoneSorting, UserContextService $userContextService)

No description

Parameters

ReverseZoneSorterInterface $reverseZoneSorting
UserContextService $userContextService

at line 56
array getZoneSortOrder(array $allowedValues, string $sessionKey = SessionKeys::LIST_ZONE_SORT_BY, string $defaultSortBy = 'name', mixed $submittedSortBy = null, mixed $submittedDirection = null)

Get zone sort order from session/submitted values. Callers pass distinct $sessionKey values (see {SessionKeys}) to keep buckets isolated.

Parameters

array $allowedValues

Allowed sort values
string $sessionKey

Session bucket (direction stored under $sessionKey . '_direction')
string $defaultSortBy

Fallback sort column when nothing valid is supplied
mixed $submittedSortBy

Sort column as submitted (POST first, then GET); anything but a string is ignored
mixed $submittedDirection

Sort direction as submitted; anything but a string is ignored

Return Value

array

[sortBy, sortDirection]

at line 109
array applySortingToZones(array $zones, string $sortBy, string $sortType)

Apply client-side sorting to reverse zones when sorting by name

Parameters

array $zones

Array of zones to sort
string $sortBy

Sort column
string $sortType

Sorting type (natural, etc.)

Return Value

array

Sorted zones

at line 143
string getReverseZoneTypeFilter(mixed $submittedType = null)

Get reverse zone type filter from a submitted value, falling back to session.

Parameters

mixed $submittedType

Filter value as submitted; anything but a string is ignored

Return Value

string