\LISTCOMMON

LISTCOMMON common functions for listing, searching, selecting etc. resources

Summary

Methods
Properties
Constants
__construct()
resourcesExist()
lastMulti()
display()
noResources()
displayAscDesc()
pagingStyle()
displayOrder()
$pagingObject
$keepHighlight
$patterns
$navigate
$listQuarantined
$metadata
$metadataKeyword
$metadataText
$metadataTextCite
$metadataTextJoin
$metadataTextCond
$quickSearch
$browse
$metadataPaging
$ideasFound
No constants found
No protected methods found
No protected properties found
N/A
No private methods found
No private properties found
N/A

Properties

$pagingObject

$pagingObject : 

object

Type

$keepHighlight

$keepHighlight : 

boolean

Type

$patterns

$patterns : 

string

Type

$navigate

$navigate : 

string

Type

$listQuarantined

$listQuarantined : 

boolean

Type

$metadata

$metadata : 

boolean

Type

$metadataKeyword

$metadataKeyword : 

string

Type

$metadataText

$metadataText : 

array

Type

$metadataTextCite

$metadataTextCite : 

array

Type

$metadataTextJoin

$metadataTextJoin : 

array

Type

$metadataTextCond

$metadataTextCond : 

array

Type

$quickSearch

$quickSearch : 

boolean

Type

$browse

$browse : 

string

Type

$metadataPaging

$metadataPaging : 

boolean

Type

$ideasFound

$ideasFound : 

booolean *

Type

Methods

__construct()

__construct() : 

LISTCOMMON

Returns

resourcesExist()

resourcesExist() : 

Check there are resources to display

Returns

lastMulti()

lastMulti(  listType = FALSE) : 

Display a list from the lastMulti menu item

Parameters

listType

(list, search etc)

Returns

display()

display(  sql,   listType = FALSE) : 

Produce a list of resources

Parameters

sql
listType

Default is FALSE

Returns

noResources()

noResources(  listType) : 

Tidy display when there are no resources

Parameters

listType

Returns

displayAscDesc()

displayAscDesc(  type) : 

Print radio buttons ascending, descending for ordering

Parameters

type

Returns

pagingStyle()

pagingStyle(  sql,   listType,   order,   queryString,   conditions = FALSE,   joins = FALSE,   conditionsOneField = FALSE,   table = resource,   subQ = FALSE) : 

Set the paging object if paging is alphabetic or not

Parameters

sql
listType
order
queryString
conditions

Array of conditions to SQL (default is FALSE)

joins

Array of table joins to SQL (array(table => array(rightField, leftField)) (Default is FALSE)

conditionsOneField
table

default is 'resource'

subQ

Optional SQL subquery for input to COUNT operations - default is FALSE

Returns

displayOrder()

displayOrder(  type,   reorder = FALSE) : 

Ordering options for select and quicksearch

Parameters

type
reorder

Default is FALSE

Returns