Common methods for user bibliographies

version 1
package wikindx4\core\browse
author Mark Grimshaw

 Methods

BROWSECOMMON

__construct() 

Work out text colour based on field frequency.

colourText(int $lowestSum, int $highestSum, int $frequency) : string

Parameters

$lowestSum

int

$highestSum

int

$frequency

int

Returns

string

Format display information string

linksInfo() 

Return limited set from final array if paging required

paging(array $inputArray) : array

Parameters

$inputArray

array

Returns

array

Work out text size based on field frequency.

sizeText(int $lowestSum, int $highestSum, int $frequency) : string

Size range is 1em to 1.5em for items with $index of <= 255 and more for anything larger. Limit maximum size to 2.

Parameters

$lowestSum

int

$highestSum

int

$frequency

int

Returns

string

Return a SQL condition clause if we are browsing a user bibliography to ensure that listed, selected or searched resources come only from that user bibliography.

userBibCondition(string $field, boolean $bibInfo) 

Parameters

$field

string

SQL field to join 'userbibliographyresourceResourceId' to

$bibInfo

boolean

If TRUE, gather bibliography details into $this->bibInfo. Default is TRUE

Set the paging counter

setPaging() 

 Properties

 

$bibInfo 
 

$commonBib 
 

$config 
 

$db 
 

$highColour 
 

$highSize 
 

$html 
 

$lowColour 
 

$lowSize 
 

$messages 
 

$session 
 

$sizeDiff 
 

$template 
 

$vars