Format a bibliographic resource for output.
package | wikindx4\core\bibcitation |
---|---|
author | Mark Grimshaw |
__construct(string $output)
string
'html', plain', 'rtf'. Default is 'html'
addAllOtherItems(array $row)
addItem(string $item, string $fieldName)
author | Mark Grimshaw |
---|---|
version | 1 |
string
The item to be added.
string
The database fieldName of the item to be added
checkInitials(array $creator, int $initialsStyle, boolean $firstNameInitial) : string
see | \formatNames() |
---|---|
author | Mark Grimshaw |
version | 1 |
array
Associative array of creator name e.g.
array(['surname'] => 'Grimshaw', ['firstname'] => Mark, ['initials'] => 'M N G', ['prefix'] => ))
Initials must be space-delimited.
int
boolean
string
Formatted string of initials.formatDate(int $startDay, int $startMonth, int $endDay, int $endMonth, boolean $webArticle)
author | Mark Grimshaw |
---|---|
version | 2 |
int
int
int
int
boolean
Default is FALSE. for 'web_article', $startDay and $startMonth represent the publication date
formatNames(array $creators, string $nameType, boolean $shortFootnote) : string
author | Mark Grimshaw |
---|---|
version | 1 |
array
Multi-associative array of creator names e.g. this array might be of the primary authors:
array([0] => array(['surname'] => 'Grimshaw', ['firstname'] => Mark, ['initials'] => 'N', ['prefix'] => ), [1] => array(['surname'] => 'Witt', ['firstname'] => Jan, ['initials'] => , ['prefix'] => 'de'))
string
'creator1', 'creator2' etc.
boolean
If TRUE, this is being used for just the primary creator names in a footnote style citation using Ibid, Idem, op cit. etc. Default is FALSE.
string
Optional if $nameType == 'citation': formatted string of all creator names in the input array.formatPages(string $start, string $end, mixed $citation) : string
$this->style['pageFormat']: 0 == 132-9 1 == 132-39 2 == 132-139
author | Mark Grimshaw |
---|---|
version | 1 |
string
Page start.
string
Page end. Default is FALSE.
mixed
If called from CITEFORMAT, this is the array of citation stylings. Default is FALSE.
string
Pages.formatRunningTime(int $minutes, int $hours)
formatShortTitle(string $pString, string $delimitLeft, string $delimitRight) : void
Anything enclosed in $delimitLeft...$delimitRight is to be left unchanged
author | Mark Grimshaw |
---|---|
version | 1 |
string
Raw title string.
string
Default is FALSE.
string
Default is FALSE.
formatTitle(string $pString, string $delimitLeft, string $delimitRight) : void
Anything enclosed in $delimitLeft...$delimitRight is to be left unchanged
author | Mark Grimshaw |
---|---|
version | 1 |
string
Raw title string.
string
Default is FALSE.
string
Default is FALSE.
formatTransTitle(string $pString, string $delimitLeft, string $delimitRight) : void
Anything enclosed in $delimitLeft...$delimitRight is to be left unchanged
author | Mark Grimshaw |
---|---|
version | 1 |
string
Raw title string.
string
Default is FALSE.
string
Default is FALSE.
getStyle(array $common, array $types, array $footnote)
author | Mark Grimshaw |
---|---|
version | 1 |
array
Array of global formatting data
array
Array of style definitions for each resource type
array
Array of style definitions for footnote creators
initialise()
map(mixed $template) : string
author | Mark Grimshaw |
---|---|
version | 1 |
mixed
If called from CITEFORMAT, this is the array of template elements. Default is FALSE.
string
For printing to the output medium.preProcess(string $type, array $row) : array
author | Mark Grimshaw |
---|---|
version | 1 |
string
The resource type
array
Associate array of raw SQL data
array
Processed row of raw SQL datacardinalToOrdinal(string $cardinal, string $field) : string
author | Mark Grimshaw |
---|---|
version | 1 |
string
Input number.
string
Default is FALSE.
string
checkPartial(string $type)
If it does not and $this->$type has a partial template array, rearrange $this->$type
author | Mark Grimshaw |
---|---|
version | 1 |
string
Resource type
findAlternates(array $typeArray)
preProcessBibtex(array $row, string $type) : string | array
author | Mark Grimshaw |
---|---|
version | 1 |
array
assoc. array of elements for one bibtex entry
string
resource type
string
array
resource type|resource assoc. array of elements for one bibtex entrytitleCapitalization(string $pString, string $delimitLeft, string $delimitRight) : string
author | Mark Grimshaw |
---|---|
version | 1 |
string
Raw title string.
string
string
string
Formatted title string.$citationFootnote
$footnotePages
Setting this to TRUE (set externally in CITEFORMAT) loads a different set of templates and settings for footnotes. The default FALSE is for full bibliography.
$footnoteStyle
$output
$patternHighlight
$patterns
$styleMap
$type
$wikindx
$bibtex
$bibtexParsePath
$countRecords
$creators
$dateMonthNoDay
$dir
$editorSwitch
$footnoteType
$parsestyle
$partialDone
$preview
$previousCreator
$utf8