WIKINDX API trunk

EXPORTER

AbstractYes

EXPORTER

parent/base exporter class. The specific exporter classes should inherit.

Table of Contents

Properties

$authors  : mixed
array
$creators  : mixed
array
$db  : mixed
object
$entry  : mixed
array
$map  : mixed
object

Methods

export()  : mixed
This is the main public function for exporting
formatName()  : string
formatName - format one name depending on the export type
titleFormat()  : string
titleFormat - format and return the resource title from the supplied SQL $row
convertEntry()  : mixed
Convert raw array of data to the appropriate format
dateFormat()  : mixed
Create date
getData()  : mixed
get and format data
nameFormat()  : mixed
format names
uEncode()  : mixed
Url encode

Properties

$creators

array

protected mixed $creators

Methods

export()

This is the main public function for exporting

public abstract export(array<string|int, mixed> $row, array<string|int, mixed> $creators, array<string|int, mixed> $publishers) : mixed
Parameters
$row : array<string|int, mixed>
$creators : array<string|int, mixed>
$publishers : array<string|int, mixed>

formatName()

formatName - format one name depending on the export type

public formatName(array<string|int, mixed> $creatorRow, string $exportType) : string
Parameters
$creatorRow : array<string|int, mixed>
$exportType : string
Return values
string

titleFormat()

titleFormat - format and return the resource title from the supplied SQL $row

public titleFormat(array<string|int, mixed> $row[, bool $bibtex = false ]) : string
Parameters
$row : array<string|int, mixed>
$bibtex : bool = false
Return values
string

convertEntry()

Convert raw array of data to the appropriate format

protected abstract convertEntry() : mixed

dateFormat()

Create date

protected dateFormat(array<string|int, mixed> $row) : mixed
Parameters
$row : array<string|int, mixed>

getData()

get and format data

protected getData(array<string|int, mixed> $row) : mixed
Parameters
$row : array<string|int, mixed>

nameFormat()

format names

protected nameFormat() : mixed

uEncode()

Url encode

protected abstract uEncode(string $element) : mixed
Parameters
$element : string

        
On this page

Search results