ProcessPageLister class

Admin tool for finding and listing pages by any property.

Click any linked item for full usage details and examples. Hookable methods are indicated with the icon. In addition to those shown below, the ProcessPageLister class also inherits all the methods and properties of: Process, WireData and Wire.

Show class?     Show args?       Only hookable?    

Common

NameReturnSummary 
ProcessPageLister::addSessionBookmark(string $id, array $bookmark)
string

Given a unique ID and an array of Lister settings (in $bookmark) return a URL to view those pages in Lister

 
ProcessPageLister::buildColumnsField()
None

Build the columns asmSelect

 
ProcessPageLister::checkBookmark()
null string false

Check for a bookmark specified in GET variable $n

 
ProcessPageLister::execute()
string

Execute the main Lister action, which is to render the Lister

ProcessPageLister::executeActions()
stringListerPro
ProcessPageLister::executeConfig()
stringListerPro
ProcessPageLister::executeEditBookmark()
string

Implementation for ./edit-bookmark/ URL segment

ProcessPageLister::executeNavJSON()
string array

Output JSON list of navigation items for this module's bookmarks

ProcessPageLister::executeReset()
None

Execute the reset action, which resets columns, filters, and anything else stored in the session

ProcessPageLister::executeSave()
stringListerPro
ProcessPageLister::executeUnknown()
string

Catch-all for bookmarks

ProcessPageLister::executeViewport()
stringListerPro
ProcessPageLister::get(string $key)
mixed string

Get a Lister setting

 
ProcessPageLister::getBookmarksInstance()
ProcessPageListerBookmarks

Get an instance of ProcessPageListerBookmarks

 
ProcessPageLister::getInputfieldSelector()
InputfieldSelector

Get the InputfieldSelector instance for this Lister

 
ProcessPageLister::getSelector()
string

Get the selector string to be used in finding results

ProcessPageLister::getSelectorTemplates(string $selector)
array

Determine allowed templates from selector string

 
ProcessPageLister::identifyLanguage(string $name)
Language null

Identify language for given field name / column name

 
ProcessPageLister::prepareExternalAssets()
None

Prepare the session values for external assets

 
ProcessPageLister::removeBlankSelectors(string $selector)
string

Remove blank items like "template=, " from the selector string

 
ProcessPageLister::renderExternalAssets()
string

Return a markup string with scripts that load external assets for an ajax request

 
ProcessPageLister::renderExtras()
string

Render additional tabs, setup so that descending classes can use as a template method

 
ProcessPageLister::resetLister()
None

Reset all Lister settings so it is starting from a blank state

 
ProcessPageLister::sessionClear()
None

Clear all Lister session variables

 
ProcessPageLister::sessionGet(string $key)
string int array null

Get a Lister session variable

 
ProcessPageLister::sessionSet(string $key, $value)
None

Set a Lister session variable

 
ProcessPageLister::set(string $key, mixed $value)
ProcessPageLister Process

Set a Lister setting

 

For hooks

These methods are only useful for hooking and should not be called directly.

NameReturnSummary 
ProcessPageLister::renderedExtras(string $markup)
string

Called when extra tabs markup has been rendered

Properties

NameReturnSummary 
ProcessPageLister::addURL string Add page base URL [$config->urls->admin . 'page/add/']  
ProcessPageLister::allowBookmarks bool Whether or not to allow bookmarks 
ProcessPageLister::allowIncludeAll bool allow include=all or check_access=0 mode when user is non-superuser? [false] 
ProcessPageLister::allowSystem bool whether or not system templates/fields are allowed for selection. for system fields, it only refers to system custom fields excluding title. [false] 
ProcessPageLister::blankLabel string Label when a field is blank
DEFAULT: Blank		 
ProcessPageLister::cacheTotal bool cache the total, per selector, for increased performance? [true]  
ProcessPageLister::columns array Array of columns (field names) to display in the lister  
ProcessPageLister::configMode bool Configuration mode where some limits are removed
DEFAULT: false		 
ProcessPageLister::defaultLimit int Max items to show per pagination [25] 
ProcessPageLister::defaultSelector string The default selector string that appears but MAY be removed or changed [template=, title%=] 
ProcessPageLister::defaultSort string Default field to sort by [-modified] 
ProcessPageLister::delimiters array Delimiters for multi-value column values, indexed by field name 
ProcessPageLister::disallowColumns array columns that may not be displayed [array(pass,config)] 
ProcessPageLister::editMode int Edit mode, see windowMode constants [self::windowModeNone]  
ProcessPageLister::editOption int Edit option setting, used only by ListerPro 
ProcessPageLister::editURL string Edit page base URL [$config->urls->admin . 'page/edit/']  
ProcessPageLister::imageFirst int bool Show only first image? [false]  
ProcessPageLister::imageHeight int Height for thumbnails, 0=proportional to width [100] 
ProcessPageLister::imageStyle int 1=Detailed, 0=Image only
DEFAULT: 0		 
ProcessPageLister::imageWidth int Width for thumbnails, 0=proportional to height [0] 
ProcessPageLister::initSelector string The selector string that may not be changed. 
ProcessPageLister::limitFields array Limit selectable filters/columns to only those present in this array [empty] 
ProcessPageLister::nativeDateFormat string wireDate() format for created and modified dates 
ProcessPageLister::parent null Page Parent page for all listed children (optional) 
ProcessPageLister::preview bool whether or not to show the selector string preview in InputfieldSelector [self::debug] 
ProcessPageLister::responsiveTable bool Whether or not Lister table should be responsive rather than horiz scroll 
ProcessPageLister::showIncludeWarnings bool Whether or not to show warnings about what pages were excluded to to max "include=" mode [true] 
ProcessPageLister::statusLabels array Array of status labels of status_name => label 
ProcessPageLister::systemLabels array Array of system page labels of field_name => label 
ProcessPageLister::template null Template Template page for all listed children (optional) 
ProcessPageLister::toggles array One or more of: collapseFilters, collapseColumns, noNewFilters, disableColumns, noButtons [empty] 
ProcessPageLister::useColumnLabels bool whether to use labels for fields (versus names) in column selection and column labels [true]  
ProcessPageLister::viewMode int View mode, see windowMode constants [self::windowModeNone] 

Additional methods and properties

In addition to the methods and properties above, ProcessPageLister also inherits the methods and properties of these classes:

API reference based on ProcessWire core version 3.0.252